Setup for openstack-doc-tools gating

Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Enhance .gitignore to ignore files used by gating and by more
editors.

Change-Id: Id33d04f734d438d01dd5bbd784abaa213de5dbc9
This commit is contained in:
Andreas Jaeger 2013-12-31 17:35:48 +01:00
parent 27bf719357
commit 30f4240e0c
4 changed files with 51 additions and 0 deletions

11
.gitignore vendored
View File

@ -1,4 +1,15 @@
.DS_Store
target/
*.xpr
# Packages
*.egg
*.egg-info
# Testenvironment
.tox
# Editors
*~
.*.swp
.bak

15
README Normal file
View File

@ -0,0 +1,15 @@
Testing of changes and building of the manual
=============================================
Install the python tox package and run "tox" from the top-level
directory to use the same tests that are done as part of our Jenkins
gating jobs.
If you like to run individual tests, run:
* "tox -e checkniceness" - to run the niceness tests
* "tox -e checksyntax" - to run syntax checks
* "tox -e checkdeletions" - to check that no deleted files are referenced
* "tox -e checkbuild" - to actually build the manual
tox will use the openstack-doc-tools package for execution of these
tests.

1
test-requirements.txt Normal file
View File

@ -0,0 +1 @@
openstack-doc-tools

24
tox.ini Normal file
View File

@ -0,0 +1,24 @@
[tox]
minversion = 1.6
envlist = checkbuild,checkniceness,checksyntax
skipsdist=True
[testenv]
setenv =
VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
deps = -r{toxinidir}/test-requirements.txt
[testenv:venv]
commands = {posargs}
[testenv:checkniceness]
commands = openstack-doc-test --api-site --check-niceness
[testenv:checksyntax]
commands = openstack-doc-test --api-site --check-syntax
[testenv:checkbuild]
commands = openstack-doc-test --api-site --check-build