{"type":"doc","content":[{"type":"paragraph","content":[{"text":"AIO Tests supports importing WebdriverIO (WDIO) results through it’s support for ","type":"text"},{"text":"JUnit reports","type":"text","marks":[{"type":"link","attrs":{"href":"https://webdriver.io/docs/junit-reporter"}}]},{"text":" or via the ","type":"text"},{"text":"hooks","type":"text","marks":[{"type":"link","attrs":{"href":"https://webdriver.io/docs/configurationfile"}}]},{"text":" available in WebdriverIO. ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"WebdriverIO","type":"text","marks":[{"type":"link","attrs":{"href":"https://webdriver.io/"}}]},{"text":" is an automation framework which leverages the power of the Webdriver protocol and is built to automate web and mobile applications. It is an open source project that is run with open governance and owned by a non-profit entity called ","type":"text"},{"text":"OpenJS Foundation","type":"text","marks":[{"type":"link","attrs":{"href":"https://openjsf.org/"}}]},{"text":". The WDIO runner currently supports ","type":"text"},{"text":"Mocha","type":"text","marks":[{"type":"link","attrs":{"href":"http://mochajs.org/"}}]},{"text":", ","type":"text"},{"text":"Jasmine","type":"text","marks":[{"type":"link","attrs":{"href":"http://jasmine.github.io/"}}]},{"text":", and ","type":"text"},{"text":"Cucumber","type":"text","marks":[{"type":"link","attrs":{"href":"https://cucumber.io/"}}]},{"text":" frameworks and is capable of generating a host of reports including a ","type":"text"},{"text":"JUnit report","type":"text","marks":[{"type":"link","attrs":{"href":"https://webdriver.io/docs/junit-reporter"}}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"There are two ways to integrate AIO Tests with Webdriver IO either via the JUnit report or via AIO REST API calls in afterTest hooks of Webdriver IO. This document provides an overview on :","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Generating the Junit report from WebdriverIO tests and uploading it to AIO Tests. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Using ","type":"text"},{"text":"AIO Tests REST APIs","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/"}}]},{"text":" to report results and much more, using the WDIO framework hooks.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The demo example is based on the ","type":"text"},{"text":"Getting Started project of Webdriver IO","type":"text","marks":[{"type":"link","attrs":{"href":"https://webdriver.io/docs/gettingstarted"}}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"5eb8b458-5c8e-4124-b351-ec8773fb5612"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"974cc8a7-813b-4f0d-a833-e81163f7ca23"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Required WDIO Setup","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"npm init wdio ./path/to/new/project","type":"text","marks":[{"type":"code"}]},{"text":". On prompt to select framework, select Mocha.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For reporting results","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For JUnit report ","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"npm install @wdio/junit-reporter --save-dev","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For reporting results via AIO Tests API","type":"text","marks":[{"type":"strong"}]},{"text":" : ","type":"text"},{"text":"npm install axios","type":"text","marks":[{"type":"code"}]},{"text":" (This can be replaced with any library to make API calls)","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Running your tests","type":"text"}]},{"type":"paragraph","content":[{"text":"The sample test generated by Webdriver IO is as follows. One more test has been added to demo an error case.","type":"text"}]},{"type":"codeBlock","content":[{"text":"const LoginPage = require('../pageobjects/login.page');\nconst SecurePage = require('../pageobjects/secure.page');\n\ndescribe('My Login application', () => {\n it('should login with valid credentials', async () => {\n await LoginPage.open();\n\n await LoginPage.login('tomsmith', 'SuperSecretPassword!');\n await expect(SecurePage.flashAlert).toBeExisting();\n await expect(SecurePage.flashAlert).toHaveTextContaining(\n 'You logged into a secure area!');\n });\n it('should login with invalid credentials : ', async () => {\n await LoginPage.open();\n\n await LoginPage.login('tomsmith', 'SuperSecretPassword1');\n await expect(SecurePage.flashAlert).toBeExisting();\n await expect(SecurePage.flashAlert).toHaveTextContaining(\n 'You logged into a secure area!');\n });\n});","type":"text"}]},{"type":"paragraph","content":[{"text":"To trigger the WDIO tests, use:","type":"text"}]},{"type":"paragraph","content":[{"text":"npx wdio run wdio.conf.js","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Or","type":"text"}]},{"type":"paragraph","content":[{"text":"npm run wdio","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting results via JUnit file","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setting up WDIO JUnit reporter","type":"text"}]},{"type":"paragraph","content":[{"text":"The WDIO JUnit reporter requires a configuration in the wdio.conf.js which is the configuration file for Webdriver IO. JUnit reporter, along with any other reporter, can be setup as follows :","type":"text"}]},{"type":"codeBlock","content":[{"text":"framework: 'mocha',\n \n// Test reporter for stdout.\n// The only one supported by default is 'dot'\n// see also: https://webdriver.io/docs/dot-reporter\nreporters: ['spec',['junit', {\n outputDir: './',outputFileFormat: function(options) { \n return `wdio-junit-results.xml`\n}}]],","type":"text"}]},{"type":"paragraph","content":[{"text":"Running the tests generates the following Junit xml:","type":"text"}]},{"type":"expand","attrs":{"title":"WDIO JUnit xml"},"content":[{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n (/Users/varshneyn/aiotcms/automation-demo-repos/webdriverio-mocha/test/specs/example.e2e.js:18:45)\n at processTicksAndRejections (node:internal/process/task_queues:96:5)\n]]>\n \n \n","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Uploading results to AIO Tests","type":"text"}]},{"type":"paragraph","content":[{"text":"Post execution of a suite, the TEST-.xml file can be uploaded either via","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AIO Tests REST API","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/NAT/pages/1900880129"}}]},{"text":" call using multipart form-data to upload file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Cycle options in Cycles Tab inside AIO Tests","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/NAT/pages/1900879982"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"via ","type":"text"},{"text":"AIO Tests Jenkins Plugin","type":"text","marks":[{"type":"link","attrs":{"href":"https://plugins.jenkins.io/aio-tests/"}}]}]}]}]},{"type":"paragraph","content":[{"text":"Please follow the above links to continue to import results using either of the options.","type":"text"}]},{"type":"paragraph","content":[{"text":"Uploading the above file for the first time will ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"create new cases in the system. The new case is created with ","type":"text"},{"type":"hardBreak"},{"text":"- title as the ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" value from tag of the JUnit report","type":"text"},{"type":"hardBreak"},{"text":"- automation key as ","type":"text"},{"text":"classname.name","type":"text","marks":[{"type":"code"}]},{"text":" from the JUnit report. ","type":"text"},{"type":"hardBreak"},{"text":"- status as Published","type":"text"},{"type":"hardBreak"},{"text":"- automation status as Automated","type":"text"},{"type":"hardBreak"},{"text":"- automation owner as user uploading the results","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the newly created case to the cycle being uploaded to","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Mark the details of the run ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Execution mode is set to Automated","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Duration of run is set to Actual Effort","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Status of run is set based on status mapping table below","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Failures and errors are reported as Run Level comments","type":"text"}]}]}]}]}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"If the same file is uploaded again, the cases will be identified using the automation key (","type":"text"},{"text":"classname.name )","type":"text","marks":[{"type":"code"}]},{"text":"and would be updated, instead of creating new cases. ","type":"text"}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"There is no way to map case keys to WDIO cases for the JUnit report since the WDIO JUnit reporter strips off all non-alphanumeric characters while generating the JUnit report.","type":"text"}]},{"type":"paragraph","content":[{"text":"e.g. If the test name is “","type":"text"},{"text":"describe('My Login application SCRUM-TC-11'\"","type":"text","marks":[{"type":"code"}]},{"text":" the Junit report strips of the hyphens and reports it as ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Status Mapping JUnit → AIO Tests","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"c7a4f064-3033-473c-807a-e85a32323bf0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"JUnit XML","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[350.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"AIO Tests Mapping","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"No tag inside means Passed","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[350.0]},"content":[{"type":"paragraph","content":[{"text":"Passed case","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Passed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[350.0]},"content":[{"type":"paragraph","content":[{"text":"Skipped case either by @Ignore or others","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Not Run","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[350.0]},"content":[{"type":"paragraph","content":[{"text":"Indicates that the test failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals.","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Failed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[350.0]},"content":[{"type":"paragraph","content":[{"text":"Indicates that the test errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable;","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Failed","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting results via WebdriverIO Mocha Hooks and AIO Tests REST APIs","type":"text"}]},{"type":"paragraph","content":[{"text":"AIO Tests provides a rich set of APIs for ","type":"text"},{"text":"Execution Management","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20management"}}]},{"text":", using which users can not only report execution status, but also add effort, actual results, comments, defects and attachments to runs as well as steps. ","type":"text"},{"type":"hardBreak"},{"text":"AIO Tests also provides APIs to ","type":"text"},{"text":"create cycles","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Cycle%20Operations"}}]},{"text":" and to ","type":"text"},{"text":"add cases to cycles","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20management/addCaseToCycle"}}]},{"text":" for execution planning.","type":"text"}]},{"type":"paragraph","content":[{"text":"The basic sample below will show how Mocha Hooks in WebdriverIO can leverage the AIO Tests REST APIs to report results. In the wdio.conf.js, the ","type":"text"},{"text":"afterTest","type":"text","marks":[{"type":"code"}]},{"text":" method can be used to make AIO API call.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Mocha aftestTest method","type":"text"}]},{"type":"paragraph","content":[{"text":"The afterTest call is defined as below: [ref ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://webdriver.io/docs/configurationfile"}},{"text":" ]","type":"text"}]},{"type":"codeBlock","content":[{"text":"/**\n * Function to be executed after a test (in Mocha/Jasmine only)\n * @param {Object} test test object\n * @param {Object} context scope object the test was executed with\n * @param {Error} result.error error object in case the test fails, otherwise `undefined`\n * @param {Any} result.result return object of test function\n * @param {Number} result.duration duration of test\n * @param {Boolean} result.passed true if test has passed, otherwise false\n * @param {Object} result.retries informations to spec related retries, e.g. `{ attempts: 0, limit: 0 }`\n */\n afterTest: function (test, context, { error, result, duration, passed, retries }) {\n },","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Establish a convention for AIO Tests Case keys","type":"text"}]},{"type":"paragraph","content":[{"text":"For the purpose of the example, we have established a convention to map cases - the AIO Tests case key is the prefix to the case title e.g. ","type":"text"},{"text":"it('NVPROJ-TC-11: should login with valid credentials'","type":"text","marks":[{"type":"code"}]},{"text":" contains NVPROJ-TC-11, which is the AIO Tests Case key. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Any convention can be established and the code consuming it can cater to the convention. In our case, we are using startsWith to identify the case key.","type":"text"}]},{"type":"codeBlock","content":[{"text":"describe('My Login application', () => {\n it('NVPROJ-TC-11: should login with valid credentials', async () => {\n await LoginPage.open();\n\n await LoginPage.login('tomsmith', 'SuperSecretPassword!');\n await expect(SecurePage.flashAlert).toBeExisting();\n await expect(SecurePage.flashAlert).toHaveTextContaining(\n 'You logged into a secure area!');\n });\n it('NVPROJ-TC-12: should login with invalid credentials : ', async () => {\n await LoginPage.open();\n\n await LoginPage.login('tomsmith', 'SuperSecretPassword1');\n await expect(SecurePage.flashAlert).toBeExisting();\n await expect(SecurePage.flashAlert).toHaveTextContaining(\n 'You logged into a secure area!');\n });\n});","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Reporting result via API","type":"text"}]},{"type":"paragraph","content":[{"text":"In the example below, the ","type":"text"},{"text":"postResults","type":"text","marks":[{"type":"code"}]},{"text":" method uses Axios to make an HTTP call. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It uses the test title to identify the case key [ based on the convention we established]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a POST request","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"URL :","type":"text","marks":[{"type":"strong"}]},{"text":" For cloud the URL host would be ","type":"text"},{"text":"https://tcms.aiojiraapps.com/aio-tcms/api/v1","type":"text","marks":[{"type":"code"}]},{"text":". For Jira server, it would be the native Jira server hostname.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"strong"}]},{"text":" : Please refer to ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://aiosupport.atlassian.net/wiki/spaces/NAT/pages/1900879117"}},{"text":" to understand how to authorize users. The authentication information goes in the ","type":"text"},{"text":"headers: {'Authorization': ''},","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"POST Body : ","type":"text","marks":[{"type":"strong"}]},{"text":"The body consists of data from the test object provided by Webdriver IO. If the case has failed, the error is posted as comments.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If required, the basic example can be extended to upload attachments against the case using the ","type":"text"},{"text":"upload attachment API.","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20management/addAttachmentsToLatestRun"}}]}]}]}]}]}]},{"type":"codeBlock","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"const axios = require('axios');\nconst chalk = require('chalk');\nexports.config = {\n //\n // ====================\n // Runner Configuration\n // ====================\n //\n afterTest: function(test, context, { error, result, duration, passed, retries }) {\n return this.postResults(test, {error, duration, passed});\n },\n postResults(test, { error, duration, passed }) {\n if(test.title.startsWith(\"NVPROJ-TC-\")) {\n let tc = test.title.split(\":\")[0]\n console.log(chalk.hex('#0094a6').underline.bold(\"Reporting results ...\" + tc))\n let resultData = {\"testRunStatus\": passed? \"Passed\":\"Failed\", \"effort\": duration/1000};\n if(!passed)\n {\n resultData[\"comments\"] = [error.matcherResult.message]\n }\n return axios({\n method: 'post',\n url: `https://tcms.aiojiraapps.com/aio-tcms/api/v1/project/NVPROJ/testcycle/NVPROJ-CY-48/testcase/${tc}/testrun`,\n headers: {'Authorization': ''},\n data :resultData\n })\n .then(function (response) {\n console.log(response.data)\n }).catch((e) => console.log(e));\n }\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"Running the above in the afterTest method, will result in 2 cases being added to cycle ","type":"text"},{"text":"NVPROJ-CY-48","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NVPROJ-TC-11: should login with valid credentials","type":"text","marks":[{"type":"code"}]},{"text":" - NVPROJ-TC-11 will be added to cycle with status as passed and duration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NVPROJ-TC-12: should login with invalid credentials ","type":"text","marks":[{"type":"code"}]},{"text":" - NVPROJ-TC-12 will be added to cycle with status as Failed and comments would hold the error messages.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The above is a basic example of what can be done with the hooks and AIO Tests APIs. It is recommended to add appropriate error handling and enhance it based on your automation requirements.","type":"text"}]}]},{"type":"paragraph"}],"version":1}

Browser not supported