Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pnast/feature/mic 5679 jenkins reuse #392

Merged
merged 6 commits into from
Jan 13, 2025
Merged

Pnast/feature/mic 5679 jenkins reuse #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8131f4d
Update Jenkinsfile
patricktnast Jan 8, 2025
c0037e4
standardize name
patricktnast Jan 8, 2025
237a372
add format
patricktnast Jan 8, 2025
6b72957
Update Jenkinsfile
patricktnast Jan 8, 2025
efc9a5f
blank-ish commit
patricktnast Jan 9, 2025
f905bc2
Merge branch 'main' into pnast/feature/mic-5679-jenkins-reuse
patricktnast Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
263 changes: 2 additions & 261 deletions Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,261 +1,2 @@
def githubUsernameToSlackName(github_author) {
// Add team members as necessary
def mapping = [
"Jim Albright": "albrja",
"Steve Bachmeier": "sbachmei",
"Hussain Jafari": "hjafari",
"Patrick Nast": "pnast",
"Rajan Mudambi": "rmudambi",
]
return mapping.get(github_author, "channel")
}

pipeline_name="vivarium_inputs"
conda_env_name="${pipeline_name}-${BRANCH_NAME}-${BUILD_NUMBER}"
conda_env_path="/tmp/${conda_env_name}"
// comma separated string list of branches to run periodic builds on
scheduled_branches = "main"
CRON_SETTINGS = scheduled_branches.split(',').collect{it.trim()}.contains(BRANCH_NAME) ? 'H H(20-23) * * *' : ''
// defaults for conda and pip are a local directory /svc-simsci for improved speed.
// In the past, we used /ihme/code/* on the NFS (which is slower)
shared_path="/svc-simsci"


pipeline {
// This agent runs as svc-simsci on node simsci-ci-coordinator-01.
// It has access to standard IHME filesystems and singularity
agent { label "coordinator" }
triggers {
cron(CRON_SETTINGS)
}

options {
// Keep 100 old builds.
buildDiscarder logRotator(numToKeepStr: "100")

// Wait 60 seconds before starting the build.
// If another commit enters the build queue in this time, the first build will be discarded.
quietPeriod(60)

// Fail immediately if any part of a parallel stage fails
parallelsAlwaysFailFast()
}

parameters {
booleanParam(
name: "DEPLOY_OVERRIDE",
defaultValue: false,
description: "Whether to deploy despite building a non-default branch. Builds of the default branch are always deployed."
)
booleanParam(
name: "IS_CRON",
defaultValue: true,
description: "Indicates a recurring build. Used to skip deployment steps."
)
string(
name: "SLACK_TO",
defaultValue: "simsci-ci-status",
description: "The Slack channel to send messages to."
)
booleanParam(
name: "DEBUG",
defaultValue: false,
description: "Used as needed for debugging purposes."
)
}

stages {
stage("Initialization") {
steps {
script {
// Use the name of the branch in the build name
currentBuild.displayName = "#${BUILD_NUMBER} ${GIT_BRANCH}"
}
}
}

stage("Python version matrix") {
// we don't want to go to deployment if any of the matrix branches fail
failFast true
matrix {
// customWorkspace setting must be ran within a node
agent {
node {
// Run child tasks on slurm node.
label "slurm"
}
}
axes {
axis {
// parallelize by python minor version
name 'PYTHON_VERSION'
values "3.10", "3.11"
}
}

environment {
// Get the branch being built and strip everything but the text after the last "/"
BRANCH = sh(script: "echo ${GIT_BRANCH} | rev | cut -d '/' -f1 | rev", returnStdout: true).trim()
TIMESTAMP = sh(script: 'date', returnStdout: true)
// Specify the path to the .condarc file via environment variable.
// This file configures the shared conda package cache.
CONDARC = "${shared_path}/miniconda3/.condarc"
CONDA_BIN_PATH = "${shared_path}/miniconda3/bin"
// Specify conda env by build number so that we don't have collisions if builds from
// different branches happen concurrently.
PYTHON_DEPLOY_VERSION = "3.11"
CONDA_ENV_NAME = "${conda_env_name}"
CONDA_ENV_PATH = "${conda_env_path}_${PYTHON_VERSION}"
// Set the Pip cache.
XDG_CACHE_HOME = "${shared_path}/pip-cache"
// Jenkins commands run in separate processes, so need to activate the environment every
// time we run pip, poetry, etc.
ACTIVATE = "source ${CONDA_BIN_PATH}/activate ${CONDA_ENV_PATH} &> /dev/null"
}

stages {
stage("Debug Info") {
steps {
echo "Jenkins pipeline run timestamp: ${TIMESTAMP}"
// Display parameters used.
echo """Parameters:
DEPLOY_OVERRIDE: ${params.DEPLOY_OVERRIDE}"""

// Display environment variables from Jenkins.
echo """Environment:
ACTIVATE: '${ACTIVATE}'
BUILD_NUMBER: '${BUILD_NUMBER}'
BRANCH: '${BRANCH}'
CONDARC: '${CONDARC}'
CONDA_BIN_PATH: '${CONDA_BIN_PATH}'
CONDA_ENV_NAME: '${CONDA_ENV_NAME}'
CONDA_ENV_PATH: '${CONDA_ENV_PATH}'
GIT_BRANCH: '${GIT_BRANCH}'
JOB_NAME: '${JOB_NAME}'
WORKSPACE: '${WORKSPACE}'
XDG_CACHE_HOME: '${XDG_CACHE_HOME}'"""
}
}

stage("Build Environment") {
environment {
// Command for activating the base environment. Activating the base environment sets
// the correct path to the conda binary which is used to create a new conda env.
ACTIVATE_BASE = "source ${CONDA_BIN_PATH}/activate &> /dev/null"
}
steps {
// The env should have been cleaned out after the last build, but delete it again
// here just to be safe.
sh "rm -rf ${CONDA_ENV_PATH}"
sh "${ACTIVATE_BASE} && make build-env PYTHON_VERSION=${PYTHON_VERSION}"
// open permissions for test users to create file in workspace
sh "chmod 777 ${WORKSPACE}"
}
}

stage("Install Package") {
steps {
sh "${ACTIVATE} && make install \"ARGS=${GIT_BRANCH}\""
}
}

// NOTE: We exclude several usual stages (Format, Lint, and Type Check)
// because they are already being run in github actions.

// Tests
// NOTE: We only run slow e2e tests here because unit and mocked e2e tests are already
// being run in github actions.
// NOTE: we do not distinguish between scheduled (IS_CRON) and triggered (e.g. on-push)
// builds here like we typically do. Usually we would run slow tests on a schedule and
// fast tests when triggered, but in this case the repo (hosted on github) does not have
// access to the Jenkins builds anyway and so we can't block a merge with a failed
// build. As such, we just always run the slow tests and will at least get a slack
// message upon failure (even if too late and the merge already happened).
stage("Run Unmocked E2E Tests") {
steps {
sh "${ACTIVATE} && make e2e-runslow"
publishHTML([
allowMissing: true,
alwaysLinkToLastBuild: false,
keepAll: true,
reportDir: "output/htmlcov_e2e",
reportFiles: "index.html",
reportName: "Coverage Report - E2E tests",
reportTitles: ''
])
}
}

// Build
stage('Build and Deploy') {
when {
expression { "${PYTHON_DEPLOY_VERSION}" == "${PYTHON_VERSION}" }
}
stages {
stage("Build Docs") {
steps {
sh "${ACTIVATE} && make build-doc"
}
}
stage("Build Package") {
steps {
sh "${ACTIVATE} && make build-package"
}
}
} // stages within build and deploy
} // build and deploy stage
} // stages bracket within Python matrix
post {
always {
sh "${ACTIVATE} && make clean"
sh "rm -rf ${CONDA_ENV_PATH}"
// Generate a message to send to Slack.
script {
if (env.BRANCH == "main") {
channelName = "simsci-ci-status"
} else {
channelName = "simsci-ci-status-test"
}
// Run git command to get the author of the last commit
developerID = sh(
script: "git log -1 --pretty=format:'%an'",
returnStdout: true
).trim()
slackID = githubUsernameToSlackName(developerID)
slackMessage = """
Job: *${env.JOB_NAME}*
Build number: #${env.BUILD_NUMBER}
Build status: *${currentBuild.result}*
Author: @${slackID}
Build details: <${env.BUILD_URL}/console|See in web console>
""".stripIndent()
}

// Delete the workspace directory.
deleteDir()
}
failure {
echo "This build triggered by ${developerID} failed on ${GIT_BRANCH}. Sending a failure message to Slack."
slackSend channel: "#${channelName}",
message: slackMessage,
teamDomain: "ihme",
tokenCredentialId: "slack"
}
success {
script {
if (params.DEBUG) {
echo 'Debug is enabled. Sending a success message to Slack.'
slackSend channel: "#${channelName}",
message: slackMessage,
teamDomain: "ihme",
tokenCredentialId: "slack"
} else {
echo 'Debug is not enabled. No success message will be sent to Slack.'
}
}
}
} // post bracket
} // Python matrix bracket
} // Python matrix stage bracket
} // stages bracket
}
@Library("vivarium_build_utils") _
reusable_pipeline(scheduled_branches: ["main"], test_types: ["e2e"], python_versions: ["3.10", "3.11"], requires_slurm: true)
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ install: # Install setuptools, install this package in editable mode
# FIXME: Add support for installing non-develop branches of vivarium_gbd_access
# @sh vivarium_build_utils/install_dependency_branch.sh vivarium_gbd_access ${GIT_BRANCH} jenkins

# NOTE: we cannot currently install anything but the 'main' branch in vivarium_gbd_access
# NOTE: We cannot currently install anything but the 'main' branch in vivarium_gbd_access
# due to it being hosted on bitbucket and behind the IHME firewall (which vivarium_build_utils
# cannot see because it is on github). One workaround until we get this fixed is to
# TEMPORARILY (i.e. just for testing) change the vivarium_gbd_access setup.py data_requires
Expand All @@ -89,7 +89,7 @@ format: setup.py pyproject.toml $(MAKE_SOURCES) # Run the code formatter and imp
black $(LOCATIONS)
@echo "Ignore, Created by Makefile, `date`" > $@

e2e-runslow: $(MAKE_SOURCES) # Run all (--runslow) end-to-end tests
e2e: $(MAKE_SOURCES) # Run all (--runslow) end-to-end tests
export COVERAGE_FILE=./output/.coverage.e2e
pytest tests/e2e -vvv --runslow --cov --cov-report term --cov-report html:./output/htmlcov_e2e
@echo "Ignore, Created by Makefile, `date`" > $@
Expand Down
Loading