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
1=== modified file 'Dockerfile'
2--- Dockerfile 2017-04-23 10:06:47 +0000
3+++ Dockerfile 2017-04-23 15:07:34 +0000
4@@ -47,8 +47,8 @@
5 RUN pip install --upgrade pip
6
7 # Branch the dupllicity repo for testing
8-RUN bzr branch lp:~dernils/duplicity/testing
9+RUN bzr branch lp:duplicity
10
11 # Installing requirements for pip
12-RUN pip install -r ./testing/requirements.txt
13+RUN pip install -r ./duplicity/requirements.txt
14
15
16=== modified file 'README-REPO'
17--- README-REPO 2017-04-22 19:30:28 +0000
18+++ README-REPO 2017-04-23 15:07:34 +0000
19@@ -26,39 +26,3 @@
20 or
21
22 PYTHONPATH=$DUP_ROOT bin/rdiffdir
23-
24------------------------
25-Running the unit tests:
26------------------------
27-
28-To run all tests:
29-cd testing; ./run-tests
30-
31-You can run specific tests using:
32-tox -- -s [folder].[folder].[file].[class].[test]
33-For example:
34-tox -- -s testing.unit.test_selection
35-or:
36-tox -- -s testing.unit.test_selection.MatchingTest.test_tuple_include
37-
38-Note: some tests require rdiff and pylint to be installed on the system for
39-them to pass.
40-
41-Please run all tests on your branch (run-tests) before proposing a merge, to
42-ensure that all tests pass. The decorator @unittest.expectedFailure can be used
43-to commit a known-failing test case without breaking the test suite, for
44-example to exhibit the behaviour in a bug report before it has been fixed.
45-
46------------------------------------------
47-Testing against multiple Python versions:
48------------------------------------------
49-
50-Duplicity uses tox to make it easy to test your code against multiple
51-environments. Running tests using the commands above will automatically test
52-code against different supported environments, including the versions of
53-dependencies used by the Launchpad build system.
54-
55-You can test against a single environment, e.g.
56-tox -e py27
57-for example if you are working on fixing a bug, but please do a full run-tests
58-before submitting a merge request.
59
60=== modified file 'README-TESTING'
61--- README-TESTING 2017-04-23 10:06:47 +0000
62+++ README-TESTING 2017-04-23 15:07:34 +0000
63@@ -30,17 +30,42 @@
64
65 ‘setup.py test‘
66
67-
68 2. Using __tox__
69 Tox 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
70 runs the tests in each of the environments that are configured in the tox.ini file (see root folder of the repository)
71
72+Duplicity uses tox to make it easy to test your code against multiple
73+environments. Running tests using the commands above will automatically test
74+code against different supported environments, including the versions of
75+dependencies used by the Launchpad build system.
76+
77+
78 A tox run can be started simply by typing
79
80 ‘tox‘
81
82 from the main duplicity folder.
83
84+You can run specific tests using:
85+‘tox -- -s [folder].[folder].[file].[class].[test]‘
86+For example:
87+‘tox -- -s testing.unit.test_selection‘
88+or:
89+‘tox -- -s testing.unit.test_selection.MatchingTest.test_tuple_include‘
90+
91+You can test against a single environment, e.g.
92+‘tox -e py27‘
93+for example if you are working on fixing a bug, but please do a full run-tests
94+before submitting a merge request.
95+
96+Note: some tests require rdiff and pylint to be installed on the system for
97+them to pass.
98+
99+Please run all tests on your branch (run-tests) before proposing a merge, to
100+ensure that all tests pass. The decorator @unittest.expectedFailure can be used
101+to commit a known-failing test case without breaking the test suite, for
102+example to exhibit the behaviour in a bug report before it has been fixed.
103+
104 3. Via a __docker__ image
105 Testing 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.
106 Along with the tests, a docker image has been created (cf. Dockerfile in root folder of repo) that ensure the following things:
107
108=== modified file 'requirements.txt'
109--- requirements.txt 2017-04-22 19:30:28 +0000
110+++ requirements.txt 2017-04-23 15:07:34 +0000
111@@ -1,4 +1,11 @@
112-dropbox
113+dropbox==6.9.0
114 lockfile
115 pexpect
116 pyrax
117+pycryptopp
118+paramiko
119+urllib3
120+boto
121+tox
122+coverage
123+pylint
124\ No newline at end of file

Subscribers

People subscribed via source and target branches