~ubuntu-archive/britney/britney2

« back to all changes in this revision

Viewing changes to doc/contributing-to-britney.rst

  • Committer: Niels Thykier
  • Date: 2017-12-03 12:06:37 UTC
  • Revision ID: git-v1:90e4bb6ba222fc99efeecdf7ad0743bc0e626ba7
Rewrite documentation in sphinx

Signed-off-by: Niels Thykier <niels@thykier.net>

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Contributing to the development of britney2
 
2
===========================================
 
3
 
 
4
If you are interested in improving britney, you can obtain the source
 
5
code via::
 
6
 
 
7
  git clone https://anonscm.debian.org/git/mirror/britney2.git
 
8
  # Additional tests
 
9
  git clone https://anonscm.debian.org/git/collab-maint/britney2-tests.git
 
10
 
 
11
You will need some packages to run britney and the test suites::
 
12
 
 
13
  # Runtime dependencies
 
14
  apt install python3 python3-apt python3-yaml
 
15
  # Test dependencies
 
16
  apt install python3-pytest libclass-accessor-perl rsync 
 
17
  # Documentation generator
 
18
  apt install python3-sphinx
 
19
 
 
20
 
 
21
Britney has some basic unit tests, which are handled by py.test.  It
 
22
also has some larger integration tests (from the `britney2-tests`
 
23
repo).  Running the tests are done via::
 
24
 
 
25
  cd britney2
 
26
  # Basic unit tests
 
27
  py.test-3
 
28
  # Integration tests
 
29
  rm -fr ./test-out/
 
30
  ../britney2-tests/bin/runtests ./britney.py ../britney2-tests/t ./test-out
 
31
 
 
32
The `runtests` command in `britney2-tests` supports running only a
 
33
subset of the tests.  Please see its `--help` output for more
 
34
information.
 
35
 
 
36
Finally, there is also some heavier tests based on some snapshots of
 
37
live data from Debian.  The data files for these are available in the
 
38
`live-data` submodule of the `britney2-tests` repo.  They consume
 
39
quite a bit of disk space and britney will need at least 1.3GB of RAM
 
40
to process them.