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

fix: cryptic error message + feat: # indicates comment column #1459

Merged
merged 2 commits into from
Oct 4, 2023

Conversation

degenaro
Copy link
Collaborator

@degenaro degenaro commented Oct 2, 2023

Types of changes

  • Hot fix (emergency fix and release)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation (change which affects the documentation site)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release (develop -> main)

Quality assurance (all should be covered).

  • My code follows the code style of this project.
  • Documentation for my change is up to date?
  • My PR meets testing requirements.
  • All new and existing tests passed.
  • All commits are signed-off.

Summary

fix - improved error message when csv cell contains bad data
feat - ignore column when heading starts with #

Key links:

Before you merge

  • Ensure it is a 'squash commit' if not a release.
  • Ensure CI is currently passing
  • Check sonar. If you are working for a fork a maintainer will reach out, if required.

@degenaro degenaro changed the title Fix/cryptic error message fix: cryptic error message + feat: # indicates comment column Oct 2, 2023
@degenaro
Copy link
Collaborator Author

degenaro commented Oct 2, 2023

Help information for csv-to-oscal-cd task.

Purpose: From csv produce OSCAL component_definition file.


Configuration flags sit under [task.csv-to-oscal-cd]:
  title                = (required) the component definition title.
  version              = (required) the component definition version.
  csv-file             = (required) the path of the csv file. [1st row are column headings; 2nd row are column descriptions; 3rd row and beyond is data]
  required columns:      $$Component_Title
                         $$Component_Description
                         $$Component_Type
                         $$Rule_Id
                         $$Rule_Description (see note 1)
                         $$Profile_Source (see note 1)
                         $$Profile_Description (see note 1)
                         $$Control_Id_List (see note 1)
                         $$Namespace
  optional columns:      $Parameter_Id (see note 1)
                         $Parameter_Description (see note 1)
                         $Parameter_Value_Alternatives (see note 1)
                         $Parameter_Value_Default (see note 1)
                         $Check_Id (see note 2)
                         $Check_Description (see note 2)
  comment columns:       #Informational (see note 3)
  output-dir           = (required) the path of the output directory for synthesized OSCAL .json files.
  component-definition = (optional) the path of the existing component-definition OSCAL .json file.
  class.column-name    = (optional) the class to associate with the specified column name, e.g. class.Rule_Id = scc_class
  output-overwrite     = (optional) true [default] or false; replace existing output when true.
  validate-controls    = (optional) on, warn, or off [default]; validate controls exist in resolved profile.

Notes: [1] column is ignored for validation component type
       [2] column is required for validation component type
       [3] column name starting with # causes column to be ignored

Copy link
Collaborator

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

LGTM

@degenaro degenaro merged commit 45eda01 into develop Oct 4, 2023
16 of 17 checks passed
@degenaro degenaro deleted the fix/cryptic-error-message branch October 4, 2023 11:49
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.

2 participants