Skip to content

add doctest harness and update CI#93

Draft
gknapp1 wants to merge 3 commits intoORNL:candidate-v2.0.0from
gknapp1:test-harness
Draft

add doctest harness and update CI#93
gknapp1 wants to merge 3 commits intoORNL:candidate-v2.0.0from
gknapp1:test-harness

Conversation

@gknapp1
Copy link
Copy Markdown
Collaborator

@gknapp1 gknapp1 commented May 8, 2026

While we had an integration/smoke test in the CI by running the tutorial case, there are no unit tests for AdditiveFOAM. This adds a doctest framework for unit test.

I chose doctest because it is lightweight enough to not add much of a burden on compiling and can be compiled easily with wmake. This does mean that AdditiveFOAM would vendor (distribute) the doctest header and associated MIT License file to be compatible with the doctest license, which is common practice.

New features:

  • doctest header and initial framework to provide a place to add unit tests
  • basic unit test of the segment functionality to demonstrate
  • update CI to use a OpenFOAM-13 container (third-party, since openfoam.org does not distribute an official OpenFOAM-13 container)
  • update CI to include building and running the unit tests

In draft until:

  • implementation of additional unit tests
  • update once WIP V2.0 refinement model #92 is merged (though possibly will merge this first, then update other PR)

@gknapp1 gknapp1 self-assigned this May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant