component_xml

boomi_cicd.util.component_xml.clone_repository()[source]

Clone the component repository. The function will import GitPython to avoid the need to install git unless the component_xml_git.py script is used. :return: Repo object

boomi_cicd.util.component_xml.commit_and_push(repo, commit_message='Commit from Boomi CICD')[source]

Commit and push changes to the component repository. :param repo: Repo object :param commit_message: Commit Message. Default is “Commit from Boomi CICD”. :return: None.

boomi_cicd.util.component_xml.delete_unused_files(repo, process_base_dir, component_info_names, process_name)[source]

Delete unused files from the component repository. :param repo: Repo object :param process_base_dir: Directory of the current process. :param component_info_names: :param process_name: Name of the process from the release JSON file. :return: None.

boomi_cicd.util.component_xml.get_component_info_from_manifest(packaged_manifest)[source]

Get the component info from the packaged manifest. This contains a list of all component ids within the packaged component. :param packaged_manifest: :return: A list of all the component IDs within the packaged component manifest. :rtype: list

boomi_cicd.util.component_xml.get_component_refs(process_base_dir)[source]

Get the component references from the directory. :param process_base_dir: :return: A name/value pair for the component name and component ID. :rtype: set

boomi_cicd.util.component_xml.get_component_xml_file_refs(location)[source]

Read .componentRef file to get component id of folder/files.

Parameters:

location (str) – The location of the file.

Returns:

A dictionary containing folder references with their IDs as keys and names as values.

Return type:

dict

boomi_cicd.util.component_xml.install_sonarqube()[source]

Install SonarQube Scanner CLI.

Returns:

The path to the SonarQube Scanner CLI executable.

Return type:

str

boomi_cicd.util.component_xml.process_component(repo, process_base_dir, component_info_id, component_refs, process_name)[source]
boomi_cicd.util.component_xml.process_git_release(repo, file_components, release)[source]

Process a release from the release json and update the component repository. This function is the main function for the component_xml_git.py script. :param repo: Boomi Component Repository :param file_components: The base name/value pair for the component name and component ID. :param release: The release json. :return: None.

boomi_cicd.util.component_xml.rename_component_folder(repo, file_components, component_id, process_name)[source]

Rename the component folder if the process name has changed. :param repo: Boomi Component Repository :param file_components: The base name/value pair for the component name and component ID. :param component_id: The component ID. :param process_name: The process name. :return: None.

boomi_cicd.util.component_xml.set_component_xml_file_refs(location, file_refs)[source]

Write .componentRef file to set component id of folder/files.

Parameters:
  • location (str) – The location of the file.

  • file_refs (dict) – A dictionary containing folder references with their IDs as keys and names as values.