Python操作Jenkins API

浅浅的花香味﹌ 2023-09-28 19:18 19阅读 0赞

### 简介 ###

本次我们将要学习JenkinsAPI接口，我们先用Python-jenkins这个库完成。

仓库Pypi ：https://pypi.org/project/python-jenkins/

在线文档: http://python-jenkins.readthedocs.org/en/latest/

当前环境Python版本 v3.7.0

### 功能 ###

*  Create new jobs 创建新项目
 *  Copy existing jobs 复制已存在的项目
 *  Delete jobs 删除项目
 *  Update jobs 更新项目
 *  Get a job’s build information 获取一个项目的构建信息
 *  Get Jenkins master version information 获取Jenkins master的版本信息
 *  Get Jenkins plugin information 过去jenkins插件信息
 *  Start a build on a job 构建一个项目
 *  Create nodes 创建一个节点
 *  Enable/Disable nodes 启用/禁用节点
 *  Get information on nodes 获取节点信息
 *  Create/delete/reconfig views 创建/删除/更新视图
 *  Put server in shutdown mode (quiet down) 关机
 *  List running builds 列出构建中的项目
 *  Delete builds 删除构建
 *  Wipeout job workspace
 *  Create/delete/update folders 创建/删除/更新文件夹
 *  Set the next build number 设置下次构建ID
 *  Install plugins 安装插件

### 使用思路 ###

例如我要创建一个项目

1.  要先找到创建项目的方法
2.  然后根据API文档查阅如何使用 每个接口的使用方法
3.  打开一个python解释器调试

### 初始化配置 ###

安装python-jenkins

pip install python-jenkins==1.6.0

测试

ZeyangdeMacBook-Pro:~ zeyang$ python3
    Python 3.7.4 (v3.7.4:e09359112e, Jul  8 2019, 14:54:52)
    [Clang 6.0 (clang-600.0.57)] on darwin
    Type "help", "copyright", "credits" or "license" for more information.
    >>> import jenkins
    >>> server = jenkins.Jenkins("http://127.0.0.1:8080",username="admin",password="admin")
    >>> server.get_whoami()
    {'_class': 'hudson.model.User', 'absoluteUrl': 'http://127.0.0.1:8080/user/admin', 'description': '', 'fullName': 'admin', 'id': 'admin', 'property': [{'_class': 'jenkins.security.ApiTokenProperty'}, {'_class': 'jenkins.security.LastGrantedAuthoritiesProperty'}, {'_class': 'hudson.model.MyViewsProperty'}, {'_class': 'hudson.model.PaneStatusProperties'}, {'_class': 'hudson.security.HudsonPrivateSecurityRealm$Details'}, {'_class': 'org.jenkinsci.main.modules.cli.auth.ssh.UserPropertyImpl'}, {'_class': 'jenkins.security.seed.UserSeedProperty'}, {'_class': 'hudson.search.UserSearchProperty', 'insensitiveSearch': True}, {'_class': 'hudson.model.TimeZoneProperty'}]}

查看 所有的方法

>>> dir(server)
    ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_add_missing_builds', '_auth_resolved', '_auths', '_build_url', '_get_encoded_params', '_get_job_folder', '_get_tag_text', '_get_view_jobs', '_maybe_add_auth', '_request', '_response_handler', '_session', '_timeout_warning_issued', 'assert_credential_exists', 'assert_folder', 'assert_job_exists', 'assert_node_exists', 'assert_promotion_exists', 'assert_view_exists', 'auth', 'build_job', 'build_job_url', 'cancel_queue', 'check_jenkinsfile_syntax', 'copy_job', 'create_credential', 'create_folder', 'create_job', 'create_node', 'create_promotion', 'create_view', 'credential_exists', 'crumb', 'debug_job_info', 'delete_build', 'delete_credential', 'delete_job', 'delete_node', 'delete_promotion', 'delete_view', 'disable_job', 'disable_node', 'enable_job', 'enable_node', 'get_all_jobs', 'get_build_console_output', 'get_build_env_vars', 'get_build_info', 'get_build_test_report', 'get_credential_config', 'get_credential_info', 'get_info', 'get_job_config', 'get_job_info', 'get_job_info_regex', 'get_job_name', 'get_jobs', 'get_node_config', 'get_node_info', 'get_nodes', 'get_plugin_info', 'get_plugins', 'get_plugins_info', 'get_promotion_config', 'get_promotion_name', 'get_promotions', 'get_promotions_info', 'get_queue_info', 'get_queue_item', 'get_running_builds', 'get_version', 'get_view_config', 'get_view_name', 'get_views', 'get_whoami', 'install_plugin', 'is_folder', 'jenkins_open', 'jenkins_request', 'job_exists', 'jobs_count', 'list_credentials', 'maybe_add_crumb', 'node_exists', 'promotion_exists', 'quiet_down', 'reconfig_credential', 'reconfig_job', 'reconfig_node', 'reconfig_promotion', 'reconfig_view', 'rename_job', 'run_script', 'server', 'set_next_build_number', 'stop_build', 'timeout', 'upsert_job', 'view_exists', 'wait_for_normal_op', 'wipeout_job_workspace']

**do操作方法**

<table> 
 <thead> 
  <tr> 
   <th>功能</th> 
   <th>python方法</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>项目操作</td> 
   <td>create_job disable_job &nbsp;delete_job copy_job enable_job &nbsp;job_exists &nbsp;jobs_count upsert_job</td> 
  </tr> 
  <tr> 
   <td>构建操作</td> 
   <td>build_job delete_build build_job_url &nbsp;stop_build</td> 
  </tr> 
  <tr> 
   <td>凭据操作</td> 
   <td>create_credential delete_credentialcredential_exists</td> 
  </tr> 
  <tr> 
   <td>视图操作</td> 
   <td>create_view &nbsp;delete_view view_exists</td> 
  </tr> 
  <tr> 
   <td>节点操作</td> 
   <td>create_node disable_node delete_node enable_node node_exists</td> 
  </tr> 
  <tr> 
   <td>晋级操作</td> 
   <td>create_promotion &nbsp;delete_promotion promotion_exists</td> 
  </tr> 
  <tr> 
   <td>取消队列</td> 
   <td>cancel_queue</td> 
  </tr> 
  <tr> 
   <td>检查jenkinsfile语法</td> 
   <td>check_jenkinsfile_syntax</td> 
  </tr> 
  <tr> 
   <td>检查项目信息</td> 
   <td>debug_job_info</td> 
  </tr> 
  <tr> 
   <td>文件夹操作</td> 
   <td>is_folder create_folder</td> 
  </tr> 
  <tr> 
   <td>安装插件</td> 
   <td>install_plugin</td> 
  </tr> 
 </tbody> 
</table>

**get获取方法**

<table> 
 <thead> 
  <tr> 
   <th>功能</th> 
   <th>python方法</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>获取项目信息</td> 
   <td>get_all_jobs get_job_config get_job_info get_job_info_regex get_job_name get_jobs</td> 
  </tr> 
  <tr> 
   <td>获取构建信息</td> 
   <td>get_build_console_output get_build_env_vars get_build_info &nbsp;get_build_test_report</td> 
  </tr> 
  <tr> 
   <td>获取凭据信息</td> 
   <td>get_credential_config &nbsp; get_credential_info list_credentials</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>get_info</td> 
  </tr> 
  <tr> 
   <td>获取节点信息</td> 
   <td>get_node_config get_node_info get_nodes</td> 
  </tr> 
  <tr> 
   <td>获取插件信息</td> 
   <td>get_plugin_info get_plugins get_plugins_info</td> 
  </tr> 
  <tr> 
   <td>获取晋级信息</td> 
   <td>get_promotion_config get_promotion_name get_promotions &nbsp;get_promotions_info</td> 
  </tr> 
  <tr> 
   <td>获取队列信息</td> 
   <td>get_queue_info get_queue_item</td> 
  </tr> 
  <tr> 
   <td>获取运行中构建</td> 
   <td>get_running_builds</td> 
  </tr> 
  <tr> 
   <td>获取版本</td> 
   <td>get_version</td> 
  </tr> 
  <tr> 
   <td>获取视图信息</td> 
   <td>get_view_config &nbsp;get_view_name get_views</td> 
  </tr> 
  <tr> 
   <td>获取当前用户</td> 
   <td>get_whoami</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>jenkins_open</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>jenkins_request</td> 
  </tr> 
 </tbody> 
</table>

**更新操作**

<table> 
 <thead> 
  <tr> 
   <th>功能</th> 
   <th>python方法</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>关机</td> 
   <td>quiet_down</td> 
  </tr> 
  <tr> 
   <td>更新凭据</td> 
   <td>reconfig_credential</td> 
  </tr> 
  <tr> 
   <td>更新项目</td> 
   <td>reconfig_job</td> 
  </tr> 
  <tr> 
   <td>更新节点</td> 
   <td>reconfig_node</td> 
  </tr> 
  <tr> 
   <td>更新晋级</td> 
   <td>reconfig_promotion</td> 
  </tr> 
  <tr> 
   <td>更新视图</td> 
   <td>reconfig_view</td> 
  </tr> 
  <tr> 
   <td>重命名项目</td> 
   <td>rename_job</td> 
  </tr> 
  <tr> 
   <td>运行脚本</td> 
   <td>run_script</td> 
  </tr> 
  <tr> 
   <td>设置下次构建id</td> 
   <td>set_next_build_number</td> 
  </tr> 
 </tbody> 
</table>