Skip to content

Commit

Permalink
Updated README for correct pytest file name (#74)
Browse files Browse the repository at this point in the history
Closes #73 

README updated with test_csv_to_code_differences.py
  • Loading branch information
jcadam14 authored Jan 8, 2024
1 parent 5aeb5f1 commit 41faf8b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ branch.

### Testing the FIG CSV

A standard pytest ([`test_csv_differences.py`](tests/test_csv_differences.py)) has been written that compares the validation code in [`phase_validations.py`](regtech_data_validator/phase_validations.py)
A standard pytest ([`test_csv_to_code_differences.py`](tests/test_csv_to_code_differences.py)) has been written that compares the validation code in [`phase_validations.py`](regtech_data_validator/phase_validations.py)
to the [`FIG CSV`](https://github.com/cfpb/sbl-content/blob/main/fig-files/validation-spec/2024-validations.csv). This test will check that
the list of validation IDs in one match the other, and will report on IDs that are missing in either.
The test will also validate that all severities (error or warning) match. The test will then
Expand All @@ -248,7 +248,7 @@ do a hard string compare between the violation descriptions, with a couple of ca
currently the test will strip off some of this formatting and compare the text.

This test is ran automatically as part of our unit testing pipeline. A developer can also
run the test manually by running the command `poetry run pytest tests/test_csv_differences.py`
run the test manually by running the command `poetry run pytest tests/test_csv_to_code_differences.py`

This will create an errors.csv file at the root of the repo that can be used to easily view
differences found between the two files.
Expand Down

0 comments on commit 41faf8b

Please sign in to comment.