用戶API
該模塊是有用的高級功能的集合,這些功能可以自動執行常見任務。 這些函數中的許多函數被設計爲向命令行公開,因此它們具有簡單的字符串參數。
等待所有任務完成:
jenkinsapi.api.block_until_complete(jenkinsurl, jobs, maxwait=12000, interval=30, raise_on_timeout=True, username=None, password=None, ssl_verify=True)
查找所有最新構建的job:
jenkinsapi.api.get_artifacts(jenkinsurl, jobid=None, build_no=None, username=None, password=None, ssl_verify=True)
通過構建號查詢jenkins任務的結果:
jenkinsapi.api.get_build(jenkinsurl, jobname, build_no, username=None, password=None, ssl_verify=True)
從jenkins任務中獲取最新的構建結果:
jenkinsapi.api.get_latest_build(jenkinsurl, jobname, username=None, password=None, ssl_verify=True)
jenkinsapi.api.get_latest_complete_build(jenkinsurl, jobname, username=None, password=None, ssl_verify=True)
jenkinsapi.api.get_latest_test_results(jenkinsurl, jobname, username=None, password=None, ssl_verify=True)
根據提供的URL返回View。 便於嵌套視圖。
jenkinsapi.api.get_nested_view_from_url(url, username=None, password=None, ssl_verify=True)
jenkinsapi.api.get_view_from_url(url, username=None, password=None, ssl_verify=True)
查找任務的最新完成版本並將其保存到目標目錄的便捷方法。 如果不存在則自動創建目錄:
jenkinsapi.api.grab_artifact(jenkinsurl, jobid, artifactid, targetdir, username=None, password=None, strict_validation=False, ssl_verify=True)
安裝構建:
jenkinsapi.api.install_artifacts(artifacts, dirstruct, installdir, basestaticurl, strict_validation=False)
在hudson作業的整個歷史中搜索具有其名稱與提供的正則表達式匹配的任務的構建。 僅返回該任務。
@param jenkinsurl:jenkins服務器的基本URL @param jobid:我們要通過@paramartifact進行搜索的作業的名稱RegExp:一個編譯後的正則表達式對象
(不是re-string)
@param用戶名:Jenkins登錄用戶名,可選@param密碼:Jenkins登錄密碼,可選
jenkinsapi.api.search_artifact_by_regexp(jenkinsurl, jobid, artifactRegExp, username=None, password=None, ssl_verify=True
在jenkin job的整個歷史中搜索構建名稱的列表。 如果same_build爲true,則確保所有工件都來自job的同一內部版本
jenkinsapi.api.search_artifacts(jenkinsurl, jobid, artifact_ids=None, username=None, password=None, ssl_verify=True)