Project

General

Profile

Running tests » History » Version 3

Tom Clegg, 09/22/2014 03:17 PM

1 1 Tom Clegg
h1. Running tests
2
3 3 Tom Clegg
{{toc}}
4
5 1 Tom Clegg
The arvados-dev git repository has a @run-tests.sh@ script which tests (nearly) all of the components in the arvados source tree. Jenkins at https://ci.curoverse.com uses this exact script, so running it _before pushing a new master_ is a good way to predict whether Jenkins will fail your build and start pestering you by IRC.
6
7
h2. Background
8
9
You have the arvados source tree at @~/arvados@ and you might have local modifications.
10
11
h2. Download/update the test script
12
13
First time:
14
15
<pre>
16
cd
17
git clone git://git.curoverse.com:arvados-dev.git
18
</pre>
19
20
Next times, to get any updates:
21
22
<pre>
23
cd ~/arvados-dev
24
git pull
25
</pre>
26
27
h2. Install prerequisites
28
29
The test script doesn't (yet) check for all prerequisites up front, so you'll save some time by installing these things before going any attempting to run tests:
30
* [[Go]]
31
* "API server dependencies":http://doc.arvados.org/install/install-api-server.html (Install debian packages, ruby, bundler. Create "arvados" postgres user. You don't need to run "bundle install", though.)
32
* "Workbench dependencies":http://doc.arvados.org/install/install-workbench-app.html (Currently just graphviz. Skip "bundle install".)
33 2 Tom Clegg
* @apt-get install python-epydoc linkchecker@
34
35 1 Tom Clegg
36
h2. Run all tests
37
38
Basic usage:
39
40
<pre>
41
~/arvados-dev/jenkins/run-tests.sh WORKSPACE=~/arvados
42
</pre>
43
44
h2. Save time by skipping some tests
45
46
Running all tests takes a while. You don't want to do this after each tiny change. You can use the --skip and --only arguments to select specific components. Some components also accept component-specific arguments to select specific test classes/cases.
47
48
h2. Save more time by skipping install
49
50
Normally, even when you're running only one component's test suite, @run-tests.sh@ still runs the _install_ recipe for all of the components. This addresses dependencies between components: for example, Workbench tests expect the Python and CLI SDKs to be installed.
51
52
When you're not worried about these dependencies going out of sync (e.g., you're only touching Workbench tests) you can install everything once this way:
53
54
<pre>
55
~/arvados-dev/jenkins/run-tests.sh --only install --leave-temp WORKSPACE=~/arvados
56
</pre>
57
58
After running everything, you'll see something like this:
59
60
<pre>
61
Leaving behind temp dirs:  VENVDIR="/tmp/tmp.y3tsTmigio" GOPATH="/tmp/tmp.3r4sSA9F3l"
62
</pre>
63
64
Copy these temp dirs to the end of your run-tests.sh command line, add @--skip-install@, and choose a test suite to run, like this:
65
66
<pre>
67
~/arvados-dev/jenkins/run-tests.sh --only workbench --skip-install WORKSPACE=~/arvados VENVDIR="/tmp/tmp.y3tsTmigio" GOPATH="/tmp/tmp.3r4sSA9F3l"
68 3 Tom Clegg
</pre>
69
70
h2. Other options
71
72
For more usage info, try:
73
74
<pre>
75
~/arvados-dev/jenkins/run-tests.sh --help
76 1 Tom Clegg
</pre>