Skip to content

Commit

Permalink
docs: update Technical requirements for the reporters
Browse files Browse the repository at this point in the history
Add a description of signature.
  • Loading branch information
gibiw committed Jun 20, 2024
1 parent 1efd7bb commit c1abc37
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Technical requirements for the reporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,20 @@ This method should contain the path or paths to the files and create the attachm

Each reporter should support the parametrize tests.
The reporter should collect the parameters and the values as key-value pairs.

### Signature

Each reporter should support the signature. It is a unique identifier for the test.
The signature should be collected automatically and be unique for each test.

Signature should be in lower case and without spaces (replace to `_`).

The signature should contain the following information:
- the test file path, for example: `src/test/java/com/qase/tests/MyTest.java` -> `src::test::java::com::qase::tests::mytest.java`
- the test class name, for example: `mytest`
- the test method name, for example: `testmethod`
- the qase id if it is defined, for example: `123`
- the parameters if they are defined, for example: `{param1:value1}`

Example of the signature: `src::test::java::com::qase::tests::mytest.java::mytest::testmethod::123::{param1:value1}::{param2::value2}`

0 comments on commit c1abc37

Please sign in to comment.