Python Jenkins 套件函式庫操作教學

– 8 分鐘閱讀

Python-Jenkins 套件函式庫提供便捷的 Jenkins 伺服器控制方式，涵蓋觸發建置、檢視記錄、管理作業等功能。安裝套件前需確認 Python 環境和 Pip 已安裝設定，再以 pip install python-jenkins 指令安裝。連線 Jenkins 伺服器時，需提供伺服器 URL、使用者名稱和密碼建立連線物件，再利用套件提供的 API 進行操作，例如 build_job 觸發建置、get_job_config 取得工作組態、create_job 建立新工作。此外，文章也說明如何列出所有工作、刪除工作，以及處理引數化工作的建置。更進一步，示範如何在 Jenkins Pipeline 中使用分享函式庫，減少程式碼重複並提升維護性，包含分享函式庫的結構、程式碼範例以及在 Jenkinsfile 中的應用方式。

使用Python-Jenkins套件函式庫

在本文中，我們將探討如何使用Python-Jenkins套件函式庫來控制Jenkins伺服器。首先，您需要安裝必要的軟體，包括Python解譯器、PyCharm和Python-Jenkins套件。

安裝Python解譯器

您可以從官方Python網站下載適合您作業系統的Python解譯器。安裝過程相對簡單，只需按照安裝程式的指引即可完成。

安裝PyCharm

PyCharm是一個流行的Python編輯器，提供了多種功能來幫助您編寫和除錯Python程式碼。您可以下載PyCharm的專業版（30天免費試用）或社群版（免費）。

安裝Python-Jenkins套件

安裝Python-Jenkins套件之前，您需要確保Pip（Python套件安裝器）已經安裝並新增到系統環境變數中。這個過程在第15章中有詳細介紹。

一旦Pip已經安裝並組態完成，您就可以使用以下命令安裝Python-Jenkins套件：

pip install python-jenkins

使用Python-Jenkins套件函式庫

Python-Jenkins套件函式庫提供了一種簡單的方式來控制Jenkins伺服器。您可以使用它來觸發建置、檢視建置記錄、管理作業等。

以下是一個簡單的範例，示範如何使用Python-Jenkins套件函式庫來觸發一個建置：

import jenkins

# 建立Jenkins連線
server = jenkins.Jenkins('https://your-jenkins-server.com', username='your-username', password='your-password')

# 觸發建置
server.build_job('your-job-name')

在這個範例中，我們首先建立了一個Jenkins連線，然後使用build_job方法來觸發一個建置。

內容解密：
  • jenkins.Jenkins類別：用於建立Jenkins連線。
  • build_job方法：用於觸發一個建置。
  • username和password引數：用於驗證Jenkins連線。

圖表翻譯：

  flowchart TD
    A[建立Jenkins連線] --> B[觸發建置]
    B --> C[檢視建置記錄]
    C --> D[管理作業]

在這個圖表中，我們展示瞭如何使用Python-Jenkins套件函式庫來控制Jenkins伺服器。首先，我們建立了一個Jenkins連線，然後使用build_job方法來觸發一個建置。接下來，我們可以檢視建置記錄和管理作業。

連線Jenkins伺服器並操作工作

連線Jenkins伺服器

首先，我們需要使用Python的jenkins函式庫來連線Jenkins伺服器。以下是連線Jenkins伺服器的程式碼：

import jenkins

# 連線Jenkins伺服器
server = jenkins.Jenkins('https://your-jenkins-server.com', 
                        username='your-username', 
                        password='your-password')

請將https://your-jenkins-server.com、your-username和your-password替換為您的Jenkins伺服器URL、使用者名稱和密碼。

取得登入使用者資訊

接下來，我們可以使用get_whoami() API來取得登入使用者資訊：

# 取得登入使用者資訊
user = server.get_whoami()
version = server.get_version()
print('Hello %s from Jenkins %s' % (user['fullName'], version))

這段程式碼會印出登入使用者的全名和Jenkins伺服器版本。

取得工作組態檔

我們可以使用get_job_config() API來取得工作組態檔：

# 取得工作組態檔
DemoJobConfiguration = server.get_job_config('Demo')

這段程式碼會取得名為Demo的工作組態檔，並將其儲存到DemoJobConfiguration變數中。

建立新工作

最後，我們可以使用create_job() API來建立新工作：

# 建立新工作
server.create_job('JobCreatedUsingPythonJenkins', DemoJobConfiguration)

這段程式碼會建立一個名為JobCreatedUsingPythonJenkins的新工作，並使用儲存於DemoJobConfiguration變數中的組態檔。

內容解密：

上述程式碼示範瞭如何使用Python的jenkins函式庫來連線Jenkins伺服器、取得登入使用者資訊、取得工作組態檔和建立新工作。每個API都有其特定的用途，例如get_whoami()用於取得登入使用者資訊，而get_job_config()用於取得工作組態檔。透過這些API，我們可以實作對Jenkins伺服器的各種操作。

圖表翻譯：

  flowchart TD
    A[連線Jenkins伺服器] --> B[取得登入使用者資訊]
    B --> C[取得工作組態檔]
    C --> D[建立新工作]

這個Mermaid圖表展示了程式碼的執行流程，從連線Jenkins伺服器開始，然後取得登入使用者資訊，接著取得工作組態檔，最後建立新工作。

混合主題篇章（二）

在深入探討Jenkins自動化的世界中，我們來到了混合主題的第二部分。在這裡，我們將探索如何使用Python指令碼來控制和管理Jenkins的各項功能，包括列出所有可用的工作、觸發特定工作的建置，以及刪除不再需要的工作。

列出所有可用的工作

首先，我們需要了解如何使用Python來列出Jenkins中所有可用的工作。這可以透過以下程式碼實作：

# 取得Jenkins伺服器物件
server = jenkins.Jenkins('http://localhost:8080')

# 取得所有工作的清單
jobs = server.get_jobs()

# 列印工作清單
for job in jobs:
    print(job.name)

這段程式碼會列出Jenkins中所有工作的名稱，讓您快速瞭解系統中有哪些工作。

觸發非引數化工作的建置

接下來，我們來看看如何觸發一個不接受任何引數的工作（簡單非引數化工作）的建置。以下是示範程式碼：

# 觸發名為"ReleaseCalculatorAPI"的工作建置
server.build_job('ReleaseCalculatorAPI')

這行程式碼會立即觸發名為"ReleaseCalculatorAPI"的工作進行建置。

刪除特定工作

如果您需要刪除一個不再需要的工作，可以使用以下程式碼：

# 刪除名為"JobCreatedUsingPythonJenkins"的工作
server.delete_job('JobCreatedUsingPythonJenkins')

請小心使用這個功能，因為刪除工作會永久刪除其所有相關資料和歷史記錄。

觸發引數化工作的建置

最後，讓我們看看如何觸發一個接受引數的工作（引數化工作）的建置。以下是示範程式碼：

# 建立名為"BuildAndDeployCalculatorWebApplication"的引數化工作
params = {
    'param1': 'value1',
    'param2': 'value2'
}
server.build_job('BuildAndDeployCalculatorWebApplication', params=params)

這段程式碼會觸發名為"BuildAndDeployCalculatorWebApplication"的工作建置，並傳遞必要的引數。

內容解密：

上述程式碼示範瞭如何使用Python來控制和管理Jenkins的各項功能。透過這些範例，您可以學習到如何列出所有可用的工作、觸發特定工作的建置，以及刪除不再需要的工作。同時，也展示瞭如何處理引數化工作的建置，讓您能夠更靈活地使用Jenkins進行自動化任務。

圖表翻譯：

  graph LR
    A[取得Jenkins伺服器物件] --> B[列出所有工作]
    B --> C[觸發特定工作建置]
    C --> D[刪除不再需要的工作]
    D --> E[觸發引數化工作建置]

這個流程圖展示了使用Python控制Jenkins的基本流程，從取得Jenkins伺服器物件開始，到列出所有工作、觸發特定工作建置、刪除不再需要的工作，最後到觸發引數化工作建置。

在Jenkins Pipeline中使用分享函式庫

在Jenkins Pipeline中，分享函式庫（Shared Libraries）是一種實用的方法，可以讓多個工作流程（Jobs）共用相同的程式碼和邏輯。這樣可以減少程式碼的重複性，並提高維護性。

建立分享函式庫

要建立一個分享函式庫，需要建立一個名為 vars 的目錄，並在其中建立一個 .groovy 檔案。這個檔案將包含分享函式庫的程式碼。注意，檔名必須使用駱駝命名法（camel case）。

分享函式庫的結構

分享函式庫的結構如下：

SharedLibrary/
vars/
buildJavaAPI.groovy

在 buildJavaAPI.groovy 檔案中，可以定義一個名為 call 的函式，這個函式將被用於在 Jenkins Pipeline 中呼叫分享函式庫。

定義分享函式庫的程式碼

以下是 buildJavaAPI.groovy 檔案中的程式碼：

def call(String repoUrl, String branch, String credentials) {
    pipeline {
        agent any
        //...
    }
}

這個函式接受三個引數： repoUrl、branch 和 credentials。這些引數可以用於定義 Jenkins Pipeline 的行為。

在Jenkins Pipeline中使用分享函式庫

要在 Jenkins Pipeline 中使用分享函式庫，需要在 Jenkinsfile 中呼叫 call 函式：

@Library('SharedLibrary') _

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                buildJavaAPI 'https://github.com/user/repo.git', 'master', 'credentials-id'
            }
        }
    }
}

在這個例子中，分享函式庫被呼叫，並傳遞了三個引數： repoUrl、branch 和 credentials。

優點

使用分享函式庫可以帶來以下優點：

  • 減少程式碼的重複性
  • 提高維護性
  • 方便地在多個工作流程中共用相同的程式碼和邏輯

從技術架構視角來看，Python-Jenkins套件函式庫為自動化Jenkins工作流程提供了簡潔而強大的解決方案。本文深入探討了從安裝套件到操作Jenkins任務的各個方面，涵蓋了連線伺服器、管理工作、觸發建置以及運用分享函式庫等關鍵技術。分析顯示，Python-Jenkins的易用性和靈活性使其成為管理Jenkins的理想工具，尤其在處理引數化建置和程式化任務方面更具優勢。然而，安全性考量始終是自動化流程中不可忽視的一環，妥善管理Jenkins憑證和存取許可權至關重要。展望未來，隨著DevOps的持續發展，預期Python-Jenkins將在更複雜的自動化場景中扮演更重要的角色，例如整合至更廣泛的CI/CD流程、結合容器化技術以及支援更精細的許可權控管。對於追求高效能DevOps實踐的團隊而言，深入理解並善用Python-Jenkins將是提升自動化成熟度的關鍵策略。

玄貓

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。