python-jenkins API方法介绍

信息获取

• 获取job的信息字典
  get_job_info(name, depth=0, fetch_all_builds=False)
  参数:

  • name - 项目名称
  • depth - JSON的深度
  • fetch_all_builds - true:返回所有的构建，否则只返回最近100个

  返回:

  • 字典

• 正则匹配项目信息
  get_job_info_regex(pattern, depth=0, folder_depth=0)

• 返回项目的名称
  get_job_name(name)

• 以可读的模式打印项目信息
  debug_job_info

• 从requests.Request返回HTTP响应的body
  jenkins_open(req, add_crumb=True, resolve_auth=True)

• 打开对Jenkins服务器的HTTP请求的实用程序
  jenkins_request(req, add_crumb=True, resolve_auth=True)

• 获取队列中的任务
  get_queue_item(number, depth=0)

• 获取构建信息字典
  get_build_info(name, number, depth=0)

• 获取构建的环境变量
  get_build_env_vars(name, number, depth=0)

• 获取测试结果报告
  get_build_test_report(name, number, depth=0)

• 获取队列信息
  get_queue_info()

• 取消一个队列构建
  cancel_queue(id)

• 获取项目及视图信息
  get_info(item='', query=None)

• 获取用户信息
  get_whoami(depth=0)

• 获取版本信息
  get_version()

• 获取所有已安装插件信息
  get_plugins_info(depth=2)

• 获取指定已安装插件信息
  get_plugin_info(name, depth=2)

• 获取插件详细信息
  get_plugins(depth=2)

• 获取项目列表
  get_jobs(folder_depth=0, view_name=None)

• 获取所有项目的列表
  get_all_jobs(folder_depth=None)

项目操作

• 复制项目
  copy_job(from_name, to_name)
• 修改项目名称
  rename_job(from_name, to_name)
• 删除项目
  delete_job(name)
• 使项目可用
  enable_job(name)
• 禁用项目
  disable_job(name)
• 设置下一次的构建号
  set_next_build_number(name, number)
• 检查项目是否存在
  job_exists(name)
• 项目数统计
  jobs_count()
• 断言项目存在
  assert_job_exists(name, exception_message='job[%s] does not exist')
• 创建项目
  create_job(name, config_xml)
• 获取项目配置
  get_job_config(name)
• 重配置项目
  reconfig_job(name, config_xml)
• 获取构建项的URL
  build_job_url(name, parameters=None, token=None)
• 构建项目
  build_job(name, parameters=None, token=None)
• 运行脚本
  run_script(script, node=None)
• 安装插件
  install_plugin(name, include_dependencies=True)
• 停止构建
  stop_build(name, number)
• 删除构建
  delete_build(name, number)
• 清空指定项目的工作空间
  wipeout_job_workspace(name)
• 获取正在运行的构建
  get_running_builds()

节点相关

---

• 获取所有子节点服务器简要信息
  get_nodes(depth=0)
• 获取节点详细信息
  get_node_info(name, depth=0)
• 判断节点存在
  node_exists(name)
• 断言节点存在
  assert_node_exists(name, exception_message='node[%s] does not exist')
• 删除节点
  delete_node(name)
• 使节点不可用
  disable_node(name, msg='')
• 使节点可用
  enable_node(name)
• 创建节点
  create_node(name, numExecutors=2, nodeDescription=None, remoteFS='/var/lib/jenkins', labels=None, exclusive=False, launcher='hudson.slaves.CommandLauncher', launcher_params={})
• 获取节点配置
  get_node_config(name)
• 重新配置节点
  reconfig_node(name, config_xml)
• 获取构建命令行输出
  get_build_console_output(name, number)

视图相关

---

• 获取视图名称
  get_view_name(name)
• 断言视图存在
  assert_view_exists(name, exception_message='view[%s] does not exist')
• 判断视图存在
  view_exists(name)
• 获取视图简要信息
  get_views()
• 删除视图
  delete_view(name)
• 创建视图
  create_view(name, config_xml)
• 重新配置视图
  reconfig_view(name, config_xml)
• 获取视图配置
  get_view_config(name)

系统操作

• 关闭服务
  quiet_down()
• 等待服务准备好
  wait_for_normal_op(timeout)