Notes for Sphinx Tool Developers

Development is to be done in TDD fashion. This is not a request, it is a demand!


Actually, the way the test regime is set up, this is more BDD as much as TDD. Tests are partitioned as unit tests (of which there are actually very few), and system tests (which is where the main focus is). An individual system test is a self contained project with a SConstruct driven by a SCons test.

+ project
|    + Sconstruct
|    |

The name of the directory should be a description of what the test does.

The can use all the features available fromt he SCons testing framework.

See the current tests for further ideas.


In order to run tests you need to have Dirk Baechle's SCons tool test framework. This is a Bazaar branch held on Launchpad. First get a branch:

bzr branch 

To run all the Sphinx tool tests from the top level of the Sphinx tool hierarchy:

python <path-to-scons-test-framework>/ -s test


Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.