Added files

Mamitsubute · Mamitsubute · commit 26da18522ce8 · 2024-04-16T15:43:22.000+09:00
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/.DS_Store b/.github/.DS_Store
diff --git a/.github/workflows/magicpod_test.yml b/.github/workflows/magicpod_test.yml
@@ -0,0 +1,36 @@
+on: [push]
+jobs:
+  magic_pod_job:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+      - name: Prepare testplan
+        env:
+          TESTRAIL_URL: <YOUR URL>
+          TESTRAIL_USER: <YOUR USER ACCOUNT>
+          TESTRAIL_PASSWORD: ${{ secrets.TESTRAIL_PASSWORD }}
+        run: python testrail_prepare.py
+      - name: Install magicpod-api-client
+        env:
+          MAGICPOD_API_TOKEN: ${{ secrets.MAGICPOD_API_TOKEN }}
+        run: bash download_magicpod_api_client.sh
+      - name: Run MagicPod
+        env:
+          MAGICPOD_API_TOKEN: ${{ secrets.MAGICPOD_API_TOKEN }}
+          MAGICPOD_ORGANIZATION_NAME: <YOUR ORGANIZATION_NAME>
+          MAGICPOD_PROJECT_NAME: <YOUR PROJECT_NAME>
+          MAGICPOD_TEST_SETTING_ID: <YOUR SETTING_ID>
+        run: python run_magicpod.py
+      - name: Add test results to TestRail
+        env:
+          TESTRAIL_URL: <YOUR URL>
+          TESTRAIL_USER: <YOUR USER NAME>
+          TESTRAIL_PASSWORD: ${{ secrets.TESTRAIL_PASSWORD }}
+        run: python testrail_add_test_result.py
diff --git a/download_magicpod_api_client.sh b/download_magicpod_api_client.sh
@@ -0,0 +1,4 @@
+OS=mac
+FILENAME=magicpod-api-client
+curl -L "https://app.magicpod.com/api/v1.0/magicpod-clients/api/${OS}/latest/" -H "Authorization: Token ${MAGICPOD_API_TOKEN}" --output ${FILENAME}.zip
+unzip -q ${FILENAME}.zip
diff --git a/run_magicpod.py b/run_magicpod.py
@@ -0,0 +1,88 @@
+import os
+import re
+import requests
+import sys
+import json
+import inspect
+import subprocess
+import zipfile
+import shutil
+
+class MagicpodApiClientWrapper:
+    def __init__(self, secret_api_token, org_name, project_name, cmd_path, tmp_dir):
+        self._secret_api_token = secret_api_token
+        self._org_name = org_name
+        self._project_name = project_name
+        self._cmd_path = cmd_path
+        self._tmp_dir = tmp_dir
+
+    def _run_command(self, command):
+        try:
+            result = subprocess.run(
+                command,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                text=True,  # Get the output as text mode
+                check=True  # Raise an error is error code is not 0
+            )
+            return result.stdout, result.stderr
+        except subprocess.CalledProcessError as e:
+            return None, f"Error: error code {e.returncode} "
+        except FileNotFoundError:
+            return None, "Error: Command not found"
+
+    def batch_run(self, setting_id):
+        command = [
+            self._cmd_path,
+            "batch-run",
+            "-t", self._secret_api_token,
+            "-o", self._org_name,
+            "-p", self._project_name,
+            "-S", str(setting_id)
+        ]
+        stdout, stderr = self._run_command(command=command)
+        print(command)
+        print(stdout)
+        print(stderr)
+        return stdout
+
+    def get_latest_batch_number(self):
+        latest_number = 0
+        url = f"https://magic-pod.com/api/v1.0/{self._org_name}/{self._project_name}/batch-runs/?count=1"
+        headers = {
+            "Authorization": f"Token {self._secret_api_token}"
+        }
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            result = response.json()
+            latest_number = result['batch_runs'][0]['batch_run_number']
+        return latest_number
+
+    def get_batch_run(self, batch_run_number):
+        url = f"https://magic-pod.com/api/v1.0/{self._org_name}/{self._project_name}/batch-run/{batch_run_number}"
+        headers = {
+            "Authorization": f"Token {self._secret_api_token}"
+        }
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            result = response.json()
+            return result
+
+def run_magicpod(output_filename, magicpod_api_client_path, temp_dir):
+    if not temp_dir.endswith('/'):
+        temp_dir += '/'
+    MAGICPOD_API_TOKEN = os.environ.get("MAGICPOD_API_TOKEN")
+    MAGICPOD_ORGANIZATION_NAME = os.environ.get("MAGICPOD_ORGANIZATION_NAME")
+    MAGICPOD_PROJECT_NAME = os.environ.get("MAGICPOD_PROJECT_NAME")
+    MAGICPOD_TEST_SETTING_ID = os.environ.get("MAGICPOD_TEST_SETTING_ID")
+    client = MagicpodApiClientWrapper(secret_api_token=MAGICPOD_API_TOKEN, org_name=MAGICPOD_ORGANIZATION_NAME, project_name=MAGICPOD_PROJECT_NAME, cmd_path=magicpod_api_client_path, tmp_dir=temp_dir)
+    # Run MagicPod tests
+    client.batch_run(MAGICPOD_TEST_SETTING_ID)
+    # Get test results
+    latest_batch_number = client.get_latest_batch_number()
+    test_results = client.get_batch_run(latest_batch_number)
+    # Save test results in a file
+    with open(output_filename, "w", encoding='utf-8') as file:
+        file.write(json.dumps(test_results))
+
+run_magicpod(output_filename='./magicpod_result',magicpod_api_client_path='./magicpod-api-client', temp_dir='./')
diff --git a/testrail.py b/testrail.py
@@ -0,0 +1,103 @@
+"""TestRail API binding for Python 3.x.
+
+(API v2, available since TestRail 3.0)
+
+Compatible with TestRail 3.0 and later.
+
+Learn more:
+
+http://docs.gurock.com/testrail-api2/start
+http://docs.gurock.com/testrail-api2/accessing
+
+Copyright Gurock Software GmbH. See license.md for details.
+"""
+
+import base64
+import json
+
+import requests
+
+
+
+class APIClient:
+    def __init__(self, base_url):
+        self.user = ''
+        self.password = ''
+        if not base_url.endswith('/'):
+            base_url += '/'
+        self.__url = base_url + 'index.php?/api/v2/'
+
+    def send_get(self, uri, filepath=None):
+        """Issue a GET request (read) against the API.
+
+        Args:
+            uri: The API method to call including parameters, e.g. get_case/1.
+            filepath: The path and file name for attachment download; used only
+                for 'get_attachment/:attachment_id'.
+
+        Returns:
+            A dict containing the result of the request.
+        """
+        return self.__send_request('GET', uri, filepath)
+
+    def send_post(self, uri, data):
+        """Issue a POST request (write) against the API.
+
+        Args:
+            uri: The API method to call, including parameters, e.g. add_case/1.
+            data: The data to submit as part of the request as a dict; strings
+                must be UTF-8 encoded. If adding an attachment, must be the
+                path to the file.
+
+        Returns:
+            A dict containing the result of the request.
+        """
+        return self.__send_request('POST', uri, data)
+
+    def __send_request(self, method, uri, data):
+        url = self.__url + uri
+
+        auth = str(
+            base64.b64encode(
+                bytes('%s:%s' % (self.user, self.password), 'utf-8')
+            ),
+            'ascii'
+        ).strip()
+        headers = {'Authorization': 'Basic ' + auth}
+
+        if method == 'POST':
+            if uri[:14] == 'add_attachment':    # add_attachment API method
+                files = {'attachment': (open(data, 'rb'))}
+                response = requests.post(url, headers=headers, files=files)
+                files['attachment'].close()
+            else:
+                headers['Content-Type'] = 'application/json'
+                payload = bytes(json.dumps(data), 'utf-8')
+                response = requests.post(url, headers=headers, data=payload)
+        else:
+            headers['Content-Type'] = 'application/json'
+            response = requests.get(url, headers=headers)
+
+        if response.status_code > 201:
+            try:
+                error = response.json()
+            except:     # response.content not formatted as JSON
+                error = str(response.content)
+            raise APIError('TestRail API returned HTTP %s (%s)' % (response.status_code, error))
+        else:
+            if uri[:15] == 'get_attachment/':   # Expecting file, not JSON
+                try:
+                    open(data, 'wb').write(response.content)
+                    return (data)
+                except:
+                    return ("Error saving attachment.")
+            else:
+                try:
+                    return response.json()
+                except: # Nothing to return
+                    return {}
+
+
+
+class APIError(Exception):
+    pass
diff --git a/testrail_add_test_result.py b/testrail_add_test_result.py
@@ -0,0 +1,93 @@
+import os
+import re
+import sys
+import base64
+import json
+import requests
+import argparse
+from datetime import datetime
+from testrail import *
+
+class TestRailAPIWrapper:
+
+    def __init__(self, base_url, user, password):
+        self._client = APIClient(base_url)
+        self._client.user = user
+        self._client.password = password
+
+    def get_tests(self, run_id):
+        # https://docs.testrail.techmatrix.jp/testrail/docs/702/api/reference/tests/
+        # GET index.php?/api/v2/get_tests/:run_id
+        response = self._client.send_get(
+            'get_tests/'+str(run_id))
+        return response['tests']
+
+    def add_result(self, test_id, entries):
+        # https://docs.testrail.techmatrix.jp/testrail/docs/702/api/reference/results/
+        response = self._client.send_post(
+            'add_result/'+str(test_id),entries)
+        return response
+
+TESTRAIL_URL = os.environ.get("TESTRAIL_URL")
+TESTRAIL_USER = os.environ.get("TESTRAIL_USER")
+TESTRAIL_PASSWORD = os.environ.get("TESTRAIL_PASSWORD")
+TESTRAIL_TESTPLAN_JSON_FILENAME = './testplan.json'
+
+def add_result(json_filename):
+    print(f"Adding the result according to the JSON file: {json_filename}")
+
+    if not os.path.exists(json_filename):
+        print("Error: json file is not found.")
+        sys.exit(1)
+
+    if not os.path.exists(TESTRAIL_TESTPLAN_JSON_FILENAME):
+        print("Error: testplan file is not found.")
+        sys.exit(1)
+    
+    with open(TESTRAIL_TESTPLAN_JSON_FILENAME, "r") as f:
+        testplan_data = json.load(f)
+        print(json.dumps(testplan_data, indent=4))
+    
+    with open(json_filename, "r") as f:
+        magicpod_result_data = json.load(f)
+        print(json.dumps(magicpod_result_data, indent=4))
+
+    client = TestRailAPIWrapper(TESTRAIL_URL, TESTRAIL_USER, TESTRAIL_PASSWORD)
+
+    magicpod_patterns = magicpod_result_data['test_cases']['details']
+    testrail_testruns = testplan_data['entries'][0]['runs']
+    for magicpod_pattern in magicpod_patterns:
+        for testrail_testrun in testrail_testruns:
+            if testrail_testrun['config'] == magicpod_pattern['pattern_name']: # browser name
+                testrail_tests = client.get_tests(testrail_testrun['id'])
+                for testrail_test in testrail_tests:
+                    pattern = r"\/(\d+)\/$"
+                    test_case_id_registered_in_testrail = re.search(pattern, testrail_test['custom_magicpod_url']).group(1)
+                    magicpod_test_results = magicpod_pattern['results']
+                    for magicpod_test_result in magicpod_test_results:
+                        if int(test_case_id_registered_in_testrail) == int(magicpod_test_result['test_case']['number']):
+                            if magicpod_test_result['status'] == "succeeded":
+                                status = 1
+                            elif magicpod_test_result['status'] == "failed":
+                                status = 5
+                            
+                            started_at = datetime.fromisoformat(magicpod_test_result['started_at'])
+                            if magicpod_test_result['finished_at'] == "":
+                                finished_at = datetime.fromisoformat(datetime.now().strftime("%Y-%m-%dT%H:%M:%S"))
+                            else:
+                                finished_at = datetime.fromisoformat(magicpod_test_result['finished_at'])
+                            elapsed_seconds = str((finished_at - started_at).total_seconds()) + "s"
+
+                            comment = f"MagicPod URL:{magicpod_result_data['url']}"
+
+                            result_data = {
+                                "status_id": status,
+                                "comment": comment,
+                                "elapsed": elapsed_seconds,
+                            }
+
+                            # 登録
+                            add_result_response = client.add_result(testrail_test['id'], result_data)
+                            print(json.dumps(add_result_response, indent=4))
+
+add_result('./magicpod_result')
diff --git a/testrail_prepare.py b/testrail_prepare.py
@@ -0,0 +1,61 @@
+import os
+import sys
+import base64
+import json
+import requests
+import argparse
+from datetime import datetime
+from testrail import *
+
+class TestRailAPIWrapper:
+
+    def __init__(self, base_url, user, password):
+        self._client = APIClient(base_url)
+        self._client.user = user
+        self._client.password = password
+
+    def add_plan(self, project_id, entries):
+        # https://docs.testrail.techmatrix.jp/testrail/docs/702/api/reference/plans/
+        # POST index.php?/api/v2/add_plan/:project_id
+        entries["name"] = datetime.now().strftime("%Y-%m-%d-%H-%M") + " MagicPod Test"
+        response = self._client.send_post(
+            'add_plan/'+str(project_id),entries)
+        return response
+
+TESTRAIL_URL = os.environ.get("TESTRAIL_URL")
+TESTRAIL_USER = os.environ.get("TESTRAIL_USER")
+TESTRAIL_PASSWORD = os.environ.get("TESTRAIL_PASSWORD")
+TESTRAIL_TESTPLAN_JSON_FILENAME = './testplan.json'
+TESTRAIL_PROJECT_ID = 3 # [ToDo]Change to the target project id in TestRail
+TESTRAIL_TESTPLAN_ENTRY = {
+    "name": "testplan_name",
+    "entries": [
+        {
+            "suite_id": 3, # [ToDo]Change to the target suite_id in TestRail
+            "include_all": True, # All test cases in a suite will be included in the test plan
+            "config_ids": [5,6,7], # [ToDo]Change to the target config ids
+            "runs": [
+                {
+                    "config_ids": [5] # [ToDo]Change to the target config id
+                },
+                {
+                    "config_ids": [6] # [ToDo]Change to the target config id
+                },
+                {
+                    "config_ids": [7] # [ToDo]Change to the target config id
+                }
+            ]
+        },
+    ]
+}
+
+
+def prepare_testplan():
+    print("Preparing test plan")
+    client = TestRailAPIWrapper(TESTRAIL_URL, TESTRAIL_USER, TESTRAIL_PASSWORD)
+    response = client.add_plan(TESTRAIL_PROJECT_ID, TESTRAIL_TESTPLAN_ENTRY)
+    print(json.dumps(response, indent=4))
+    with open(TESTRAIL_TESTPLAN_JSON_FILENAME, "w", encoding='utf-8') as file:
+        file.write(json.dumps(response))
+
+prepare_testplan()
