Skip to content

Commit

Permalink
Test/general tests (#331)
Browse files Browse the repository at this point in the history
* check that ruleset is full

* add comments

* note about why no docs for tests

* update total rules to 105
  • Loading branch information
tab1tha authored Aug 23, 2023
1 parent 35d0d60 commit 4bd5a70
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# CIN-validator
The CIN validator is an open source, volunteer built tool that allows users to validate CIN census data year round via the command line, or using the browser based front end (URL HERE). It also provides a framework which other validation tools can easily be built on top of.

The functions are documented using sphinx format so that a docs website can be auto-generated if need be. Also, there is an increased use of python typing as a form of intrinsic documentation. This does not apply to test functions as they neither receive nor return data, in the strict sense.
More extensive documentation can be found here: https://data-to-insight.github.io/CIN-validator/

## Setup
Expand Down
8 changes: 8 additions & 0 deletions tests/test_ruleset.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
def test_ruleset_complete():
# registry is filled with whatever ruleset is imported.
# If multiple rulesets are imported, the registry will contain the sum of them all.
import cin_validator.rules.cin2022_23
from cin_validator.rule_engine import registry

# check that there are 107 rules in the 2022/2023 version of CIN rules.
assert len(registry) == 105

0 comments on commit 4bd5a70

Please sign in to comment.