在 Jenkins 中使用聲明式 Pipeline 構建 Android 項目

Blue Ocean 是 Jenkins 推出的一套新的 UI，對比經典 UI 更具備現代化氣息。2017 年 4 月 James Dumay 在博客上正式推出了 Blue Ocean 1.0。

兼容 Blue Ocean 的 Jenkins 版本只須要安裝插件便可使用，對於已經在使用 Pipeline 構建的 Jenkins Job 基本能夠無縫切換到新 UI。

以構建 Android 項目爲例，學習如何使用 Jenkins Blue Ocean 與聲明式 Pipeline，示例項目能夠在 GitHub 上查看：

github.com/TomCzHen/je…

部署 Jenkins

在 Linux 上使用 docker-compose 經過項目中的編排文件快速部署 Jenkins。

修改 .env 中的 ANDROID_HOME 參數爲 Android SKD 路徑，而後執行 docker-compose up -d 啓動容器，經過 http://ip:8080 訪問 Jenkins。

能夠根據須要修改 jenkins_home 的掛載路徑，因爲示例項目的 Jenkinsfile 是直接使用 master 節點做爲構建節點，所以 Windows 系統的 Android SDK 應該是沒法使用的(Mac 不肯定，沒硬件)。Windows/Mac 下構建須要以添加 Jenkins Agent 的方式運行，並在 Jenkinsfile 中須要修改構建使用的 Agent 和相應構建命令，相應的環境變量也須要配置。

關於如何在 CLI 下管理 Android SDK 能夠閱讀官方文檔： developer.android.com/studio/comm…

Fork 示例項目或者 Clone 後簽入到可訪問的 Git 倉庫中，按嚮導操做添加新 Pipeline 便可。示例項目分爲 master beta prod 三個分支，分別對應開發環境、測試環境、生產環境，僅做參考。

Docker Compose

...

    environment:
      - ANDROID_HOME=/opt/android-linux-sdk
      - ANDROID_SDK_HOME=/var/jenkins_home/tmp/android
      - GRADLE_USER_HOME=/var/jenkins_home/tools/gradle

...
複製代碼

ANDROID_HOME 是 Android SDK 的路徑，ANDROID_SDK_HOME 是 Android 項目構建中 SDK 產生的臨時文件路徑，GRADLE_USER_HOME 是 Gradle 的路徑。

ANDROID_SDK_HOME 與 GRADLE_USER_HOME 默認都是在用戶目錄下，經過聲明環境變量配置到 /var/jenkins_home 路徑下，也能夠在 Jenkins 中配置環境變量的方式實現。

...

    volumes:
      - /etc/localtime:/etc/localtime:ro
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - jenkins_home:/var/jenkins_home
      - ${ANDROID_HOME}:/opt/android-linux-sdk

...
複製代碼

初始化 Jenkins 密碼能夠經過 docker-compose logs jenkins-blueocean 查看日誌獲得。部署 Jenkins 完成後按嚮導完成初始化，安裝必要的插件。

在 Jenkins 插件管理中安裝 Blue Ocean Plugin 與 Android Signing Plugin 插件。

注：掛載 /var/run/docker.sock 的緣由是使用類型爲 Docker 或 Docker File 的 Agent，Jenkins 須要能夠訪問 Docker Daemon。

準備工做

因爲 Jenkinsfile 與項目代碼是存放在同一項目下，所以須要將敏感信息與項目分離，交由 Jenkins 管理保存。而後在構建過程當中讀取 Jenkins 配置信息，避免敏感信息泄漏。

對於 Android 項目，最重要的是 APK 簽名文件，經過使用插件 Android Signing Plugin 來保護簽名文件及密鑰。

使用 Credentials Plugin 插件保護項目中第三方 API 的 Secret Key，避免在項目代碼中泄漏.

Credentials Plugin

在 Credentials 中添加 ID 爲 BETA_SECRET_KEY 與 PROD_SECRET_KEY 的 Secret Text，內容爲須要保護的 API Secret Key。

Android Sign Plugin

Android Sign Plugin 依賴 Credentials Plugin，由於 Credentials Plugin 只支持 PKCS#12 格式的證書，因此先須要將生成好的 JKS 證書轉換爲 PKCS#12 格式：

keytool -importkeystore -srckeystore tomczhen.jks -srcstoretype JKS -deststoretype PKCS12 -destkeystore tomczhen.p12
複製代碼

添加類型爲 credential，選擇上傳證書文件，將 PKCS#12 證書上傳到並配置好 ID，本項目中使用了 ANDROID_SIGN_KEY_STORE 做爲 ID。

Jenkinsfile

參考文檔： Blue Ocean Pipeline Syntax Pipeline Steps Reference

Pipeline 功能在以前的 Jenkins 版本中已經存在了，Jenkins Pipeline 分有兩種：Declarative Pipeline 與 Scripted Pipeline 。

二者的區別是 Declarative Pipeline 必須以 pipeline 塊包含：

pipeline {
    ...
}

複製代碼

而 Scripted Pipeline 則以 node 塊包含：

node {
    ...
}
複製代碼

Declarative Pipeline 使用聲明式的寫法，也支持引入 Scripted Pipeline 代碼：

pipeline {
    ...

    stages {
        ...

        stage('Script Example) { steps { script { if (isUnix()) { sh './gradlew clean assembleBetaDebug' } else { bat 'gradlew clean assembleBetaDebug' } } } ... } ... } 複製代碼

雖然功能和靈活度上並無 Scripted Pipeline 強，可是簡單易懂，能夠快速上手使用。本文的的腳本代碼都是 Declarative Pipeline 類型的。

參數

使用 parameters 塊來聲明參數化，不過因爲 Blue Ocean 與 Declarative Pipeline 都是新生事物，因此當前支持的參數類型有限，須要等待社區擴展或者以 Scripted Pipeline 實現複雜需求。

pipeline {
    ...

    parameters {
        string(
            name: 'PARAM_STRING',
            defaultValue: 'String',
            description: 'String Parameter'
        )

        choice(
            name: 'PARAM_CHOICE',
            choices: '1st\n2nd\n3rd',
            description: 'Choice Parameter'
        )

        booleanParam(
            name: 'PARAM_CHECKBOX',
            defaultValue: true,
            description: 'Checkbox Parameter'
        )

        text(
            name: 'PARAM_TEXT'
            defaultValue: 'a-long-text',
            description: 'Text Parameter'
        )
    }

    stages {
        ...

        stage('Parameters Example') {
            steps {
                echo "Output Parameters"
                echo "PARAM_STRING=${params.PARAM_STRING}"
                echo "PARAM_CHOICE=${params.PARAM_CHOICE}"
                echo "PARAM_CHECKBOX=${params.PARAM_CHECKBOX}"
                echo "PARAM_TEXT=${params.PARAM_TEXT}"
            }
        }

        ...
    }

    ...
}
複製代碼

環境變量

能夠經過 environment 聲明環境變量，在 pipeline 頂層聲明的變量全局有效，而在 stage 中聲明的變量僅在 stage 中有效。

使用 withEnv 可讓變量僅在執行 step 時有效，能夠根據須要選擇聲明的方法。

pipeline {
    ...

    environment {
        CC = 'clang'
    }

    stages {
        ...

        stage('withEnv Example') {
            steps {
                echo 'Run Step With Env'
                withEnv(['ENV_FIRST=true', 'ENV_SECOND=sqlite']) {
                    echo "ENV_FIRST=${env.ENV_FIRST}"
                    echo "ENV_SECOND=${env.ENV_SECOND}"
                }
            }
        }

        stage('Environment Example') {
            environment {
                SECRET_KEY = credentials('a-secret-text-id')
            }

            steps {
                sh 'printenv'
            }
        }
    }

    ...
}
複製代碼

Credentials

有兩種方式獲取 Credential 的值，一種是使用 credentials()，在環境變量說明中已經有使用過，還可使用 withCredentials 的方式獲取：

pipeline {
    ...

    stages {
        ...
        stage("Build Beta APK") {
            steps {
                echo 'Building Beta APK...'
                withCredentials([string(credentialsId: 'BETA_SECRET_KEY', variable: 'SECRET_KEY')]) {
                script {
                    if (isUnix()) {
                        sh './gradlew clean assembleBetaDebug'
                    } else {
                        bat 'gradlew clean assembleBetaDebug'
                }
            }
        }

        ...
    }

    ...
}
複製代碼

與 withEnv 同樣，SECRET_KEY 只在 withCredentials 塊內部有效。

Android Sign

Android Sign Plugin 的使用比較簡單，配置好參數便可：

pipeline {
    ...

    stages {
        ...

        stage("Sign APK") {
            steps {
                echo 'Sign APK'
                signAndroidApks(
                    keyStoreId: "ANDROID_SIGN_KEY_STORE",
                    keyAlias: "tomczhen",
                    apksToSign: "**/*-prod-release-unsigned.apk",
                    archiveSignedApks: false,
                    archiveUnsignedApks: false
                )
            }
        }

        ...
    }

    ...
}
複製代碼

Android Gradle

參考文檔： Configure Build Variants

Build Config

在 Jenkinsfile 中聲明的環境變量，能夠在 gradle 腳本中獲取變量值：

android {
    ...

    defaultConfig {
        ...

        buildConfigField "String", "SECRET_KEY", String.format("\"%s\"", System.getenv("SECRET_KEY") ?: "Develop Secret Key")
    }

    ...
}
複製代碼

而後在 Android 項目代碼中使用 BuildConfig 類來使用：

BuildConfig.SECRET_KEY
複製代碼

Product Flavors

使用 Product Flavor 來對應不一樣的構建分支：

android {
    ...

    productFlavors {
        dev {
            ...
            applicationIdSuffix ".dev"
            versionNameSuffix "-dev"
            resValue("string", "version_name_suffix", getVersionNameSuffix())
        }
        beta {
            ...
            applicationIdSuffix ".beta"
            versionNameSuffix "-beta"
            resValue("string", "version_name_suffix", getVersionNameSuffix())
        }
        prod {
            ...
            resValue("string", "version_name_suffix", "")
        }
    }

    ...
}
複製代碼

ToDo

• 觸發構建
• 測試步驟
• 構建物收集