From 1d881de90c048a247433652dd990fe396bbf208f Mon Sep 17 00:00:00 2001
From: Tim Crawford <tcrawford@system76.com>
Date: Thu, 8 Jun 2023 12:55:01 -0600
Subject: [PATCH] Add Jenkinsfile for Pipeline

This attempts to match the existing configuration of the firmware-open
project in Jenkins.

The curl command is constructed from the GitHub docs to submit the
commit status [1].

[1]: https://docs.github.com/en/rest/commits/statuses#create-a-commit-status

Ref: https://www.jenkins.io/doc/book/pipeline/
Signed-off-by: Tim Crawford <tcrawford@system76.com>
---
 Jenkinsfile | 137 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 137 insertions(+)
 create mode 100644 Jenkinsfile

diff --git a/Jenkinsfile b/Jenkinsfile
new file mode 100644
index 0000000..499b8de
--- /dev/null
+++ b/Jenkinsfile
@@ -0,0 +1,137 @@
+#!/usr/bin/env groovy
+
+// Required plugins:
+// - Jenkins Core
+// - Pipeline (https://plugins.jenkins.io/workflow-aggregator/)
+// - Git (https://plugins.jenkins.io/git/)
+// - AnsiColor (https://plugins.jenkins.io/ansicolor/)
+// - Slack Notification (https://plugins.jenkins.io/slack/)
+
+def all_models = 'addw2 addw3 bonw14 bonw15 darp5 darp6 darp7 darp8 darp9 galp3-c galp4 galp5 galp6 galp7 gaze15 gaze16-3050 gaze16-3060 gaze16-3060-b gaze16-3050 gaze16-3060-b gaze17-3050 gaze17-3060-b gaze18 lemp9 lemp10 lemp11 lemp12 oryp5 oryp6 oryp7 oryp8 oryp9 oryp10 oryp11 serw13'
+
+def getCommitSha() {
+  sh "git rev-parse HEAD > .git/current-commit"
+  return readFile(".git/current-commit").trim()
+}
+
+void setBuildStatus(String state, String message) {
+    commit = getCommitSha()
+
+    sh """
+    curl \
+      -X POST \
+      -H \'Accept: application/vnd.github+json\' \
+      -H \'Authorization: token ${GITHUB_TOKEN}\' \
+      https://api.github.com/repos/system76/firmware-open/statuses/${commit} \
+      -d \'{\"state\": \"${state}\", \"target_url\": \"${BUILD_URL}\", \"description\": \"${message}\"}\'
+    """
+}
+
+pipeline {
+    agent {
+        label 'warp.pop-os.org'
+    }
+
+    environment {
+        GITHUB_TOKEN = credentials('github-commit-status')
+    }
+
+    options {
+        buildDiscarder(logRotator(numToKeepStr: '16', artifactNumToKeepStr: '1'))
+        disableConcurrentBuilds()
+        timeout(time: 1, unit: 'HOURS')
+        timestamps()
+        ansiColor('xterm')
+    }
+
+    parameters {
+        string(name: 'MODELS', defaultValue: "$all_models", description: 'Space separated list of models to build', trim: true)
+        string(name: 'GIT_BRANCH', defaultValue: '', description: 'Git branch or revision to build (master, for example)', trim: true)
+    }
+
+    // TODO: Set up webhook so trigger isn't needed.
+    triggers {
+        pollSCM('H/5 * * * *')
+    }
+
+    stages {
+        stage('Prepare') {
+            steps {
+                checkout([
+                    $class: 'GitSCM',
+                    branches: [[name: "${GIT_BRANCH}"]],
+                    extensions: [
+                        [
+                            $class: 'SubmoduleOption',
+                            disableSubmodules: false,
+                            parentCredentials: true,
+                            recursiveSubmodules: true,
+                            reference: '',
+                            trackingSubmodules: false
+                        ],
+                        [ $class: 'GitLFSPull' ],
+                        [ $class: 'PruneStaleBranch' ],
+                    ],
+                    userRemoteConfigs: [[url: 'https://github.com/system76/firmware-open']]
+                ])
+
+                setBuildStatus("pending", "Pending")
+                slackSend(color: "good", message: "${JOB_NAME} - #${BUILD_ID} started (<${BUILD_URL}|Open>)")
+
+                sh """#!/bin/bash
+                    # Install dependencies
+                    #./scripts/deps.sh
+                    . "${HOME}/.cargo/env"
+
+                    # Reset
+                    git submodule update --init --recursive --checkout
+                    git reset --hard
+                    git submodule foreach --recursive git reset --hard
+
+                    # Clean
+                    git clean -dffx
+                    git submodule foreach --recursive git clean -dff
+
+                    # EDK2 builds fail if file paths in INFs change from what's in the build cache
+                    pushd edk2; git clean -dffx; popd
+                """
+            }
+        }
+        stage('Build') {
+            steps {
+                // The workspace is reused, so must build models sequentially.
+                script {
+                    def list = params.MODELS.tokenize()
+                    list.each { model ->
+                        stage(model) {
+                            sh """#!/bin/bash
+                                . "${HOME}/.cargo/env"
+                                # WORSKSPACE is set by Jenkins, but EDK2 uses it
+                                env --unset=WORKSPACE \
+                                ./scripts/build.sh "${model}"
+                            """
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    post {
+        always {
+            archiveArtifacts artifacts: 'build/*/*', allowEmptyArchive: true
+        }
+        success {
+            setBuildStatus("success", "Successful")
+            slackSend(color: "good", message: "${JOB_NAME} - #${BUILD_ID} successful (<${BUILD_URL}|Open>)")
+        }
+        failure {
+            setBuildStatus("failure", "Failed")
+            slackSend(color: "danger", message: "${JOB_NAME} - #${BUILD_ID} failed (<${BUILD_URL}|Open>)")
+        }
+        aborted {
+            setBuildStatus("failure", "Failed")
+            slackSend(color: "warning", message: "${JOB_NAME} - #${BUILD_ID} aborted (<${BUILD_URL}|Open>)")
+        }
+    }
+}