John R Barker ecbf8e933a Docs how to test (2nd) (#24094 )

* Big testing doc refactor
* Combine all the testing documentation in to one place to make it easier to find
* Convert everything to RST
* Create testing_network guide
* Create testing landing page
* For each section detail "how to run" and "how to extend testing"
* More examples
* Lots more detail

2017-04-28 09:08:26 +01:00

1.8 KiB

Raw Blame History

PEP 8

Topics

PEP 8 style guidelines are enforced by pep8 on all python files in the repository by default.

Current Rule Set

By default all files are tested using the current rule set. All pep8 tests are executed, except those listed in the current ignore list.

Changes to the Rule Set need approval from the Core Team, and must be done via the Testing Working Group.

Legacy Rule Set

Files which are listed in the legacy file list are tested using the legacy rule set.

All pep8 tests are executed, except those listed in the current ignore list or legacy ignore list.

Files listed in the legacy file list which pass the current rule set will result in an error.

This is intended to prevent regressions on style guidelines for files which pass the more stringent current rule set.

Skipping Tests

Files listed in the skip list are not tested by pep8.

Removed Files

Files which have been removed from the repository must be removed from the legacy file list and the skip list.

Running Locally

The pep8 check can be run locally with:

./test/runner/ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...

1.8 KiB Raw Blame History