{"id":19845406,"url":"https://github.com/qavajs/xray-formatter","last_synced_at":"2025-05-01T21:30:33.236Z","repository":{"id":163107467,"uuid":"633867431","full_name":"qavajs/xray-formatter","owner":"qavajs","description":"xray formatter for qavajs framework","archived":false,"fork":false,"pushed_at":"2023-11-17T10:18:18.000Z","size":68,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-29T03:01:10.075Z","etag":null,"topics":["qa","test-automation","testing"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qavajs.png","metadata":{"files":{"readme":"README.MD","changelog":"CHANGELOG.MD","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-04-28T13:16:20.000Z","updated_at":"2024-02-07T14:36:28.000Z","dependencies_parsed_at":"2023-11-17T11:45:02.419Z","dependency_job_id":null,"html_url":"https://github.com/qavajs/xray-formatter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fxray-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fxray-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fxray-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fxray-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qavajs","download_url":"https://codeload.github.com/qavajs/xray-formatter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224278483,"owners_count":17285080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["qa","test-automation","testing"],"created_at":"2024-11-12T13:07:38.205Z","updated_at":"2025-05-01T21:30:33.227Z","avatar_url":"https://github.com/qavajs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @qavajs/xray-formatter\n\nXray formatter for cucumber framework\n\n### Installation\nTo install formatter run\n\n`npm install @qavajs/xray-formatter`\n\nadd to formatter section in config file\n \ncloud configuration:\n```javascript\nexport default {\n    format: ['@qavajs/xray-formatter:report/xray.out'],\n    formatOptions: {\n        xray: {\n            client_id: 'client_id', // generated client_id from xray cloud\n            client_secret: 'client_secret', // generated client_id from xray client_secret\n            testExecutionKey: 'ABC-12', // test execution jira key to send result\n            tagRegexp: 'TEST_(.+)', // optional, parse tag regexp. default /@(.+-\\d+)/\n            requestsPerSecond: 1 // optional, requests to Xray per second (to prevent rate limit error)\n        }\n    }\n}\n```\n\nserver configuration:\n```javascript\nexport default {\n    format: ['@qavajs/xray-formatter:report/xray.out'],\n    formatOptions: {\n        xray: {\n            endpoint: 'https://your.jira.instance/jira', //jira api endpoint\n            client_secret: 'client_secret', // personal access key from jira instance\n            testExecutionKey: 'ABC-12', // test execution jira key to send result\n            tagRegexp: 'TEST_(.+)', // optional, parse tag regexp. default /@(.+-\\d+)/\n            requestsPerSecond: 1 // optional, requests to Xray per second (to prevent rate limit error)\n        }\n    }\n}\n```\n\n### How it works?\nPlugin reads all tags in jira key format (@ABCD-123) or ones that matches `tagRegexp` and update corresponding scenarios in provided test execution\n\n### Development\n`npm install`\n\nadd config file xrayConfig.ts to test-e2e\n\n### F.A.Q\n- Does it work with Jira Server?\n  \n  Yes\n  \n- What if multiple automated test cases are mapped to one Xray test case?\n\n  The Xray test will fail if any one of the test cases fails.\n  \n- What multiple xray cases mapped to one test automation case?\n  \n  All mapped test cases will get same status\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqavajs%2Fxray-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqavajs%2Fxray-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqavajs%2Fxray-formatter/lists"}