Skip to content

Commit

Permalink
Merge branch 'master' into use-cliff
Browse files Browse the repository at this point in the history
  • Loading branch information
mtreinish committed Jan 10, 2018
2 parents 865b222 + ae58186 commit a637125
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 21 deletions.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Slim/Super Test Repository
.. image:: https://travis-ci.org/mtreinish/stestr.svg?branch=master
:target: https://travis-ci.org/mtreinish/stestr

.. image:: https://img.shields.io/appveyor/ci/mtreinish/stestr/master.svg?logo=appveyor
:target: https://ci.appveyor.com/project/mtreinish/stestr

.. image:: https://coveralls.io/repos/github/mtreinish/stestr/badge.svg?branch=master
:target: https://coveralls.io/github/mtreinish/stestr?branch=master

Expand Down
5 changes: 3 additions & 2 deletions doc/source/MANUAL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ colorization with subunit-trace output. If you prefer to deal with the raw
subunit yourself and run your own output rendering or filtering you can use
the ``--subunit`` flag to output the result stream as raw subunit v2.

There is also an ``--abbreviate`` flag availble, when this is used a single
There is also an ``--abbreviate`` flag available, when this is used a single
character is printed for each test as it is executed. A ``.`` is printed for a
successful test, a ``F`` for a failed test, and a ``S`` for a skipped test.

Expand Down Expand Up @@ -300,7 +300,8 @@ the stestr config file permits this. When set, tests are grouped by the group(0)
of any regex match. Tests with no match are not grouped.

For example, setting the following option in the stestr config file will group
tests in the same class together (the last . splits the class and test method)::
tests in the same class together (the last '.' splits the class and test
method)::

group_regex=([^\.]+\.)+

Expand Down
2 changes: 1 addition & 1 deletion doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ of these functions has a defined stable Python API signature with args and
kwargs so that people can easily call the functions from other python programs.
This function is what can be expected to be used outside of stestr as the stable
interface.
All the stable functions can be imported the the command module directly::
All the stable functions can be imported the command module directly::

from stestr import command

Expand Down
30 changes: 15 additions & 15 deletions doc/source/api/test_processor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@
Test Processor Module
=====================

This module contains the definition of the TestListingFixture fixture class.
This fixture is used for handling the actual spawning of worker processes
for running tests, or listing tests. It is constructed as a `fixture`_ to
handle the lifecycle of the test id list files which are used to pass test ids
to the workers processes running the tests.
This module contains the definition of the ``TestProcessorFixture`` fixture
class. This fixture is used for handling the actual spawning of worker
processes for running tests, or listing tests. It is constructed as a `fixture`_
to handle the lifecycle of the test id list files which are used to pass test
ids to the workers processes running the tests.

.. _fixture: https://pypi.python.org/pypi/fixtures

In the normal workflow a TestListingFixture get's returned by the
:ref:`api_config_file`'s get_run_command() function. The config file parses the
config file and the cli options to create a TestListingFixture with the correct
options. This Fixture then gets returned to the CLI commands to enable them to
run the commands.
In the normal workflow a ``TestProcessorFixture`` get's returned by the
:ref:`api_config_file`'s ``get_run_command()`` function. The config file parses
the config file and the cli options to create a ``TestProcessorFixture`` with
the correct options. This Fixture then gets returned to the CLI commands to
enable them to run the commands.

The TestListingFixture class is written to be fairly generic in the command
it's executing. This is an artifact of being forked from testrepository where
the test command is defined in the configuration file. In stestr the command is
hard coded ``stestr.config_file`` module so this extra flexibility isn't really
needed.
The ``TestProcessorFixture`` class is written to be fairly generic in the
command it's executing. This is an artifact of being forked from testrepository
where the test command is defined in the configuration file. In stestr the
command is hard coded ``stestr.config_file`` module so this extra flexibility
isn't really needed.

API Reference
-------------
Expand Down
1 change: 0 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@ Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

2 changes: 0 additions & 2 deletions stestr/subunit_trace.py
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#!/usr/bin/env python

# Copyright 2014 Hewlett-Packard Development Company, L.P.
# Copyright 2014 Samsung Electronics
# All Rights Reserved.
Expand Down

0 comments on commit a637125

Please sign in to comment.