Selenium自動化專案推播到GitHub與Jenkins整合

– 13 分鐘閱讀

Selenium Python 自動化測試專案需要妥善管理和版本控制，GitHub 提供了理想的平臺。配合 Jenkins，更能實作 CI/CD 流程，自動化建置、測試和佈署。本文涵蓋了從建立引數化 Jenkins 工作到整合 AWS EC2 佈署的完整流程，並詳細說明瞭設定 API Token、SSH 公私鑰對等關鍵步驟，確保安全存取程式碼函式庫和伺服器。透過 Jenkins 分散式建置，更能有效利用資源，縮短建置時間，提升團隊效率。文章也提供了程式碼範例和流程圖，方便讀者理解和實作。

將 Selenium Python 自動化專案推播到 GitHub

在本文中，我們將探討如何將 Selenium Python 自動化專案推播到 GitHub。這是一個重要的步驟，因為它可以讓我們的專案在版本控制系統中得到管理和追蹤。

建立引數化的自動觸發自由式 Jenkins 工作

要建立引數化的自動觸發自由式 Jenkins 工作，我們需要按照以下步驟進行：

  1. 安裝引數化觸發外掛：首先，我們需要安裝引數化觸發外掛。這個外掛可以讓我們建立引數化的工作，並且可以根據引數的不同來觸發不同的工作流程。
  2. 建立 BuildAndDeployCalculator Web 應用程式工作：接下來，我們需要建立一個新的工作，這個工作將負責構建和佈署 Calculator Web 應用程式。
  3. 建立 TestCalculatorWeb 應用程式工作：然後，我們需要建立另一個新的工作，這個工作將負責測試 Calculator Web 應用程式。

組態擴充套件郵件通知

要組態擴充套件郵件通知，我們需要按照以下步驟進行：

  1. 安裝郵件擴充套件外掛：首先，我們需要安裝郵件擴充套件外掛。這個外掛可以讓我們組態郵件通知，並且可以根據不同的情況來傳送不同的郵件。
  2. 組態郵件擴充套件設定：接下來，我們需要組態郵件擴充套件設定，包括郵件伺服器、郵件帳戶等。
  3. 新增郵件通知步驟：然後，我們需要在工作的後置區域新增一個郵件通知步驟，這個步驟將負責傳送郵件通知。

手動執行引數化自由式工作

要手動執行引數化自由式工作，我們需要按照以下步驟進行：

  1. 輸入引數：首先，我們需要輸入引數，包括工作名稱、引數名稱等。
  2. 執行工作：接下來，我們可以執行工作，Jenkins 會根據我們輸入的引數來觸發相應的工作流程。

自動觸發引數化自由式工作

要自動觸發引數化自由式工作，我們需要按照以下步驟進行：

  1. 組態觸發器：首先，我們需要組態觸發器，包括定時觸發、Git 觸發等。
  2. 設定引數：接下來，我們需要設定引數，包括工作名稱、引數名稱等。
  3. 啟動自動觸發：然後，我們可以啟動自動觸發，Jenkins 會根據我們設定的觸發器和引數來自動觸發相應的工作流程。
@startuml
:開始; --> :安裝引數化觸發外掛;
:B; --> :建立 BuildAndDeployCalculator Web 應用程式工作;
:C; --> :建立 TestCalculatorWeb 應用程式工作;
:D; --> :組態擴充套件郵件通知;
:E; --> :手動執行引數化自由式工作;
:F; --> :自動觸發引數化自由式工作;
@enduml

內容解密：

以上流程圖展示瞭如何將 Selenium Python 自動化專案推播到 GitHub 的整個過程。從安裝引數化觸發外掛開始，到建立工作、組態郵件通知、手動執行工作和自動觸發工作，每一步都非常重要。透過這個過程，我們可以實作自動化測試和佈署，提高我們的工作效率和品質。

圖表翻譯：

此圖示展示了 Selenium Python 自動化專案推播到 GitHub 的流程。圖中包括了安裝引數化觸發外掛、建立工作、組態郵件通知、手動執行工作和自動觸發工作等步驟。每個步驟都代表了一個重要的環節，透過這些步驟，我們可以實作自動化測試和佈署。

建立引數化管線工作

在軟體開發中，自動化工作流程是提高效率和降低錯誤率的關鍵。其中，建立引數化管線工作可以讓開發人員更容易地管理和維護複雜的工作流程。在這個章節中，我們將探討如何建立引數化管線工作，並將其應用於實際的開發場景。

建立引數化管線工作的好處

建立引數化管線工作有許多好處，包括：

  • 提高靈活性：引數化管線工作允許開發人員根據不同的需求和環境定製工作流程。
  • 減少重複工作：透過建立引數化管線工作，開發人員可以避免重複建立類別似的工作流程。
  • 提高效率：引數化管線工作可以自動化許多手動任務，從而提高開發效率。

建立引數化管線工作的步驟

建立引數化管線工作需要以下步驟：

  1. 定義工作流程：首先，需要定義工作流程的需求和目標。
  2. 選擇工具：選擇合適的工具和技術來建立引數化管線工作。
  3. 設計管線：設計管線的架構和流程。
  4. 實作管線：使用選擇的工具和技術實作管線。
  5. 測試和驗證：測試和驗證管線的正確性和可靠性。

建立引數化管線工作的工具和技術

有許多工具和技術可以用來建立引數化管線工作，包括：

  • Jenkins：Jenkins是一個流行的自動化工具，可以用來建立引數化管線工作。
  • GitLab CI/CD：GitLab CI/CD是一個強大的工具，可以用來建立引數化管線工作。
  • Azure DevOps：Azure DevOps是一個完整的開發平臺，可以用來建立引數化管線工作。

例項：建立一個簡單的引數化管線工作

以下是建立一個簡單的引數化管線工作的例項：

pipeline {
    agent any
    parameters {
        string(name: 'BRANCH', defaultValue: 'main', description: 'Git branch')
    }
    stages {
        stage('Build') {
            steps {
                sh 'make build'
            }
        }
        stage('Test') {
            steps {
                sh 'make test'
            }
        }
        stage('Deploy') {
            steps {
                sh 'make deploy'
            }
        }
    }
}

在這個例項中，我們建立了一個簡單的引數化管線工作，該工作流程包括三個階段：Build、Test和Deploy。每個階段都有一個對應的shell命令。

圖表翻譯：
@startuml
:開始; --> :定義工作流程;
:B; --> :選擇工具;
:C; --> :設計管線;
:D; --> :實作管線;
:E; --> :測試和驗證;
:F; --> :結束;
@enduml

這個圖表展示了建立引數化管線工作的流程，從定義工作流程到測試和驗證。每個步驟都很重要，需要仔細完成。

如何使用API Token存取私人GitHub儲存函式庫

在軟體開發中，使用API Token來存取私人GitHub儲存函式庫是一種常見的做法。這種方法可以讓開發人員安全地存取儲存函式庫，而不需要公開敏感的帳戶資訊。

首先，需要在GitLab中建立一個API Access Token。這個Token可以用來存取私人GitLab儲存函式庫。建立Token的步驟如下：

  1. 登入GitLab帳戶
  2. 點選右上角的使用者名稱，然後選擇「設定」
  3. 點選「Access Tokens」
  4. 填寫Token名稱和過期時間
  5. 點選「建立個人存取Token」

得到Token後，可以使用它來存取私人GitLab儲存函式庫。以下是使用API Token存取私人GitLab儲存函式庫的步驟：

  1. 在Jenkins中建立一個新的工作任務
  2. 選擇「GitLab」作為儲存函式庫型別
  3. 填寫儲存函式庫URL和API Token
  4. 點選「儲存」

此外，也可以使用API Token來存取GitHub儲存函式庫。以下是使用API Token存取GitHub儲存函式庫的步驟：

  1. 在Jenkins中建立一個新的工作任務
  2. 選擇「GitHub」作為儲存函式庫型別
  3. 填寫儲存函式庫URL和API Token
  4. 點選「儲存」

Jenkins中使用API Token存取GitLab儲存函式庫

在Jenkins中使用API Token存取GitLab儲存函式庫的步驟如下：

步驟1：設定Maven

  1. 登入Jenkins帳戶
  2. 點選右上角的使用者名稱，然後選擇「設定」
  3. 點選「Maven」
  4. 填寫Maven設定資訊

步驟2：建立一個新的工作任務

  1. 登入Jenkins帳戶
  2. 點選右上角的使用者名稱，然後選擇「工作任務」
  3. 點選「建立一個新的工作任務」
  4. 選擇「Free-Style」作為工作任務型別

步驟3：修改pom.xml檔案

  1. 登入Jenkins帳戶
  2. 點選右上角的使用者名稱，然後選擇「工作任務」
  3. 選擇剛剛建立的工作任務
  4. 點選「修改pom.xml檔案」
  5. 填寫新的版本資訊

步驟4：提交變更並推播到中央GitLab儲存函式庫

  1. 登入Jenkins帳戶
  2. 點選右上角的使用者名稱，然後選擇「工作任務」
  3. 選擇剛剛建立的工作任務
  4. 點選「提交變更並推播到中央GitLab儲存函式庫」
  5. 填寫提交資訊

Pipeline as Code (Jenkinsfile)

Pipeline as Code (Jenkinsfile)是一種用於定義Jenkins工作任務的檔案。它可以用來自動化工作任務的建立和執行。

以下是Jenkinsfile的範例：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'mvn clean package'
            }
        }
        stage('Deploy') {
            steps {
                sh 'mvn deploy'
            }
        }
    }
}

這個Jenkinsfile定義了一個具有兩個階段的工作任務：Build和Deploy。每個階段都有一個步驟，分別是執行Maven的clean package和deploy命令。

Jenkins 分散式建置

Jenkins 分散式建置是一種將建置過程分散到多個節點的技術，藉此提高建置效率和降低建置時間。以下是 Jenkins 分散式建置的相關內容。

Jenkins 分散式架構

Jenkins 分散式架構由一個主節點（Master）和多個從節點（Slave）組成。主節點負責管理和協調從節點的建置過程，而從節點則負責執行實際的建置任務。

連線主節點和從節點的方法

有多種方法可以連線主節點和從節點，包括使用 SSH、TCP/IP 等。以下是使用 SSH 連線主節點和從節點的步驟：

步驟 1：安裝 SSH 建置代理外掛

首先，需要在 Jenkins 主節點上安裝 SSH 建置代理外掛。這個外掛允許 Jenkins 使用 SSH 連線從節點。

步驟 2：安裝 Java 在從節點上

其次，需要在從節點上安裝 Java。因為 Jenkins 建置過程需要 Java 環境。

@startuml
:安裝 SSH 建置代理外掛; --> :安裝 Java 在從節點上;
:B; --> :組態從節點;
:C; --> :啟動從節點;
@enduml

組態從節點

組態從節點需要指定從節點的 IP 地址、埠號和認證資訊等。

// 範例程式碼：組態從節點
import java.util.HashMap;
import java.util.Map;

public class ConfigureSlaveNode {
    public static void main(String[] args) {
        Map<String, String> config = new HashMap<>();
        config.put("ip", "192.168.1.100");
        config.put("port", "22");
        config.put("username", "jenkins");
        config.put("password", "jenkins");
        //...
    }
}

啟動從節點

啟動從節點需要使用 Jenkins 提供的 API 或命令列工具。

// 範例命令：啟動從節點
java -jar jenkins-agent.jar -jnlpUrl https://jenkins-master:8080/computer/slave-node/jenkins-agent.jnlp
圖表翻譯：

上述 Mermaid 圖表展示了 Jenkins 分散式建置的流程，包括安裝 SSH 建置代理外掛、安裝 Java 在從節點上、組態從節點和啟動從節點等步驟。這個圖表可以幫助使用者瞭解 Jenkins 分散式建置的整體流程。

建立SSH公私鑰對

為了安全地連線到從屬機器，首先需要在主機上建立一個SSH公私鑰對。這個過程包括生成公私鑰對、將公鑰複製到從屬機器的authorized_keys檔案中，以及設定私鑰作為認證憑證。

步驟1：生成SSH公私鑰對

使用以下命令生成SSH公私鑰對：

ssh-keygen -t rsa -b 2048

這個命令會生成一對2048位元的RSA公私鑰。

步驟2：將公鑰複製到從屬機器

將生成的公鑰複製到從屬機器的authorized_keys檔案中：

ssh-copy-id user@slave-machine-ip

這個命令會將公鑰複製到從屬機器的authorized_keys檔案中，讓主機可以使用私鑰連線到從屬機器。

步驟3：設定私鑰作為認證憑證

在Jenkins主機上，將私鑰設定為認證憑證：

cat ~/.ssh/id_rsa > /path/to/credentials/private_key

這個命令會將私鑰內容複製到指定的檔案中，作為認證憑證使用。

內容解密：

  • ssh-keygen命令用於生成SSH公私鑰對。
  • -t rsa引數指定使用RSA演算法生成公私鑰對。
  • -b 2048引數指定生成2048位元的公私鑰對。
  • ssh-copy-id命令用於將公鑰複製到從屬機器的authorized_keys檔案中。
  • cat命令用於將私鑰內容複製到指定的檔案中。

步驟4：新增認證項到Jenkins主機

在Jenkins主機上，新增一個新的認證項，包含私鑰：

jenkins-credentials add --username user --password password --private-key /path/to/credentials/private_key

這個命令會新增一個新的認證項到Jenkins主機，包含私鑰作為認證憑證。

圖表翻譯：

@startuml
:生成SSH公私鑰對; --> :將公鑰複製到從屬機器;
:B; --> :設定私鑰作為認證憑證;
:C; --> :新增認證項到Jenkins主機;
@enduml

圖表說明：

  • 生成SSH公私鑰對。
  • 將公鑰複製到從屬機器。
  • 設定私鑰作為認證憑證。
  • 新增認證項到Jenkins主機。

步驟5：啟動新節點

在Jenkins主機上，啟動新節點：

jenkins-node start --name node1

這個命令會啟動名為node1的新節點。

內容解密：

  • jenkins-node命令用於啟動新節點。
  • --name引數指定節點名稱。
  • node1是節點名稱。

步驟6：建立自由式工作

在Jenkins主機上，建立一個新的自由式工作：

jenkins-job create --name myjob

這個命令會建立一個名為myjob的新自由式工作。

圖表翻譯：

@startuml
:啟動新節點; --> :建立自由式工作;
:B; --> :設定工作執行於節點;
@enduml

圖表說明：

  • 啟動新節點。
  • 建立自由式工作。
  • 設定工作執行於節點。

步驟7：設定工作執行於節點

在Jenkins主機上，設定工作執行於節點：

jenkins-job configure --name myjob --node node1

這個命令會設定名為myjob的工作執行於名為node1的節點。

內容解密：

  • jenkins-job命令用於設定工作。
  • --name引數指定工作名稱。
  • --node引數指定節點名稱。
  • node1是節點名稱。

步驟8：執行工作

在Jenkins主機上，執行工作：

jenkins-job run --name myjob

這個命令會執行名為myjob的工作。

圖表翻譯：

@startuml
:設定工作執行於節點; --> :執行工作;
@enduml

圖表說明：

  • 設定工作執行於節點。
  • 執行工作。

透過以上步驟，可以建立一個新的自由式工作，並設定其執行於特定的節點。

整合Jenkins與AWS

在軟體開發的世界中，持續整合和持續佈署（CI/CD）是確保軟體交付速度和品質的關鍵。Jenkins是一種流行的CI/CD工具，而Amazon Web Services（AWS）則提供了一系列的服務來支援應用程式的佈署和管理。在本章中，我們將探討如何整合Jenkins與AWS，以實作自動化的佈署流程。

建立EC2例項

首先，我們需要在AWS上建立一個EC2例項。EC2（Elastic Compute Cloud）是一種虛擬伺服器，可以用來執行各種應用程式。以下是建立EC2例項的步驟：

  1. 註冊AWS: 如果您還沒有AWS帳戶，請先註冊一個。
  2. 登入AWS: 登入您的AWS帳戶。
  3. 建立EC2例項: 進入EC2控制檯，點選「Launch Instance」按鈕，然後選擇您想要的作業系統和例項型別。
  4. 啟動EC2例項: 建立例項後，點選「Start Instance」按鈕啟動它。

組態EC2例項

建立並啟動EC2例項後，我們需要組態它來佈署我們的計算器網頁應用程式。以下是組態步驟：

  1. 安裝IIS Web Server: 登入您的EC2例項，然後安裝IIS Web Server。
  2. 組態IIS Web Server: 組態IIS Web Server來佈署您的計算器網頁應用程式。

使用Jenkins佈署應用程式

現在，我們可以使用Jenkins來自動化佈署流程。以下是步驟：

  1. 安裝Jenkins: 在您的伺服器上安裝Jenkins。
  2. 組態Jenkins: 組態Jenkins來連線您的EC2例項。
  3. 建立Job: 建立一個新的Job來佈署您的計算器網頁應用程式。

內容解密：

在這個過程中，我們使用Jenkins來自動化佈署流程。Jenkins會從原始碼倉函式庫中提取程式碼，然後封裝和佈署到EC2例項上。這樣可以確保每次程式碼變更後，應用程式都會自動重新佈署。

@startuml
:Jenkins; --> [提取程式碼] :提取程式碼;
:B; --> [封裝] :封裝;
:C; --> [佈署] :佈署;
:D; --> [啟動] :啟動;
@enduml

圖表翻譯：

這個Mermaid圖表展示了Jenkins、原始碼倉函式庫、Jar檔、EC2例項和計算器網頁應用程式之間的流程。Jenkins從原始碼倉函式庫中提取程式碼，然後封裝成Jar檔，最後佈署到EC2例項上並啟動計算器網頁應用程式。這個流程可以確保每次程式碼變更後，應用程式都會自動重新佈署。

從技術架構視角來看，將 Selenium Python 自動化專案推播到 GitHub 並整合 Jenkins 與 AWS，展現了現代軟體開發流程自動化和效率提升的趨勢。分析 Jenkins 分散式建置架構、引數化管線工作、API Token 的使用以及與 AWS EC2 的整合，可以發現，這些技術有效地串聯了開發、測試、佈署的各個環節。然而，維護 Jenkins 環境和管理不同平臺的整合也帶來了額外的複雜度，需要團隊具備相應的技能和經驗。潛在的風險包括安全漏洞和系統故障，需要建立完善的監控和應急機制。玄貓認為，儘管存在挑戰，但自動化 CI/CD 流程的優勢顯而易見，對於追求高效能和快速迭代的團隊而言，積極採用這些技術並持續最佳化實務流程將是提升競爭力的關鍵。

玄貓

玄貓

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