Merge pull request #9 from prashanth-sams/upload

feat: Added automation api for bulk cucumber ouput upload

Author: prashanth-sams

Readme.md

@@ -11,8 +11,11 @@ npm install --save-dev qmetry-cucumber
 
 ## How to use
 
-#### qmetry.config.json
-Create `qmetry.config.json` file in the test project's root folder and add the below configurations.
+#### Case #1 Open API
+
+> Create `qmetry.config.json` file in the test project's root folder and add the below configurations.
+
+##### qmetry.config.json
 ```
 {
     "baseUrl": "https://<your base url>",
@@ -26,6 +29,51 @@ Create `qmetry.config.json` file in the test project's root folder and add the b
 ```
 Here, `testCycleId`, `summary` and `description` fields are optional.
 
+#### Case #2 Automation API
+
+> Submit the Cucumber test output in JSON format to QMetry using the Automation API. To achieve this, create a `qmetry.config.json` file in the root directory of your test project and add the following configurations.
+
+##### qmetry.config.json
+```
+{
+    "baseUrl": "https://<your base url>",
+    "authorization": "<jira auth creds encoded by base64>",
+    
+    "automationApiKey": "<automation api key>",
+    "automation": {
+        "format": "cucumber",
+        "attachFile": true,
+        "isZip":false,
+        "build":"",
+        "fields":{ 
+            "testCycle":{ 
+                "labels": ["<your label>"],
+                "status":"Done",
+                "summary": "<test cycle summary>",
+                "description": "<test cycle description>",
+                "customFields": [
+                    {
+                        "name": "<field name; say., Environment>",
+                        "value": "<field value; say., DEV>"
+                    }
+                ]
+            },
+            "testCase":{ 
+                "labels": ["<your label>"],
+                "description": "<test case description>",
+                "customFields": [
+                    {
+                        "name": "<field name; say., Environment>",
+                        "value": "<field value; say., DEV>"
+                    }
+                ]
+            }
+        }
+    }
+}
+```
+Here, `baseUrl`, `authorization`, `automationApiKey`, and `automation > format` are the only mandatory fields.
+
 #### Feature
 ```
 Scenario: [PRO-TC-1] [PRO-TC-2] User logs in with valid credentials

package.json

@@ -1,6 +1,6 @@
 {
   "name": "qmetry-cucumber",
-  "version": "1.1.1",
+  "version": "2.1.2",
   "description": "Sync cucumber automation test results with Qmetry Test Cycle",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,7 +17,7 @@
     "build": "rm -rf ./dist/* && tsup",
     "publish": "npm run build && npm publish",
     "lint": "prettier --check . && eslint .",
-    "test": "jest"
+    "test": "cd test && npm test"
   },
   "keywords": [
     "qmetry",

src/config.ts

@@ -29,7 +29,29 @@ export const getConfig = async () => {
             projectId: data?.projectId,
             testCycleId: data?.testCycleId,
             summary: data?.summary || 'Test Cycle Summary',
-            description: data?.description || 'Automated status update using qmetry-cucumber'
+            description: data?.description || 'Automated status update using qmetry-cucumber',
+            
+            automationApiKey: data?.automationApiKey,
+            automation: {
+                format: data?.automation?.format,
+                attachFile: data?.automation?.attachFile,
+                isZip: data?.automation?.isZip,
+                build: data?.automation?.build,
+                fields: {
+                    testCycle: {
+                        labels: data?.automation?.fields?.testCycle?.labels,
+                        status: data?.automation?.fields?.testCycle?.status,
+                        summary: data?.automation?.fields?.testCycle?.summary,
+                        description: data?.automation?.fields?.testCycle?.description,
+                        customFields: data?.automation?.fields?.testCycle?.customFields || [],
+                    },
+                    testCase: {
+                        labels: data?.automation?.fields?.testCase?.labels,
+                        description: data?.automation?.fields?.testCase?.description,
+                        customFields: data?.automation?.fields?.testCase?.customFields || [],
+                    },
+                },
+            }
         };
     } catch (error) {
         console.error('Error fetching configuration:', error);

src/qmetry-cucumber.ts

@@ -1,7 +1,9 @@
 import axios, { AxiosResponse } from 'axios';
-import { TestStepResultStatus, ResponseData, ExecutionResultProps, ExecutionResult, ResultPair, TestCaseList, Keys } from './types';
+import { TestStepResultStatus, ResponseData, ExecutionResultProps, ExecutionResult, ResultPair, TestCaseList, importResultProps, Keys } from './types';
 import { getConfig } from './config';
 import { delay, checkStatusId } from './utils';
+import FormData from 'form-data';
+import fs from 'fs';
 
 export async function updateQmetryStatus (name: string, status?: TestStepResultStatus) {
     const config = await getConfig();
@@ -245,3 +247,67 @@ export async function validateTestCycleId(testCycleId: string): Promise<boolean>
 
     return response;
 }
+
+export async function sendTestResultToQmetry(jsonData: any) {
+    const config = await getConfig();
+
+    const url = `${config.baseUrl}/rest/qtm4j/automation/latest/importresult`;
+
+    const headers = {
+        'Content-Type': 'application/json',
+        'apiKey': `${config.automationApiKey}`,
+        'Authorization': `${config.authorization}`
+    };
+
+    if (!config?.automation?.format) {
+        throw new Error('Format is a required field but was not provided.');
+    }
+
+    const body: importResultProps = {
+        format: config.automation.format,
+        attachFile: config?.automation.attachFile,
+        isZip: config?.automation.isZip,
+        build: config?.automation.build,
+        fields: {
+            testCycle: {
+                labels: config?.automation?.fields?.testCycle?.labels,
+                status: config?.automation?.fields?.testCycle?.status,
+                summary: config?.automation?.fields?.testCycle?.summary,
+                description: config?.automation?.fields?.testCycle?.description,
+                customFields: config?.automation?.fields?.testCycle?.customFields || [],
+            },
+            testCase: {
+                labels: config?.automation?.fields?.testCase?.labels,
+                description: config?.automation?.fields?.testCase?.description,
+                customFields: config?.automation?.fields?.testCase?.customFields || [],
+            }
+        }
+    };
+
+    const response = await axios.post(url, body, { headers }).then((resp) => {
+        return resp.data.url;
+    });
+    
+    submitFile(response, jsonData);
+}
+
+export async function submitFile(url: string, jsonData: any) {
+
+    const config = await getConfig();
+    const form = new FormData();
+
+    const headers = {
+        'Content-Type': 'multipart/form-data',
+        'apiKey': `${config.automationApiKey}`,
+        'Authorization': `${config.authorization}`,  
+    };
+
+    form.append('file', fs.createReadStream(jsonData));
+
+    axios.post(url, form, { headers })
+        .then((response) => {
+        })
+        .catch((error) => {
+            console.error('Error submitting file:', error);
+        });
+}

src/types.ts

@@ -72,4 +72,58 @@ export interface QmetryConfig {
     testCycleId?: string;
     summary?: string;
     description?: string;
+    automationApiKey?: string;
+    automation?: Automation;
+}
+
+export interface Automation {
+    format: string;
+    attachFile?: boolean;
+    isZip?: boolean;
+    build?: string;
+    fields?: {
+        testCycle?: {
+            labels?: string[];
+            status?: string;
+            summary?: string;
+            description?: string;
+            customFields?: CustomField[];
+        };
+        testCase?: {
+            labels?: string[];
+            description?: string;
+            customFields?: CustomField[];
+        }
+    }
+}
+
+export interface CustomField {
+    name: string;
+    value: string;
+}
+
+export interface ImportResultResponse {
+    url: string;
+    trackingId: string;
+}
+
+export interface importResultProps {
+    format: string;
+    attachFile?: boolean;
+    isZip?: boolean;
+    build?: string;
+    fields: {
+        testCycle: {
+            labels?: string[];
+            status?: string;
+            summary?: string;
+            description?: string;
+            customFields?: CustomField[];
+        };
+        testCase: {
+            labels?: string[];
+            description?: string;
+            customFields?: CustomField[];
+        }
+    }
 }

test/qmetry.config.json

@@ -2,5 +2,40 @@
     "baseUrl": "",
     "apiKey": "",
     "authorization": "",
-    "projectId": 0
-}
+    "projectId": 0,
+    "testCycleId": "",
+    "summary":"",
+    "description": "",
+
+    "automationApiKey": "",
+    "automation": {
+        "format": "cucumber",
+        "attachFile": true,
+        "isZip":false,
+        "build":"",
+        "fields":{ 
+            "testCycle":{ 
+                "labels": [""],
+                "status":"Done",
+                "summary":"",
+                "description": "",
+                "customFields": [
+                    {
+                        "name": "Environment",
+                        "value": "DEV"
+                    }
+                ]
+            },
+            "testCase":{ 
+                "labels": [""],
+                "description": "",
+                "customFields": [
+                    {
+                        "name": "Environment",
+                        "value": "DEV"
+                    }
+                ]
+            }
+        }
+    }
+}

test/src/test/hooks/hooks.ts

@@ -5,7 +5,7 @@ import { config } from "../../../playwright.config";
 import { getEnv } from "../helper/env/env";
 import { createLogger } from "winston";
 import { options } from "../helper/utils/logger";
-import { updateQmetryStatus } from "../../../../src/qmetry-cucumber";
+import { updateQmetryStatus, sendTestResultToQmetry } from "../../../../src/qmetry-cucumber";
 
 export let context: BrowserContext;
 let browser: Browser;
@@ -71,4 +71,5 @@ After(async function ({ pickle, result }){
 
 AfterAll(async function (){
     await browser.close();
+    sendTestResultToQmetry(process.cwd() + '/test-result/reports/cucumber-report.json');
 });