Development

Testing

Our tests are inside tests/. Tests are implemented using pytest.

Install the latest code from git

To begin developing, check out the code from github:

$ git clone [email protected]:vcs-python/vcspull.git
$ cd vcspull

Now create a virtualenv, if you don’t know how to, you can create a virtualenv with:

$ virtualenv .venv

Then activate it to current tty / terminal session with:

$ source .venv/bin/activate

Good! Now let’s run this:

$ pip install -r requirements/test.txt -e .

This has pip, a python package manager install the python package in the current directory. -e means --editable, which means you can adjust the code and the installed software will reflect the changes.

Test Runner

As you seen above, the vcspull command will now be available to you, since you are in the virtual environment, your PATH environment was updated to include a special version of python inside your .venv folder with its own packages.

$ make test

You probably didn’t see anything but tests scroll by.

If you found a problem or are trying to write a test, you can file an issue on github.

Test runner options

Test only a file:

$ py.test tests/test_config.py

will test the tests/test_config.py tests.

$ py.test tests/test_config::test_export_json

tests test_export_json inside of tests/test_config.py.

Multiple can be separated by spaces:

$ py.test tests/test_{window,pane}.py tests/test_config.py::test_export_json