Skip to content

Latest commit

 

History

History
68 lines (57 loc) · 7.21 KB

CONTRIBUTING.md

File metadata and controls

68 lines (57 loc) · 7.21 KB
Raw

Contribution guidelines

How to contribute

If you are able and willing to contribute to the TestRail CLI, you are welcome to, just follow the steps below:

  1. Create an issue according using our pre-defined templates
  2. Add a comment stating your intention and a high level description of the solution you propose to implement
  3. Wait for approval before starting to code
  4. Implement solution and create pull request using the available template
  5. If everything goes according to plan, the pull request will be merged and a new version will be released :)

Coding guidelines

Unit tests

Executing the unit tests

Ensure testing libraries are installed. In the root directory, run:

python3 -m pip install -r ./tests/requirements.txt

To run all tests:

python3 -m pytest -c ./tests/pytest.ini -W ignore::pytest.PytestCollectionWarning --alluredir=./allure-results

List of all test markers can be found by running:

pytest --markers -c ./tests/pytest.ini

Folder structure

Folder description
helpers modules used during the tests usually to prepare needed data
test_data data used during the tests (files with input data, expected results, structures passed as pytest.mark.parameters etc.)

CLI App

Folder structure

Folder module description
api - modules to be used to communicate with TestRail over API.
api api_client Used for basic communication with TestRail over API. Handles retries and timeouts.
api api_request_handler Used for API communication with TestRail (getting and adding resources). It uses api_client for basic communication and api_data_provider to get bodies from internal data classes.
api api_response_verify Used for verifying the response from TestRail.
api results_uploader Used for uploading the results into TestRail instance.
commands - commands that extends parsing functionality. For more details please check Parsers section.
commands cmd_parse_junit Junit parser command. It's used together with cli module. The idea is to have separate commands for different file parsers. This way it should be easier to extend trcli in case other result file format needs to be parsed.
data_classes - modules that are responsible for storing data parsed from result files in unified format
data_classes dataclass_testrail Used to store data parsed from result file. Contains common structures that are reflecting data structures within TestRail. Each reader should parse result file to those structures.
data_classes validation_exception Exception raised on validation errors
data_providers - module that is responsible for creating bodies for API calls
data_providers api_data_provider Module that is responsible for creating bodies for API calls
readers - modules that are responsible for parsing result files into internal data classes. Check Parsers section for more details
readers file_parser Contains basic abstract class to be used to create all results parsers.
readers junit_xml Junit result file parser. Used to parse result files into internal data structures.
root constants Contains constants used in whole code (error messages, prompt slogans, --help related strings etc.)
root settings Multithreading and some default settings.
root cli Main cli module responsible for parsing parameters from command line. It parses all parameters and runtime information into Environment class.

Parsers

Parsers are located in /trcli/readers/. To add a new parser please read the desired file and fill required dataclasses with the data (located in /trcli/data_classes/).

Sending information to user (logging/prompting)

For printing messages on console and prompting users functions from Environment class should be used. Those functions handle --silent/--verbose/--yes/--no parameters properly.