Playwright adapter for Test IT
npm install testit-adapter-playwright
npm install testit-adapter-playwright
Usage
$3
| Description | File property | Environment variable |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------|
| Location of the TMS instance | url | TMS_URL |
| API secret key How to getting API secret key? | privateToken | TMS_PRIVATE_TOKEN |
| ID of project in TMS instance How to getting project ID? | projectId | TMS_PROJECT_ID |
| ID of configuration in TMS instance How to getting configuration ID? | 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 |
| 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
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 |
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",
"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:lateststages:
- run
first-job:
stage: run
script:
- npm install
- npx playwright test
artifacts:
paths:
- node_modules/
$3
Methods can be used to specify information about autotest.
Description of metadata methods:
-
- 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 - tags in the work item
- 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$3
#### 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
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",
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 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 before posting your first idea as well.
Distributed under the Apache-2.0 License. See LICENSE for more information.