Skip to content

feat: Add unit test to verify that every Notice has an entry in RULES.md#1331

Merged
bdferris-v2 merged 5 commits intomasterfrom
issue/1324/rules_documentation_test
Feb 17, 2023
Merged

feat: Add unit test to verify that every Notice has an entry in RULES.md#1331
bdferris-v2 merged 5 commits intomasterfrom
issue/1324/rules_documentation_test

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

@bdferris-v2 bdferris-v2 commented Feb 11, 2023

Summary:

When writing new validation rules, we often forget to update RULES.md with updated documentation. While #1324 has some ideas on addressing that in the long term, in the short term, we can add a unit-test that will fail if there is an entry in RULES.md for a newly added notice.

For example, this test should fail initially because StopWithoutLocationNotice is missing from RULES.md per #1330.

Please make sure these boxes are checked before submitting your pull request - thanks!

@bdferris-v2 bdferris-v2 mentioned this pull request Feb 11, 2023
Merged
4 tasks
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 11, 2023

✅ Rule acceptance tests passed.
New Errors: 0 out of 1390 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1390 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1390 sources (~0 %) are corrupted.
Commit: e1a345b
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@isabelle-dr
Copy link
Copy Markdown
Contributor

isabelle-dr commented Feb 13, 2023

Thank you for adding this test @bdferris-v2 !

unit-test that will fail if there is an entry in RULES.md for a newly added notice.
You mean that will fail if there is no entry in RULES.md for a newly added notice, right?

Why is the test_pack_doc workflow failing in this PR?

@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

bdferris-v2 commented Feb 13, 2023

@isabelle-dr the test is correctly identifying that StopWithoutLocationNotice is not properly documented in RULES.md and failing as result :)

@bdferris-v2 bdferris-v2 mentioned this pull request Feb 16, 2023
Open
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 16, 2023

✅ Rule acceptance tests passed.
New Errors: 0 out of 1391 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1391 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1391 sources (~0 %) are corrupted.
Commit: d749c0f
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

asvechnikov2
asvechnikov2 approved these changes Feb 17, 2023
View reviewed changes
Copy link
Copy Markdown
Collaborator

@asvechnikov2 asvechnikov2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of questions, otherwise, looks good, thank you!

@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

bdferris-v2 commented Feb 17, 2023

@asvechnikov2 thanks for the review!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 17, 2023

✅ Rule acceptance tests passed.
New Errors: 0 out of 1391 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1391 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1391 sources (~0 %) are corrupted.
Commit: 0ff991a
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@bdferris-v2 bdferris-v2 merged commit 865fc1e into master Feb 17, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/rules_documentation_test branch February 17, 2023 06:12
KClough pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Feb 24, 2023
@bdferris-v2 @KClough
feat: Add unit test to verify that every Notice has an entry in RULES…
d7a178b 
….md (MobilityData#1331)

* Add a unit test that verifies that every Notice has an entry in RULES.md.
* Move notice schema scanning into ClassGraphDiscovery for consistency with other ClassGraph methods.
* Include doc changes in the test_pack_doc.yml workflow.
KClough pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Mar 1, 2023
@bdferris-v2 @KClough
feat: Add unit test to verify that every Notice has an entry in RULES…
18a4911 
….md (MobilityData#1331)

* Add a unit test that verifies that every Notice has an entry in RULES.md.
* Move notice schema scanning into ClassGraphDiscovery for consistency with other ClassGraph methods.
* Include doc changes in the test_pack_doc.yml workflow.
@isabelle-dr isabelle-dr linked an issue Mar 27, 2023 that may be closed by this pull request
[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md) #1324
Closed
ryon pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Apr 1, 2023
@bdferris-v2 @ryon
feat: Add unit test to verify that every Notice has an entry in RULES…
f3c3398 
….md (MobilityData#1331)

* Add a unit test that verifies that every Notice has an entry in RULES.md.
* Move notice schema scanning into ClassGraphDiscovery for consistency with other ClassGraph methods.
* Include doc changes in the test_pack_doc.yml workflow.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asvechnikov2 asvechnikov2 asvechnikov2 approved these changes

@isabelle-dr isabelle-dr Awaiting requested review from isabelle-dr

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md)

3 participants

@bdferris-v2 @isabelle-dr @asvechnikov2