spiny 0.5

Command line parameters

You run Spiny from the root of the Python project that you want to test, ie the direectory that has the setup.py file.

The command line parameters are:

usage: spiny [-h] [–version] [-c <filename>] [-e <environments>] [-v] [-q]

[<configvar> [<configvar> …]]

Run tests under several Python versions.

positional arguments:

<configvar> Override a config variable by “section:variable=value”

Example: “spiny:venv-dir=.venv”

optional arguments:

-h, --help

Show this help message and exit.

--version

Show the version and exit.

-c <filename>, --config <filename>

The config file to use. Defaults “to spiny.cfg”.

-e <environments>, --envlist <environments>

A list of environments to run, separated by commas.

-v, --verbose

Increases the output, -vv increases it even more.

-q, --quiet

Reduces output to only the run summary, -qq removes also that.

Version support

Spiny can be run under Python 2.6, 2.7, 3.3 and 3.4. It can also be run under PyPy, PyPy3 and Jython.

It can run tests under a much wider range of Python versions, this has been tested with Python 2.4, 2.5, 3.1 and 3.2 in addition to the above Python versions.

IronPython is supported in theory, but I can’t get virtualenv working with IronPython. Other Python implementations are not tested. If one doesn’t work, you are welcome to raise an issue and I can look into it.

Configuration files

Spiny does not typically need a configuration file. It will instead look at your setup.py and find out what Python versions you module supports, and run the tests with those versions.

You declare version support with classifiers, like this:

setup(
    ...
    classifiers=[
        ...
        "Programming Language :: Python",
        "Programming Language :: Python :: 2.6",
        "Programming Language :: Python :: 2.7",
        "Programming Language :: Python :: 3.3",
        "Programming Language :: Python :: 3.4",
        "Programming Language :: Python :: Implementation :: PyPy",
        ...
        ],
    ...
)

With these classifiers, Spiny will run the tests under Python 2.6, 2.7, 3.3, 3.4 and also under PyPy.

You can configure Spiny explicitly on a configuration basis. You can add a spiny.cfg located in the project root, or you can add the configuration to the projects setup.cfg.

You can also have a personal configuration file in ~/.config/spiny.cfg whose configuration options will be valid for all projects.

Under the [spiny] section the following configuration options are supported:

• environments: A whitespace separated list of Python and Python versions.

• venv-dir: The name of the directory to install virtualenvs in. Defaults to .venv.

• max-processes: The maxiumum of concurrent processes to run tests with. Defaults to the number of CPU’s you have.

• test-commands: The commands used to run the tests. You can have several lines of commands. Defaults to {envpython} setup.py test. There are a few variables that you can use in the commands that will be replaced:

  • {envpython} will be replaced with the full path to the Python executable in the virtualenv

  • {basepython} will be replaced with the full path to the Python executable the virtualenv is created from

  • {envdir} will be replaced with the full path to the virtualenv directory.

  • {projectdir} will be replaced with the full path to the directory of the Python project (ie, the current directory)

• setup-commands: The commands used to create the virtualenv. The default for this varies, but it boils down to {envpython} -m virtualenv {envdir}.

• use-setup-py: If requirements data from setup.py should be used to gather requirements. This means setup.py needs to exist, and be executable without side-effects. Defaults to true.

• use-requirements-txt: If requirements data from requiremenets.txt should be used to gather requirements. Defaults to true.

• changedir: A directory to change to before running the tests. Variables from test-commands are usable.

Example:

[spiny]
environments = python2.7
               python3.4
               pypy2.4

venv-dir = .venv

test-commands = {envpython} something.py magic
                {envpython} setup.py test

max-processes = 3

There is also a [pythons] section, which defines up the paths to the various executables, per environment:

[pythons]
python2.6 = /pythons/python26/bin/python
python2.7 = /pythons/python27/bin/python
python3.3 = /pythons/python33/bin/python3
python3.4 = /pythons/python34/bin/python3

If you don’t configure this, the executables that are on the PATH will be used.

This doesn’t make much sense to have in the projects spiny.cfg, as each person who runs the tests are likely to have differing Python installs. However, this does make a lot of sense to have in the personal configuration file.

You can add the [pythons] section in your projects spiny.cfg, but the usecase for that is very limited. Possibly if you are using custom Pythons in your project.

max-processes also is reasonable in your personal file, if you for example have very long-running tests, and you want to keep a CPU free, for example for browing the web while the tests run. It also makes sense in a project file if your tests use a lot of memory, to avoid running out of memory.

environments and test-commands only make sense per configuration and not in the personal file. However, no checks for this are done, so you can add them there if you want to, but the results are unlikely to be practical.

Todo

Things that needs doing:

• Make the tests run under itself.

• Figure out how to run coverage on things run by subprocesses.

• Add commands per environment, enabling things like a pep8 environment that checks for pep8 compliance, etc.

• Windows support. Maybe.

0.5 (2016-02-26)

• CTRL-C will now kill the program.

• Renamed {envpath} to {envdir}, {python} to {envpython} and {project_dir} to {projectdir}. Also added {basepython} to the Python version used to install the virtual env.

• Various changes to make custom commands more stable and flexible.

• Added a changedir option to the config.

• You can now run tests for Pythons that does not support any version of virtualenv, such as Python 2.3 and earlier.

• Gives a nice error message and exits with -1 if it doesn’t know what versions to use.

• Dropped support for running Spiny with Python 2.6.

• If using a system Python 3 the virtualenv will no longer install system Python 2.

• Spiny now supports having different requirements in setup.py for different versions of Python.

• Not finding an executable for a specific environment is no longer a fatal error, so you don’t have to have all the supported versions installed.

0.4 (2014-11-01)

• Added support for requirements.txt.

• Added parameters to skip executing setup.py.

• Added a setup-commands parameter to override how the virtualenv is made.

• The -e parameter now actually works.

• The information about the python execs is now cached. This speeds up startup, a lot, fetching the Python environments goes from around 5 seconds to less than a tenth.

• A profile of each virtualenv is now saved in the virtualenv, containing it’s name, the full path of the Python exe, and the installed requirements. A virtualenv will now only be updated if this has changed since the last run. This also speeds up tests runs a lot in the typical case.

0.3 (2014-10-30)

• Now runs under Python 3, PyPy, PyPy3, Jython.

• All output is now through logging, which enables you to select verbosity.

• Added –version, –verbose and –quiet options.

• Now use subprocess32 under Python 2.

• Will now run tests in parallell with multiprocessing. A ‘max-processes’ option in the [spiny] section will allow you to cap the processes if you don’t want to max your computer. Otherwise it will use as many processes as multiprocessing will report cpu’s.

0.2 (2014-10-27)

• Now prints a summary in the end.

• Regard more virtualenv tests as failures.

• Return 1 if not all tests succeeded.

• Fall back to setup.cfg is there is no spiny config file.

• Renamed spiny.conf to spiny.cfg for consistency.

• Made the configuration file optional.

• Spiny will now grep setup.py for Python version classifiers if no environment configuration is found.

• If both Python X and Python X.Y is given as environments, it will skip the tests for Python X, seeing as it is fulfilled by Python X.Y.

• The version specified in the [pythons] section now have preference.

• Setting a config option from the command line now works even if the section doesn’t exist.

• Spiny will now attempt to extract the test requirements and install them into the virtualenv before running the tests, to avoid polluting the project directory with .egg directories.

0.1.1 (2014-10-18)

• Initial release