implement new namespace patterns based on ABNF #882

bernhardreiter · 2025-08-15T15:36:56Z

add the new leading ABNF from ABNF suggestions #858 for namespace into src/ssvc/utils/ssvc_namespace_pattern.abnf.
The location was chosen to be as close to the python file where it is integrated.
replace old regular expression patterns in patterns.py with ones generated from the ABNF
Generation was done with

abnf              2.4.0
abnf-to-regexp    1.1.3
python 3.11.2

on Debian GNU/Linux Bookworm.

replace JSON schema files with the newly generated ones
adapt tests for the changed namespace rules
Some experimental tests were removed.

based on #881, so that tests run in principle.

One failing test was there before and is untouched.

black was hinted upon in the repository, so the changed code was run by it.

A review should take a deeper look at the changed testcases in test_namespaces_pattern.py
and note that docs/reference/code/namespaces.md is know to need to be overhauled with the results of the discussions that lead to #858.
(The documentation has not been adapted further as the reasoning behind the #858 are not fully documented in that issue.)

Assuming shared copyright on the new file, ssvc_namespace_pattern.abnf. As I am working on behalf of @tschmidtb51, the (German) BSI owns the copyright of copyrightable changes.

Additional suggestions for further improvements (out of scope for this new code):

Someone may consider to place the namespace properties part in one JSON schema file and refer to it from the others.
Test cases could be overhauled as well, cutting down some elder ones that were kept to show the difference, but maybe a duplication. And adding some more for the enhanced patterns.
Add code to generate an insert the patterns from the ABNF into the python part.
This means extending the requirements.

resolve #858

use new ABNF from #858 and use the pattern created from it to replace the existing patterns. add compatibility definitions and change for tests so the existing tests can be started (and fail where changes from #858 affect them).

.. as it comes from working file `s3.abnf` from #858 (comment) and one intermediate and two trailing spaces are unnecessary

use valid examples where it is fairly obvious what the meaning of the test is. Remove tests where it is not or the test does not seem useful anymore. (The pattern schema is not yet adapted and thus checks via the schema will fail.)

in code that the new ssvc pattern touched

tschmidtb51

First half of my review - main point:

Please use x_example.test#test instead.

docs/reference/code/namespaces.md

tschmidtb51 · 2025-08-15T15:51:06Z

docs/reference/code/namespaces.md

+    `x_org.example#bar`, and there are no guarantees of global uniqueness for the 
+    decision points in the `x_org.example#bar` namespace.


Suggested change

`x_org.example#bar`, and there are no guarantees of global uniqueness for the

decision points in the `x_org.example#bar` namespace.

`x_example.test#test`, and there are no guarantees of global uniqueness for the

decision points in the `x_example.test#test` namespace.

@ahouseholder Or we rephrase that to x_example.test#documentation

I worked on that part - please have a look in the namespaces.md during your review.

src/ssvc/decision_tables/base.py

src/ssvc/outcomes/x_com_yahooinc/paranoids.py

src/test/decision_points/test_dp_base.py

src/test/test_namespaces_pattern.py

.. by fixing a typo in a test example. .. by adding whitespace after [ and before ] to be consistent.

following suggestion in #882 (comment)

following suggestion #882 (comment)

ahouseholder

holding my review until @tschmidtb51's concerns have been resolved.

ahouseholder · 2025-08-19T14:21:44Z

Additional suggestions for further improvements (out of scope for this new code):

Someone may consider to place the namespace properties part in one JSON schema file and refer to it from the others.

Pydantic-generated schemas have redundant $defs across files #831

tschmidtb51

@bernhardreiter Please address my comments.

@ahouseholder There are some questions in this review for you: Could you please answer them?

src/ssvc/utils/ssvc_namespace_pattern.abnf

src/test/test_namespaces_pattern.py

src/test/utils/test_toposort.py

- addresses parts of #858 - update decision to match current ABNF - minor format updates and clarifications

tschmidtb51 · 2025-08-19T16:33:05Z

@ahouseholder: How do we call a collection of decision points in one namespace? It is not necessarily a decision point group... Currently, I use "model" but I guess there should be a better wording for that.

make sure pattern is ended and correct example

…nto namespacepattern

remove code that added an anchor to fix a test

after previous changes that anchored the ssvc pattern

Co-authored-by: tschmidtb51 <[email protected]>

ahouseholder · 2025-08-19T19:06:27Z

@ahouseholder: How do we call a collection of decision points in one namespace? It is not necessarily a decision point group... Currently, I use "model" but I guess there should be a better wording for that.

I'd suggest collection.

We use model interchangeably with the thing we now call a DecisionTable.

to `.example.test#test` from `.com.example#foo` and other combinations.

ahouseholder · 2025-08-19T19:25:37Z

@tschmidtb51 I think I've addressed all your comments directed at me. Please let me know if I've missed anything.

tschmidtb51

Still some minors.

src/test/test_namespaces.py

src/test/test_namespaces_pattern.py

Co-authored-by: tschmidtb51 <[email protected]>

src/ssvc/utils/field_specs.py

remove old textual description in favor of a link to the ABNF, which is a more precise description. Avoid duplication this way.

bernhardreiter · 2025-08-19T21:01:32Z

@bernhardreiter Please also update the namespaces.md based on the ABNF (especially the last 20 lines).

6a0bc7e improved the documentation in two places. It mainly links to the new ABNF file and avoids some duplication this way.

- addresses review comments of #882 - update a few examples - corrected "model" to "collection"

tschmidtb51

I think we addressed all comments so far - @ahouseholder Please review.

bernhardreiter · 2025-08-20T08:55:57Z

Note that docs/reference/code/namespaces.md would still need more love before it is a good documentation. It partly explains the ABNF, mixed with meaning. This would need to be cross checked, then stripped of duplicates, corrected for errors found in the process and then checked in the mkdocs layout.
I suggest a new issue for this.

sei-vsarvepalli · 2025-08-20T19:54:20Z

The link checker fails can be fixed but the src/test/test_mixins.py failures need to be reviewed still.

bernhardreiter · 2025-08-21T07:04:46Z

but the src/test/test_mixins.py failures need to be reviewed still.

Note that this test failure was there before this PR, so the PR does not worsen the situation.

bernhardreiter added 6 commits August 15, 2025 09:54

add new TestNamespacePattern from #858

574f4c8

add new ssvc namspace pattern based on ABNF

9eb9de6

use new ABNF from #858 and use the pattern created from it to replace the existing patterns. add compatibility definitions and change for tests so the existing tests can be started (and fail where changes from #858 affect them).

cleanup whitespace in ssvc_namespace_pattern.abnf

72e7f32

.. as it comes from working file `s3.abnf` from #858 (comment) and one intermediate and two trailing spaces are unnecessary

adapt namespace tests to new patterns from #858

f81c23a

use valid examples where it is fairly obvious what the meaning of the test is. Remove tests where it is not or the test does not seem useful anymore. (The pattern schema is not yet adapted and thus checks via the schema will fail.)

cleanup codestyle with black (minor)

4824e20

in code that the new ssvc pattern touched

put freshly generated schema files in

6a53385

bernhardreiter requested review from ahouseholder, cgyarbrough, j--- and sei-vsarvepalli as code owners August 15, 2025 15:36

bernhardreiter mentioned this pull request Aug 15, 2025

ABNF suggestions #858

Closed

tschmidtb51 suggested changes Aug 15, 2025

View reviewed changes

tschmidtb51 reviewed Aug 15, 2025

View reviewed changes

src/test/test_namespaces_pattern.py Outdated Show resolved Hide resolved

bernhardreiter added 4 commits August 18, 2025 09:24

make namespace abnf and examples more consistent

9bc7850

.. by fixing a typo in a test example. .. by adding whitespace after [ and before ] to be consistent.

improve x_com_yahooinc namespace model example

57b7201

following suggestion in #882 (comment)

improving namespace example

b33d2e0

following suggestion #882 (comment)

fix example x_name-space

80ab7f1

bernhardreiter requested a review from tschmidtb51 August 18, 2025 15:41

ahouseholder self-assigned this Aug 18, 2025

ahouseholder reviewed Aug 18, 2025

View reviewed changes

tschmidtb51 suggested changes Aug 19, 2025

View reviewed changes

tschmidtb51 added 2 commits August 19, 2025 17:27

Merge branch 'main' into namespacepattern

b091c8f

Namespace ABNF

4707b60

- addresses parts of #858 - update decision to match current ABNF - minor format updates and clarifications

bernhardreiter and others added 9 commits August 19, 2025 20:01

improve test_namespaces.py

2f34378

make sure pattern is ended and correct example

Merge remote-tracking branch 'refs/remotes/origin/namespacepattern' i…

d5fee73

…nto namespacepattern

Fix ssvc/utils/patterns.py by anchoring NS_PATTERN

47191aa

remove code that added an anchor to fix a test

cleanup tailing whitespace for ssvc_namespace_pattern.abnf

0dd4e93

change to updated json schema files

975a4b9

after previous changes that anchored the ssvc pattern

Update src/test/test_namespaces.py

1ba6510

Co-authored-by: tschmidtb51 <[email protected]>

Update src/test/test_namespaces_pattern.py

4108860

Co-authored-by: tschmidtb51 <[email protected]>

fix typo in comment of test_namespaces_pattern.py

72c3f7e

Update src/test/test_namespaces_pattern.py

24713a0

Co-authored-by: tschmidtb51 <[email protected]>

change test case for namespace

1c199b4

to `.example.test#test` from `.com.example#foo` and other combinations.

add test if NS_PATTERN is anchored

27b468c

tschmidtb51 reviewed Aug 19, 2025

View reviewed changes

src/test/test_namespaces.py Outdated Show resolved Hide resolved

src/test/test_namespaces_pattern.py Outdated Show resolved Hide resolved

src/test/test_namespaces_pattern.py Outdated Show resolved Hide resolved

bernhardreiter and others added 2 commits August 19, 2025 22:27

Update src/test/test_namespaces_pattern.py

ed27a96

Co-authored-by: tschmidtb51 <[email protected]>

Update src/test/test_namespaces_pattern.py

74f5456

Co-authored-by: tschmidtb51 <[email protected]>

tschmidtb51 reviewed Aug 19, 2025

View reviewed changes

src/ssvc/utils/field_specs.py Outdated Show resolved Hide resolved

adjust documentation for new namespace rules

6a0bc7e

remove old textual description in favor of a link to the ABNF, which is a more precise description. Avoid duplication this way.

Namespace ABNF

026b84c

- addresses review comments of #882 - update a few examples - corrected "model" to "collection"

tschmidtb51 approved these changes Aug 19, 2025

View reviewed changes

fix relative link in namespaces.md documentation

b81144f

sei-vsarvepalli mentioned this pull request Aug 20, 2025

Update namespace documentation as we include ABNF information. #896

Open

sei-vsarvepalli approved these changes Aug 20, 2025

View reviewed changes

sei-vsarvepalli mentioned this pull request Aug 20, 2025

Namespacepattern updates from #882 #898

Merged

ahouseholder merged commit b81144f into CERTCC:main Aug 21, 2025
0 of 2 checks passed

ahouseholder added this to the 2025-09 milestone Aug 21, 2025

		`x_org.example#bar`, and there are no guarantees of global uniqueness for the
		decision points in the `x_org.example#bar` namespace.

implement new namespace patterns based on ABNF #882

implement new namespace patterns based on ABNF #882

Uh oh!

Conversation

bernhardreiter commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tschmidtb51 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tschmidtb51 Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

tschmidtb51 Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

tschmidtb51 Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ahouseholder left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahouseholder commented Aug 19, 2025

Uh oh!

tschmidtb51 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tschmidtb51 commented Aug 19, 2025

Uh oh!

ahouseholder commented Aug 19, 2025

Uh oh!

ahouseholder commented Aug 19, 2025

Uh oh!

tschmidtb51 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bernhardreiter commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tschmidtb51 left a comment

Choose a reason for hiding this comment

Uh oh!

bernhardreiter commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sei-vsarvepalli commented Aug 20, 2025

Uh oh!

bernhardreiter commented Aug 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bernhardreiter commented Aug 15, 2025 •

edited

Loading

tschmidtb51 Aug 19, 2025 •

edited

Loading

ahouseholder left a comment •

edited

Loading

bernhardreiter commented Aug 19, 2025 •

edited

Loading

bernhardreiter commented Aug 20, 2025 •

edited

Loading