Start a HACKING.md file and document how to run the tests

This commit is contained in:
Stef Walter 2018-09-17 09:54:10 +02:00 committed by Brian C. Lane
parent 5cb1748908
commit e95c09dd7e
1 changed files with 31 additions and 0 deletions

31
HACKING.md Normal file
View File

@ -0,0 +1,31 @@
# Hacking on Lorax
Here's where to get the code:
$ git clone https://github.com/weldr/lorax
$ cd lorax/
How to build it:
$ make
## How to run the tests
To run the tests you need the following dependencies installed:
$ yum install python3-nose python3-pytest-mock python3-pocketlint \
python3-mock
Run the basic linting tests like this:
$ make check
To run the broader unit and integration tests we use:
$ make test
Some of the tests will be skipped unless a lorax-composer process is running
and listening on an accessible socket. Either run lorax-composer from the
checkout, or the installed version.