Skip to content

chore: update docs #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
taipoxinous merged 1 commit into from
Aug 31, 2026
Merged

chore: update docs #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions testit-adapter-behave/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Description of tags:
- `Labels` - labels listed in the autotest card
- `Tags` - tags listed in the autotest card
- `Links` - links listed in the autotest card
- `Layer` - test pyramid layer on the autotest card (source `Run`). Recommended values: `E2E`, `UI`, `API`, `Contract`, `Integration`, `Component`, `Unit`; any non-empty string is accepted
- `NameSpace` - directory in the TMS system (default - file's name of test)
- `ClassName` - subdirectory in the TMS system (default - class's name of test)

Expand Down Expand Up @@ -196,6 +197,7 @@ Feature: Sample
@Title=Title_in_the_autotest_card
@Description=Test_with_all_annotations
@Tags=Tag1,Tag2
@Layer=API
@Links={"url":"https://dumps.example.com/module/repository","title":"Repository","description":"Example_of_repository","type":"Repository"}
Scenario: Create new project, section and test case
When I create a project
Expand Down
8 changes: 8 additions & 0 deletions testit-adapter-nose/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Description of decorators:
- `testit.labels` - labels listed in the autotest card
- `testit.tags` - tags listed in the autotest card
- `testit.links` - links listed in the autotest card
- `testit.layer` - test pyramid layer on the autotest card (source `Run`). Recommended values: `testit.TestLayers` (`E2E`, `UI`, `API`, `Contract`, `Integration`, `Component`, `Unit`); any non-empty string is accepted
- `testit.step` - the designation of the step called in the body of the test or other step
- `testit.nameSpace` - directory in the TMS system (default - file's name of test)
- `testit.className` - subdirectory in the TMS system (default - class's name of test)
Expand Down Expand Up @@ -162,6 +163,13 @@ def oneOneStep():
@testit.step('step 2')
def oneTwoStep():
return True


# Layer on autotest card
@testit.externalId('api_layer_test')
@testit.layer(testit.TestLayers.API)
def test_with_layer():
assert True
```

#### Parameterized test
Expand Down
15 changes: 15 additions & 0 deletions testit-adapter-pytest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Description of decorators:
- `testit.labels` - labels listed in the autotest card
- `testit.tags` - tags listed in the autotest card
- `testit.links` - links listed in the autotest card
- `testit.layer` - test pyramid layer on the autotest card (source `Run`). Recommended values: `testit.TestLayers` (`E2E`, `UI`, `API`, `Contract`, `Integration`, `Component`, `Unit`); any non-empty string is accepted. Also supported as `@pytest.mark.layer("API")`
- `testit.step` - the designation of the step called in the body of the test or other step
- `testit.nameSpace` - directory in the TMS system (default - file's name of test)
- `testit.className` - subdirectory in the TMS system (default - class's name of test)
Expand Down Expand Up @@ -186,6 +187,20 @@ def oneTwoStep():
@pytest.mark.skipif(True, reason='Because i can')
def test_skip():
assert True


# Layer via decorator
@testit.externalId('api_layer_test')
@testit.layer(testit.TestLayers.API)
def test_with_layer_decorator():
assert True


# Layer via pytest mark
@testit.externalId('ui_layer_test')
@pytest.mark.layer("UI")
def test_with_layer_mark():
assert True
```

#### Parameterized test
Expand Down
10 changes: 10 additions & 0 deletions testit-adapter-robotframework/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Description of tags:
- `testit.links` - links listed in the autotest card
- `testit.labels` - labels listed in the autotest card
- `testit.tags` - tags listed in the autotest card
- `testit.layer` - test pyramid layer on the autotest card (source `Run`). Recommended values: `E2E`, `UI`, `API`, `Contract`, `Integration`, `Component`, `Unit`; any non-empty string is accepted
- `testit.nameSpace` - directory in the TMS system (default - file's name of test)
- `testit.className` - subdirectory in the TMS system (default - class's name of test)

Expand Down Expand Up @@ -209,11 +210,20 @@ Test With All Params
[Tags] testit.externalID:123 testit.title:${{'Different title'}} testit.displayName:${{'Different name'}}
... testit.description:${{'Different description'}} testit.workitemsID:${{[123, '456']}}
... testit.links:${{{'url': 'http://google.com', 'type':'Issue'}}} testit.labels:${{['smoke', 'lol']}}
... testit.layer:API
[Setup] Setup
Log Something
Log Another
[Teardown] Teardown

Test With Layer
[Tags] testit.layer:API
[Setup] Setup
Do Something
Do Another Thing
Log I'am a step
[Teardown] Teardown

Test With Add Link
[Setup] Setup
Do Something
Expand Down
Loading