|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- # Public APIs Scripts
-
- This directory contains all validation and testing scripts used by Public APIs.
-
- ```bash
- scripts
- │ github_pull_request.sh # used to validate changes of a pull request
- │ requirements.txt # contains dependencies of validate package
- │
- ├───tests # contains all unit tests from the validate package
- │ test_validate_format.py
- │ test_validate_links.py
- │
- └───validate # validate package
- format.py
- links.py
- ```
-
- ## Run validations
-
- To run format validation on the `README.md` file, being in the root directory of public-apis, run:
-
- ```bash
- $ python scripts/validate/format.py README.md
- ```
-
- To run link validation on the `README.md` file, being in the root directory of public-apis, run:
-
- ```bash
- $ python scripts/validate/links.py README.md
- ```
-
- ## Running Tests
-
- To run all tests it is necessary to change to the scripts directory:
-
- ```bash
- $ cd scripts
- ```
-
- then run:
-
- ```bash
- $ python -m unittest discover tests/ --verbose
- ```
-
- To run only the format tests, run:
-
- ```bash
- $ python -m unittest discover tests/ --verbose --pattern "test_validate_format.py"
- ```
-
- To run only the links tests, run:
-
- ```bash
- $ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py"
- ```
-
- *Note that it is necessary to have [python](https://www.python.org/) installed.*
|