Module ploigos_step_runner.step_implementers.generate_metadata.semantic_version

StepImplementer for the generate-metadata to generate a semantic version from given input.

Supports the following semantic versions (https://semver.org/) :

• major.minor.patch+build
• major.minor.patch-pre_rleease+build

Notes

When tagging container images we will regex + to - due to https://github.com/docker/distribution/issues/1201.

Source for version sections:

• major.minor.patch
  • will come from previous sub step of generate_metadata step, with step results including 'app_version'
  • known implementers:
  • maven
• pre-release
  • will come from previous sub step of generate_metadata step, with step results including 'pre_release'
  • known implementers:
  • git
• build
  • will come from previous sub step of generate_metadata step, with step results including 'build'
  • known implementers:
  • git

Step Configuration

Step configuration expected as input to this step. Could come from:

• static configuration
• runtime configuration
• previous step results

Result Artifacts

Results artifacts output by this step.

Classes

class SemanticVersion (workflow_result, parent_work_dir_path, config, environment=None)

StepImplementer for the generate-metadata to generate a semantic version from given input.

Expand source code

class SemanticVersion(StepImplementer):  # pylint: disable=too-few-public-methods
    """`StepImplementer` for the `generate-metadata` to generate a
    semantic version from given input.
    """

    @staticmethod
    def step_implementer_config_defaults():
        """Getter for the StepImplementer's configuration defaults.

        Returns
        -------
        dict
            Default values to use for step configuration values.

        Notes
        -----
        These are the lowest precedence configuration values.

        """
        return DEFAULT_CONFIG

    @staticmethod
    def _required_config_or_result_keys():
        """Getter for step configuration or previous step result artifacts that are required before
        running this step.

        See Also
        --------
        _validate_required_config_or_previous_step_result_artifact_keys

        Returns
        -------
        array_list
            Array of configuration keys or previous step result artifacts
            that are required before running the step.
        """
        return REQUIRED_CONFIG_OR_PREVIOUS_STEP_RESULT_ARTIFACT_KEYS

    def _run_step(self):
        """Runs the step implemented by this StepImplementer.

        Returns
        -------
        StepResult
            Object containing the dictionary results of this step.
        """
        step_result = StepResult.from_step_implementer(self)

        # construct version and image tag
        version_core = self.get_value('app-version')
        version = f'{version_core}'
        image_tag = f'{version_core}'
        pre_release = None
        if self.get_value('is-pre-release'):
            pre_release = self.__get_semantic_version_pre_release()
            if pre_release:
                version += f'-{pre_release}'
                image_tag += f'-{pre_release}'
            else:
                # NOTE: maybe at some point we should set some default pre-release value if
                #       none calculated so that semver reflects that it is a pre-release?
                pass
        build = self.__get_semantic_version_build()
        if build:
            version += f'+{build}'
            image_tag += f"{self.get_value('container-image-tag-build-deliminator')}{build}"

        # add artifacts
        step_result.add_artifact(
            name='version',
            value=version,
            description='Full constructured semantic version'
        )
        step_result.add_artifact(
            name='container-image-tag',
            value=image_tag,
            description='Constructed semantic version without build identifier' \
              ' since not compatible with container image tags'
        )
        step_result.add_artifact(
            name='semantic-version-core',
            value=version_core,
            description='Semantic version version core portion'
        )
        if pre_release:
            step_result.add_artifact(
                name='semantic-version-pre-release',
                value=pre_release,
                description='Semantic version pre-release portion'
            )
        if build:
            step_result.add_artifact(
                name='semantic-version-build',
                value=build,
                description='Semantic version build portion'
            )

        # add evidence
        step_result.add_evidence(
            name='version',
            value=version,
            description='Full constructured semantic version'
        )
        step_result.add_evidence(
            name='container-image-tag',
            value=image_tag,
            description='semantic version without build identifier' \
                ' since not compatible with container image tags'
        )

        return step_result

    def __get_semantic_version_pre_release(self):
        """Get the pre-release portion of the semantic version

        Returns
        -------
        Pre-release portion of the semantic version.
        """
        pre_release = None
        pre_release_identifiers = []

        # if branch given add as a pre-release identifier
        branch = self.get_value('branch')
        if branch:
            pre_release_regex = re.compile(r"/", re.IGNORECASE)
            branch_pre_release_identifier = re.sub(pre_release_regex, '-', branch)
            pre_release_identifiers.append(branch_pre_release_identifier)

        # if workflow run num given ass as  apre-release identifier
        workflow_run_num = self.get_value('workflow-run-num')
        if workflow_run_num:
            pre_release_identifiers.append(workflow_run_num)

        # if additional pre-release identifiers given, add as pre-release identifiers
        additional_pre_release_identifiers = self.get_value('additional-pre-release-identifiers')
        if additional_pre_release_identifiers:
            if isinstance(additional_pre_release_identifiers, list):
                pre_release_identifiers += additional_pre_release_identifiers
            else:
                pre_release_identifiers.append(additional_pre_release_identifiers)

        if pre_release_identifiers:
            pre_release = '.'.join(pre_release_identifiers)

        return pre_release

    def __get_semantic_version_build(self):
        """Get the build portion of the semantic version

        Returns
        -------
        Build portion of the semantic version.
        """
        build = None
        build_identifiers = []

        # if commit-hash given add as a build identifier
        commit_hash = self.get_value('commit-hash')
        if commit_hash:
            commit_hash_build_identifier = None
            commit_hash_build_identifier_length = self.get_value('commit-hash-build-identifier-length')
            if commit_hash_build_identifier_length:
                commit_hash_build_identifier = str(commit_hash)[:commit_hash_build_identifier_length]
            else:
                commit_hash_build_identifier = commit_hash
            build_identifiers.append(commit_hash_build_identifier)

        # if workflow run num given as a build identifier
        workflow_run_num = self.get_value('workflow-run-num')
        if workflow_run_num:
            build_identifiers.append(str(workflow_run_num))

        # if additional pre-release identifiers given, add as pre-release identifiers
        additional_build_identifiers = self.get_value('additional-build-identifiers')
        if additional_build_identifiers:
            if isinstance(additional_build_identifiers, list):
                build_identifiers += additional_build_identifiers
            else:
                build_identifiers.append(additional_build_identifiers)

        if build_identifiers:
            build = '.'.join(build_identifiers)

        return build

Ancestors

• StepImplementer
• abc.ABC

Static methods

def step_implementer_config_defaults()

Getter for the StepImplementer's configuration defaults.

Returns

dict

Default values to use for step configuration values.

Notes

These are the lowest precedence configuration values.

Inherited members

• StepImplementer:
  • config
  • create_working_dir_sub_dir
  • environment
  • get_config_value
  • get_copy_of_runtime_step_config
  • get_result_value
  • get_value
  • global_config_defaults
  • global_environment_config_defaults
  • has_config_value
  • run_step
  • step_config
  • step_config_overrides
  • step_environment_config
  • step_name
  • sub_step_implementer_name
  • sub_step_name
  • work_dir_path
  • workflow_result
  • write_working_file