pytest-config 0.0.8

Base configurations and utilities for developing your Python project test suite.

# pytest-config

Base configurations and utilities for developing your Python project test suite.

## Installation

pip install git+git://github.com/buzzfeed/pytest_config.git@<version>#egg=pytest_config==<version>

This will install:

- pytest_config `py.test` plugin
- a simple django app that extends the `django-admin.py startapp` (under development).
- a `pytest_config.init` command to initialize new config files
- a `pytest_config.update` command to interactively update your config files
against the lates default values.

## Features

### Automatic fix for the sys.path known issue.

`pytest_config` takes care of the `sys.path`
[known issue between pytest and pytest-django](http://pytest-django.readthedocs.org/en/latest/faq.html#i-see-an-error-saying-could-not-import-myproject-settings)
by fake-installing your project, adding a simple `setup.py` if necessary.

### Config files management

##### pytest_config.init

This command will copy all the configuration files needed to easily configure
`py.test` and `coverage`. Beware of this command as **it will simply replace any
existing config files in you current directory**.

##### pytest_config.update

This command will read the default configuration files and your customized
configuration files. If any of the options in you custom configuration differs
from the defaults, you will be prompted if you want to keep the current one.
If you decline, the default will be saved to your local configuration.

##### Available options

The two previous commands share a few of their interface, which is as follows:

Print the help page.

$ pytest_config.update -h

Make the command apply its operations only for the `.coveragerc` file.

$ pytest_config.[init|update] --coverage

Make the command apply its operations only for the `pytest.ini` file.

$ pytest_config.[init|update] --pytest-ini

`pytest_config.update` has additional options, though:

Silence the process so that you are not prompted about anything.
All the defaults will be automatically applied if you use this.

$ pytest_config.update -y

If for any reason your project fake installation breaks, you can fix it by calling:

$ pytest_config.update -p

### Automatic test marking

pytest_config automatically marks your tests at runtime with markers based on
what directories the tests are in, so under this architecture:

project_root/
app_name/
tests/ # root `tests` directory
├── __init__.py
└── app_name/
├── __init__.py
├── integration/
│   ├── __init__.py
│ └── test_foo.py
└── unit/
├── __init__.py
   └── test_bar.py

- test functions/methods inside `app_name/unit/*.py` will be marked with
`@pytest.mark.<app_name>` and `@pytest.mark.unit`
- test functions/methods inside `app_name/integration/*.py` will be marked with
`@pytest.mark.<app_name>` and `@pytest.mark.integration`

and so on. This will allow you to run tests on a per-app and per-type basis by running:

$ py.test -m unit
$ py.test -m integration
$ py.test -m app_name
$ py.test -m 'app_name and <type>'
$ py.test -m '<type> and app_name'

### Integration with Caliendo

The following command line arguments have been added to `py.test` to integrate it
smoothly with [caliendo](https://github.com/buzzfeed/caliendo).

##### --caliendo

Enable the overall use of `caliendo` in your tests.

$ py.test --caliendo

##### --caliendo-prefix *

Set the path to where the caliendo files should live. If you are defining this
yourself, it's recommended that you set it as a path relative to your current
working directory, i.e. `caliendo`, `./caliendo`, `whatever/caliendo` and not
as an absolute path. Defaults to `$PWD/caliendo`.

$ py.test --caliendo --caliendo-prefix [path_to_caliendo_files]

##### --caliendo-purge *

Set the `CALIENDO_PURGE` environment variable so that caliendo can get rid of
unused cache, evs, etc.

$ py.test --caliendo --caliendo-purge

##### --caliendo-prompt *

Set the `CALIENDO_PROMPT` environment variable so that you may use the
[interactive prompt built in caliendo](https://github.com/buzzfeed/caliendo#configuration).

$ py.test --caliendo --caliendo-prompt

\* *This requires the `--caliendo` option to be present*


# History

### 0.0.8 (2014-06-19)

* Cleanup and organization for releasing to PyPI.
* Added MANIFEST.in
* Moved `pytest_config.django` Django app to just `pytest_config`.

### 0.0.7 (2014-06-16)

* Added `--runslow` option to run tests marked as slow tests.
* Added `pytest-django` as package requirement since this is meant to be used
within Django projects.
* `pep8>=1.5.6` as package requirement as this version supports more PEP8 rules.

### 0.0.6 (2014-06-05)

* Fixed bug when detecting parsing DJANGO_SETTINGS_MODULE and checking
availability of such.

### 0.0.5 (2014-05-30)

* Added support for lowercase `django_settings_module` ini value in pytest.ini.
* Added `-y`, `--overwrite` to `pytest_config.update` that will make the script
automatically overwrite the user configurations with the defaults.
* Added `-p`, `--fix-path` to only fix the pytest-django known issue.
* `pretty._print_*` is now `pretty.print_*`.

### 0.0.4 (2014-05-22)

* Refactored `_print_color` to make text coloring function `colorize_text`
importable and reusable over apps using `pytest_config`.

### 0.0.3 (2014-05-15)

* Added `--fix-path-issues` option to inspect the current django project and
check whether the project is available in the `PYTHON_PATH` for `py.test`;
if not, add it to the pat by installing in via a simple `setup.py` file.
* Made `pytest_config.init` and `pytest_config.update` more verbose.

## 0.0.2 (2014-05-13)

* Added commands to initialize and interactively update the configuration files.
* Checking last version of configuration files before running the tests.
* If no information of configuration files last version is available,
print an error message and terminate tests execution until this information
is available.
* If the version seems outdated, print a warning suggesting the user to run
the updater command.

## 0.0.1 (2014-05-08)

* First release as having initial configurations.
* Caliendo-friendly command arguments available.