Release Pipeline

The release_pipeline.py script is the main script used within the boomi_cicd library. It will read through a release JSON file and creating the package, deploy the processes, schedules, and listener status as defined in the file.

If the package version is not created, then the script will create the package component. Then it will deploy the version of the packaged component to the desired environment. If the process is a listener, then the listener status will be set to what is within the release JSON file. If nothing is set, then it defaults to RUNNING. Finally, if a schedule is defined, then the schedule will be set to the desired schedule.

import boomi_cicd


# Open release json
releases = boomi_cicd.set_release()

environment_id = boomi_cicd.query_environment(boomi_cicd.ENVIRONMENT_NAME)

for release in releases["pipelines"]:
    component_id = release["componentId"]
    package_version = release["packageVersion"]
    notes = release.get("notes")

    package_id = boomi_cicd.query_packaged_component(component_id, package_version)

    if not package_id:
        package_id = boomi_cicd.create_packaged_component(
            component_id, package_version, notes
        )

    # The third parameter determines if the package is currently deployed (True) or has every been deployed (False)
    package_deployed = boomi_cicd.query_deployed_package(
        package_id, environment_id, False
    )
    if not package_deployed:
        deployment_id = boomi_cicd.create_deployed_package(
            release, package_id, environment_id
        )
        # delete_deployed_package(deployment_id) # Delete deployment is useful for testing

Required Environment Variables

Required Environment Variables

Environment Variable	Description
BOOMI_ACCOUNT_ID	The Boomi account ID.
BOOMI_ATOM_NAME	The name of the Boomi Atom.
BOOMI_BASE_URL	The base URL for the Boomi API. https://api.boomi.com/api/rest/v1
BOOMI_ENVIRONMENT_NAME	The Boomi environment name.
BOOMI_PASSWORD	The Boomi password. Atomsphere API Token is recommended
BOOMI_RELEASE_FILE	The name of the release JSON file to use.
BOOMI_USERNAME	The Boomi username. Atomsphere API Token is recommended

Command Line Arguments

• -r, –release_file: The release JSON file to use. If not specified, then the BOOMI_RELEASE_FILE environment variable will be used.

Release JSON File

{
  "pipelines": [
    {
      "processName": "An Example Batch Process",
      "packageVersion": "2.0",
      "componentId": "83d6013f-96f5-4a75-a97b-f4934b0ec2e8",
      "notes": "This is an example set of notes",
      "schedule": "0 0 1 * * * ; 30 0 2-7 * * *",
      "automatedTestId": "used within automated_testing.py"
    },
    {
      "processName": "An Example Listener Process",
      "packageVersion": "1.0",
      "componentId": "b24f310b-6a66-4e0d-97a3-26f1e812b79a",
      "notes": "This is an example set of notes",
      "listenerStatus": "RUNNING"
    },
    {
      "processName": "An Example Custom Library",
      "componentId": "7bd40730-6df3-4ba9-b4b2-ed9153dbca6d",
      "packageVersion": "1.0",
      "notes": "Initial deployment"
    }
  ]
}