{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This article will show simplified code samples to invoke ","type":"text"},{"text":"AIO Rest APIs","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2025619567"}}]},{"text":" in Java to report automated test results in the AIO Tests execution. ","type":"text"},{"type":"hardBreak"},{"text":"The AIO Tests REST APIs use a mix of GET, POST and Multipart-form data requests to get details on execution cycles and create them, report results against individual cases or import results into AIO Tests with the results file for all cases.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this documentation, you’ll understand:","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"outline":{"value":"false"},"style":{"value":"none"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"27375aeb-0bc4-4089-8d16-c76e87448baa"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"10b5231d-015b-43f0-8ceb-8f99708391f6"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"For the purpose of this sample, we are going to use","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"REST Assured","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/rest-assured/rest-assured/wiki/GettingStarted"}}]},{"text":" - to make API calls","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Gson","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/google/gson"}}]},{"text":" - for JSON response parsing. It can be replaced with any JSON parsing library like Jackson or JSON-simple. (","type":"text"},{"text":"Dependencies","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2025652356/Code+Sample+-+Java#dependencies"}}]},{"text":")","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Sample","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Config","type":"text"}]},{"type":"paragraph","content":[{"text":"We will be using the following RestAssured config to define the common setup.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The Authorization header as shown in the ","type":"text","marks":[{"type":"em"}]},{"text":"AIO Tests API Token","type":"text","marks":[{"type":"em"},{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2025422897"}}]},{"text":".","type":"text","marks":[{"type":"em"}]}]}]},{"type":"codeBlock","content":[{"text":"setupRestAssured() {\n RequestSpecBuilder builder = new RequestSpecBuilder();\n builder.setBaseUri(\"https://tcms.aiojiraapps.com\");\n builder.setBasePath(\"/aio-tcms/api/v1\");\n builder.addHeader(\"Authorization\", \"AioAuth \");\n builder.log(LogDetail.METHOD).log(LogDetail.URI);\n defaultRequestSpec = builder.build();\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1. Get Cycle Details [","type":"text"},{"text":"Swagger","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Case%20Operations/getTestCaseDetail"}}]},{"text":"]","type":"text"}]},{"type":"paragraph","content":[{"text":"Get Cycle Details and ","type":"text"},{"text":"other Cycle information APIs","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2025619567/Rest+APIs#API"}}]},{"text":" can be used to get details of existing cycles, run summary and cycle folder structures.","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class AIORestAssuredExample {\n\n public static final String GET_CYCLE_DETAILS = \"/project/{projectKey}/testcycle/{cycleKey}/detail\";\n private static RequestSpecification defaultRequestSpec;\n \n public static void main(String[] args) {\n \n //Setup Rest assured config\n RequestSpecBuilder builder = new RequestSpecBuilder();\n builder.setBaseUri(\"https://tcms.aiojiraapps.com\").setBasePath(\"/aio-tcms/api/v1\");\n builder.addHeader(\"Authorization\", \"AioAuth \");\n builder.log(LogDetail.METHOD).log(LogDetail.URI);\n defaultRequestSpec = builder.build();\n \n //Get cycle details\n Response cycleDetails = doGet(GET_CYCLE_DETAILS, \"ATSMPL\", \"ATSMPL-CY-37\");\n System.out.println(cycleDetails.jsonPath().get(\"ID\").toString());\n }\n\n public static Response doGet(String path, String ...pathParams) {\n Response response = given(defaultRequestSpec).when().get(path,pathParams).andReturn();\n return response;\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2. Create Cycle [","type":"text"},{"text":"Swagger","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Cycle%20creation"}}]},{"text":"]","type":"text"}]},{"type":"paragraph","content":[{"text":"Depending on your organization’s process/needs, automation execution results can be captured in AIO Tests in two ways.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"By creating a new cycle for each execution [e.g. Regression Release 1_Day 1, Regression Release 1_Day 2 are individual cycles and only one execution is captured as part of each of these cycles] ","type":"text"},{"type":"hardBreak"},{"text":"Or","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"By creating a new run in an existing cycle for each execution [e.g. Regression Release 1 is a cycle and daily executions are captured as multiple runs in the same cycle]","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Below code sample (code is in #3) shows both creating a cycle, adding cases to it and reporting results.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3. Mark Execution Results [","type":"text"},{"text":"Swagger","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20Results%20%26%20Case%2FRun%20management/markTestCaseResult"}}]},{"text":"]","type":"text"}]},{"type":"paragraph","content":[{"text":"The below sample creates a new cycle and reports the execution results and duration of the run of your test cases. ","type":"text"},{"type":"hardBreak"},{"text":"The sample methods can be added to your test framework’s listeners or hooks which execute either after a case finishes or after execution finishes. [e.g. ","type":"text"},{"text":"IInvokedMethodListener","type":"text","marks":[{"type":"code"}]},{"text":" in TestNG / ","type":"text"},{"text":"TestCaseFinished","type":"text","marks":[{"type":"code"}]},{"text":" event in Cucumber / ","type":"text"},{"text":"RunListener/TestExecutionListener","type":"text","marks":[{"type":"code"}]},{"text":" in JUnit]","type":"text"},{"type":"hardBreak"},{"text":"These case runs show up with Execution Mode as Automated in AIO Tests.","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class AIORestAssuredExample {\n public static final String CREATE_CYCLE = \"/project/{projectKey}/testcycle/detail\";\n public static final String MARK_CASE = \"project/{projectKey}/testcycle/{cycleKey}/testcase/{caseKey}/testrun?createNewRun={createNewRun}\";\n \n private static RequestSpecification defaultRequestSpec;\n \n public static void main(String[] args) {\n \n setupAIORestAssuredConfig();\n \n //Create a new cycle\n String newCycleKey = createCycle(projectKey);\n \n //Mark test execution status of cases - status/duration can come from Result object of test frameworks\n markCaseStatus(projectKey, newCycleKey, Arrays.asList(\"ATSMPL-TC-1\",\"ATSMPL-TC-2\"), \"Passed\");\n }\n\n public static String createCycle(String projectKey) {\n Map newCycleDetails = new HashMap<>();\n newCycleDetails.put(\"title\", \"Regression Release 1\");\n newCycleDetails.put(\"objective\", \"Trial Run\");\n \n //If cycle needs to be created in specific folder, add folder information\n newCycleDetails.put(\"folder\", Collections.singletonMap(\"ID\",\"213\"));\n\n Response response = doPost(CREATE_CYCLE, newCycleDetails, projectKey);\n String newCycleKey = response.jsonPath().getString(\"key\");\n return newCycleKey;\n }\n \n public static void markCaseStatus(String projectKey, String cycleKey, List caseKeys, String testRunStatus) {\n Map runStatus = new HashMap<>();\n runStatus.put(\"testRunStatus\", testRunStatus);\n runStatus.put(\"effort\", \"60000\");\n for(String caseKey : caseKeys) {\n //Passing run status, path params and createNewRun as true\n doPost(MARK_CASE, runStatus, projectKey, cycleKey, caseKey, \"true\" );\n }\n }\n \n public static Response doPost(String path, Map params, Object ...pathParams) {\n Response response = given(defaultRequestSpec).contentType(ContentType.JSON).body(params).when().post(path,pathParams).andReturn();\n return response;\n }\n \n public void setupAIORestAssuredConfig() {\n RequestSpecBuilder builder = new RequestSpecBuilder();\n builder.setBaseUri(\"https://tcms.aiojiraapps.com\").setBasePath(\"/aio-tcms/api/v1\");\n builder.addHeader(\"Authorization\", \"AioAuth \");\n builder.log(LogDetail.METHOD).log(LogDetail.URI);\n defaultRequestSpec = builder.build();\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"4. Import Execution Results from JUnit/TestNG XML Files [","type":"text"},{"text":"Swagger","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20Results%20%26%20Case%2FRun%20management/importTestResults"}}]},{"text":"]","type":"text"}]},{"type":"paragraph","content":[{"text":"As a post-execution step, AIO Tests currently supports the ","type":"text"},{"text":"JUnit","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2026602633"}}]},{"text":" XML Report format and the ","type":"text"},{"text":"TestNG","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2026668135"}}]},{"text":" report format. ","type":"text"},{"type":"hardBreak"},{"text":"To import results from either of these formats to AIO Tests, the ","type":"text"},{"text":"Import Results API","type":"text","marks":[{"type":"link","attrs":{"href":"https://aiosupport.atlassian.net/wiki/spaces/AioTests/pages/2026569775"}}]},{"text":" can be used in post-execution listeners/hooks.","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class AIORestAssuredExample {\n public static final String IMPORT_RESULTS = \"/project/{projectKey}/testcycle/{cycleKey}/import/results?type={type}\";\n private static RequestSpecification defaultRequestSpec;\n\n public static void main(String[] args) {\n \n setupAIORestAssuredConfig();\n \n importResults(\"ATSMPL\", \"ATSMPL-CY-37\",\"target/TEST-ForestCreatorTests.xml\", \"Junit\");\n }\n\n private static void importResults(String projectKey, String cycleKey, String fileName, String frameworkType) {\n Map formParams = new HashMap<>();\n formParams.put(\"createNewRun\", true);\n formParams.put(\"addCaseToCycle\", true);\n formParams.put(\"createCase\", true);\n File f = new File(fileName);\n doMultipartPost(IMPORT_RESULTS, f, formParams, projectKey, cycleKey, frameworkType);\n }\n \n public static Response doMultipartPost(String path, File file, Map formParams, Object ...pathParams) {\n Response response = given(defaultRequestSpec).multiPart(\"file\", file).formParams(formParams).when().post(path,pathParams).andReturn();\n response.prettyPrint();\n return response;\n }\n \n public static void setupAIORestAssuredConfig() {\n RequestSpecBuilder builder = new RequestSpecBuilder();\n builder.setBaseUri(\"https://tcms.aiojiraapps.com\").setBasePath(\"/aio-tcms/api/v1\");\n builder.addHeader(\"Authorization\", \"AioAuth \");\n builder.log(LogDetail.METHOD).log(LogDetail.URI);\n defaultRequestSpec = builder.build();\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"5. Upload an Attachment to a Case as Evidence [","type":"text"},{"text":"Swagger","type":"text","marks":[{"type":"link","attrs":{"href":"https://tcms.aiojiraapps.com/aio-tcms/aiotcms-static/api-docs/#/Execution%20management/addAttachmentsToLatestRun"}}]},{"text":"]","type":"text"}]},{"type":"paragraph","content":[{"text":"Users can choose to upload an attachment to cases in the cycle as evidence. There are two attachment APIS, one to attach to the latest run of a case, which takes as input just the case ID, and the other API is to attach to an older run or a specific run. The below sample code can be used in hooks of frameworks to attach files:","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class AIOUploadAttachment {\n public static final String UPLOAD_EVIDENCE = \"/project/{projectKey}/testcycle/{cycleKey}/testcase/{caseKey}/attachment\";\n private static RequestSpecification defaultRequestSpec;\n\n public static void main(String[] args) {\n\n setupAIORestAssuredConfig();\n\n attachEvidence(\"NVTES\", \"NVTES-CY-628\",\"NVTES-TC-3\", \"\");\n }\n\n private static void attachEvidence(String projectKey, String cycleKey, String testcaseKey, String fileName) {\n File f = new File(fileName);\n doMultipartPost(UPLOAD_EVIDENCE, f, projectKey, cycleKey, testcaseKey);\n }\n\n public static Response doMultipartPost(String path, File file, Object ...pathParams) {\n Response response = given(defaultRequestSpec).multiPart(\"file\", file).when().post(path,pathParams).andReturn();\n response.prettyPrint();\n return response;\n }\n\n public static void setupAIORestAssuredConfig() {\n RequestSpecBuilder builder = new RequestSpecBuilder();\n builder.setBaseUri(\"https://tcms.aiojiraapps.com\").setBasePath(\"/aio-tcms/api/v1\");\n builder.addHeader(\"Authorization\", \"AioAuth \");\n builder.log(LogDetail.METHOD).log(LogDetail.URI);\n defaultRequestSpec = builder.build();\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"dependencies"},"legacyAnchorId":{"value":"CodeSample-Java-dependencies"}},"macroMetadata":{"macroId":{"value":"dfea592cab1506487dc1427eba25f76f1fc5bac353fcb90fa6484fba37796930"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"39390a7e-8f6a-4826-a8b9-b2429370a45c"}},{"text":"Dependencies","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n io.rest-assured\n rest-assured\n 4.3.1\n compile\n\n\n com.google.code.gson\n gson\n 2.8.6\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"For further queries and suggestions, please feel free to reach out to our customer support service via ","type":"text","marks":[{"type":"strong"}]},{"text":"help@aiotests.com","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"link","attrs":{"href":"mailto:help@aiotests.com"}}]},{"text":".","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported