+
+HELP_INCLUDE_ALL_PARTS
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
HELP_LEVERAGED
diff --git a/api_reference/trestle.core.catalog.catalog_reader/index.html b/api_reference/trestle.core.catalog.catalog_reader/index.html
index c6405d0c4..66b3a710e 100644
--- a/api_reference/trestle.core.catalog.catalog_reader/index.html
+++ b/api_reference/trestle.core.catalog.catalog_reader/index.html
@@ -4880,30 +4880,45 @@ ssp.control_implementation.implemented_requirements
)
ssp.control_implementation.implemented_requirements.append(control_imp_req)
+ CatalogReader._add_statement_to_impl_requirement(control_imp_req, statement_id)
+ return control_imp_req
+
+ @staticmethod
+ def _add_statement_to_impl_requirement(impl_req: ossp.ImplementedRequirement, statement_id: str) -> ossp.Statement:
+ """Update the implemented requirement with a new statement."""
statement = gens.generate_sample_model(ossp.Statement)
statement.statement_id = statement_id
statement.by_components = None
- control_imp_req.statements = as_list(control_imp_req.statements)
- control_imp_req.statements.append(statement)
- return control_imp_req
+ impl_req.statements = as_list(impl_req.statements)
+ impl_req.statements.append(statement)
+ return statement
@staticmethod
def _get_by_comp_from_imp_req(
imp_req: ossp.ImplementedRequirement, statement_id: str, comp_uuid: str
) -> ossp.ByComponent:
if statement_id:
+ found_statement: Optional[ossp.Statement] = None
for statement in as_list(imp_req.statements):
if statement.statement_id == statement_id:
- for by_comp in as_list(statement.by_components):
- if by_comp.component_uuid == comp_uuid:
- return by_comp
- # didnt find bycomp so need to make one
- by_comp = gens.generate_sample_model(ossp.ByComponent)
- by_comp.component_uuid = comp_uuid
- by_comp.implementation_status = com.ImplementationStatus(state=const.STATUS_PLANNED)
- statement.by_components = as_list(statement.by_components)
- statement.by_components.append(by_comp)
- return by_comp
+ found_statement = statement
+ break
+
+ # If the statement doesn't exist, create it
+ if not found_statement:
+ found_statement = CatalogReader._add_statement_to_impl_requirement(imp_req, statement_id)
+ else:
+ for by_comp in as_list(found_statement.by_components):
+ if by_comp.component_uuid == comp_uuid:
+ return by_comp
+
+ # didnt find bycomp or new statement so need to make one
+ by_comp = gens.generate_sample_model(ossp.ByComponent)
+ by_comp.component_uuid = comp_uuid
+ by_comp.implementation_status = com.ImplementationStatus(state=const.STATUS_PLANNED)
+ found_statement.by_components = as_list(found_statement.by_components)
+ found_statement.by_components.append(by_comp)
+ return by_comp
else:
for by_comp in as_list(imp_req.by_components):
if by_comp.component_uuid == comp_uuid:
@@ -4914,7 +4929,6 @@ imp_req.by_components = as_list(imp_req.by_components)
imp_req.by_components.append(by_comp)
return by_comp
- raise TrestleError(f'Internal error seeking by_comp for component {comp_uuid} and statement {statement_id}')
@staticmethod
def _read_comp_info_from_md(control_file_path: pathlib.Path,
diff --git a/api_reference/trestle.core.catalog.catalog_writer/index.html b/api_reference/trestle.core.catalog.catalog_writer/index.html
index 8247591a1..8c8926b76 100644
--- a/api_reference/trestle.core.catalog.catalog_writer/index.html
+++ b/api_reference/trestle.core.catalog.catalog_writer/index.html
@@ -4847,9 +4847,11 @@ # adds it to prof-param-value-origin
if prof_param_value_origin != '' and prof_param_value_origin is not None:
if context.purpose == ContextPurpose.PROFILE:
- new_dict[const.PROFILE_PARAM_VALUE_ORIGIN] = prof_param_value_origin
+ if const.AGGREGATES not in [prop.name for prop in as_list(param.props)]:
+ new_dict[const.PROFILE_PARAM_VALUE_ORIGIN] = prof_param_value_origin
else:
- new_dict[const.PROFILE_PARAM_VALUE_ORIGIN] = const.REPLACE_ME_PLACEHOLDER
+ if const.AGGREGATES not in [prop.name for prop in as_list(param.props)]:
+ new_dict[const.PROFILE_PARAM_VALUE_ORIGIN] = const.REPLACE_ME_PLACEHOLDER
# then insert the original, incoming values as values
if param_id in control_param_dict:
orig_param = control_param_dict[param_id]
@@ -4862,6 +4864,8 @@ new_dict.pop(const.VALUES)
if new_dict[const.GUIDELINES] is None:
new_dict.pop(const.GUIDELINES)
+ if const.AGGREGATES in [prop.name for prop in as_list(orig_param.props)]:
+ new_dict.pop(const.PROFILE_PARAM_VALUE_ORIGIN)
else:
# if the profile doesnt change this param at all, show it in the header with values
tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
diff --git a/api_reference/trestle.core.commands.author.ssp/index.html b/api_reference/trestle.core.commands.author.ssp/index.html
index 763b9aa20..315d81f33 100644
--- a/api_reference/trestle.core.commands.author.ssp/index.html
+++ b/api_reference/trestle.core.commands.author.ssp/index.html
@@ -5884,6 +5884,14 @@
action='store_true',
default=False
)
+ self.add_argument(
+ '-iap',
+ '--include-all-parts',
+ help=const.HELP_INCLUDE_ALL_PARTS,
+ required=False,
+ action='store_true',
+ default=False
+ )
def _run(self, args: argparse.Namespace) -> int:
try:
@@ -5913,7 +5921,8 @@
md_path,
yaml_header,
args.overwrite_header_values,
- args.force_overwrite
+ args.force_overwrite,
+ args.include_all_parts
)
except Exception as e: # pragma: no cover
@@ -5928,7 +5937,8 @@
md_path: pathlib.Path,
yaml_header: Dict[str, Any],
overwrite_header_values: bool,
- force_overwrite: bool
+ force_overwrite: bool,
+ include_all_parts: bool
) -> int:
"""
Generate the ssp markdown from the profile and compdefs.
@@ -5960,6 +5970,7 @@
context.overwrite_header_values = overwrite_header_values
context.allowed_sections = None
context.comp_def_name_list = compdef_name_list
+ context.include_all_parts = include_all_parts
# if file not recognized as URI form, assume it represents name of file in trestle directory
profile_in_trestle_dir = '://' not in profile_name_or_href
diff --git a/api_reference/trestle.core.control_context/index.html b/api_reference/trestle.core.control_context/index.html
index aa04b8bcc..eec0cef45 100644
--- a/api_reference/trestle.core.control_context/index.html
+++ b/api_reference/trestle.core.control_context/index.html
@@ -2690,6 +2690,13 @@
control_implementation
+
+
+
+
+ include_all_parts
+
+
@@ -4853,6 +4860,13 @@
control_implementation
+
+
+
+
+ include_all_parts
+
+
@@ -5218,6 +5232,7 @@
trestle_root: pathlib.Path
md_root: pathlib.Path
prompt_responses: bool
+ include_all_parts: bool
overwrite_header_values: bool
set_parameters_flag: bool
cli_yaml_header: Optional[Dict[Any, Any]] = None
@@ -5245,6 +5260,7 @@
trestle_root: pathlib.Path,
md_root: pathlib.Path,
prompt_responses: bool = False,
+ include_all_parts: bool = False,
overwrite_header_values: bool = False,
set_parameters_flag: bool = False,
cli_yaml_header: Optional[Dict[Any, Any]] = None,
@@ -5271,6 +5287,7 @@
trestle_root,
md_root,
prompt_responses,
+ include_all_parts,
overwrite_header_values,
set_parameters_flag,
cli_yaml_header=cli_yaml_header,
@@ -5306,6 +5323,7 @@
context.trestle_root,
context.md_root,
context.prompt_responses,
+ context.include_all_parts,
context.overwrite_header_values,
context.set_parameters_flag,
cli_yaml_header=copy.deepcopy(context.cli_yaml_header),
@@ -5510,6 +5528,27 @@
+include_all_parts: bool
+
+
+ dataclass-field
+
+
+
+
+
+
+
+
+
+
+
+
inherited_props: Optional[Dict[str, Any]]
@@ -5851,7 +5890,7 @@
-__init__(self, purpose, to_markdown, trestle_root, md_root, prompt_responses, overwrite_header_values, set_parameters_flag, cli_yaml_header=None, sections_dict=None, profile=None, required_sections=None, allowed_sections=None, comp_def=None, comp_name=None, component=None, comp_def_name_list=None, inherited_props=None, rules_dict=None, rules_params_dict=None, control_implementation=None, uri_name_map=None, comp_dict=None, merged_header=None)
+__init__(self, purpose, to_markdown, trestle_root, md_root, prompt_responses, include_all_parts, overwrite_header_values, set_parameters_flag, cli_yaml_header=None, sections_dict=None, profile=None, required_sections=None, allowed_sections=None, comp_def=None, comp_name=None, component=None, comp_def_name_list=None, inherited_props=None, rules_dict=None, rules_params_dict=None, control_implementation=None, uri_name_map=None, comp_dict=None, merged_header=None)
special
@@ -5918,6 +5957,7 @@ context
.trestle_root,
context.md_root,
context.prompt_responses,
+ context.include_all_parts,
context.overwrite_header_values,
context.set_parameters_flag,
cli_yaml_header=copy.deepcopy(context.cli_yaml_header),
@@ -5951,7 +5991,7 @@
-generate(purpose, to_markdown, trestle_root, md_root, prompt_responses=False, overwrite_header_values=False, set_parameters_flag=False, cli_yaml_header=None, sections_dict=None, profile=None, required_sections=None, allowed_sections=None, comp_def=None, comp_name=None, component=None, comp_def_name_list=None, inherited_props=None, rules_dict=None, rules_params_dict=None, control_implementation=None, uri_name_map=None, comp_dict=None, merged_header=None)
+generate(purpose, to_markdown, trestle_root, md_root, prompt_responses=False, include_all_parts=False, overwrite_header_values=False, set_parameters_flag=False, cli_yaml_header=None, sections_dict=None, profile=None, required_sections=None, allowed_sections=None, comp_def=None, comp_name=None, component=None, comp_def_name_list=None, inherited_props=None, rules_dict=None, rules_params_dict=None, control_implementation=None, uri_name_map=None, comp_dict=None, merged_header=None)
classmethod
@@ -5973,6 +6013,7 @@ trestle_root
: pathlib.Path,
md_root: pathlib.Path,
prompt_responses: bool = False,
+ include_all_parts: bool = False,
overwrite_header_values: bool = False,
set_parameters_flag: bool = False,
cli_yaml_header: Optional[Dict[Any, Any]] = None,
@@ -5999,6 +6040,7 @@ trestle_root,
md_root,
prompt_responses,
+ include_all_parts,
overwrite_header_values,
set_parameters_flag,
cli_yaml_header=cli_yaml_header,
diff --git a/api_reference/trestle.core.control_interface/index.html b/api_reference/trestle.core.control_interface/index.html
index a58ce04bc..6dd3e4a2f 100644
--- a/api_reference/trestle.core.control_interface/index.html
+++ b/api_reference/trestle.core.control_interface/index.html
@@ -6377,6 +6377,24 @@ return choices_str
return ''
+ @staticmethod
+ def _param_as_aggregated_value(
+ param: common.Parameter,
+ param_dict: Dict[str, common.Parameter],
+ verbose: bool = False,
+ brackets: bool = False
+ ) -> str:
+ """Convert parameter aggregation to str."""
+ # review is an aggregated parameter
+ if const.AGGREGATES in [prop.name for prop in as_list(param.props)]:
+ aggregated_values = ''
+ for prop in as_list(param.props):
+ if prop.value not in param_dict:
+ continue
+ aggregated_values += ', '.join(as_list(param_dict[prop.value].values)) + ', '
+ return aggregated_values[:-2]
+ return ''
+
@staticmethod
def _param_label_choices_as_str(param: common.Parameter, verbose: bool = False, brackets: bool = False) -> str:
"""Convert param label or choices to string, using choices if present."""
@@ -6388,6 +6406,7 @@ @staticmethod
def _param_values_assignment_str(
param: common.Parameter,
+ param_dict: Dict[str, common.Parameter],
value_assigned_prefix: Optional[str] = None,
value_not_assigned_prefix: Optional[str] = None
) -> str:
@@ -6399,6 +6418,9 @@ # otherwise use param selection if present
if not param_str:
param_str = ControlInterface._param_selection_as_str(param, True, False)
+ # otherwise use param aggregated values if present
+ if not param_str:
+ param_str = ControlInterface._param_as_aggregated_value(param, param_dict, True, False)
# finally use label and param_id as fallbacks
if not param_str:
param_str = param.label if param.label else param.id
@@ -6429,7 +6451,8 @@ brackets: bool = False,
params_format: Optional[str] = None,
value_assigned_prefix: Optional[str] = None,
- value_not_assigned_prefix: Optional[str] = None
+ value_not_assigned_prefix: Optional[str] = None,
+ param_dict: Dict[str, common.Parameter] = None
) -> Optional[str]:
"""
Convert parameter to string based on best available representation.
@@ -6462,7 +6485,7 @@ param_str = ''
elif param_rep == ParameterRep.ASSIGNMENT_FORM:
param_str = ControlInterface._param_values_assignment_str(
- param, value_assigned_prefix, value_not_assigned_prefix
+ param, param_dict, value_assigned_prefix, value_not_assigned_prefix
)
if not param_str:
param_str = ''
@@ -6561,11 +6584,20 @@ elif param_dict[param_ids[i]] is not None:
param = param_dict[param_ids[i]]
param_str = ControlInterface.param_to_str(
- param, param_rep, False, False, params_format, value_assigned_prefix, value_not_assigned_prefix
+ param,
+ param_rep,
+ False,
+ False,
+ params_format,
+ value_assigned_prefix,
+ value_not_assigned_prefix,
+ param_dict
)
text = text.replace(staches[i], param_str, 1).strip()
if show_value_warnings and param_rep != ParameterRep.LABEL_OR_CHOICES and not param.values:
- logger.warning(f'Parameter {param_id} has no values and was referenced by prose.')
+ # verifies the current parameter is not an aggregated parameter to throw a warning
+ if const.AGGREGATES not in [prop.name for prop in as_list(param.props)]:
+ logger.warning(f'Parameter {param_id} has no values and was referenced by prose.')
elif show_value_warnings:
logger.warning(f'Control prose references param {param_ids[i]} with no specified value.')
# there may be staches remaining that we can't replace if not in param_dict
@@ -8364,7 +8396,7 @@
-param_to_str(param, param_rep, verbose=False, brackets=False, params_format=None, value_assigned_prefix=None, value_not_assigned_prefix=None)
+param_to_str(param, param_rep, verbose=False, brackets=False, params_format=None, value_assigned_prefix=None, value_not_assigned_prefix=None, param_dict=None)
staticmethod
@@ -8456,7 +8488,8 @@ brackets
: bool = False,
params_format: Optional[str] = None,
value_assigned_prefix: Optional[str] = None,
- value_not_assigned_prefix: Optional[str] = None
+ value_not_assigned_prefix: Optional[str] = None,
+ param_dict: Dict[str, common.Parameter] = None
) -> Optional[str]:
"""
Convert parameter to string based on best available representation.
@@ -8489,7 +8522,7 @@ param_str = ''
elif param_rep == ParameterRep.ASSIGNMENT_FORM:
param_str = ControlInterface._param_values_assignment_str(
- param, value_assigned_prefix, value_not_assigned_prefix
+ param, param_dict, value_assigned_prefix, value_not_assigned_prefix
)
if not param_str:
param_str = ''
diff --git a/api_reference/trestle.core.control_writer/index.html b/api_reference/trestle.core.control_writer/index.html
index 2b48dc722..4e50bbfd5 100644
--- a/api_reference/trestle.core.control_writer/index.html
+++ b/api_reference/trestle.core.control_writer/index.html
@@ -4781,6 +4781,22 @@
else:
self._insert_status(ImplementationStatus(state=const.STATUS_PLANNED), level)
+ def _process_main_component(self, part_id: str, part_label: str, comp_dict: CompDict) -> None:
+ """Handle prompts for This System component."""
+ self._md_file.new_paragraph()
+ self._md_file.new_header(3, const.SSP_MAIN_COMP_NAME)
+ self._md_file.new_paragraph()
+ prose = f'{const.SSP_ADD_THIS_SYSTEM_IMPLEMENTATION_FOR_CONTROL_TEXT}: {part_id} -->'
+ status = ImplementationStatus(state=const.STATUS_PLANNED)
+ sys_comp_dict: Dict[str, ComponentImpInfo] = comp_dict.get(const.SSP_MAIN_COMP_NAME, {})
+ if sys_comp_dict and part_label in sys_comp_dict:
+ comp_info = sys_comp_dict[part_label]
+ if comp_info.prose:
+ prose = comp_info.prose
+ status = comp_info.status
+ self._md_file.new_paraline(prose)
+ self._insert_status(status, 4)
+
def _add_component_control_prompts(self, control_id: str, comp_dict: CompDict, context: ControlContext) -> bool:
"""Add prompts to the markdown for the control itself, per component."""
if context.purpose not in [ContextPurpose.COMPONENT, ContextPurpose.SSP]:
@@ -4790,19 +4806,10 @@
did_write = False
# do special handling for This System
if context.purpose == ContextPurpose.SSP:
- self._md_file.new_paragraph()
- self._md_file.new_header(3, const.SSP_MAIN_COMP_NAME)
- self._md_file.new_paragraph()
- prose = f'{const.SSP_ADD_THIS_SYSTEM_IMPLEMENTATION_FOR_CONTROL_TEXT}: {control_id} -->'
- status = ImplementationStatus(state=const.STATUS_PLANNED)
- if const.SSP_MAIN_COMP_NAME in comp_dict:
- comp_info = list(comp_dict[const.SSP_MAIN_COMP_NAME].values())[0]
- if comp_info.prose:
- prose = comp_info.prose
- status = comp_info.status
- self._md_file.new_paraline(prose)
- self._insert_status(status, 4)
+ # Passing in the control id and the empty key ('') for the label
+ self._process_main_component(control_id, '', comp_dict)
did_write = True
+
sorted_comp_names = sorted(comp_dict.keys())
for comp_name in sorted_comp_names:
dic = comp_dict[comp_name]
@@ -4848,14 +4855,11 @@
# if no label guess the label from the sub-part id
part_label = ControlInterface.get_label(prt)
part_label = prt.id.split('.')[-1] if not part_label else part_label
- # only write out part if rules apply to it
- rules_apply = False
- for _, dic in comp_dict.items():
- if part_label in dic and dic[part_label].rules:
- rules_apply = True
- break
- if not rules_apply:
+
+ # Determine if this part should be written out
+ if self._skip_part(context, part_label, comp_dict):
continue
+
if not did_write_part:
self._md_file.new_line(const.SSP_MD_LEAVE_BLANK_TEXT)
# insert extra line to make mdformat happy
@@ -4863,11 +4867,17 @@
self._md_file.new_hr()
self._md_file.new_header(level=2, title=f'Implementation for part {part_label}')
wrote_label_content = False
+ # To reduce verbosity by default, the main component
+ # is conditionally written for each part dependant on the control context.
+ if context.purpose == ContextPurpose.SSP and context.include_all_parts:
+ self._process_main_component(prt.id, part_label, comp_dict)
+ wrote_label_content = True
sorted_comp_names = sorted(comp_dict.keys())
for comp_name in sorted_comp_names:
- dic = comp_dict[comp_name]
+ # This System already handled
if comp_name == const.SSP_MAIN_COMP_NAME:
continue
+ dic = comp_dict[comp_name]
if part_label in dic:
# insert the component name for ssp but not for comp_def
# because there should only be one component in generated comp_def markdown
@@ -4895,6 +4905,24 @@
self._insert_comp_info(part_label, dic, context)
self._md_file.new_hr()
+ def _skip_part(self, context: ControlContext, part_label: str, comp_dict: CompDict) -> bool:
+ """
+ Check if a part should be skipped based on rules and context.
+
+ Notes: The default logic is to conditionally add control parts based
+ on whether the component has rules associated with that part. This can be
+ changed using the control context for SSP markdown.
+ """
+ if context.purpose == ContextPurpose.SSP and context.include_all_parts:
+ return False
+ else:
+ no_applied_rules = True
+ for _, dic in comp_dict.items():
+ if part_label in dic and dic[part_label].rules:
+ no_applied_rules = False
+ break
+ return no_applied_rules
+
def _dump_subpart_infos(self, level: int, part: Dict[str, Any]) -> None:
name = part['name']
title = self._sections_dict.get(name, name) if self._sections_dict else name
diff --git a/api_reference/trestle.core.repository/index.html b/api_reference/trestle.core.repository/index.html
index 3a64fe521..e65c80177 100644
--- a/api_reference/trestle.core.repository/index.html
+++ b/api_reference/trestle.core.repository/index.html
@@ -5090,7 +5090,7 @@
markdown_dir: str,
set_parameters: bool = False,
regenerate: bool = False,
- version: str = ''
+ version: Optional[str] = None
) -> bool:
"""Assemble catalog markdown into OSCAL Catalog in JSON."""
logger.debug(f'Assembling model {name} of type catalog.')
@@ -5125,10 +5125,10 @@
markdown_dir: str,
set_parameters: bool = False,
regenerate: bool = False,
- version: str = '',
- sections: str = '',
- required_sections: str = '',
- allowed_sections: str = ''
+ version: Optional[str] = None,
+ sections: Optional[str] = None,
+ required_sections: Optional[str] = None,
+ allowed_sections: Optional[str] = None
) -> bool:
"""Assemble profile markdown into OSCAL Profile in JSON."""
logger.debug(f'Assembling model {name} of type profile.')
@@ -5194,7 +5194,7 @@
markdown_dir: str,
compdefs: str,
regenerate: bool = False,
- version: str = ''
+ version: Optional[str] = None
) -> bool:
"""Assemble ssp markdown into OSCAL SSP in JSON."""
logger.debug(f'Assembling model {name} of type ssp.')
@@ -5227,7 +5227,7 @@
name: str,
output: str,
force_overwrite: bool = False,
- yaml_header: str = '',
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False
) -> bool:
"""Generate catalog markdown from OSCAL Catalog in JSON."""
@@ -5260,10 +5260,10 @@
name: str,
output: str,
force_overwrite: bool = False,
- yaml_header: str = '',
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False,
- sections: str = '',
- required_sections: str = ''
+ sections: Optional[str] = None,
+ required_sections: Optional[str] = None
) -> bool:
"""Generate profile markdown from OSCAL Profile in JSON."""
logger.debug(f'Generating markdown for {name} of type profile.')
@@ -5322,9 +5322,10 @@
profile: str,
output: str,
compdefs: str,
- leveraged_ssp: str = '',
+ leveraged_ssp: Optional[str] = None,
force_overwrite: bool = False,
- yaml_header: str = '',
+ include_all_parts: bool = False,
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False
) -> bool:
"""Generate ssp markdown from OSCAL Profile and Component Definitions."""
@@ -5339,6 +5340,7 @@
leveraged_ssp=leveraged_ssp,
trestle_root=self.root_dir,
force_overwrite=force_overwrite,
+ include_all_parts=include_all_parts,
yaml_header=yaml_header,
overwrite_header_values=overwrite_header_values,
verbose=verbose
@@ -5402,7 +5404,7 @@
-assemble_catalog_markdown(self, name, output, markdown_dir, set_parameters=False, regenerate=False, version='')
+assemble_catalog_markdown(self, name, output, markdown_dir, set_parameters=False, regenerate=False, version=None)
@@ -5420,7 +5422,7 @@ markdown_dir: str,
set_parameters: bool = False,
regenerate: bool = False,
- version: str = ''
+ version: Optional[str] = None
) -> bool:
"""Assemble catalog markdown into OSCAL Catalog in JSON."""
logger.debug(f'Assembling model {name} of type catalog.')
@@ -5511,7 +5513,7 @@
-assemble_profile_markdown(self, name, output, markdown_dir, set_parameters=False, regenerate=False, version='', sections='', required_sections='', allowed_sections='')
+assemble_profile_markdown(self, name, output, markdown_dir, set_parameters=False, regenerate=False, version=None, sections=None, required_sections=None, allowed_sections=None)
@@ -5529,10 +5531,10 @@ markdown_dir: str,
set_parameters: bool = False,
regenerate: bool = False,
- version: str = '',
- sections: str = '',
- required_sections: str = '',
- allowed_sections: str = ''
+ version: Optional[str] = None,
+ sections: Optional[str] = None,
+ required_sections: Optional[str] = None,
+ allowed_sections: Optional[str] = None
) -> bool:
"""Assemble profile markdown into OSCAL Profile in JSON."""
logger.debug(f'Assembling model {name} of type profile.')
@@ -5575,7 +5577,7 @@
-assemble_ssp_markdown(self, name, output, markdown_dir, compdefs, regenerate=False, version='')
+assemble_ssp_markdown(self, name, output, markdown_dir, compdefs, regenerate=False, version=None)
@@ -5593,7 +5595,7 @@ markdown_dir: str,
compdefs: str,
regenerate: bool = False,
- version: str = ''
+ version: Optional[str] = None
) -> bool:
"""Assemble ssp markdown into OSCAL SSP in JSON."""
logger.debug(f'Assembling model {name} of type ssp.')
@@ -5633,7 +5635,7 @@
-generate_catalog_markdown(self, name, output, force_overwrite=False, yaml_header='', overwrite_header_values=False)
+generate_catalog_markdown(self, name, output, force_overwrite=False, yaml_header=None, overwrite_header_values=False)
@@ -5649,7 +5651,7 @@ name: str,
output: str,
force_overwrite: bool = False,
- yaml_header: str = '',
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False
) -> bool:
"""Generate catalog markdown from OSCAL Catalog in JSON."""
@@ -5737,7 +5739,7 @@
-generate_profile_markdown(self, name, output, force_overwrite=False, yaml_header='', overwrite_header_values=False, sections='', required_sections='')
+generate_profile_markdown(self, name, output, force_overwrite=False, yaml_header=None, overwrite_header_values=False, sections=None, required_sections=None)
@@ -5753,10 +5755,10 @@ name: str,
output: str,
force_overwrite: bool = False,
- yaml_header: str = '',
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False,
- sections: str = '',
- required_sections: str = ''
+ sections: Optional[str] = None,
+ required_sections: Optional[str] = None
) -> bool:
"""Generate profile markdown from OSCAL Profile in JSON."""
logger.debug(f'Generating markdown for {name} of type profile.')
@@ -5797,7 +5799,7 @@
-generate_ssp_markdown(self, profile, output, compdefs, leveraged_ssp='', force_overwrite=False, yaml_header='', overwrite_header_values=False)
+generate_ssp_markdown(self, profile, output, compdefs, leveraged_ssp=None, force_overwrite=False, include_all_parts=False, yaml_header=None, overwrite_header_values=False)
@@ -5813,9 +5815,10 @@ profile: str,
output: str,
compdefs: str,
- leveraged_ssp: str = '',
+ leveraged_ssp: Optional[str] = None,
force_overwrite: bool = False,
- yaml_header: str = '',
+ include_all_parts: bool = False,
+ yaml_header: Optional[str] = None,
overwrite_header_values: bool = False
) -> bool:
"""Generate ssp markdown from OSCAL Profile and Component Definitions."""
@@ -5830,6 +5833,7 @@ leveraged_ssp=leveraged_ssp,
trestle_root=self.root_dir,
force_overwrite=force_overwrite,
+ include_all_parts=include_all_parts,
yaml_header=yaml_header,
overwrite_header_values=overwrite_header_values,
verbose=verbose
diff --git a/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog/index.html b/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog/index.html
index e20e7a90d..eb379bf44 100644
--- a/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog/index.html
+++ b/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog/index.html
@@ -5436,19 +5436,27 @@ def _add_property(self, xlsx_helper: XlsxHelper, props: List[Property], row: int, key: str) -> None:
"""Add property."""
- name = self._get_normalized_name(key)
- value = xlsx_helper.get(row, key)
- if value:
- props.append(self._create_property(name, value))
+ try:
+ name = self._get_normalized_name(key)
+ value = xlsx_helper.get(row, key)
+ if value:
+ props.append(self._create_property(name, value))
+ except KeyError as e:
+ text = f'key {e} not found.'
+ logger.debug(text)
def _add_property_boolean(self, xlsx_helper: XlsxHelper, props: List[Property], row: int, key: str) -> None:
"""Add property."""
- name = self._get_normalized_name(key)
- value = xlsx_helper.get(row, key)
- if value:
- props.append(self._create_property(name, 'True'))
- else:
- props.append(self._create_property(name, 'False'))
+ try:
+ name = self._get_normalized_name(key)
+ value = xlsx_helper.get(row, key)
+ if value:
+ props.append(self._create_property(name, 'True'))
+ else:
+ props.append(self._create_property(name, 'False'))
+ except KeyError as e:
+ text = f'key {e} not found.'
+ logger.debug(text)
def _add_part(self, xlsx_helper: XlsxHelper, parts: List[Part], id_: str, row: int, key: str) -> None:
"""Add part."""
@@ -5862,7 +5870,7 @@ def _mapper(self) -> None:
"""Map columns heading names to column numbers."""
self._col_name_to_number = {}
- cols = self._work_sheet.max_column
+ cols = self._work_sheet.max_column + 1
row = 1
for col in range(row, cols):
cell = self._work_sheet.cell(row, col)
diff --git a/contributing/mkdocs_contributing/index.html b/contributing/mkdocs_contributing/index.html
index 08e904254..45321e5df 100644
--- a/contributing/mkdocs_contributing/index.html
+++ b/contributing/mkdocs_contributing/index.html
@@ -4754,7 +4754,6 @@ Contributing In General