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

Profile resolver: Metadata tests and way of determining top UUID #1175

Merged
merged 3 commits into from
Apr 15, 2022

Conversation

galtm
Copy link
Contributor

@galtm galtm commented Mar 15, 2022

Committer Notes

This pull request adds XSpec tests for the profile resolver's metadata phase and also includes minor updates in the XSLT, mostly to align with latest profile resolver spec.

  • Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
  • Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
  • Support global parameter hide-source-profile-uri
  • Stub of opr:oscal-version function
  • Stub of message handler template, using xsl:message for now
  • Add XSpec tests

All Submissions:

  • Have you selected the correct base branch per Contributing guidance?
  • 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]
  • Do all automated CI/CD checks pass?

I don't think my XSLT updates are changes in core features, but let me know if they are.

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@wendellpiez
Copy link
Contributor

Created #1178 to amend readmes at top level, which now require revision. Formerly, the Profile Resolver was used primarily in CI/CD and had simple entry points with no parameters. Now it supports runtime flags, we also need to write the documentation.

wendellpiez
wendellpiez previously approved these changes Mar 15, 2022
Copy link
Contributor

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

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

Made #1178 as follow-on

@david-waltermire
Copy link
Contributor

@wendellpiez and @galtm Should we address #1178 before merging this? This could be done as a PR against or update to @galtm 's branch.

@wendellpiez
Copy link
Contributor

Sure, @galtm what makes sense to you? It's easy enough for me to make a PR using Github alone for this task. Alternatively if you know what you need to know, it would likely be easy to fold in.

@galtm
Copy link
Contributor Author

galtm commented Mar 30, 2022

@wendellpiez and @david-waltermire-nist , are you asking if I can do #1178? I don't mind updating a readme. I have two questions, though.

  1. I noticed that 1178 says it is for v1.0.3, but I assumed this PR would be for a later version. If I mention the runtime flags as in this PR, should I do that on the develop branch and then 1178 is not really for v1.0.3?

  2. Is there more than one readme about the profile resolver? The one I see is https://github.com/usnistgov/OSCAL/blob/main/src/utils/util/resolver-pipeline/readme.md.

@wendellpiez
Copy link
Contributor

@galtm it looks likely to me #1178 is mislabelled and it should be 1.1.0 - @david-waltermire-nist ?

As for which readme, how about updating the one you see, which pertains specifically to how to operate this pipeline, and give us a heads-up if you see anything amiss or wrong in any of the others? We could track loose ends on the Issue and either make edits accordingly or spin off new Issues.

@galtm
Copy link
Contributor Author

galtm commented Mar 30, 2022

@wendellpiez , your idea sounds fine to me, pending version confirmation from @david-waltermire-nist .

@galtm
Copy link
Contributor Author

galtm commented Apr 5, 2022

I pushed 0d0c508 to address #1178 . Also,

  • I clarified what is in the testing subfolder.
  • I made some editorial-type updates that I hope are enhancements.
  • Based on a conversation with @wendellpiez , I changed $home from a global XSLT parameter (settable when invoking the pipeline) to a global XSLT variable because we didn't think the value needed to be settable from the outside.

@wendellpiez and @david-waltermire-nist : Let me know if you want to iterate on the readme or if there's anything else I should do for this PR.

- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
Copy link
Contributor

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

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

Awesome! thanks @galtm

Copy link
Contributor

@david-waltermire david-waltermire left a comment

Choose a reason for hiding this comment

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

Thanks Amanda!

@david-waltermire david-waltermire merged commit de13b23 into usnistgov:develop Apr 15, 2022
@galtm galtm deleted the wip-profiler-tests-2 branch April 17, 2022 15:53
david-waltermire pushed a commit that referenced this pull request May 17, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
david-waltermire pushed a commit that referenced this pull request Jun 21, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
david-waltermire pushed a commit that referenced this pull request Jul 13, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
david-waltermire pushed a commit that referenced this pull request Aug 23, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request Oct 6, 2022
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit that referenced this pull request Oct 18, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
david-waltermire pushed a commit that referenced this pull request Oct 31, 2022
- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request Jan 10, 2023
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request Feb 6, 2023
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request Jun 29, 2023
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request Jul 10, 2023
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
@aj-stein-nist aj-stein-nist removed this from the v1.1.0 milestone Jul 27, 2023
aj-stein-nist pushed a commit to galtm/OSCAL that referenced this pull request Sep 28, 2023
…istgov#1175)

- Metadata tests and way of determining top UUID
- Remove global parameter assign-uuid (note backward incompatibility - is it OK?)
- Instead, support global parameters uuid-method and top-uuid, in uuid-method-choice.xsl
- Support global parameter hide-source-profile-uri
- Stub of opr:oscal-version function
- Stub of message handler template, using xsl:message for now
- Add XSpec tests
- Add table of parameters and clarify testing folder content
- Change "home" from global param to global variable; does not need to be set from outside
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Profile resolution how-to readmes
4 participants