{"id":18995325,"url":"https://github.com/testpointcorp/applitools-vansah-java-integration","last_synced_at":"2026-01-27T13:33:54.643Z","repository":{"id":249214329,"uuid":"822719303","full_name":"testpointcorp/applitools-vansah-java-integration","owner":"testpointcorp","description":"This tutorial guides you through the process of integrating Applitools with Vansah Test Management for Jira using Java to automatically send your test case results.","archived":false,"fork":false,"pushed_at":"2024-07-26T06:54:55.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-02T09:35:32.360Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/testpointcorp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T17:17:39.000Z","updated_at":"2024-07-26T06:54:58.000Z","dependencies_parsed_at":"2024-11-08T17:32:39.580Z","dependency_job_id":"8883ec85-666e-4fcd-b40d-5622db0c86e1","html_url":"https://github.com/testpointcorp/applitools-vansah-java-integration","commit_stats":null,"previous_names":["testpointcorp/applitools-vansah-java-integration"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/testpointcorp/applitools-vansah-java-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testpointcorp%2Fapplitools-vansah-java-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testpointcorp%2Fapplitools-vansah-java-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testpointcorp%2Fapplitools-vansah-java-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testpointcorp%2Fapplitools-vansah-java-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/testpointcorp","download_url":"https://codeload.github.com/testpointcorp/applitools-vansah-java-integration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testpointcorp%2Fapplitools-vansah-java-integration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28813539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T12:25:15.069Z","status":"ssl_error","status_checked_at":"2026-01-27T12:25:05.297Z","response_time":168,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T17:30:00.156Z","updated_at":"2026-01-27T13:33:54.638Z","avatar_url":"https://github.com/testpointcorp.png","language":"Java","readme":"# Applitools Integration with Vansah Test Management For Jira\nFollow the instructions below to integrate [Applitools](https://applitools.com/) with [`Vansah Test Management`](https://marketplace.atlassian.com/apps/1224250/vansah-test-management-for-jira?tab=overview\u0026hosting=cloud) for Jira using Java. The integration will allow you to send your Test Case results to Vansah\n\n## Prerequisites\n- Applitools - [Applitools](https://applitools.com/) project is already set up with the API token properly configured in the environment variables.\n- Make sure you have installed all your Maven and TestNG dependencies.\n\t\n- Vansah Binding - Download VansahNode.java file from this repo [`VansahNode.java`](https://github.com/testpointcorp/Vansah-API-Binding-Java/blob/prod/src/main/java/com/vansah/VansahNode.java).\n- Make sure that [`Vansah`](https://marketplace.atlassian.com/apps/1224250/vansah-test-management-for-jira?tab=overview\u0026hosting=cloud) is installed in your Jira workspace\n- You need to Generate  [`Vansah connect`](https://help.vansah.com/en/articles/9824979-generate-a-vansah-api-token-from-jira) token to authenticate with Vansah APIs.\n\n## Configuration\n**Setting Environment Variables** - Store your Vansah API token as an environment variable for security. \n\nFor Windows (use cmd)\n```cmd\nsetx VANSAH_TOKEN \"your_vansah_api_token_here\"\t\n```\nFor macOS\n```bash\necho export VANSAH_TOKEN=\"your_vansah_api_token_here\" \u003e\u003e ~/.bash_profile\nsource ~/.bash_profile\n```\nFor Linux (Ubuntu, Debian, etc.)\n```bash\necho export VANSAH_TOKEN=\"your_vansah_api_token_here\" \u003e\u003e ~/.bashrc\nsource ~/.bashrc\n```\n\n## Implementation\nTo enable Vansah Integration in Applitools project, follow these steps:\n\n1. Make sure you have mentioned all your Maven and TestNG dependencies in the [pom.xml](https://github.com/testpointcorp/applitools-vansah-java-integration/blob/main/pom.xml)\n       \n\t   \u003cdependencies\u003e\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003ecom.mashape.unirest\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003eunirest-java\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e1.4.9\u003c/version\u003e\n\t\t\u003c/dependency\u003e\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003eorg.seleniumhq.selenium\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003eselenium-java\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e4.8.0\u003c/version\u003e\n\t\t\u003c/dependency\u003e\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003ecom.applitools\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003eeyes-selenium-java5\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e5.57.0\u003c/version\u003e\n\t\t\t\u003cscope\u003etest\u003c/scope\u003e\n\t\t\u003c/dependency\u003e\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003eorg.testng\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003etestng\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e7.7.1\u003c/version\u003e\n\t\t\t\u003cscope\u003etest\u003c/scope\u003e\n\t\t\u003c/dependency\u003e\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003eio.github.bonigarcia\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003ewebdrivermanager\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e5.9.1\u003c/version\u003e\n\t\t\u003c/dependency\u003e\n\n\t   \u003c/dependencies\u003e\n\t\n\t\n\n2. Ensure that [`VansahBinding.java`](/src/test/java/com/vansah/VansahNode.java) is located in your package `/applitools-vansah/src/test/java`\n2. Define Vansah constants in the Java Class file: \n    ```java\n    \n    private String testCaseKey; // Mandatory: Vansah Test Case Key\n\n    // Mandatory: Provide Issue Key or Test Folder ID to which the Test Case is associated\n    private String jiraIssueKey = \"TEST-5\"; \n\n    private String testedSprint = \"TEST Sprint 1\"; //The sprint during which the test was conducted\n    private String testedEnv = \"STAGING\";    // The environment in which the test was conducted\n    private String testedVersion = \"v1\"; // The version of the software tested\n\n    private int result = 2; // Default value `2`: \"passed\"\n    private VansahNode vansahTest; // VansahNode object to manage test details\n\n\t\n    ```\n3. Set up Vansah Variables in setupBeforeEachTest() with `@BeforeMethod` Annotation\n    ```Java\n    @BeforeMethod\n     public void setupBeforeEachTest() throws MalformedURLException {\n    // Set up Vansah Test Variables\n    vansahTest = new VansahNode(); // Initialize a new VansahNode object\n\n    // Set the Vansah token using an environment variable\n    vansahTest.setVansahToken(System.getenv(\"VANSAH_TOKEN\"));\n\n    // Set the JIRA issue key to associate the test case with the appropriate issue or set the TESTFOLDERS_ID\n    vansahTest.setJIRA_ISSUE_KEY(jiraIssueKey);\n\n    // Set the sprint name to indicate which sprint the test is part of\n    vansahTest.setSPRINT_NAME(testedSprint);\n\n    // Set the environment name to specify the environment in which the test is executed\n    vansahTest.setENVIRONMENT_NAME(testedEnv);\n\n    // Set the release name to denote the version of the software being tested\n    vansahTest.setRELEASE_NAME(testedVersion);\n    \n    ```\n4. Add Test Case Key value to each of your Test\n    ```java\n    @Test\n\tpublic void landingPage() {\n\n\t\t//Vansah Test Case Key\n\t\ttestCaseKey = \"TEST-C8\";\n\t\t/**\n\t\t Your Test logic\n\t\t**/\n\t}\n\n    ```\n5.   Set up to `send` the results to Vansah in cleanUpAfterEachTest() with      `@AfterMethod` Annotation\n     ```Java\n     @AfterMethod\n        public void cleanUpAfterEachTest() throws Exception {\n \n        // Close Eyes to tell the server it should display the results.\n        eyes.closeAsync();\n\n        // Quit the WebDriver instance.\n        driver.quit();\n        try {\n            // Get all test results from the runner and print them.\n            TestResultsSummary allTestResults = runner.getAllTestResults();\n            System.out.println(allTestResults);\n        } catch (Exception e) {\n            // If any exception occurs, set the result to \"failed\" (1) and print the error message.\n            result = 1;\n            System.out.println(e.getMessage());\n        } catch (DiffsFoundException e) {\n            // If differences are found, set the result to \"failed\" (1) and print the error message.\n            result = 1;\n            System.out.println(e.getMessage());\n        } finally {\n            // Add the test result to Vansah from Jira Issue with the specified testCaseKey and result.\n            vansahTest.addQuickTestFromJiraIssue(testCaseKey, result);\n        }\n        }\n**Please note :** If you encounter any other Exception, **catch** it here, set result=1 to log the result as **failed** in Vansah. \n### \nBy following the above steps, your Applitools project will be equipped to send test run results directly to Vansah, streamlining your testing and reporting process.\n\nEnsure that all files are placed and configured as described to facilitate successful integration.\n\nFor more details on Applitools, visit the [docs](https://applitools.com/docs/index.html).\n\nFor Vansah specific configurations and API details, please refer to the [Vansah API documentation](https://apidoc.vansah.com/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestpointcorp%2Fapplitools-vansah-java-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftestpointcorp%2Fapplitools-vansah-java-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestpointcorp%2Fapplitools-vansah-java-integration/lists"}