Merge lp:~dernils/duplicity/documentation into lp:~duplicity-team/duplicity/0.8-series

Proposed by nils
Status: Merged
Merged at revision: 1193
Proposed branch: lp:~dernils/duplicity/documentation
Merge into: lp:~duplicity-team/duplicity/0.8-series
Diff against target: 124 lines (+36/-40)
4 files modified
Dockerfile (+2/-2)
README-REPO (+0/-36)
README-TESTING (+26/-1)
requirements.txt (+8/-1)
To merge this branch: bzr merge lp:~dernils/duplicity/documentation
Reviewer Review Type Date Requested Status
duplicity-team Pending
Review via email: mp+323005@code.launchpad.net

Description of the change

Minor changes to README-REPO, README-TESTING
Also re-done the changes to requirements.txt and Dockerfile

To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'Dockerfile'
--- Dockerfile 2017-04-23 10:06:47 +0000
+++ Dockerfile 2017-04-23 15:07:34 +0000
@@ -47,8 +47,8 @@
47RUN pip install --upgrade pip47RUN pip install --upgrade pip
4848
49# Branch the dupllicity repo for testing 49# Branch the dupllicity repo for testing
50RUN bzr branch lp:~dernils/duplicity/testing50RUN bzr branch lp:duplicity
5151
52# Installing requirements for pip 52# Installing requirements for pip
53RUN pip install -r ./testing/requirements.txt53RUN pip install -r ./duplicity/requirements.txt
5454
5555
=== modified file 'README-REPO'
--- README-REPO 2017-04-22 19:30:28 +0000
+++ README-REPO 2017-04-23 15:07:34 +0000
@@ -26,39 +26,3 @@
26or26or
2727
28PYTHONPATH=$DUP_ROOT bin/rdiffdir28PYTHONPATH=$DUP_ROOT bin/rdiffdir
29
30-----------------------
31Running the unit tests:
32-----------------------
33
34To run all tests:
35cd testing; ./run-tests
36
37You can run specific tests using:
38tox -- -s [folder].[folder].[file].[class].[test]
39For example:
40tox -- -s testing.unit.test_selection
41or:
42tox -- -s testing.unit.test_selection.MatchingTest.test_tuple_include
43
44Note: some tests require rdiff and pylint to be installed on the system for
45them to pass.
46
47Please run all tests on your branch (run-tests) before proposing a merge, to
48ensure that all tests pass. The decorator @unittest.expectedFailure can be used
49to commit a known-failing test case without breaking the test suite, for
50example to exhibit the behaviour in a bug report before it has been fixed.
51
52-----------------------------------------
53Testing against multiple Python versions:
54-----------------------------------------
55
56Duplicity uses tox to make it easy to test your code against multiple
57environments. Running tests using the commands above will automatically test
58code against different supported environments, including the versions of
59dependencies used by the Launchpad build system.
60
61You can test against a single environment, e.g.
62tox -e py27
63for example if you are working on fixing a bug, but please do a full run-tests
64before submitting a merge request.
6529
=== modified file 'README-TESTING'
--- README-TESTING 2017-04-23 10:06:47 +0000
+++ README-TESTING 2017-04-23 15:07:34 +0000
@@ -30,17 +30,42 @@
3030
31‘setup.py test‘ 31‘setup.py test‘
3232
33
342. Using __tox__332. Using __tox__
35Tox is a generic virtualenv management and test command line tool that is used for checking your package installs correctly with different Python versions and interpreters. It 34Tox is a generic virtualenv management and test command line tool that is used for checking your package installs correctly with different Python versions and interpreters. It
36runs the tests in each of the environments that are configured in the tox.ini file (see root folder of the repository)35runs the tests in each of the environments that are configured in the tox.ini file (see root folder of the repository)
3736
37Duplicity uses tox to make it easy to test your code against multiple
38environments. Running tests using the commands above will automatically test
39code against different supported environments, including the versions of
40dependencies used by the Launchpad build system.
41
42
38A tox run can be started simply by typing 43A tox run can be started simply by typing
3944
40‘tox‘45‘tox‘
4146
42from the main duplicity folder. 47from the main duplicity folder.
4348
49You can run specific tests using:
50‘tox -- -s [folder].[folder].[file].[class].[test]‘
51For example:
52‘tox -- -s testing.unit.test_selection‘
53or:
54‘tox -- -s testing.unit.test_selection.MatchingTest.test_tuple_include‘
55
56You can test against a single environment, e.g.
57‘tox -e py27‘
58for example if you are working on fixing a bug, but please do a full run-tests
59before submitting a merge request.
60
61Note: some tests require rdiff and pylint to be installed on the system for
62them to pass.
63
64Please run all tests on your branch (run-tests) before proposing a merge, to
65ensure that all tests pass. The decorator @unittest.expectedFailure can be used
66to commit a known-failing test case without breaking the test suite, for
67example to exhibit the behaviour in a bug report before it has been fixed.
68
443. Via a __docker__ image 693. Via a __docker__ image
45Testing on a developer's machine can be tricky. Testing duplicity requires a set of dependencies being installed and reacts sensitiviely to changes of the local python configuration. In order to make sure that such interactions do not pose any influence on executing the tests, docker is the technology of choice. 70Testing on a developer's machine can be tricky. Testing duplicity requires a set of dependencies being installed and reacts sensitiviely to changes of the local python configuration. In order to make sure that such interactions do not pose any influence on executing the tests, docker is the technology of choice.
46Along with the tests, a docker image has been created (cf. Dockerfile in root folder of repo) that ensure the following things:71Along with the tests, a docker image has been created (cf. Dockerfile in root folder of repo) that ensure the following things:
4772
=== modified file 'requirements.txt'
--- requirements.txt 2017-04-22 19:30:28 +0000
+++ requirements.txt 2017-04-23 15:07:34 +0000
@@ -1,4 +1,11 @@
1dropbox1dropbox==6.9.0
2lockfile2lockfile
3pexpect3pexpect
4pyrax4pyrax
5pycryptopp
6paramiko
7urllib3
8boto
9tox
10coverage
11pylint
5\ No newline at end of file12\ No newline at end of file

Subscribers

People subscribed via source and target branches