Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 29342955: Issue 3985 - Unified test runner for sitescripts (Closed)
Patch Set: Created May 23, 2016, 9:50 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « .hgignore ('k') | Vagrantfile » ('j') | Vagrantfile » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
--- a/README.md
+++ b/README.md
@@ -76,8 +76,45 @@
1. Create a sitescripts configuration file that lists the web modules that you
are testing under the `multiplexer` section. (Depending on the modules you are
testing you may need to add additional configuration as well.)
2. Save the configuration file somewhere where it will be found, for example
3. Type `python multiplexer.py`, it will start a web server at
http://localhost:5000/ . This web server will use any URL handlers that have
been defined in the modules you are testing to respond to requests.
+## Testing
+There are tests for some parts of the functionality of sitescripts. They are
+located in `test` directories and can be run via
+[Tox](https://tox.readthedocs.org/). There are two parts of the test suite:
+the tests that only depend on the packages that can be automatically installed
+by tox and the tests that have other dependencies (a database). The first part
+is run by tox by default:
+ $ tox
+The tests dependent on the database are covering the packages `filterhits` and
Sebastian Noack 2016/05/24 07:58:36 Nice idea to use Vagrant for tests with non-python
+`notifications`. They can be run in a standard prepared environment using
+ $ vagrant up
+ Bringing machine 'default' up with 'virtualbox' provider...
+ ==> default: Importing base box 'debian/contrib-jessie64'...
+ ...
+ $ vagrant ssh
+ ...
+ vagrant@debiancontrib-jessie:~$ cd /vagrant
+ vagrant@debiancontrib-jessie:/vagrant$ tox -e filtehits,notifications
mathias 2016/05/23 22:25:32 Do you really want a binary image from an un-trust
+It's also possible to run the other tests inside of vagrant environment by not
+giving any arguments to `tox`.
+Please note that since the subpackages of sitescripts are not installed via
+`setup.py` but are instead imported directly from the working directory, the
+`.pyc` files that are created next to the `.py` files might be obsolete and or
+not matching the environment. This might cause the tests to fail and Tox/Pytest
+normally hints at the source of the problem in these cases. The problem can be
+fixed by deleting all `.pyc` files:
+ $ find . -name '*.pyc' | xargs rm
mathias 2016/05/23 22:25:32 After addressing my comment above, you could trans
« no previous file with comments | « .hgignore ('k') | Vagrantfile » ('j') | Vagrantfile » ('J')

Powered by Google App Engine
This is Rietveld