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 unit test metaschema conformant with ADR#6 #826

Conversation

aj-stein-gsa
Copy link
Contributor

@aj-stein-gsa aj-stein-gsa commented Oct 28, 2024

Committer Notes

This PR will add a machine-readable specification of the JSON/YAML-based unit-test initiated in #593. It does not include proposed changes with team support in #817. Such a change will come in a later PR.

All Submissions:

  • Have you selected the correct base branch per Contributing guidance?
  • Have you set "Allow edits and access to secrets by maintainers"?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions] (Will squash/rebase on approval and merge.)
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • If applicable, have all FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated.? This is a backlog item to backport work into gaps from previous and current issues in progress on the board.
  • If applicable, does this PR reference the issue it addresses and explain how it addresses the issue? This is a backlog item to backport work into gaps from previous and current issues in progress on the board.

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

We are proposing changes to the structure of the JSON/YAML unit test
file used for all constraints test suite management. This version
documents the model of that YAML file before the proposed change in the
comments of the GSA#817 PR, linked below.

GSA#817 (comment)
@aj-stein-gsa aj-stein-gsa added the type: backlog item For developer work that is not part of a user-facing epic or user story. label Oct 28, 2024
@aj-stein-gsa aj-stein-gsa self-assigned this Oct 28, 2024
@aj-stein-gsa aj-stein-gsa changed the title [skip ci] Metaschema module for unit test struct Add unit test metaschema conformant with ADR#6 Oct 28, 2024
@aj-stein-gsa aj-stein-gsa marked this pull request as ready for review October 28, 2024 21:25
@aj-stein-gsa aj-stein-gsa requested a review from a team as a code owner October 28, 2024 21:25
This addresses changes that should be handled as determined by upstream
guidance from metaschema-framework maintainers.

metaschema-framework/metaschema-java#221
metaschema-framework/metaschema#44
@aj-stein-gsa aj-stein-gsa force-pushed the chore-backport-unit-test-metaschema-model branch from 417ad9e to 3a245cf Compare October 29, 2024 02:13
Gabeblis
Gabeblis previously approved these changes Oct 29, 2024
Copy link

@Gabeblis Gabeblis left a comment

Choose a reason for hiding this comment

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

This looks really good! This actually is already compatible with the change I made in #817. This would be useful to integrate into the GitHub Actions workflows.

@aj-stein-gsa
Copy link
Contributor Author

aj-stein-gsa commented Oct 29, 2024

This looks really good! This actually is already compatible with the change I made in #817. This would be useful to integrate into the GitHub Actions workflows.

Yeah turns out making it less compatible was annoying, and I found a resolved bug in metaschema-framework/metaschema-java#219 and a sorta bug (really a "well, don't do that" that will lead to fixups in metaschema-framework/metaschema-java#221, but yep, there you have it.

Copy link
Member

@Rene2mt Rene2mt left a comment

Choose a reason for hiding this comment

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

@aj-stein-gsa this is great!!! Liking the application of metaschema and metaschema constraints this scenario.

I have a blocking change request to include the pipeline assembly reference, but aside from that, I tested locally and it looks good.

Thanks to @Rene2mt for PR feedback about the missing ref to the assembly definition of pipeline in the model.

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Copy link

@Gabeblis Gabeblis left a comment

Choose a reason for hiding this comment

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

Solid, solid as a rock

@aj-stein-gsa aj-stein-gsa merged commit bc9a2a3 into GSA:develop Oct 29, 2024
Copy link
Collaborator

@wandmagic wandmagic left a comment

Choose a reason for hiding this comment

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

nice work, I'll add this to the test runner

wandmagic pushed a commit that referenced this pull request Nov 1, 2024
* [skip ci] Metaschema module for unit test struct

We are proposing changes to the structure of the JSON/YAML unit test
file used for all constraints test suite management. This version
documents the model of that YAML file before the proposed change in the
comments of the #817 PR, linked below.

#817 (comment)

* [skip ci] Document unit test metaschema elements

* [skip ci] Do not explicitly use default types

* [skip ci] Add missing `@id` and `@level` to model

* [skip ci] Add pipeline to pipeline, thx @wandmagic

* [skip ci] Backport #219 docs into model remarks

* [skip ci] Fix max-occurs re bad model cardinality

This addresses changes that should be handled as determined by upstream
guidance from metaschema-framework maintainers.

metaschema-framework/metaschema-java#221
metaschema-framework/metaschema#44

* [skip ci] Is a pipeline with a ref even a pipeline at all?

Thanks to @Rene2mt for PR feedback about the missing ref to the assembly definition of pipeline in the model.

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>

---------

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
brian-ruf pushed a commit to brian-ruf/fedramp-automation that referenced this pull request Nov 8, 2024
* [skip ci] Metaschema module for unit test struct

We are proposing changes to the structure of the JSON/YAML unit test
file used for all constraints test suite management. This version
documents the model of that YAML file before the proposed change in the
comments of the GSA#817 PR, linked below.

GSA#817 (comment)

* [skip ci] Document unit test metaschema elements

* [skip ci] Do not explicitly use default types

* [skip ci] Add missing `@id` and `@level` to model

* [skip ci] Add pipeline to pipeline, thx @wandmagic

* [skip ci] Backport GSA#219 docs into model remarks

* [skip ci] Fix max-occurs re bad model cardinality

This addresses changes that should be handled as determined by upstream
guidance from metaschema-framework maintainers.

metaschema-framework/metaschema-java#221
metaschema-framework/metaschema#44

* [skip ci] Is a pipeline with a ref even a pipeline at all?

Thanks to @Rene2mt for PR feedback about the missing ref to the assembly definition of pipeline in the model.

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>

---------

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
This was referenced Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: backlog item For developer work that is not part of a user-facing epic or user story.
Projects
Status: 🚢 Ready to Ship
Development

Successfully merging this pull request may close these issues.

5 participants