Testing Master Plan

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 (#237)
    • Find more useful tests for kernels
    • Test derivatives against automatic differentiation (#290)
• Unit tests for WCSPH RHS
  • State equations (#292)
  • Viscosity
  • pressure_acceleration (#293)
  • continuity_equation!
  • interact!
    • Linear and angular momentum conservation (#293)
    • Total energy conservation (#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 (#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 #629).
• Tests for callbacks
• Example tests
  • Simple smoke tests as system tests (#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 (#72)
• Doctests
• Run CI on LTS and current stable release versions of Julia (expensive).

Start by reviewing the unchecked items in this testing plan and the existing unit and system tests referenced by the checklist. Choose one narrowly scoped target such as summation_density!, continuity_equation!, or pressure_evolution, then identify its current test entry point. Done means the selected behavior has focused tests that pass and cover the stated case.