Profile resolution working #559

wendellpiez · 2019-12-06T18:48:56Z

Committer Notes

WIP for Profile resolution, including specification and examples.

All Submissions:

Have you followed the guidelines in our Contributing document?
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?

Changes to Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them? Yes, although there is more to do
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. Pending

bradh

Just a few random comments based on a first-pass look.

bradh · 2019-12-06T22:57:05Z

docs/themes/uswds.rej

@@ -0,0 +1,5 @@
+--- docs/themes/uswds


Don't think you want this file.

@david-waltermire-nist is this in the way?

bradh · 2019-12-06T23:10:09Z

src/specifications/profile-resolution/readme.md

+
+* XML authoring using raw tags or alternatively, in a structured editing environment with outlining, layout, formatting and UI widgets
+* One-button production of a self-contained HTML file for preview in a browser
+* Another button for production of a version for the web site (targeting NIST/USWDS/Hugo - in development


Closing bracket missing.

Superseded --

bradh · 2019-12-06T23:13:10Z

src/specifications/profile-resolution/profile-resolution-working-specml.xml

+      <p>A valid catalog must have <tgt>metadata</tgt> in addition to controls and control groups.
+        Additionally it may have <tgt>back-matter</tgt>. How to produce and populate the
+          <tgt>metadata</tgt> and <tgt>back-matter</tgt> is described below 
+        <revisit>link me</revisit>, as is the construction


More work on the spec is in order: this is pretty soft.

bradh · 2019-12-06T23:15:30Z

src/specifications/profile-resolution/readme.md

+* One-button production of a self-contained HTML file for preview in a browser
+* Another button for production of a version for the web site (targeting NIST/USWDS/Hugo - in development
+* Schematron support for ad-hoc rules
+* Lightweight tagging is an HTML core plus a little healthy XML goodness for a few specification-oriented semantics


The meaning of this line isn't very clear. Is more about the implementation than the capability?

bradh · 2019-12-06T23:16:18Z

src/specifications/profile-resolution/readme.md

+
+So far, the Schematron performs only one test: it complains if the section numbering goes too deep.
+
+The RNC schema does introduce ID/IDREF relations, which oXygen exploits


Add "." at the end, otherwise it looks like the file might just have been chopped off.

bradh · 2019-12-06T23:19:11Z

src/utils/util/resolve/punchlist.md

+
+Things to sketch out and test:
+
+Import with no include - implicit all


I think you already have this as an example?

This is now in the experimental pipeline with clearer docs.

bradh · 2019-12-06T23:36:58Z

src/specifications/profile-resolution/profile-resolution-examples/abc-full_catalog.xml

+        <title>ABC Catalog</title>
+        <last-modified>2019-11-01T10:16:22.939-04:00</last-modified>
+        <version>1.0</version>
+        <oscal-version>1.0-MR2</oscal-version>


I think we used 1.0.0-milestone2 in existing examples.

bradh · 2019-12-06T23:42:20Z

src/utils/util/resolver-pipeline/readme.md

+P --> import3[Selection] 
+import3 --> catalog.B[CPG from Catalog B]
+
+CPG is "controls, parameters and groups" remember parameters can be loose


"loose" probably needs extra explanation or cross-reference.

anweiss · 2019-12-09T18:43:47Z

@wendellpiez is it worth maybe including in the output catalog a reference to the profile(s) from which the catalog itself was resolved? ... i.e. a circular ref ... profile(s) > catalog (which has ref to profile(s) from which it was resolved). Otherwise, it's difficult to tell which profile(s) that a particular catalog was resolved from.

…tion (#23)

These are selective imports from the catalogs/abc-simple_catalog.xml, essentially identical except for how the catalog is referenced.

…le (#16) This is basically the entire catalog, except for the a1 profile. The change adds the parent groups, and the children of c1.

This is essentially the same as the catalog, and adds the parent groups to the existing result.

This adds the parent group, missing params and parts of the control.

This is basically the same as the catalog, less the children on c1

Adds the parent group and title, and missing control c3.a-1

These are essentially identical, since keep is the default.

david-waltermire · 2020-02-07T19:02:52Z

This will be addressed by PR #624, where the commits from this PR have been rebased. Closing this PR as a result.

Committing back working files

38f28ac

wendellpiez mentioned this pull request Dec 6, 2019

Profile resolution ng #513

Closed

4 tasks

wendellpiez added 4 commits December 6, 2019 16:16

Now with cleanup logic

39ef578

Progress on spec; finishing pass on profile resolution

bf95e9d

More finishing touches

92abd28

Tightening logic in modify stage

7886e93

bradh reviewed Dec 6, 2019

View reviewed changes

wendellpiez added 2 commits December 6, 2019 19:45

Fixing up as-is merging

06e56c4

Small repairs in modify phase

715e412

wendellpiez added 15 commits December 9, 2019 14:44

More modification testing

1b16388

More unit testing for resolution pipeline

2e2ddff

Building out end-to-end testing for profile resolution

bc0806b

Refinements to profile resolution draft

6dfdf07

Now supporting 'trace' switch for verbose pipelining

d18ef71

Renaming resolution processing subdirectories

9f41439

Adding start of merge-custom xspec tests

109d421

Adding merge logic for back matter

7112187

Now combining back matter in merge

be3b7bb

Adding a provisional 'output-expected' resolved profile set

203c887

More adjustments to profile resolution pipeline

3f1d467

Renamed profile resolution tests (the hard way)

626df20

Renaming stylesheet parameter

f54f672

Refreshed testing files

f99e94a

Further adjustments to spec draft

005b261

david-waltermire mentioned this pull request Dec 12, 2019

Placement of loose parameters in profile resolution #523

Closed

wendellpiez added 4 commits December 12, 2019 11:40

Renaming and cleanup

a3bd632

Addressing usnistgov#523: top level of catalog model now permits param

0846697

New starter XSLT for production of Profile Resolution Specification

58e4a7e

Removed older draft material

9f44355

bradh and others added 10 commits January 7, 2020 10:51

Fix typo in match part of spec.

71c8f0f

add Docker resources and update build scripts

366f714

update doc README

ec1035f

fix typos

93ceac8

Restored broken links from flags to their fields/assemblies.

8f0225e

Added simple control call link checker Schematron cf Issue usnistgov#534

c612c76

updated maven version to 3.6.3 to fix missing 3.6.2

6852835

Updated Dev Lunch Bluejeans URL

07c2e1d

Added CircleCI script for generating the profile resolution specifica…

db3fdf2

…tion (#23)

Adding profile resolution HTML to gitignore

2fccd6a

wendellpiez force-pushed the profile-resolution-ng-repaired branch from 918d284 to 2fccd6a Compare January 7, 2020 15:52

bradh added 10 commits January 7, 2020 10:59

Fix catalog reference in loose param test profile example (#13)

295ef3d

Fix profile resolver results for full-test_profile.xml example (#14)

df88d22

Update "expected" profile resolver output for the base tests. (#15)

6c0e0d6

These are selective imports from the catalogs/abc-simple_catalog.xml, essentially identical except for how the catalog is referenced.

Update expected resolution result for exclude-call-test profile examp…

cd81cf1

…le (#16) This is basically the entire catalog, except for the a1 profile. The change adds the parent groups, and the children of c1.

Update all-test profile resolution result. (#17)

9e9667a

Update the expected implicit "all" profile resolver result. (#18)

95c4982

This is essentially the same as the catalog, and adds the parent groups to the existing result.

Update loose param profile resolution example (#19)

117040c

This adds the parent group, missing params and parts of the control.

Update the all-no-children profile resolution example result (#20)

c977982

This is basically the same as the catalog, less the children on c1

Update include-call-with-children profile resolution example (#21)

ae999b4

Adds the parent group and title, and missing control c3.a-1

Update merge-keep profile resolution examples. (#22)

9f7a33b

These are essentially identical, since keep is the default.

wendellpiez mentioned this pull request Jan 16, 2020

Profile unit tests for normal and edge cases #121

Closed

Addressing feedback from @bradh see usnistgov#559

442ea40

david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this pull request Feb 7, 2020

Addressing feedback from @bradh see usnistgov#559

d38d766

david-waltermire mentioned this pull request Feb 7, 2020

Integration of Profile Resolution NG into Build Process #624

Merged

8 tasks

david-waltermire closed this Feb 7, 2020

david-waltermire mentioned this pull request Feb 7, 2020

Tracking control identity via catalog of origin #538

Closed

3 tasks

david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this pull request Mar 17, 2020

Addressing feedback from @bradh see usnistgov#559

e64f739

david-waltermire pushed a commit that referenced this pull request Mar 27, 2020

Addressing feedback from @bradh see #559

171c8ec

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Profile resolution working #559

Profile resolution working #559

wendellpiez commented Dec 6, 2019

bradh left a comment

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

bradh Dec 6, 2019

wendellpiez Jan 23, 2020

anweiss commented Dec 9, 2019 •

edited

Loading

david-waltermire commented Feb 7, 2020


		So far, the Schematron performs only one test: it complains if the section numbering goes too deep.

		The RNC schema does introduce ID/IDREF relations, which oXygen exploits


		Things to sketch out and test:

		Import with no include - implicit all

Profile resolution working #559

Profile resolution working #559

Conversation

wendellpiez commented Dec 6, 2019

Committer Notes

All Submissions:

Changes to Core Features:

bradh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anweiss commented Dec 9, 2019 • edited Loading

david-waltermire commented Feb 7, 2020

anweiss commented Dec 9, 2019 •

edited

Loading