Skip to content

Commit 8c29a12

Browse files
committed
Improve test docs
1 parent 533506d commit 8c29a12

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

tests/Behat/README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ docker compose up -d
1313
Now you can run the tests:
1414

1515
```bash
16+
# all tests
1617
docker compose exec php composer behat
18+
# only a specific redmine version
19+
docker compose exec php composer behat -- --suite=redmine_50103
20+
# only specific endpoints
21+
docker compose exec php composer behat -- --tags=issue,group
22+
# only specific endpoints on a specific redmine version
23+
docker compose exec php composer behat -- --suite=redmine_50103 --tags=issue,group
1724
```
1825

1926
## Redmine specific features
@@ -53,7 +60,7 @@ This can be handled on the `step` layer:
5360
"""
5461
```
5562

56-
### Modified Rest-API Endpoints
63+
### New Rest-API Endpoints
5764

5865
A new Redmine version could be introduce new REST-API endpoints that are missing in the older version.
5966
This can be handled on the `scenario` or `feature` layer.
@@ -88,3 +95,39 @@ default:
8895
tags: "~@since50000"
8996
9097
```
98+
99+
### Removed Rest-API Endpoints
100+
101+
A new Redmine version could remove REST-API endpoints that are missing in the newer versions.
102+
This can be handled on the `scenario` or `feature` layer.
103+
104+
1. Tag features or scenarios e.g. with `@until60000`.
105+
106+
```
107+
@until60000
108+
Feature: Interacting with the a REST API endpoint removed in 6.0.0
109+
[...]
110+
```
111+
112+
or
113+
114+
```
115+
@until60000
116+
Scenario: Using a deprecated feature
117+
Given I have a "NativeCurlClient" client
118+
And I create a project with name "Test Project" and identifier "test-project"
119+
[...]
120+
```
121+
122+
2. Exclude the tag from the specific suite in the `behat.yml` (note the `~` prefix):
123+
124+
```
125+
default:
126+
suites:
127+
[...]
128+
redmine_60000:
129+
[...]
130+
filters:
131+
tags: "~@until60000"
132+
133+
```

0 commit comments

Comments
 (0)