Skip to content
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.

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

docs: update Technical requirements for the reporters #139

Open
wants to merge 1 commit into
base: release/add_tech_doc
Choose a base branch
from
Open
Changes from all commits
Commits
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
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 package, for example: `com/qase/tests/MyTest.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}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, don’t we pass parameters separately from the signature?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes we do, but we want to include them in the signature so that it is unique for each test


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

Loading