Renamed 'set-param' in SSP for consistency with the Profile model #609

wendellpiez · 2020-01-23T19:53:37Z

Responding to Issue #568. The element for parameter setting is now set in both Profile and SSP models; its grouping name is parameter-settings in both.

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?
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.

david-waltermire · 2020-01-23T20:28:49Z

src/metaschema/oscal_profile_metaschema.xml

@@ -171,7 +171,7 @@
      <description>Set parameters or amend controls in resolution</description>
      <model>
         <assembly ref="set" max-occurs="unbounded">


It might be more consistent to use parameter-setting as the assembly name instead of set.

david-waltermire · 2020-01-23T20:29:08Z

src/metaschema/oscal_ssp_metaschema.xml

@@ -1134,10 +1134,10 @@
               </allowed-values>
            </flag>
         </assembly>
-         <assembly ref="set-param" max-occurs="unbounded">
-            <group-as name="set-params" in-json="BY_KEY"/>
+         <assembly ref="set" max-occurs="unbounded">


It might be more consistent to use parameter-setting as the assembly name instead of set.

david-waltermire · 2020-01-23T20:29:24Z

src/metaschema/oscal_ssp_metaschema.xml

@@ -1258,13 +1258,13 @@
               </allowed-values>
            </flag>
         </assembly>
-         <assembly ref="set-param" max-occurs="unbounded">
-            <group-as name="set-params" in-json="BY_KEY"/>
+         <assembly ref="set" max-occurs="unbounded">


It might be more consistent to use parameter-setting as the assembly name instead of set.

david-waltermire · 2020-01-23T20:29:37Z

src/metaschema/oscal_ssp_metaschema.xml

         </assembly>
      </model>
   </define-assembly>

-   <define-assembly name="set-param">
+   <define-assembly name="set">


It might be more consistent to use parameter-setting as the assembly name instead of set.

david-waltermire

It might be more consistent to use parameter-setting as the assembly name instead of set. Can you make this change?

wendellpiez · 2020-01-24T15:33:03Z

@david-waltermire-nist I like set because we get (in the XML)

<set param-id="param1">...</set>

With the fact that the target is a parameter expressed by the param-id flag. (Rather than <parameter-setting param-id="param1">).

In the JSON, we have a group name, which I changed to parameter-settings as you saw.

Perhaps it is not an argument against this change that it would break the data. While we had no set-param in SSPs in public data to break, we do have set (in FedRAMP profiles.)

wendellpiez · 2020-01-24T19:18:52Z

After discussion with @david-waltermire-nist we have settled on set-parameter as a compromise, leaving set unconflicted for other uses.

Will post again when this issue is done.

However, this is a breaking change in the data! so @brianrufgsa probably needs to be in sync wrt the FedRAMP profiles. Also may wish to stage this PR accordingly.

brian-ruf · 2020-01-24T19:27:14Z

@wendellpiez I am already tracking this and have an issue on the FedRAMP side to address it once the syntax is updated on the NIST/OSCAL side.
This is tracked in GSA/fedramp-automation#37, and linked to issue #568 here.

wendellpiez · 2020-01-24T20:12:01Z

@brianrufgsa perfect. We can also produce, run, and make available a transformation for updating the data.

brian-ruf · 2020-01-24T20:18:27Z

@wendellpiez - I don't think a transformation is necessary for this change. For the FedRAMP sample data in the template, it's just three lines.

If a stakeholder has a larger data file I believe a simple search/replace can address it quickly. Find "set-param" and replace with "set-parameter", should work with both XML and JSON, including closing XML tags. I doubt anything else in an OSCAL-based SSP is going to have the string "set-param" in all lower-case in any other context.

bradh · 2020-01-25T00:06:56Z

Looks like the circleci tests showed a remaining set.

wendellpiez · 2020-01-27T14:38:59Z

Cool. This failure now shows the validation errors in the current FedRAMP content (four baselines) as noted.

@brianrufgsa as you have noted, the change is straightforward. How shall we coordinate making the change in this branch? I could accept a PR from you or I could make the change myself and have you review it.

brian-ruf · 2020-01-27T14:50:49Z

@wendellpiez I have some other changes I need to make to the FedRAMP profiles (including the elimination of the FedRAMP catalog). I’ll address all updates early this week.

wendellpiez · 2020-01-27T14:53:32Z

Fantastic @brianrufgsa please let me know if I can help.

david-waltermire · 2020-01-28T03:01:52Z

@wendellpiez Do you plan to fix the content validation errors in the build?

wendellpiez · 2020-01-28T14:08:45Z

@david-waltermire-nist I could do that but @brianrufgsa gives me the impression he would rather do it. (He says he has other changes to make to the data as well.)

wendellpiez · 2020-01-28T17:36:27Z

@david-waltermire-nist this should now ready except for the conflicted files. @brianrufgsa is it fair to assume these have also been updated to your latest, and should be resolved in favor of your versions?

brian-ruf · 2020-01-28T17:46:43Z

@wendellpiez correct! These files address the syntax changes as well as the content changes I needed to make. I did not resolve the profiles as I thought @david-waltermire-nist said the CI/CD pipeline now does that automatically for profiles. If that is not in place, I can add the resolved profiles in a separate PR.

wendellpiez · 2020-01-28T17:54:16Z

@brianrufgsa yeah ... tmk we don't trust our own profile resolution yet to do this unattended. Until profile resolution is being unit tested and we can be sure it will be correct, we need to run it outside the build (and inspect the results carefully).

brian-ruf · 2020-01-28T19:30:54Z

@wendellpiez OK - I resolved the profiles and added them to your branch as well. CircleCI checks are running now.

wendellpiez · 2020-01-28T19:38:57Z

Fantastic, thanks again @brianrufgsa

david-waltermire

LGTM. Please avoid checking in generated files such as those in the json/schema tree.

…anged its grouping name to 'parameter-settings' for clarity.

…ication

…ngular name for this assembly. Data not yet updated so THIS BUILD OUGHTA BREAK

…(Thank you robot.)

brian-ruf

LGTM

david-waltermire mentioned this pull request Jan 23, 2020

[EPIC] Review all models, address feedback, and make improvements #597

Closed

23 tasks

david-waltermire reviewed Jan 23, 2020

View reviewed changes

david-waltermire suggested changes Jan 23, 2020

View reviewed changes

brian-ruf mentioned this pull request Jan 24, 2020

Change set-param to set GSA/fedramp-automation#37

Closed

6 tasks

wendellpiez mentioned this pull request Jan 24, 2020

Rename set-param in SSP model #568

Closed

david-waltermire previously approved these changes Jan 30, 2020

View reviewed changes

brian-ruf mentioned this pull request Feb 4, 2020

FedRAMP Profile Updates GSA/fedramp-automation#38

Merged

wendellpiez mentioned this pull request Feb 4, 2020

Enhancing XML- and JSON -conversion logic for metaschema constructs usnistgov/metaschema#36

Merged

8 tasks

wendellpiez added 3 commits February 4, 2020 14:27

Renamed 'set-param' in SSP for consistency with the Profile model; ch…

9154435

…anged its grouping name to 'parameter-settings' for clarity.

Catching up to schema modifications with the corresponding data modif…

580b693

…ication

Updating generated schemas

aec760d

wendellpiez and others added 5 commits February 4, 2020 14:27

Latest decision on usnistgov#568 settles on 'set-parameter' as the si…

3131123

…ngular name for this assembly. Data not yet updated so THIS BUILD OUGHTA BREAK

Argh. This error was flagged by the robot and ignored by the person. …

a4cb403

…(Thank you robot.)

Updated FedRAMP Profiles

fa25627

Adding Resolved Profiles

4a9d1f1

Moved FedRAMP baselines to correct folder under src

67ef8cc

wendellpiez dismissed david-waltermire’s stale review via 67ef8cc February 4, 2020 19:31

wendellpiez force-pushed the issue568 branch from a186d70 to 67ef8cc Compare February 4, 2020 19:31

removed generated files

4bff0c7

brian-ruf approved these changes Feb 4, 2020

View reviewed changes

david-waltermire merged commit fe7c8a3 into usnistgov:master Feb 4, 2020

wendellpiez deleted the issue568 branch March 3, 2021 15:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Renamed 'set-param' in SSP for consistency with the Profile model #609

Renamed 'set-param' in SSP for consistency with the Profile model #609

wendellpiez commented Jan 23, 2020

david-waltermire Jan 23, 2020

david-waltermire Jan 23, 2020

david-waltermire Jan 23, 2020

david-waltermire Jan 23, 2020

david-waltermire left a comment

wendellpiez commented Jan 24, 2020 •

edited

Loading

wendellpiez commented Jan 24, 2020

brian-ruf commented Jan 24, 2020

wendellpiez commented Jan 24, 2020

brian-ruf commented Jan 24, 2020 •

edited

Loading

bradh commented Jan 25, 2020

wendellpiez commented Jan 27, 2020

brian-ruf commented Jan 27, 2020

wendellpiez commented Jan 27, 2020

david-waltermire commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

brian-ruf commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

brian-ruf commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

david-waltermire left a comment

brian-ruf left a comment

Renamed 'set-param' in SSP for consistency with the Profile model #609

Renamed 'set-param' in SSP for consistency with the Profile model #609

Conversation

wendellpiez commented Jan 23, 2020

All Submissions:

Changes to Core Features:

david-waltermire Jan 23, 2020

Choose a reason for hiding this comment

david-waltermire Jan 23, 2020

Choose a reason for hiding this comment

david-waltermire Jan 23, 2020

Choose a reason for hiding this comment

david-waltermire Jan 23, 2020

Choose a reason for hiding this comment

david-waltermire left a comment

Choose a reason for hiding this comment

wendellpiez commented Jan 24, 2020 • edited Loading

wendellpiez commented Jan 24, 2020

brian-ruf commented Jan 24, 2020

wendellpiez commented Jan 24, 2020

brian-ruf commented Jan 24, 2020 • edited Loading

bradh commented Jan 25, 2020

wendellpiez commented Jan 27, 2020

brian-ruf commented Jan 27, 2020

wendellpiez commented Jan 27, 2020

david-waltermire commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

brian-ruf commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

brian-ruf commented Jan 28, 2020

wendellpiez commented Jan 28, 2020

david-waltermire left a comment

Choose a reason for hiding this comment

brian-ruf left a comment

Choose a reason for hiding this comment

wendellpiez commented Jan 24, 2020 •

edited

Loading

brian-ruf commented Jan 24, 2020 •

edited

Loading