Testing Master Plan

[efaulhaber]

This is a to-do list for testing and to keep track of the tests we already have.

• General unit tests
  • Unit tests for constructors and show
  • summation_density! (we only have a very simple test with a single particle, yet)
  • Corrections
  • restart_with! (WCSPH + TLSPH)
  • InitialCondition
    • union
    • setdiff
    • intersect
  • Setups
    • RectangularShape
    • RectangularTank
    • SphereShape
  • Smoothing kernels
    • Integral equals 1 (Add all the other typically used smoothing kernels for SPH #237)
    • Find more useful tests for kernels
    • Test derivatives against automatic differentiation (Test kernel_deriv against automatic differentiation of kernel #290)
• Unit tests for WCSPH RHS
  • State equations (Add tests for state equations #292)
  • Viscosity
  • pressure_acceleration (Add tests for wcsph-wcsph pressure_acceleration and interact! #293)
  • continuity_equation!
  • interact!
    • Linear and angular momentum conservation (Add tests for wcsph-wcsph pressure_acceleration and interact! #293)
    • Total energy conservation (Add test for total energy conservation of WCSPH-WCSPH interaction #294)
    • Momentum and energy conservation with viscosity
    • Momentum and energy conservation with density diffusion
    • More tests?
  • Density diffusion terms
• Unit tests for boundary system RHS
  • Monaghan-Kajtar kernel
  • Monaghan-Kajtar pressure_acceleration
  • Dummy particles pressure_acceleration (RHS tests for dummy particles #327)
  • Adami pressure extrapolation
  • interact!
• Unit tests for EDAC RHS
  • pressure_evolution
  • interact!
• Unit tests for solid dynamics
  • Penalty force
  • Correction matrix
  • Deformation gradient and stress tensor
• Unit tests for neighborhood search
  • TrivialNeighborhoodSearch
  • GridNeighborhoodSearch
    • Basic 2D
    • Basic 3D
    • Periodicity 2D
    • Periodicity 3D
• Linear interpolation
• Tests for visualization. Especially verification of plots (see [Docs] Getting started page claims a plot is automatically diplayed, but it isn't #629).
• Tests for callbacks
• Example tests
  • Simple smoke tests as system tests (Add system tests (smoke tests for now) #47)
  • Add some kind of solution verification for system tests. At least to catch obvious problems like when the solid in FSI is not moving.
  • Properly verify examples that are reproducing papers against the papers.
  • Run example tests with coverage (expensive). We have to track this coverage separately from the unit test coverage, or the unit test coverage report is useless. We may want to think about showing only the unit test coverage badge, or both if possible. Otherwise, the example coverage should just be used internally to keep track of the example tests.
  • Try to test the full feature set with system tests (run examples with different BCs, with and without NHS, with and without viscosity, etc.)
• Add coverage for unit tests (Enable coverage in CI for unit and integration tests #72)
• Doctests
• Run CI on LTS and current stable release versions of Julia (expensive).

[svchb]

@efaulhaber please update

[efaulhaber]

I've updated the list and made it very detailed, so that we have a good overview of what we already have and which tests we still need, exactly. For example, in case we add interact! tests first, we might forget about isolated pressure_acceleration tests, since pressure_acceleration will show up as covered in the coverage report.

Feel free to add any other tests that we want to have, so that we don't forget about them.

CC: @LasNikas