跳到主要內容

Jenkins - Get Artifacts with REST API

Problem

為了節省軟體的反安裝、下載與安裝時間，我們有隻script，會去jenkins抓某個固定位置的最新安裝程式並安裝。然而，開發過程會因為新功能或修bug等原因產生branch；原本的腳本並無法根據branch去下載安裝程式，也因此花了些時間去研究並解決這個問題。

How to?

jenkins既然有RestAPI，應該就有辦法讓人可以存取到它專案相關資訊吧? 為了達到我們目的，其中會包含幾個步驟:

  1. 取得專案build列表。
  2. 取得branch吻合的build URL。
  3. 取得此build的artifact列表。
  4. 過濾想要的artifacts。

以專案名稱Example為例，其專案的URL為:

http://tonylin.idv/job/Example

取得專案build列表

首先可以透過此URL去搜尋所有build資訊:

http://tonylin.idv/job/Example/api/json?tree=builds[*]

以一個build的結果如下:

{
  "builds": [
  {
  "actions": [
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {}
  ],
  "artifacts": [
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {}
  ],
  "building": false,
  "description": "origin/integration_testing",
  "displayName": "#6611",
  "duration": 375922,
  "estimatedDuration": 366451,
  "executor": null,
  "fullDisplayName": "Example #6611",
  "id": "6611",
  "keepLog": true,
  "number": 6611,
  "queueId": 335,
  "result": "SUCCESS",
  "timestamp": 1481712191068,
  "url": "http://tonylin.idv/job/Example/6611/",
  "builtOn": "",
  "changeSet": {},
  "culprits": [
  {},
  {},
  {},
  {},
  {},
  {}
  ],
  "fingerprint": []
  }
]
}

取得branch吻合的build URL

由於前一個URL使用[*]是列出所有項目，但其實我們只需要知道branch、build結果、build URL與build number，可以透過以下URL去做query:

http://tonylin.idv/job/Example/api/json?tree=builds[description,result,displayName,url]

三個build的輸出結果如下，從結果內容不難得知個別資訊意義，需注意的是master的description會是null或master(我們使用dscription當branch名稱):

{
  "builds": [
  {
  "description": "origin/integration_testing",
  "displayName": "#6611",
  "result": "SUCCESS",
  "url": "http://tonylin.idv/job/Example/6611/"
  },
  {
  "description": "origin/fix_memory_leak",
  "displayName": "#6610",
  "result": "SUCCESS",
  "url": "http://tonylin.idv/job/Example/6610/"
  },
  {
  "description": null,
  "displayName": "#6583",
  "result": "SUCCESS",
  "url": "http://tonylin.idv/job/Example/6583/"
  }
]
}

取得此build的artifact列表

從前一次query結果，以origin/integration_testing為例，我們需要的build URL為:

http://tonylin.idv/job/Example/6611/

接著我們可以透過以下URL去query artifacts，我需要的是檔案名稱與檔案下載路徑:

http://tonylin.idv/job/Example/6611/api/json?tree=artifacts[fileName,relativePath]

可以看到結果如下:

{
  "artifacts": [
  {
  "fileName": "user_guide.pdf",
  "relativePath": "dist/user_guide.pdf"
  },
  {
  "fileName": "Example_1.0_build6611_linux_x64.bin",
  "relativePath": "dist/Example_1.0_build6611_linux_x64.bin"
  },
  {
  "fileName": "Example_1.0_build6611_windows_x64.exe",
  "relativePath": "dist/Example_1.0_build6611_windows_x64.exe"
  }
  ]
}

接著只要根據你需要的檔案名稱做過濾後，將relativePath串到build URL就可以拿到你想要的東西了。

Sample code

針對以上過程，我用python寫了一隻範例程式給大家參考:

import requests
import json
import platform
 
 
def find_latest_build(base_url, project_name, branch=None):
    query_url = base_url + project_name + "/api/json?tree=builds[description,result,displayName,url]"
    response = requests.get(query_url)
    if response.status_code != 200:
        raise RuntimeError("request failed, status code=%d" % response.status_code)
 
    json_object = json.loads(response.content)
    found_build = None
    for build in json_object["builds"]:
        if not branch and build["description"] == "master":
            return build
        elif build["description"] == branch:
            return build
    return None
 
 
def find_installer(build_url, file_prefix):
    is_windows = platform.system() == "Windows"
    ext = ".exe" if is_windows else ".bin"
    query_url = build_url + "api/json?tree=artifacts[fileName,relativePath]"
 
    response = requests.get(query_url)
    if response.status_code != 200:
        raise RuntimeError("request failed, status code=%d" % response.status_code)
 
    json_object = json.loads(response.content)
    for artifact in json_object["artifacts"]:
        file_name = artifact["fileName"]
        if file_name.startswith(file_prefix) and file_name.endswith(ext):
            relative_path = artifact["relativePath"]
            return build_url + "artifact/" + relative_path
    return None

簡單的測試案例:

from unittest import TestCase
from jenkins.utils import find_latest_build
from jenkins.utils import find_installer
 
 
class TestJenkinsUtils(TestCase):
    base_url = "http://tonylin.idv/job/"
    project = "Example"
    installer_prefix = "Example"
 
    def test_find_latest_master_build(self):
        latest_build = find_latest_build(TestJenkinsUtils.base_url, TestJenkinsUtils.project)
        self.assertTrue(latest_build["url"].startswith(TestJenkinsUtils.base_url))
        self.assertIsNone(latest_build["description"])
        self.assertIsNotNone(latest_build["displayName"])
        self.assertEqual("SUCCESS", latest_build["result"])
 
    def test_find_latest_branch_build(self):
        branch_name = "origin/integration_testing"
 
        latest_build = find_latest_build(TestJenkinsUtils.base_url, TestJenkinsUtils.project, branch_name)
        self.assertTrue(latest_build["url"].startswith(TestJenkinsUtils.base_url))
        self.assertEqual(branch_name, latest_build["description"])
        self.assertIsNotNone(latest_build["displayName"])
        self.assertEqual("SUCCESS", latest_build["result"])
 
    def test_find_none_build(self):
        branch_name = "origin/none"
 
        latest_build = find_latest_build(TestJenkinsUtils.base_url, TestJenkinsUtils.project, branch_name)
        self.assertIsNone(latest_build)
 
    def test_find_build_with_invalid_url(self):
        branch_name = "origin/none"
        try:
            latest_build = find_latest_build(TestJenkinsUtils.base_url, "InvalidProject", branch_name)
        except RuntimeError as e:
            self.assertEqual("request failed, status code=404", e.message)
 
    def test_find_installer(self):
        latest_build = find_latest_build(TestJenkinsUtils.base_url, TestJenkinsUtils.project)
        installer_url = find_installer(latest_build["url"], TestJenkinsUtils.installer_prefix)
        self.assertTrue(installer_url.startswith(TestJenkinsUtils.base_url) and installer_url.__contains__(TestJenkinsUtils.installer_prefix))

友藏內心獨白: 純粹是為了練python而做的。

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後，安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數，以前試驗過是可以安裝完成的。因此在發生這個問題後，我檢查了它的debug console: 從console得知，eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認，有問題的是有接網路線的網卡，且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制，因此發現在Anaconda的說明文件中( link )，有提到dhcptimeout這個boot參數。看了一些人的使用範例，應該是可以直接串在isolinux.cfg中，如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串，問問Google大師，想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ，關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中；在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知，它讀取的檔案是answer file而不是boot command line。因此我接下來的測試，就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...
張貼留言
閱讀完整內容

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol，我對它的認識也是從工作接觸開始。雖說是管理網路設備，但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式，當然所有的操作也都可以透過SNMP來完成，不過可能會很痛苦。前陣子遇到一個學弟，它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中，不是要告訴你SNMP是什麼，會看這篇文章的大哥們，應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid，有MIB可以幫助你去了解它所提供的資訊是什麼，且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作，也讓我順便了解一下它的語法，接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB，我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具，唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝，如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令，就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...
張貼留言
閱讀完整內容