Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add constraint to report positive requirements #32

Open
5 tasks
aj-stein-gsa opened this issue Oct 17, 2024 · 2 comments · May be fixed by #61
Open
5 tasks

Add constraint to report positive requirements #32

aj-stein-gsa opened this issue Oct 17, 2024 · 2 comments · May be fixed by #61
Assignees
Labels
enhancement New feature or request

Comments

@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Oct 17, 2024

User Story:

As a Metaschema developer, I want to be able to write constraints that I must not counterintuitively invert the test or target for the equivalent inverse matches/expect constraint, so I Metaschema syntax to allow a report assembly (in constraint or elsewhere in the Metaschema model) to more clearly support analysis of data elements to provide software users information.

Goals:

  • Semantically distinguish reporting from defining constraints that are errors
  • Syntactically support an "inverse" test for reporting that works by requiring evaluation to equal true(), not false()

Dependencies:

N/A

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@aj-stein-gsa aj-stein-gsa added the enhancement New feature or request label Oct 17, 2024
@aj-stein-gsa
Copy link
Contributor Author

aj-stein-gsa commented Oct 25, 2024

Discussion from a meeting with maintainers:

  • So only difference is really the semantics of the @test in a constraint? Yes.
  • Should we have this but maybe not call it report, but inform? Most likely, AJ agrees.
  • It should have some @level just like other constraints, only inverse semantics @test? Yes, this approach definitely makes sense.

@david-waltermire
Copy link
Contributor

@aj-stein-gsa Would you please create a PR suggesting the changes you describe above for others to review?

aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 9, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 9, 2024
@aj-stein-gsa aj-stein-gsa linked a pull request Dec 9, 2024 that will close this issue
9 tasks
@david-waltermire david-waltermire linked a pull request Dec 10, 2024 that will close this issue
9 tasks
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 12, 2024
Address @david-waltermire's feedback about the missing constraint type
for flags.
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 19, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 19, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Dec 19, 2024
Address @david-waltermire's feedback about the missing constraint type
for flags.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

2 participants