Skip to content

href

trestle.core.commands.href ¤

Trestle Href Command.

logger ¤

Classes¤

HrefCmd (CommandPlusDocs) ¤

Change href of import in profile to point to catalog in trestle project.

This command is needed when generating an SSP with a profile that imports a catalog from a temporary location different from the final intended location of the catalog. Omit the href argument to see the list of current imports in the profile.

Source code in trestle/core/commands/href.py
class HrefCmd(CommandPlusDocs):
    """Change href of import in profile to point to catalog in trestle project.

    This command is needed when generating an SSP with a profile that imports a catalog from a temporary
    location different from the final intended location of the catalog.  Omit the href argument to see
    the list of current imports in the profile.
    """

    name = 'href'

    def _init_arguments(self) -> None:
        logger.debug('Init arguments')
        self.add_argument(
            '-n', '--name', help='Name of trestle profile to modify (just its name).', type=str, required=True
        )

        self.add_argument(
            '-hr',
            '--href',
            help='New href of form trestle://catalogs/mycat/catalog.json.',
            type=str,
            required=False,
            default=''
        )

        self.add_argument(
            '-i',
            '--item',
            help='Item number of href to modify.  Get list by running href with just -n <prof_name> to list values.',
            type=int,
            required=False,
            default=0
        )

    def _run(self, args: argparse.Namespace) -> int:
        try:
            logger.debug('Entering trestle href.')

            log.set_log_level_from_args(args)

            profile_name: str = args.name

            new_href: str = args.href.strip("'")

            item_num = args.item

            return self.change_import_href(args.trestle_root, profile_name, new_href, item_num)
        except Exception as e:  # pragma: no cover
            return handle_generic_command_exception(e, logger, f'Error while changing href or import in profile: {e}')

    @classmethod
    def change_import_href(cls, trestle_root: pathlib.Path, profile_name: str, new_href: str, import_num: int) -> int:
        """Change the href of the import in the profile to point to a catalog in a specific location.

        A Profile has an Imports list containing at least one href of a catalog or profile to be imported.
        If the item being referenced is currently in the same trestle project as the main profile, the original
        href is likely different from the one needed to access the item from the profile.  Therefore,
        in order for trestle to find the item directly from the profile, the href must be modified in a way that
        trestle can load it.

        If the item is already at the link referred to by the href as a valid URI or absolute file path then no
        change is needed.  But if the item is being worked on in the same trestle directory as the profile,
        the href should be modified to something like trestle://catalogs/my_catalog/catalog.json

        This change only needs to be made once to the profile while the profile is being used to generate SSP's
        from the local item, but if the final profile is released the href would need to be changed to the
        intended final location of the referenced item.

        Args:
            trestle_root: trestle_root for this call
            profile_name: Name of profile already imported into trestle containing href's to be changed
            new_href: New value for the href of the import.  If blank just list the hrefs
            import_num: Item number of the href to change.


        Returns:
            0 on success, 1 on failure

        Assumptions and requirements:
            The profile must be a valid profile in the trestle project.
            The import must either be a valid uri, including local file, or trestle://
            The original href is not checked and will be overwritten.
            If href is the empty string, just list all hrefs.

        Future work:
            Allow multiple imports with matching hrefs.
            Allow href to point to profile in trestle rather than catalog, and by name.
            Allow full chaining of linked catalogs and profiles.

        """
        profile_data, profile_path = load_validate_model_name(trestle_root, profile_name, Profile)
        n_imports = len(profile_data.imports)
        if not new_href:
            logger.info(f'List of imports for profile {profile_name}:')
            for ii, import_ in enumerate(profile_data.imports):
                logger.info(f'{ii:2}: {import_.href}')
            return CmdReturnCodes.SUCCESS.value
        if n_imports <= import_num:
            raise TrestleError(f'Import number {import_num} is too large.  This profile has only {n_imports} imports.')

        logger.info(f'Changing import {import_num} in profile {profile_name} from, to:')
        logger.info(f'{profile_data.imports[import_num].href}')
        logger.info(f'{new_href}')
        profile_data.imports[import_num].href = new_href
        profile_data.oscal_write(profile_path)
        return CmdReturnCodes.SUCCESS.value
name ¤
Methods¤
change_import_href(trestle_root, profile_name, new_href, import_num) classmethod ¤

Change the href of the import in the profile to point to a catalog in a specific location.

A Profile has an Imports list containing at least one href of a catalog or profile to be imported. If the item being referenced is currently in the same trestle project as the main profile, the original href is likely different from the one needed to access the item from the profile. Therefore, in order for trestle to find the item directly from the profile, the href must be modified in a way that trestle can load it.

If the item is already at the link referred to by the href as a valid URI or absolute file path then no change is needed. But if the item is being worked on in the same trestle directory as the profile, the href should be modified to something like trestle://catalogs/my_catalog/catalog.json

This change only needs to be made once to the profile while the profile is being used to generate SSP's from the local item, but if the final profile is released the href would need to be changed to the intended final location of the referenced item.

Parameters:

Name Type Description Default
trestle_root Path

trestle_root for this call

required
profile_name str

Name of profile already imported into trestle containing href's to be changed

required
new_href str

New value for the href of the import. If blank just list the hrefs

required
import_num int

Item number of the href to change.

required

Returns:

Type Description
int

0 on success, 1 on failure

Assumptions and requirements: The profile must be a valid profile in the trestle project. The import must either be a valid uri, including local file, or trestle:// The original href is not checked and will be overwritten. If href is the empty string, just list all hrefs.

Future work: Allow multiple imports with matching hrefs. Allow href to point to profile in trestle rather than catalog, and by name. Allow full chaining of linked catalogs and profiles.

Source code in trestle/core/commands/href.py
@classmethod
def change_import_href(cls, trestle_root: pathlib.Path, profile_name: str, new_href: str, import_num: int) -> int:
    """Change the href of the import in the profile to point to a catalog in a specific location.

    A Profile has an Imports list containing at least one href of a catalog or profile to be imported.
    If the item being referenced is currently in the same trestle project as the main profile, the original
    href is likely different from the one needed to access the item from the profile.  Therefore,
    in order for trestle to find the item directly from the profile, the href must be modified in a way that
    trestle can load it.

    If the item is already at the link referred to by the href as a valid URI or absolute file path then no
    change is needed.  But if the item is being worked on in the same trestle directory as the profile,
    the href should be modified to something like trestle://catalogs/my_catalog/catalog.json

    This change only needs to be made once to the profile while the profile is being used to generate SSP's
    from the local item, but if the final profile is released the href would need to be changed to the
    intended final location of the referenced item.

    Args:
        trestle_root: trestle_root for this call
        profile_name: Name of profile already imported into trestle containing href's to be changed
        new_href: New value for the href of the import.  If blank just list the hrefs
        import_num: Item number of the href to change.


    Returns:
        0 on success, 1 on failure

    Assumptions and requirements:
        The profile must be a valid profile in the trestle project.
        The import must either be a valid uri, including local file, or trestle://
        The original href is not checked and will be overwritten.
        If href is the empty string, just list all hrefs.

    Future work:
        Allow multiple imports with matching hrefs.
        Allow href to point to profile in trestle rather than catalog, and by name.
        Allow full chaining of linked catalogs and profiles.

    """
    profile_data, profile_path = load_validate_model_name(trestle_root, profile_name, Profile)
    n_imports = len(profile_data.imports)
    if not new_href:
        logger.info(f'List of imports for profile {profile_name}:')
        for ii, import_ in enumerate(profile_data.imports):
            logger.info(f'{ii:2}: {import_.href}')
        return CmdReturnCodes.SUCCESS.value
    if n_imports <= import_num:
        raise TrestleError(f'Import number {import_num} is too large.  This profile has only {n_imports} imports.')

    logger.info(f'Changing import {import_num} in profile {profile_name} from, to:')
    logger.info(f'{profile_data.imports[import_num].href}')
    logger.info(f'{new_href}')
    profile_data.imports[import_num].href = new_href
    profile_data.oscal_write(profile_path)
    return CmdReturnCodes.SUCCESS.value

handler: python