登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 安全 ›Python 实现Metersphere平台API调用

Python 实现Metersphere平台API调用

厥轧匠 2025-5-31 23:53:56
实践环境

Python 3.9.13
安装依赖包
  1. pip install pycryptodome
  2. pip install requests
复制代码
Metersphere v2.0.12
代码实现
  1. # -*- coding:utf-8 -*-
  4. import base64
  5. import os
  6. import time
  7. import uuid
  8. import json
  9. import requests
  11. from Crypto.Cipher import AES
  12. from Crypto.Util.Padding import pad
  14. # Metersphere平台-个人信息-API Keys-Access Key
  15. METER_SPHERE_ACCESS_KEY = os.environ.get('METER_SPHERE_ACCESS_KEY', 'vTiFyYFTfVAZfbRc')
  16. # Metersphere平台-个人信息-API Keys-Secret Key
  17. METER_SPHERE_SECRET_KEY = os.environ.get('METER_SPHERE_SECRET_KEY', 'N4iKP6cqT8zJLfcx')
  18. METER_SPHERE_HOST = os.environ.get('METER_SPHERE_HOST', '192.168.88.135')
  19. METER_SPHERE_PORT = os.environ.get('METER_SPHERE_PORT', '8081')
  20. METER_SPHERE_PROTOCOL = os.environ.get('METER_SPHERE_PROTOCOL', 'http')
  23. class MeterSphereCli(object):
  24.     def __init__(self):
  25.         
  26.         self.session = requests.session()
  27.         self.set_headers(METER_SPHERE_ACCESS_KEY, METER_SPHERE_SECRET_KEY)
  28.         self.host = METER_SPHERE_HOST
  29.         self.port = METER_SPHERE_PORT
  30.         self.protocol = METER_SPHERE_PROTOCOL
  31.    
  32.     def aes_encrypt(self, text, secret_key, iv: bytes = None):
  33.         cipher = AES.new(secret_key.encode('utf-8'), AES.MODE_CBC, iv.encode('utf-8'))
  34.         encrypted = cipher.encrypt(pad(text.encode('utf-8'), AES.block_size))
  35.         
  36.         # 通过aes加密后，再base64加密
  37.         b_encrypted = base64.b64encode(encrypted)
  38.         return b_encrypted
  39.    
  40.    
  41.     def set_headers(self, access_key, secret_key):
  42.         time_stamp = int(round(time.time() * 1000))
  43.         combox_key = access_key + '|' + str(uuid.uuid4()) + '|' + str(time_stamp)
  44.         signature = self.aes_encrypt(combox_key, secret_key, access_key)
  45.         header = {'Content-Type': 'application/json', 'ACCEPT': 'application/json', 'accessKey': access_key,
  46.                   'signature': signature.decode('UTF-8')}
  47.         self.session.headers.update(header)
  48.         
  49.     def get_workspaces(self, search_keyword=None, return_when_keyword_matched=True):
  50.         '''获取用户工作空间列表
  51.         @:param search_keyword 搜索关键词，仅支持 名称搜索
  52.         '''
  53.         
  54.         result = []
  55.         
  56.         url = f'{self.protocol}://{self.host}:{self.port}/track/workspace/list/userworkspace'
  57.         res = self.session.get(url)
  58.         if res.status_code != 200:
  59.             print'获取用户工作空间列表出错, 服务器返回：%s' % res.text)
  60.             return result
  61.         
  62.         res = res.json()
  63.         if res.get('success') != True:
  64.             print'获取用户工作空间列表出错, 服务器返回：%s' % res.text)
  65.             return result
  66.         
  67.         if search_keyword:
  68.             for item in res.get('data', []):
  69.                 workspace_id = item.get('id')
  70.                 name = item.get('name')
  71.                 if search_keyword in name:
  72.                     result.append({'id': workspace_id, 'name': name})
  73.                     if return_when_keyword_matched:
  74.                         return result
  75.         else:
  76.             for item in res.get('data', []):
  77.                 workspace_id = item.get('id')
  78.                 name = item.get('name')
  79.                 result.append({'id': workspace_id, 'name': name})
  80.         return result
  81.    
  82.     def get_workspace_projects(self, workspace_id, search_keyword=None, return_when_keyword_matched=True):
  83.         '''获取工作空间关联的项目
  84.         @:param search_keyword 搜索关键词，仅支持 名称搜索
  85.         '''
  86.         
  87.         result = []
  88.         
  89.         url = f'{self.protocol}://{self.host}:{self.port}/track/project/list/related'
  90.         req_body = {'workspaceId': workspace_id}
  91.         res = self.session.post(url, json=req_body)
  92.         if res.status_code != 200:
  93.             print'获取工作空间关联的项目列表出错, 服务器返回：%s' % res.text)
  94.             return result
  95.         
  96.         res = res.json()
  97.         if res.get('success') != True:
  98.             print'获取工作空间关联的项目列表出错, 服务器返回：%s' % res.text)
  99.             return result
  100.         
  101.         if search_keyword:
  102.             for item in res.get('data', []):
  103.                 project_id = item.get('id')
  104.                 name = item.get('name')
  105.                 if search_keyword in name:
  106.                     result.append({'id': project_id, 'name': name})
  107.                     if return_when_keyword_matched:
  108.                         return result
  109.         else:
  110.             for item in res.get('data', []):
  111.                 project_id = item.get('id')
  112.                 name = item.get('name')
  113.                 result.append({'id': project_id, 'name': name})
  114.         return result
  115.    
  116.    
  117.     def get_project_envs(self, project_id, search_keyword=None, return_when_keyword_matched=True):
  118.         '''获取项目环境列表
  119.         @:param search_keyword 支持环境名称、主机+端口 模糊搜索
  120.         '''
  121.         
  122.         result = []
  123.         
  124.         url = f'{self.protocol}://{self.host}:{self.port}/track/environment/list/{project_id}'
  125.         res = self.session.get(url)
  126.         if res.status_code != 200:
  127.             print'获取项目环境列表出错, 服务器返回：%s' % res.text)
  128.             return result
  129.         
  130.         res = res.json()
  131.         if res.get('success') != True:
  132.             print'获取项目环境列表出错, 服务器返回：%s' % res.text)
  133.             return result
  134.         
  135.         if search_keyword:
  136.             for item in res.get('data', []):
  137.                 env_id = item.get('id')
  138.                 name = item.get('name')
  139.                 env_config = item.get('config').strip()
  140.                 if env_config:
  141.                     env_config = json.loads(env_config)
  142.                     http_config = env_config.get('httpConfig', {})
  143.                     condition = http_config.get('conditions', [{}])[0]
  144.                     protocol = condition.get('protocol')
  145.                     socket = condition.get('socket')
  146.                     if search_keyword in name or search_keyword in socket:
  147.                         result.append({'id': env_id, 'name': name, 'protocol': protocol, 'host_port': socket})
  148.                         if return_when_keyword_matched:
  149.                             return result
  150.         else:
  151.             for item in res.get('data', []):
  152.                 env_id = item.get('id')
  153.                 name = item.get('name')
  154.                 env_config = item.get('config').strip()
  155.                 if env_config:
  156.                     env_config = json.loads(env_config)
  157.                     http_config = env_config.get('httpConfig', {})
  158.                     condition = http_config.get('conditions', [{}])[0]
  159.                     protocol = condition.get('protocol')
  160.                     socket = condition.get('socket')
  161.                     result.append({'id': env_id, 'name': name, 'protocol': protocol, 'host_port': socket})
  162.         return result
  163.    
  164.     def get_project_testplans(self, project_id, page_no=1, page_size=10, search_conditions={}):
  165.         '''获取项目计划列表
  166.         @param page: search_conditions {'name': {'value': 'test_plan_name' , 'operator': 'like'}}
  167.         '''
  168.         
  169.         result = []
  170.         url = f'{self.protocol}://{self.host}:{self.port}/track/test/plan/list/{page_no}/{page_size}'
  171.         combine = {}
  172.         if 'name' in search_conditions:
  173.             search_condition = search_conditions.get('name')
  174.             combine['name'] = {
  175.                 "operator": search_condition.get('operator'),
  176.                 "value": search_condition.get('value')
  177.             }
  178.         
  179.         req_body = {
  180.             "components": [{
  181.                 "key": "name",
  182.                 "name": "MsTableSearchInput",
  183.                 "label": "commons.name",
  184.                 "operator": {
  185.                     "value": "like",
  186.                     "options": [{
  187.                         "label": "commons.adv_search.operators.like",
  188.                         "value": "like"
  189.                     }, {
  190.                         "label": "commons.adv_search.operators.not_like",
  191.                         "value": "not like"
  192.                     }]
  193.                 }
  194.             }, {
  195.                 "key": "updateTime",
  196.                 "name": "MsTableSearchDateTimePicker",
  197.                 "label": "commons.update_time",
  198.                 "operator": {
  199.                     "options": [{
  200.                         "label": "commons.adv_search.operators.between",
  201.                         "value": "between"
  202.                     }, {
  203.                         "label": "commons.adv_search.operators.gt",
  204.                         "value": "gt"
  205.                     }, {
  206.                         "label": "commons.adv_search.operators.lt",
  207.                         "value": "lt"
  208.                     }]
  209.                 }
  210.             }, {
  211.                 "key": "createTime",
  212.                 "name": "MsTableSearchDateTimePicker",
  213.                 "label": "commons.create_time",
  214.                 "operator": {
  215.                     "options": [{
  216.                         "label": "commons.adv_search.operators.between",
  217.                         "value": "between"
  218.                     }, {
  219.                         "label": "commons.adv_search.operators.gt",
  220.                         "value": "gt"
  221.                     }, {
  222.                         "label": "commons.adv_search.operators.lt",
  223.                         "value": "lt"
  224.                     }]
  225.                 }
  226.             }, {
  227.                 "key": "moduleIds",
  228.                 "name": "MsTableSearchNodeTree",
  229.                 "label": "test_track.case.module",
  230.                 "operator": {
  231.                     "value": "in",
  232.                     "options": [{
  233.                         "label": "commons.adv_search.operators.in",
  234.                         "value": "in"
  235.                     }, {
  236.                         "label": "commons.adv_search.operators.not_in",
  237.                         "value": "not in"
  238.                     }]
  239.                 },
  240.                 "options": {
  241.                     "url": "/plan/node/list",
  242.                     "type": "POST",
  243.                     "params": {}
  244.                 }
  245.             }, {
  246.                 "key": "principal",
  247.                 "name": "MsTableSearchSelect",
  248.                 "label": "test_track.plan.plan_principal",
  249.                 "operator": {
  250.                     "options": [{
  251.                         "label": "commons.adv_search.operators.in",
  252.                         "value": "in"
  253.                     }, {
  254.                         "label": "commons.adv_search.operators.not_in",
  255.                         "value": "not in"
  256.                     }, {
  257.                         "label": "commons.adv_search.operators.current_user",
  258.                         "value": "current user"
  259.                     }]
  260.                 },
  261.                 "options": {
  262.                     "url": "/user/project/member/list",
  263.                     "labelKey": "name",
  264.                     "valueKey": "id"
  265.                 },
  266.                 "props": {
  267.                     "multiple": True
  268.                 }
  269.             }, {
  270.                 "key": "status",
  271.                 "name": "MsTableSearchSelect",
  272.                 "label": "test_track.plan.plan_status",
  273.                 "operator": {
  274.                     "options": [{
  275.                         "label": "commons.adv_search.operators.in",
  276.                         "value": "in"
  277.                     }, {
  278.                         "label": "commons.adv_search.operators.not_in",
  279.                         "value": "not in"
  280.                     }]
  281.                 },
  282.                 "options": [{
  283.                     "label": "test_track.plan.plan_status_prepare",
  284.                     "value": "Prepare"
  285.                 }, {
  286.                     "label": "test_track.plan.plan_status_running",
  287.                     "value": "Underway"
  288.                 }, {
  289.                     "label": "test_track.plan.plan_status_completed",
  290.                     "value": "Completed"
  291.                 }, {
  292.                     "label": "test_track.plan.plan_status_finished",
  293.                     "value": "Finished"
  294.                 }, {
  295.                     "label": "test_track.plan.plan_status_archived",
  296.                     "value": "Archived"
  297.                 }],
  298.                 "props": {
  299.                     "multiple": True
  300.                 }
  301.             }, {
  302.                 "key": "stage",
  303.                 "name": "MsTableSearchSelect",
  304.                 "label": "test_track.plan.plan_stage",
  305.                 "operator": {
  306.                     "options": [{
  307.                         "label": "commons.adv_search.operators.in",
  308.                         "value": "in"
  309.                     }, {
  310.                         "label": "commons.adv_search.operators.not_in",
  311.                         "value": "not in"
  312.                     }]
  313.                 },
  314.                 "options": [{
  315.                     "text": "冒烟测试",
  316.                     "value": "smoke",
  317.                     "system": True
  318.                 }, {
  319.                     "text": "系统测试",
  320.                     "value": "system",
  321.                     "system": True
  322.                 }, {
  323.                     "text": "回归测试",
  324.                     "value": "regression",
  325.                     "system": True
  326.                 }],
  327.                 "props": {
  328.                     "multiple": True
  329.                 }
  330.             }, {
  331.                 "key": "tags",
  332.                 "name": "MsTableSearchInput",
  333.                 "label": "commons.tag",
  334.                 "operator": {
  335.                     "value": "like",
  336.                     "options": [{
  337.                         "label": "commons.adv_search.operators.like",
  338.                         "value": "like"
  339.                     }, {
  340.                         "label": "commons.adv_search.operators.not_like",
  341.                         "value": "not like"
  342.                     }]
  343.                 }
  344.             }, {
  345.                 "key": "followPeople",
  346.                 "name": "MsTableSearchSelect",
  347.                 "label": "commons.follow_people",
  348.                 "operator": {
  349.                     "options": [{
  350.                         "label": "commons.adv_search.operators.in",
  351.                         "value": "in"
  352.                     }, {
  353.                         "label": "commons.adv_search.operators.current_user",
  354.                         "value": "current user"
  355.                     }]
  356.                 },
  357.                 "options": {
  358.                     "url": "/user/ws/current/member/list",
  359.                     "labelKey": "name",
  360.                     "valueKey": "id"
  361.                 },
  362.                 "props": {
  363.                     "multiple": True
  364.                 }
  365.             }, {
  366.                 "key": "actualStartTime",
  367.                 "name": "MsTableSearchDateTimePicker",
  368.                 "label": "test_track.plan.actual_start_time",
  369.                 "operator": {
  370.                     "options": [{
  371.                         "label": "commons.adv_search.operators.between",
  372.                         "value": "between"
  373.                     }, {
  374.                         "label": "commons.adv_search.operators.gt",
  375.                         "value": "gt"
  376.                     }, {
  377.                         "label": "commons.adv_search.operators.ge",
  378.                         "value": "ge"
  379.                     }, {
  380.                         "label": "commons.adv_search.operators.lt",
  381.                         "value": "lt"
  382.                     }, {
  383.                         "label": "commons.adv_search.operators.le",
  384.                         "value": "le"
  385.                     }]
  386.                 }
  387.             }, {
  388.                 "key": "actualEndTime",
  389.                 "name": "MsTableSearchDateTimePicker",
  390.                 "label": "test_track.plan.actual_end_time",
  391.                 "operator": {
  392.                     "options": [{
  393.                         "label": "commons.adv_search.operators.between",
  394.                         "value": "between"
  395.                     }, {
  396.                         "label": "commons.adv_search.operators.gt",
  397.                         "value": "gt"
  398.                     }, {
  399.                         "label": "commons.adv_search.operators.ge",
  400.                         "value": "ge"
  401.                     }, {
  402.                         "label": "commons.adv_search.operators.lt",
  403.                         "value": "lt"
  404.                     }, {
  405.                         "label": "commons.adv_search.operators.le",
  406.                         "value": "le"
  407.                     }]
  408.                 }
  409.             }, {
  410.                 "key": "planStartTime",
  411.                 "name": "MsTableSearchDateTimePicker",
  412.                 "label": "test_track.plan.planned_start_time",
  413.                 "operator": {
  414.                     "options": [{
  415.                         "label": "commons.adv_search.operators.between",
  416.                         "value": "between"
  417.                     }, {
  418.                         "label": "commons.adv_search.operators.gt",
  419.                         "value": "gt"
  420.                     }, {
  421.                         "label": "commons.adv_search.operators.ge",
  422.                         "value": "ge"
  423.                     }, {
  424.                         "label": "commons.adv_search.operators.lt",
  425.                         "value": "lt"
  426.                     }, {
  427.                         "label": "commons.adv_search.operators.le",
  428.                         "value": "le"
  429.                     }]
  430.                 }
  431.             }, {
  432.                 "key": "planEndTime",
  433.                 "name": "MsTableSearchDateTimePicker",
  434.                 "label": "test_track.plan.planned_end_time",
  435.                 "operator": {
  436.                     "options": [{
  437.                         "label": "commons.adv_search.operators.between",
  438.                         "value": "between"
  439.                     }, {
  440.                         "label": "commons.adv_search.operators.gt",
  441.                         "value": "gt"
  442.                     }, {
  443.                         "label": "commons.adv_search.operators.ge",
  444.                         "value": "ge"
  445.                     }, {
  446.                         "label": "commons.adv_search.operators.lt",
  447.                         "value": "lt"
  448.                     }, {
  449.                         "label": "commons.adv_search.operators.le",
  450.                         "value": "le"
  451.                     }]
  452.                 }
  453.             }],
  454.             "orders": [],
  455.             "nodeIds": [],
  456.             "projectId": project_id,
  457.             "selectAll": False,
  458.             "unSelectIds": [],
  459.             "combine": combine
  460.         }
  461.         res = self.session.post(url, json=req_body)
  462.         if res.status_code != 200:
  463.             print'获取项目计划列表出错, 服务器返回：%s' % res.text)
  464.             return result
  465.         
  466.         res = res.json()
  467.         if res.get('success') != True:
  468.             print'获取项目计划列表出错, 服务器返回：%s' % res.text)
  469.             return result
  470.         
  471.         data = res.get('data', {})
  472.         item_count = data.get('itemCount', 0)
  473.         
  474.         while item_count > 0:
  475.             for test_plan in data.get('listObject', []):
  476.                 id = test_plan.get('id')
  477.                 name = test_plan.get('name')
  478.                 project_id = test_plan.get('projectId')
  479.                 result.append({'id':id, 'name': name, 'project_id': project_id})
  480.             
  481.             item_count -= page_size
  482.             if item_count > 0:
  483.                 page_no += 1
  484.                 url = f'{self.protocol}://{self.host}:{self.port}/track/test/plan/list/{page_no}/{page_size}'
  485.                
  486.                 res = self.session.post(url, json=req_body)
  487.                 if res.status_code != 200:
  488.                     print'获取项目计划列表出错, 服务器返回：%s' % res.text)
  489.                     return result
  490.                
  491.                 res = res.json()
  492.                 if res.get('success') != True:
  493.                     print'获取项目计划列表出错, 服务器返回：%s' % res.text)
  494.                     return result
  495.                 data = res.get('data', {})
  496.         return result
  497.    
  498.     def get_resource_pool(self, search_keyword=None, return_when_keyword_matched=True):
  499.         ''' 获取运行资源池
  500.         @:param search_keyword 搜索关键词,支持名称模糊搜索
  501.         '''
  502.         
  503.         result = []
  504.         
  505.         url = f'{self.protocol}://{self.host}:{self.port}/track/testresourcepool/list/quota/valid'
  506.         res = self.session.get(url)
  507.         if res.status_code != 200:
  508.             print'获取资源池失败，服务器返回：%s' % res.text)
  509.             return result
  510.         
  511.         res = res.json()
  512.         if res.get('success') != True:
  513.             print'获取资源池失败，服务器返回：%s' % res.text)
  514.             return result
  515.         
  516.         if search_keyword:
  517.             for item in res.get('data'):
  518.                 pool_id = item.get('id')
  519.                 name = item.get('name')
  520.                 if search_keyword in name :
  521.                     result.append({'id': pool_id, 'name': name})
  522.                     if return_when_keyword_matched:
  523.                         return result
  524.         else:
  525.             for item in res.get('data'):
  526.                 pool_id = item.get('id')
  527.                 name = item.get('name')
  528.                 result.append({'id':pool_id, 'name':name})
  529.         return result
  530.         
  531.         
  532.     def call_testplan(self, resource_pool_id, poject_id, test_plan_id, env_id):
  533.         ''' 运行测试计划 '''
  534.         
  535.         result = {}
  536.         
  537.         url = f'{self.protocol}://{self.host}:{self.port}/track/test/plan/run'
  538.         req_body = {
  539.             "mode": "serial",
  540.             "reportType": "iddReport",
  541.             "onSampleError": False,
  542.             "runWithinResourcePool": False,
  543.             "resourcePoolId": resource_pool_id,
  544.             "envMap": {
  545.                 poject_id: env_id
  546.             },
  547.             "testPlanId": test_plan_id,
  548.             "projectId": poject_id,
  549.             "userId": "admin",
  550.             "triggerMode": "MANUAL",
  551.             "environmentType": "JSON",
  552.             "environmentGroupId": "",
  553.             "testPlanDefaultEnvMap": {
  554.             },
  555.             "requestOriginator": "TEST_PLAN",
  556.             "retryEnable": False,
  557.             "retryNum": 1,
  558.             "browser": "CHROME",
  559.             "headlessEnabled": False,
  560.             "executionWay": "RUN"
  561.         }
  562.         
  563.         res = self.session.post(url, json=req_body)
  564.         if res.status_code != 200:
  565.             print'执行测试计划失败，服务器返回：%s' % res.text)
  566.             return result
  567.         
  568.         res = res.json()
  569.         if res.get('success') != True:
  570.             print'执行测试计划失败，服务器返回：%s' % res.text)
  571.             return result
  573.         result = {'report_id': res.get('data')}
  574.         return result
  577. ms_cli = MeterSphereCli()
  579. if __name__ == '__main__':
  580.     testplan_id = None
  581.     project_id = None
  582.     project_env_id = None
  583.     res_pool_id = None
  584.     #
  585.     res = ms_cli.get_workspaces('默认工作空间')
  586.     if res:
  587.         workspace_id = res[0].get('id')
  588.         projects = ms_cli.get_workspace_projects(workspace_id, search_keyword='默认项目')
  590.         if projects:
  591.             project = projects[0]
  592.             project_id = project.get('id')
  593.             testplans = ms_cli.get_project_testplans(project_id, 1, page_size=10, search_conditions={'name': {'value': '全局前置准备', 'operator':'like'}})
  594.             if testplans:
  595.                 testplan = testplans[0]
  596.                 testplan_id = testplan.get('id')
  597.     #
  598.     if project_id:
  599.         project_envs = ms_cli.get_project_envs(project_id, '测试环境')
  601.         if project_envs:
  602.             project_env = project_envs[0]
  603.             project_env_id = project_env.get('id')
  605.     pools = ms_cli.get_resource_pool('LOCAL')
  606.     if pools:
  607.         pool = pools[0]
  608.         res_pool_id = pool.get('id')
  610.     if res_pool_id and project_id and testplan_id and project_env_id:
  611.         res = ms_cli.call_testplan(res_pool_id, project_id, testplan_id, project_env_id)
复制代码
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
厥轧匠
2025-5-31 23:53:56

0

粉丝关注

14

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫