Discoverer - S41nz/TBTAF GitHub Wiki
The Discoverer is the module in charge of parsing the TBTAF metadata embedded on source code (both test and production) and communicate the discovered data to the TBTAF Orchestrator.
-
Inputs:
- String specifying the directory where the tests are contained or the complete filepath to a single test.
-
Outputs:
- A collection of
TBTestCase
instances with their correspondingTBMetatadata
instances of describing the metadata being discovered on the source code of each test within the provided location.- Any file which matches the following criteria will be ignored:
- It contains no metadata or contains badly formed metadata.
- It doesn't include a required field or the field is empty (i.e.
<Tags></Tags>
or<TestID></TestID>
).
- Any file which matches the following criteria will be ignored:
- A collection of
-
Exceptions:
- If the provided location is either null or inaccessible then a DataValue Exception will be thrown.
-
Inputs:
- String specifying the directory where specific production source code files are contained or the complete filepath to a single file.
-
Outputs:
- A collection of
TBMetadata
instances describing the metadata being discovered on the source code of each test within the provided locations.- Any file which matches the following criteria will be ignored:
- It contains no metadata or contains badly formed metadata.
- It doesn't include a required field or the field is empty (i.e.
<Tags></Tags>
).
- Any file which matches the following criteria will be ignored:
- A collection of
-
Exceptions:
- If the provided locations are either null or non-existent then a DataValue Exception will be thrown.
At the top of the file, within a mutli-line comment region, this must be inserted
<TBTAF>
<TestID>XXXX</TestID>
<Tags>Tag1,Tag2,etc</Tags>
<Priority>[1-5]</Priority> (Optional)
<Description>Description of my test</Description> (Optional)
</TBTAF>
At the top of the file, within a mutli-line comment region, this must be inserted
<TBTAF>
<Tags>Tag1,Tag2,etc</Tags>
</TBTAF>`