# Test IT TMS adapters for Playwright ![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/main/images/banner.png) ## Getting Started ### Installation ``` npm install testit-adapter-playwright ``` ## Usage ### Configuration #### Log level The adapter includes a custom logger; the default level is `warn`. Set another level at runtime with the `LOG_LEVEL` environment variable: `error`, `warn`, `info`, or `debug`. | Description | File property | Environment variable | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------| | Location of the TMS instance | url | TMS_URL | | API secret key [How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken) | privateToken | TMS_PRIVATE_TOKEN | | ID of project in TMS instance [How to getting project ID?](https://github.com/testit-tms/.github/tree/main/configuration#projectid) | projectId | TMS_PROJECT_ID | | ID of configuration in TMS instance [How to getting configuration ID?](https://github.com/testit-tms/.github/tree/main/configuration#configurationid) | configurationId | TMS_CONFIGURATION_ID | | ID of the created test run in TMS instance.
It's necessary for **adapterMode** 1 | testRunId | TMS_TEST_RUN_ID | | Parameter for specifying the name of test run in TMS instance (**It's optional**). If it is not provided, it is created automatically | testRunName | TMS_TEST_RUN_NAME | | Tags of the test run in TMS (**It's optional**). Comma-separated list or JSON array of strings. Applied on create (adapterMode 2) or merged at startup for an existing run. Not the same as autotest tags. | testRunTags | TMS_TEST_RUN_TAGS | | Links of the test run in TMS (**It's optional**). JSON array of objects with required `url` and optional `title`, `description`, `type`. Applied on create or merged at startup so a CI job URL is visible while the run is In Progress. Link types: `Related`, `BlockedBy`, `Defect`, `Issue`, `Requirement`, `Repository`. | testRunLinks | TMS_TEST_RUN_LINKS | | Adapter mode. Default value - 1. The adapter supports following modes:
1 - in this mode, the adapter sends all results to the test run without filtering or [with filtering CLI](#run-with-filter)
2 - in this mode, the adapter creates a new test run and sends results to the new test run | adapterMode | TMS_ADAPTER_MODE | | It enables/disables certificate validation (**It's optional**). Default value - true | certValidation | TMS_CERT_VALIDATION | | Mode of automatic creation test cases (**It's optional**). Default value - false. The adapter supports following modes:
true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)
false - in this mode, the adapter will not create a test case | automaticCreationTestCases | TMS_AUTOMATIC_CREATION_TEST_CASES | | Mode of automatic updation links to test cases (**It's optional**). Default value - false. The adapter supports following modes:
true - in this mode, the adapter will update links to test cases
false - in this mode, the adapter will not update link to test cases | automaticUpdationLinksToTestCases | TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES | | Logger level, default value is `warn`, available values: [`error`, `warn`, `info`, `debug`] | | LOG_LEVEL | Add Adapter to Playwright file configuration: ```ts import { PlaywrightTestConfig } from '@playwright/test'; const config: PlaywrightTestConfig = { reporter: [ ['testit-adapter-playwright'] ], }; export default config; ``` #### File Create .env config or file config with default name tms.config.json in the root directory of the project ```json { "url": "URL", "privateToken": "USER_PRIVATE_TOKEN", "projectId": "PROJECT_ID", "configurationId": "CONFIGURATION_ID", "testRunId": "TEST_RUN_ID", "testRunName": "TEST_RUN_NAME", "testRunTags": ["smoke", "nightly"], "testRunLinks": [ { "url": "https://gitlab.example.com/group/project/-/jobs/12345", "title": "CI Job", "type": "Related" } ], "adapterMode": "ADAPTER_MODE", "automaticCreationTestCases": "AUTOMATIC_CREATION_TEST_CASES", "automaticUpdationLinksToTestCases": "AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES" } ``` #### Parallel run To create and complete TestRun you can use the Test IT CLI (use adapterMode 1 for parallel run): ``` $ export TMS_TOKEN= $ testit testrun create --url https://tms.testit.software \ --project-id 5236eb3f-7c05-46f9-a609-dc0278896464 \ --testrun-name "New test run" \ --output tmp/output.txt $ export TMS_TEST_RUN_ID=$(cat tmp/output.txt) $ npx playwright test $ testit testrun complete --url https://tms.testit.software \ --testrun-id $(cat tmp/output.txt) ``` #### Run with filter To create filter by autotests you can use the Test IT CLI (use adapterMode 1 for run with filter): ``` $ export TMS_TOKEN= $ testit autotests_filter --url https://tms.testit.software \ --configuration-id 5236eb3f-7c05-46f9-a609-dc0278896464 \ --testrun-id 6d4ac4b7-dd67-4805-b879-18da0b89d4a8 \ --framework playwright \ --output tmp/filter.txt $ export TMS_TEST_RUN_ID=6d4ac4b7-dd67-4805-b879-18da0b89d4a8 $ export TMS_ADAPTER_MODE=1 $ npx playwright test --grep "$(cat tmp/filter.txt)" ``` #### Launch using GitLab repository To run your Playwright test's from GitLab to TestIT or in reverse order using "testit-adapter-playwright", you can take this .gitlab-ci.yml file example: ``` image: node:latest stages: - run first-job: stage: run script: - npm install - npx playwright test artifacts: paths: - node_modules/ ``` ### Methods Methods can be used to specify information about autotest. Description of metadata methods: - `testit.workItemIds` - linking an autotest to a test case - `testit.displayName` - name of the autotest in the Test IT system (can be replaced with documentation strings) - `testit.externalId` - ID of the autotest within the project in the Test IT System - `testit.title` - title in the autotest card - `testit.description` - description in the autotest card - `testit.labels` - labels in the autotest card - `testit.tags` - tags in the autotest card - `testit.links` - links in the autotest card - `testit.namespace` - directory in the TMS system (default - directory's name of test) - `testit.classname` - subdirectory in the TMS system (default - file's name of test) Description of methods: - `testit.addLinks` - links in the autotest result - `testit.addAttachments` - uploading files in the autotest result - `testit.addMessage` - information about autotest in the autotest result - `testit.step` - information about step in the autotest result ### Examples #### Simple test ```js import { test } from "@playwright/test"; import { testit } from "testit-adapter-playwright"; test('All annotations', async () => { testit.externalId('all_annotations'); testit.displayName('All annotations'); testit.title('All annotations title'); testit.description('Test with all annotations'); testit.labels(['label1', 'label2']); testit.addMessage('This is a message'); testit.addLinks([ { url: 'https://www.google.com', title: 'Google', description: 'This is a link to Google', type: 'Related', }, ]); testit.addAttachment('file01.txt', 'Content', {contentType: "text/markdown",}); await testit.step("step with title", async () => { }); }); ``` #### Parameterized test > [!WARNING] > When linking a parameterized autotest to a parameterized test case, please consider the problematic points: > - In TMS test cases have a table with parameters, but autotests do not. They are not equal entities, so there may be incompatibility in terms of parameters > - Running a parameterized test case, TMS expects the results of all related autotests with all the parameters specified in the test case table > - In TMS, the parameters are limited to the string type, so the adapter transmits absolutely all the autotest parameters as a string. This implies the following problematic point for the test case table > - TMS expects a complete **textual** match of the name and value of the parameters of the test case table with the autotest parameters ```js const people = ['Alice', 'Bob']; for (const name of people) { test(`testing with ${name}`, async () => { testit.params(people); }); } ``` #### Content types ``` TEXT = "text/plain", XML = "application/xml", HTML = "text/html", CSV = "text/csv", TSV = "text/tab-separated-values", CSS = "text/css", URI = "text/uri-list", SVG = "image/svg+xml", PNG = "image/png", JSON = "application/json", ZIP = "application/zip", WEBM = "video/webm", JPEG = "image/jpeg", MP4 = "video/mp4", ``` # Contributing You can help to develop the project. Any contributions are **greatly appreciated**. * If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/adapters-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes. * Please make sure you check your spelling and grammar. * Create individual PR for each suggestion. * Please also read through the [Code Of Conduct](https://github.com/testit-tms/adapters-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well. # License Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/adapters-js/blob/master/LICENSE.md) for more information.