Skip to content

Commit

Permalink
Merge pull request #82 from sourceryinstitute/update-readme
Browse files Browse the repository at this point in the history
doc(README.md): describe unit testing framework
  • Loading branch information
rouson authored Apr 24, 2024
2 parents 0729097 + fe768e8 commit a3d9df3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,16 @@ Contents
* Input/output format strings and format string generators

### Classes
* A command-line abstraction that searches for program arguments.
* A minimalistic unit testing framework based around four types (see [./test/main.f90](./test/main.f90) for a use case):
- `test_t` is a parent type to extend when defining unit tests,
- `test_description_t` encapsulates scalar test functions and test descriptoins,
- `vector_test_description`: encapsulates array-valued test functions and test descriptions.
- `test_result_t` encapsulates test deescriptions and boolean (pass/fail) outcomes, and
* Parallel data partitioning and gathering,
* A minimalistic unit testing framework based around three types: `test_t`, `test_description_t`, and `test_result_t`
* (Co-)[Object pattern] abstract parent,
* Runtime units tracking,
* A test oracle using the [Template Method pattern], and
* A command-line abstraction that searches for program arguments.

Documentation
-------------
Expand Down
2 changes: 1 addition & 1 deletion fpm.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name = "sourcery"
version = "4.7.1"
version = "4.8.0"
license = "BSD"
author = ["Damian Rouson"]
maintainer = "[email protected]"
Expand Down

0 comments on commit a3d9df3

Please sign in to comment.