~/jenkins/how-run-automation-different-environment-jenkinsfile.md

Jenkins Pipeline - How to run Automation on Different Environment (Dev/Stage/Prod), with Credentials

2 min readOctober 07, 2022by Gorav Singal#cicd#build#jenkins
// TL;DR

Define environment-specific variables in a map and override them using a choice parameter for dev/stage/prod. Combine with withCredentials to inject secrets per environment.

Jenkins Pipeline - How to run Automation on Different Environment (Dev/Stage/Prod), with Credentials

Introduction

I have an automation script, that I want to run on different environments, with a cron schedule. I’m using a web-service, and the endpoints are different for each environment.

Also, I would need credentials for calling that web-service apis.

Recommended read on How to Run job on Cron-schedule

Jenkinsfile for Run Automation on Different Environments

pipeline {
    agent {
        node {
            label "MyNode"
        }
    }
    triggers {
        //every 24 hours at 12 AM
        cron('0 0 * * *')
    }
    stages {
        stage('Install requirements') {
            when {
                not { changeset pattern: ".*", comparator: "REGEXP" }
            }
            steps {
                withCredentials([[
                    $class: 'UsernamePasswordMultiBinding',
                    credentialsId: 'my_api_key',
                    usernameVariable: 'ARTIFACTORY_USERNAME',
                    passwordVariable: 'ARTIFACTORY_PASSWORD']
                ]) {
                    sh """
                    python3.8 -m pip install virtualenv
                    python3.8 -m venv python_env
                    source python_env/bin/activate
                    python3.8 -m pip install --upgrade pip
                    python3.8 -m pip install -r requirements.txt -i https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_PASSWORD}@artifactory.myorg.com/artifactory/api/pypi/pypi-myorg-release/simple

                    deactivate
                    """
                }
            } 
        }
        stage('Run Workflow Scheduler') {
            parallel {
                stage('Run Scheduler for Dev') {
                    steps {
                        withCredentials([[
                            $class: 'UsernamePasswordMultiBinding',
                            credentialsId: 'mygen',
                            usernameVariable: 'API_USER',
                            passwordVariable: 'API_PASSWORD']
                        ]) {
                            sh """
                            echo "Running for Dev env"

                            export WEB_SERVICE_BASE_URL="https://my-dev.myorg.com/api/"

                            python3.8 -m venv python_env
                            source python_env/bin/activate
                    
                            python3.8 app.py
                            deactivate
                            """
                        }
                    }
                }
                stage('Run Scheduler for Stage') {
                    steps {
                        withCredentials([[
                            $class: 'UsernamePasswordMultiBinding',
                            credentialsId: 'mygen',
                            usernameVariable: 'API_USER',
                            passwordVariable: 'API_PASSWORD']
                        ]) {
                            sh """
                            echo "Running for Stage env"

                            export WEB_SERVICE_BASE_URL="https://my-stg.myorg.com/api/"

                            python3.8 -m venv python_env
                            source python_env/bin/activate
                    
                            python3.8 app.py
                            deactivate
                            """
                        }
                    }
                }
                stage('Run Scheduler for Prod') {
                    steps {
                        withCredentials([[
                            $class: 'UsernamePasswordMultiBinding',
                            credentialsId: 'mygen',
                            usernameVariable: 'API_USER',
                            passwordVariable: 'API_PASSWORD']
                        ]) {
                            sh """
                            echo "Running for Prod env"

                            export WEB_SERVICE_BASE_URL="https://my-prod.myorg.com/api/"

                            python3.8 -m venv python_env
                            source python_env/bin/activate
                    
                            python3.8 app.py
                            deactivate
                            """
                        }
                    }
                }
            }
        }
    }
}

Description

I’m doing following in above file:

  • Schedule job every 24 hours: cron('0 0 * * *')
  • Not to run on code commit
  • Taking credentials from Jenkins using UsernamePasswordMultiBinding, and exposing in environment variables
  • Installing python requirements
  • Run automation via shell script
  • Then running automation run step in parallel, for each environment (dev/stage/prod)
  • Setting web service URL in environment variable

$ subscribe --weekly

One deep dive a week, in your inbox

System design, AI engineering, trading systems and interview prep. Tested code, real numbers. Free, and you can unsubscribe any time.

or read it on gyanbyte.substack.com

Share

Related Posts

Jenkins Pipeline with Jenkinsfile - How To Schedule Job on Cron and Not on Code Commit

Jenkins Pipeline with Jenkinsfile - How To Schedule Job on Cron and Not on Code Commit

Introduction In this post we will see following: How to schedule a job on cron…

How to Fetch Multiple Credentials and Expose them in Environment using Jenkinsfile pipeline

How to Fetch Multiple Credentials and Expose them in Environment using Jenkinsfile pipeline

Introduction In this post, we will see how to fetch multiple credentials and…

Jenkinsfile - How to Create UI Form Text fields, Drop-down and Run for Different Conditions

Jenkinsfile - How to Create UI Form Text fields, Drop-down and Run for Different Conditions

Introduction I had to write a CICD system for one of our project. I had to…

How to Git Clone Another Repository from Jenkin Pipeline in Jenkinsfile

How to Git Clone Another Repository from Jenkin Pipeline in Jenkinsfile

Introduction There are some cases, where I need another git repository while…

A Jenkins Groovy Pipeline for Building Python Projects and Pushing to Artifactory

A Jenkins Groovy Pipeline for Building Python Projects and Pushing to Artifactory

Introduction In this post, we will see a sample Jenkin Pipeline Groovy script…

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Introduction It is very important to introduce few process so that your code and…

Latest Posts

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

In the previous article I argued that AI is not killing software engineering…

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

A few months back I approved a PR that was almost entirely AI-generated. It…

How to Debug AI-Generated Code: Understand First, Fix Last

How to Debug AI-Generated Code: Understand First, Fix Last

In the last article I wrote about reviewing AI code before it goes in. This one…

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

Every few weeks somebody sends me a scary headline — “AI will replace all…

The Transactional Outbox Pattern: Never Lose an Event Again

The Transactional Outbox Pattern: Never Lose an Event Again

This is one of those patterns that looks like nothing until you get burnt once…

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Here is a question I like to ask in interviews: your bank account shows a…