1
=== modified file 'checkbox/parsers/cpuinfo.py'
2
=== modified file 'debian/changelog'
3
--- debian/changelog	2013-08-02 10:56:56 +0000
4
+++ debian/changelog	2013-08-28 12:36:13 +0000
5
@@ -1,3 +1,4 @@
6
1
<<<<<<< TREE
7
1
checkbox (0.16.4) saucy; urgency=low
2
checkbox (0.16.4) saucy; urgency=low
8
2
3
9
3
  [ Jeff Lane ]
4
  [ Jeff Lane ]
10
@@ -224,6 +225,69 @@
11
224
225
12
225
 -- Daniel Manrique <roadmr@ubuntu.com>  Wed, 15 May 2013 16:39:12 -0400
226
 -- Daniel Manrique <roadmr@ubuntu.com>  Wed, 15 May 2013 16:39:12 -0400
13
226
227
14
228
=======
15
229
checkbox (0.16.1) saucy; urgency=low
16
230
17
231
  * New upstream release (LP: #1180545):
18
232
19
233
  * Launchpad automated translation updates
20
234
21
235
  [ Alberto Milone ]
22
236
  * scripts/graphics_stress_test, scripts/rotation_test: make sure to
23
237
    always reset the "screen" variable. Somehow the NVIDIA driver manages
24
238
    to make it unusable after the first time. (LP: #1172667)
25
239
26
240
  [ Brendan Donegan ]
27
241
  * checkbox/parsers/submission.py - publish kernel-release information to
28
242
    interested parties.
29
243
  * scripts/rendercheck_test - change nargs='+' to action='append' for blacklist
30
244
    option so it works as expected.
31
245
    jobs/rendercheck.txt.in - blacklist gradients test as it is known to produce
32
246
    false positives. (LP: #1093718)
33
247
  * plugins/hexr_transport.py - added plugin for submitting to HEXR and 
34
248
    certification based on certify_new_transport from checkbox-certification.
35
249
    examples/checkbox-qt.ini - blacklisted hexr_transport as we won't use it
36
250
    examples/checkbox-cli.ini - blacklisted hexr_transport as we won't use it
37
251
    examples/checkbox-urwid.ini - blacklisted hexr_transport as we won't use it
38
252
39
253
  [ Daniel Manrique ]
40
254
  * Ensured that button strings from the "continue" dialog are translatable
41
255
    (LP: #1176695) 
42
256
  
43
257
  [ Jeff Lane ]
44
258
  * checkbox/parsers/cpuinfo.py - split on first instance of ':' in cpuinfo
45
259
    output lines to avoid splitting into more than 2 items. Also fixed a pep8
46
260
    issue discovered while working on this. (LP: #1180496)
47
261
  * scripts/cpu_offlining: Modified script to no longer offline cpu0 to resolve
48
262
    a bug on ARM. Modified output so most of it is redirected to stderr for
49
263
    fail cases, we don't need that much for success cases. (LP: #1078897) 
50
264
  * jobs/mediacard.txt.in: Modified test instructions to be less confusing
51
265
    (LP: #970857)
52
266
  * scripts/cpu_topology: define the cpuinfo nested dicts on creation rather
53
267
    than define elements during parsing of /proc/cpuinfo (LP: #1111878)
54
268
  * scripts/lsmod_info: Corrected error handling for the check_output() call to
55
269
    trap the correct error. (LP: #1103647)
56
270
  * jobs/camera.txt.in: removed an extraneous requres line for gir1.2
57
271
    scripts/camera_test: added code to determine what version of gst we're
58
272
    using and set video type and plugin accordingly. (LP: #1100594)
59
273
  * scripts/network_check: added ability to specify custom target URL for
60
274
    debugging failures (LP: #1128017)
61
275
  * scripts/removable_storage_test: Added error handling to trap OSError on
62
276
    non-writable media and modified output to handle subsequent
63
277
    ZeroDivisionError issues when summarizing test results.
64
278
    jobs/media.txt.in: Modified instructions for SD/SDHC to specify using
65
279
    UNLOCKED cards to avoid issues when testing read-only media (LP: #1153894)
66
280
67
281
  [ Sylvain Pineau ]
68
282
  * jobs/suspend.txt.in, scripts/gpu_test: Remove the need of running the script
69
283
    with the root user, restore the workspaces switch and the HTML5 video
70
284
    playback ; remove the extra suspend/resume (LP: #1172851)
71
285
  * checkbox/parsers/udevadm.py: Only filter devices without product AND vendor
72
286
    information (LP: #1167733)
73
287
74
288
 -- Daniel Manrique <roadmr@ubuntu.com>  Wed, 15 May 2013 16:39:12 -0400
75
289
76
290
>>>>>>> MERGE-SOURCE
77
227
checkbox (0.16) saucy; urgency=low
291
checkbox (0.16) saucy; urgency=low
78
228
292
79
229
  * New upstream release (LP: #1178403):
293
  * New upstream release (LP: #1178403):
80
230
294
81
=== modified file 'debian/po/ast.po'
82
--- debian/po/ast.po	2013-08-02 10:56:56 +0000
83
+++ debian/po/ast.po	2013-08-28 12:36:13 +0000
84
@@ -15,8 +15,13 @@
85
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
86
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
87
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
88
18
<<<<<<< TREE
89
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
90
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
91
21
=======
92
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
93
23
"X-Generator: Launchpad (build 16598)\n"
94
24
>>>>>>> MERGE-SOURCE
95
20
25
96
21
#. Type: string
26
#. Type: string
97
22
#. Description
27
#. Description
98
23
28
99
=== modified file 'debian/po/cs.po'
100
--- debian/po/cs.po	2013-08-02 10:56:56 +0000
101
+++ debian/po/cs.po	2013-08-28 12:36:13 +0000
102
@@ -15,8 +15,13 @@
103
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
104
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
105
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
106
18
<<<<<<< TREE
107
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
108
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
109
21
=======
110
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
111
23
"X-Generator: Launchpad (build 16598)\n"
112
24
>>>>>>> MERGE-SOURCE
113
20
25
114
21
#. Type: string
26
#. Type: string
115
22
#. Description
27
#. Description
116
23
28
117
=== modified file 'debian/po/de.po'
118
--- debian/po/de.po	2013-08-02 10:56:56 +0000
119
+++ debian/po/de.po	2013-08-28 12:36:13 +0000
120
@@ -15,8 +15,13 @@
121
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
122
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
123
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
124
18
<<<<<<< TREE
125
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
126
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
127
21
=======
128
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
129
23
"X-Generator: Launchpad (build 16598)\n"
130
24
>>>>>>> MERGE-SOURCE
131
20
25
132
21
#. Type: string
26
#. Type: string
133
22
#. Description
27
#. Description
134
23
28
135
=== modified file 'debian/po/en_AU.po'
136
--- debian/po/en_AU.po	2013-08-02 10:56:56 +0000
137
+++ debian/po/en_AU.po	2013-08-28 12:36:13 +0000
138
@@ -15,8 +15,13 @@
139
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
140
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
141
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
142
18
<<<<<<< TREE
143
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
144
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
145
21
=======
146
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
147
23
"X-Generator: Launchpad (build 16598)\n"
148
24
>>>>>>> MERGE-SOURCE
149
20
25
150
21
#. Type: string
26
#. Type: string
151
22
#. Description
27
#. Description
152
23
28
153
=== modified file 'debian/po/en_GB.po'
154
--- debian/po/en_GB.po	2013-08-02 10:56:56 +0000
155
+++ debian/po/en_GB.po	2013-08-28 12:36:13 +0000
156
@@ -15,8 +15,13 @@
157
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
158
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
159
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
160
18
<<<<<<< TREE
161
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
162
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
163
21
=======
164
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
165
23
"X-Generator: Launchpad (build 16598)\n"
166
24
>>>>>>> MERGE-SOURCE
167
20
25
168
21
#. Type: string
26
#. Type: string
169
22
#. Description
27
#. Description
170
23
28
171
=== modified file 'debian/po/es.po'
172
--- debian/po/es.po	2013-08-02 10:56:56 +0000
173
+++ debian/po/es.po	2013-08-28 12:36:13 +0000
174
@@ -15,8 +15,13 @@
175
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
176
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
177
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
178
18
<<<<<<< TREE
179
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
180
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
181
21
=======
182
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
183
23
"X-Generator: Launchpad (build 16598)\n"
184
24
>>>>>>> MERGE-SOURCE
185
20
25
186
21
#. Type: string
26
#. Type: string
187
22
#. Description
27
#. Description
188
23
28
189
=== modified file 'debian/po/fr.po'
190
--- debian/po/fr.po	2013-08-02 10:56:56 +0000
191
+++ debian/po/fr.po	2013-08-28 12:36:13 +0000
192
@@ -15,8 +15,13 @@
193
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
194
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
195
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
196
18
<<<<<<< TREE
197
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
198
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
199
21
=======
200
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
201
23
"X-Generator: Launchpad (build 16598)\n"
202
24
>>>>>>> MERGE-SOURCE
203
20
25
204
21
#. Type: string
26
#. Type: string
205
22
#. Description
27
#. Description
206
23
28
207
=== modified file 'debian/po/gl.po'
208
--- debian/po/gl.po	2013-08-02 10:56:56 +0000
209
+++ debian/po/gl.po	2013-08-28 12:36:13 +0000
210
@@ -15,8 +15,13 @@
211
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
212
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
213
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
214
18
<<<<<<< TREE
215
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
216
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
217
21
=======
218
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
219
23
"X-Generator: Launchpad (build 16598)\n"
220
24
>>>>>>> MERGE-SOURCE
221
20
25
222
21
#. Type: string
26
#. Type: string
223
22
#. Description
27
#. Description
224
23
28
225
=== modified file 'debian/po/he.po'
226
--- debian/po/he.po	2013-08-02 10:56:56 +0000
227
+++ debian/po/he.po	2013-08-28 12:36:13 +0000
228
@@ -15,8 +15,13 @@
229
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
230
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
231
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
232
18
<<<<<<< TREE
233
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
234
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
235
21
=======
236
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
237
23
"X-Generator: Launchpad (build 16598)\n"
238
24
>>>>>>> MERGE-SOURCE
239
20
25
240
21
#. Type: string
26
#. Type: string
241
22
#. Description
27
#. Description
242
23
28
243
=== modified file 'debian/po/hu.po'
244
--- debian/po/hu.po	2013-08-02 10:56:56 +0000
245
+++ debian/po/hu.po	2013-08-28 12:36:13 +0000
246
@@ -15,8 +15,13 @@
247
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
248
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
249
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
250
18
<<<<<<< TREE
251
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
252
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
253
21
=======
254
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
255
23
"X-Generator: Launchpad (build 16598)\n"
256
24
>>>>>>> MERGE-SOURCE
257
20
25
258
21
#. Type: string
26
#. Type: string
259
22
#. Description
27
#. Description
260
23
28
261
=== modified file 'debian/po/id.po'
262
--- debian/po/id.po	2013-08-02 10:56:56 +0000
263
+++ debian/po/id.po	2013-08-28 12:36:13 +0000
264
@@ -15,8 +15,13 @@
265
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
266
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
267
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
268
18
<<<<<<< TREE
269
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
270
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
271
21
=======
272
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
273
23
"X-Generator: Launchpad (build 16598)\n"
274
24
>>>>>>> MERGE-SOURCE
275
20
25
276
21
#. Type: string
26
#. Type: string
277
22
#. Description
27
#. Description
278
23
28
279
=== modified file 'debian/po/it.po'
280
--- debian/po/it.po	2013-08-02 10:56:56 +0000
281
+++ debian/po/it.po	2013-08-28 12:36:13 +0000
282
@@ -15,8 +15,13 @@
283
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
284
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
285
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
286
18
<<<<<<< TREE
287
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
288
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
289
21
=======
290
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
291
23
"X-Generator: Launchpad (build 16598)\n"
292
24
>>>>>>> MERGE-SOURCE
293
20
25
294
21
#. Type: string
26
#. Type: string
295
22
#. Description
27
#. Description
296
23
28
297
=== modified file 'debian/po/ja.po'
298
--- debian/po/ja.po	2013-08-02 10:56:56 +0000
299
+++ debian/po/ja.po	2013-08-28 12:36:13 +0000
300
@@ -15,8 +15,13 @@
301
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
302
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
303
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
304
18
<<<<<<< TREE
305
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
306
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
307
21
=======
308
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
309
23
"X-Generator: Launchpad (build 16598)\n"
310
24
>>>>>>> MERGE-SOURCE
311
20
25
312
21
#. Type: string
26
#. Type: string
313
22
#. Description
27
#. Description
314
23
28
315
=== modified file 'debian/po/nl.po'
316
--- debian/po/nl.po	2013-08-02 10:56:56 +0000
317
+++ debian/po/nl.po	2013-08-28 12:36:13 +0000
318
@@ -15,8 +15,13 @@
319
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
320
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
321
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
322
18
<<<<<<< TREE
323
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
324
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
325
21
=======
326
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
327
23
"X-Generator: Launchpad (build 16598)\n"
328
24
>>>>>>> MERGE-SOURCE
329
20
25
330
21
#. Type: string
26
#. Type: string
331
22
#. Description
27
#. Description
332
23
28
333
=== modified file 'debian/po/oc.po'
334
--- debian/po/oc.po	2013-08-02 10:56:56 +0000
335
+++ debian/po/oc.po	2013-08-28 12:36:13 +0000
336
@@ -15,8 +15,13 @@
337
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
338
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
339
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
340
18
<<<<<<< TREE
341
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
342
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
343
21
=======
344
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
345
23
"X-Generator: Launchpad (build 16598)\n"
346
24
>>>>>>> MERGE-SOURCE
347
20
25
348
21
#. Type: string
26
#. Type: string
349
22
#. Description
27
#. Description
350
23
28
351
=== modified file 'debian/po/pl.po'
352
--- debian/po/pl.po	2013-08-02 10:56:56 +0000
353
+++ debian/po/pl.po	2013-08-28 12:36:13 +0000
354
@@ -15,8 +15,13 @@
355
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
356
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
357
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
358
18
<<<<<<< TREE
359
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
360
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
361
21
=======
362
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
363
23
"X-Generator: Launchpad (build 16598)\n"
364
24
>>>>>>> MERGE-SOURCE
365
20
25
366
21
#. Type: string
26
#. Type: string
367
22
#. Description
27
#. Description
368
23
28
369
=== modified file 'debian/po/pt_BR.po'
370
--- debian/po/pt_BR.po	2013-08-02 10:56:56 +0000
371
+++ debian/po/pt_BR.po	2013-08-28 12:36:13 +0000
372
@@ -15,8 +15,13 @@
373
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
374
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
375
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
376
18
<<<<<<< TREE
377
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
378
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
379
21
=======
380
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
381
23
"X-Generator: Launchpad (build 16598)\n"
382
24
>>>>>>> MERGE-SOURCE
383
20
25
384
21
#. Type: string
26
#. Type: string
385
22
#. Description
27
#. Description
386
23
28
387
=== modified file 'debian/po/ro.po'
388
--- debian/po/ro.po	2013-08-02 10:56:56 +0000
389
+++ debian/po/ro.po	2013-08-28 12:36:13 +0000
390
@@ -15,8 +15,13 @@
391
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
392
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
393
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
394
18
<<<<<<< TREE
395
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
396
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
397
21
=======
398
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
399
23
"X-Generator: Launchpad (build 16598)\n"
400
24
>>>>>>> MERGE-SOURCE
401
20
25
402
21
#. Type: string
26
#. Type: string
403
22
#. Description
27
#. Description
404
23
28
405
=== modified file 'debian/po/ru.po'
406
--- debian/po/ru.po	2013-08-02 10:56:56 +0000
407
+++ debian/po/ru.po	2013-08-28 12:36:13 +0000
408
@@ -15,8 +15,13 @@
409
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
410
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
411
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
412
18
<<<<<<< TREE
413
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
414
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
415
21
=======
416
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
417
23
"X-Generator: Launchpad (build 16598)\n"
418
24
>>>>>>> MERGE-SOURCE
419
20
25
420
21
#. Type: string
26
#. Type: string
421
22
#. Description
27
#. Description
422
23
28
423
=== modified file 'debian/po/tr.po'
424
--- debian/po/tr.po	2013-08-02 10:56:56 +0000
425
+++ debian/po/tr.po	2013-08-28 12:36:13 +0000
426
@@ -15,8 +15,13 @@
427
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
428
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
429
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
430
18
<<<<<<< TREE
431
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
432
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
433
21
=======
434
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
435
23
"X-Generator: Launchpad (build 16598)\n"
436
24
>>>>>>> MERGE-SOURCE
437
20
25
438
21
#. Type: string
26
#. Type: string
439
22
#. Description
27
#. Description
440
23
28
441
=== modified file 'debian/po/uk.po'
442
--- debian/po/uk.po	2013-08-02 10:56:56 +0000
443
+++ debian/po/uk.po	2013-08-28 12:36:13 +0000
444
@@ -15,8 +15,13 @@
445
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
446
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
447
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
448
18
<<<<<<< TREE
449
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
450
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
451
21
=======
452
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
453
23
"X-Generator: Launchpad (build 16598)\n"
454
24
>>>>>>> MERGE-SOURCE
455
20
25
456
21
#. Type: string
26
#. Type: string
457
22
#. Description
27
#. Description
458
23
28
459
=== modified file 'debian/po/zh_CN.po'
460
--- debian/po/zh_CN.po	2013-08-02 10:56:56 +0000
461
+++ debian/po/zh_CN.po	2013-08-28 12:36:13 +0000
462
@@ -15,8 +15,13 @@
463
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
464
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
465
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
466
18
<<<<<<< TREE
467
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
468
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
469
21
=======
470
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
471
23
"X-Generator: Launchpad (build 16598)\n"
472
24
>>>>>>> MERGE-SOURCE
473
20
25
474
21
#. Type: string
26
#. Type: string
475
22
#. Description
27
#. Description
476
23
28
477
=== modified file 'debian/po/zh_TW.po'
478
--- debian/po/zh_TW.po	2013-08-02 10:56:56 +0000
479
+++ debian/po/zh_TW.po	2013-08-28 12:36:13 +0000
480
@@ -15,8 +15,13 @@
481
15
"MIME-Version: 1.0\n"
15
"MIME-Version: 1.0\n"
482
16
"Content-Type: text/plain; charset=UTF-8\n"
16
"Content-Type: text/plain; charset=UTF-8\n"
483
17
"Content-Transfer-Encoding: 8bit\n"
17
"Content-Transfer-Encoding: 8bit\n"
484
18
<<<<<<< TREE
485
18
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
19
"X-Launchpad-Export-Date: 2013-07-24 05:13+0000\n"
486
19
"X-Generator: Launchpad (build 16700)\n"
20
"X-Generator: Launchpad (build 16700)\n"
487
21
=======
488
22
"X-Launchpad-Export-Date: 2013-05-09 05:18+0000\n"
489
23
"X-Generator: Launchpad (build 16598)\n"
490
24
>>>>>>> MERGE-SOURCE
491
20
25
492
21
#. Type: string
26
#. Type: string
493
22
#. Description
27
#. Description
494
23
28
495
=== modified file 'jobs/graphics.txt.in'
496
=== modified file 'jobs/mediacard.txt.in'
497
--- jobs/mediacard.txt.in	2013-08-02 10:56:56 +0000
498
+++ jobs/mediacard.txt.in	2013-08-28 12:36:13 +0000
499
@@ -78,6 +78,52 @@
500
78
     The verification of this test is automated. Do not change the
78
     The verification of this test is automated. Do not change the
501
79
     automatically selected result.
79
     automatically selected result.
502
80
80
503
81
<<<<<<< TREE
504
82
=======
505
83
plugin: user-interact
506
84
name: mediacard/sd-insert-after-suspend
507
85
depends: suspend/suspend_advanced
508
86
command: removable_storage_watcher --memorycard insert sdio usb scsi
509
87
_description:
510
88
 PURPOSE:
511
89
     This test will check that the systems media card reader can
512
90
     detect the insertion of an UNLOCKED SD card after the system
513
91
     has been suspended
514
92
 STEPS:
515
93
     1. Click "Test" and insert an UNLOCKED SD card into the reader.
516
94
        If a file browser opens up, you can safely close it.
517
95
        (Note: this test will time-out after 20 seconds.)
518
96
     2. Do not remove the device after this test.
519
97
 VERIFICATION:
520
98
     The verification of this test is automated. Do not change the
521
99
     automatically selected result.
522
100
523
101
plugin: shell
524
102
name: mediacard/sd-storage-after-suspend
525
103
depends: mediacard/sd-insert-after-suspend
526
104
user: root
527
105
command: removable_storage_test -s 268400000 --memorycard sdio usb scsi
528
106
_description:
529
107
 This test is automated and executes after the mediacard/sd-insert-after-suspend test
530
108
 is run. It tests reading and writing to the SD card after the system has been suspended.
531
109
532
110
plugin: user-interact
533
111
name: mediacard/sd-remove-after-suspend
534
112
depends: mediacard/sd-insert-after-suspend
535
113
command: removable_storage_watcher --memorycard remove sdio usb scsi
536
114
_description:
537
115
 PURPOSE:
538
116
     This test will check that the system correctly detects 
539
117
     the removal of an SD card from the systems card reader 
540
118
     after the system has been suspended.
541
119
 STEPS:
542
120
     1. Click "Test" and remove the SD card from the reader.
543
121
        (Note: this test will time-out after 20 seconds.)
544
122
 VERIFICATION:
545
123
     The verification of this test is automated. Do not change the
546
124
     automatically selected result.
547
125
548
126
>>>>>>> MERGE-SOURCE
549
81
plugin: shell
127
plugin: shell
550
82
name: mediacard/sd-preinserted
128
name: mediacard/sd-preinserted
551
83
user: root
129
user: root
552
@@ -130,6 +176,51 @@
553
130
     automatically selected result.
176
     automatically selected result.
554
131
177
555
132
plugin: user-interact
178
plugin: user-interact
556
179
<<<<<<< TREE
557
180
=======
558
181
name: mediacard/sdhc-insert-after-suspend
559
182
depends: suspend/suspend_advanced
560
183
command: removable_storage_watcher --memorycard insert sdio usb scsi
561
184
_description:
562
185
 PURPOSE:
563
186
     This test will check that the systems media card reader can
564
187
     detect the insertion of an UNLOCKED SDHC media card after the 
565
188
     system has been suspended
566
189
 STEPS:
567
190
     1. Click "Test" and insert an UNLOCKED SDHC card into the reader.
568
191
        If a file browser opens up, you can safely close it.
569
192
        (Note: this test will time-out after 20 seconds.)
570
193
     2. Do not remove the device after this test.
571
194
 VERIFICATION:
572
195
     The verification of this test is automated. Do not change the
573
196
     automatically selected result.
574
197
575
198
plugin: shell
576
199
name: mediacard/sdhc-storage-after-suspend
577
200
depends: mediacard/sdhc-insert-after-suspend
578
201
user: root
579
202
command: removable_storage_test -s 268400000 --memorycard sdio usb scsi
580
203
_description:
581
204
 This test is automated and executes after the mediacard/sdhc-insert-after-suspend test
582
205
 is run. It tests reading and writing to the SDHC card after the system has been suspended.
583
206
584
207
plugin: user-interact
585
208
name: mediacard/sdhc-remove-after-suspend
586
209
depends: mediacard/sdhc-insert-after-suspend
587
210
command: removable_storage_watcher --memorycard remove sdio usb scsi
588
211
_description:
589
212
 PURPOSE:
590
213
     This test will check that the system correctly detects the removal
591
214
     of an SDHC card from the systems card reader after the system has been suspended.
592
215
 STEPS:
593
216
     1. Click "Test" and remove the SDHC card from the reader.
594
217
        (Note: this test will time-out after 20 seconds.)
595
218
 VERIFICATION:
596
219
     The verification of this test is automated. Do not change the
597
220
     automatically selected result.
598
221
599
222
plugin: user-interact
600
223
>>>>>>> MERGE-SOURCE
601
133
name: mediacard/cf-insert
224
name: mediacard/cf-insert
602
134
command: removable_storage_watcher --memorycard insert sdio usb scsi
225
command: removable_storage_watcher --memorycard insert sdio usb scsi
603
135
_description:
226
_description:
604
136
227
605
=== modified file 'jobs/resource.txt.in'
606
--- jobs/resource.txt.in	2013-07-12 14:51:00 +0000
607
+++ jobs/resource.txt.in	2013-08-28 12:36:13 +0000
608
@@ -56,6 +56,12 @@
609
56
command:
56
command:
610
57
    find -H $(echo "$PATH" | sed -e 's/:/ /g') -maxdepth 1 -type f -executable -printf "name: %f\n\n"
57
    find -H $(echo "$PATH" | sed -e 's/:/ /g') -maxdepth 1 -type f -executable -printf "name: %f\n\n"
611
58
58
612
59
name: executable
613
60
plugin: resource
614
61
description: Generates a resource for all available executables
615
62
command:
616
63
    find -H $(echo "$PATH" | sed -e 's/:/ /g') -maxdepth 1 -type f -executable -printf "name: %f\n\n"
617
64
618
59
name: device
65
name: device
619
60
plugin: resource
66
plugin: resource
620
61
command: udev_resource
67
command: udev_resource
621
62
68
622
=== added directory 'plainbox'
623
=== added file 'plainbox/MANIFEST.in.OTHER'
624
--- plainbox/MANIFEST.in.OTHER	1970-01-01 00:00:00 +0000
625
+++ plainbox/MANIFEST.in.OTHER	2013-08-28 12:36:13 +0000
626
@@ -0,0 +1,9 @@
627
1
include README.md
628
2
include COPYING
629
3
include mk-interesting-graphs.sh
630
4
recursive-include plainbox/test-data/ *.json *.xml *.txt
631
5
recursive-include docs *.rst
632
6
include docs/conf.py
633
7
include plainbox/data/report/hardware-1_0.rng
634
8
include contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy
635
9
include contrib/policykit_auth_admin_keep/org.freedesktop.policykit.pkexec.policy
636
0
10
637
=== added directory 'plainbox/contrib'
638
=== added directory 'plainbox/contrib/policykit_auth_admin_keep'
639
=== added file 'plainbox/contrib/policykit_auth_admin_keep/org.freedesktop.policykit.pkexec.policy'
640
--- plainbox/contrib/policykit_auth_admin_keep/org.freedesktop.policykit.pkexec.policy	1970-01-01 00:00:00 +0000
641
+++ plainbox/contrib/policykit_auth_admin_keep/org.freedesktop.policykit.pkexec.policy	2013-08-28 12:36:13 +0000
642
@@ -0,0 +1,30 @@
643
1
<?xml version="1.0" encoding="UTF-8"?>
644
2
<!DOCTYPE policyconfig PUBLIC
645
3
 "-//freedesktop//DTD PolicyKit Policy Configuration 1.0//EN"
646
4
 "http://www.freedesktop.org/standards/PolicyKit/1/policyconfig.dtd">
647
5
<policyconfig>
648
6
649
7
  <!--
650
8
    Policy definitions for PlainBox system actions.
651
9
    (C) 2013 Canonical Ltd.
652
10
    Author: Sylvain Pineau <sylvain.pineau@canonical.com>
653
11
  -->
654
12
655
13
  <vendor>PlainBox</vendor>
656
14
  <vendor_url>https://launchpad.net/checkbox</vendor_url>
657
15
  <icon_name>checkbox</icon_name>
658
16
659
17
  <action id="org.freedesktop.policykit.pkexec.run-plainbox-job">
660
18
    <description>Run Job command</description>
661
19
    <message>Please enter your password. Some tests require root access to run properly. Your password will never be stored and will never be submitted with test results.</message>
662
20
    <defaults>
663
21
      <allow_any>no</allow_any>
664
22
      <allow_inactive>no</allow_inactive>
665
23
      <allow_active>auth_admin_keep</allow_active>
666
24
    </defaults>
667
25
    <annotate key="org.freedesktop.policykit.exec.path">/usr/bin/checkbox-trusted-launcher</annotate>
668
26
    <annotate key="org.freedesktop.policykit.exec.allow_gui">TRUE</annotate>
669
27
  </action>
670
28
671
29
</policyconfig>
672
30
673
0
31
674
=== added directory 'plainbox/contrib/policykit_yes'
675
=== added file 'plainbox/contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy.OTHER'
676
--- plainbox/contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy.OTHER	1970-01-01 00:00:00 +0000
677
+++ plainbox/contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy.OTHER	2013-08-28 12:36:13 +0000
678
@@ -0,0 +1,29 @@
679
1
<?xml version="1.0" encoding="UTF-8"?>
680
2
<!DOCTYPE policyconfig PUBLIC
681
3
 "-//freedesktop//DTD PolicyKit Policy Configuration 1.0//EN"
682
4
 "http://www.freedesktop.org/standards/PolicyKit/1/policyconfig.dtd">
683
5
<policyconfig>
684
6
685
7
  <!--
686
8
    Policy definitions for PlainBox system actions.
687
9
    (C) 2013 Canonical Ltd.
688
10
    Author: Sylvain Pineau <sylvain.pineau@canonical.com>
689
11
  -->
690
12
691
13
  <vendor>PlainBox</vendor>
692
14
  <vendor_url>https://launchpad.net/checkbox</vendor_url>
693
15
  <icon_name>checkbox</icon_name>
694
16
695
17
  <action id="org.freedesktop.policykit.pkexec.run-plainbox-job">
696
18
    <description>Run Job command</description>
697
19
    <defaults>
698
20
      <allow_any>no</allow_any>
699
21
      <allow_inactive>no</allow_inactive>
700
22
      <allow_active>yes</allow_active>
701
23
    </defaults>
702
24
    <annotate key="org.freedesktop.policykit.exec.path">/usr/bin/checkbox-trusted-launcher</annotate>
703
25
    <annotate key="org.freedesktop.policykit.exec.allow_gui">TRUE</annotate>
704
26
  </action>
705
27
706
28
</policyconfig>
707
29
708
0
30
709
=== added directory 'plainbox/docs'
710
=== added directory 'plainbox/docs/dev'
711
=== added file 'plainbox/docs/dev/architecture.rst.OTHER'
712
--- plainbox/docs/dev/architecture.rst.OTHER	1970-01-01 00:00:00 +0000
713
+++ plainbox/docs/dev/architecture.rst.OTHER	2013-08-28 12:36:13 +0000
714
@@ -0,0 +1,40 @@
715
1
PlainBox Architecture
716
2
=====================
717
3
718
4
This document explains the architecture of PlainBox internals. It should be
719
5
always up-to-date and accurate to the extent of the scope of this overview.
720
6
721
7
.. toctree::
722
8
   :maxdepth: 3
723
9
724
10
   trusted-launcher.rst
725
11
   config.rst
726
12
   resources.rst
727
13
   old.rst
728
14
729
15
General design considerations
730
16
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
731
17
732
18
PlainBox is a reimplementation of CheckBox that replaces a reactor / event /
733
19
plugin architecture with a monolithic core and tightly integrated components.
734
20
735
21
The implementation models a few of the externally-visible concepts such as
736
22
jobs, resources and resource programs but also has some additional design that
737
23
was not present in CheckBox before.
738
24
739
25
The goal of the rewrite is to provide the right model and APIs for user
740
26
interfaces in order to build the kind of end-user solution that we could not
741
27
build with CheckBox.
742
28
743
29
This is expressed by additional functionality that is there only to provide the
744
30
higher layers with the right data (failure reason, descriptions, etc.). The
745
31
code is also intended to be highly testable. Test coverage at the time of
746
32
writing this document was exceeding 80%
747
33
748
34
The core requirement for the current phase of PlainBox development is feature
749
35
parity with CheckBox and gradual shift from one to another in the daily
750
36
responsibilities of the Hardware Certification team. Currently PlainBox
751
37
implements a large chunk of core / essential features from CheckBox. While not
752
38
all features are present the core is considered almost feature complete at this
753
39
stage.
754
40
755
0
41
756
=== added file 'plainbox/docs/dev/old.rst.OTHER'
757
--- plainbox/docs/dev/old.rst.OTHER	1970-01-01 00:00:00 +0000
758
+++ plainbox/docs/dev/old.rst.OTHER	2013-08-28 12:36:13 +0000
759
@@ -0,0 +1,343 @@
760
1
Old Architecture Notes
761
2
======================
762
3
763
4
.. warning::
764
5
765
6
    This section needs maintenance
766
7
767
8
Application Skeleton
768
9
^^^^^^^^^^^^^^^^^^^^
769
10
770
11
This skeleton represents a typical application based on PlainBox. It enumerates
771
12
the essential parts of the APIs from the point of view of an application
772
13
developer.
773
14
774
15
1. Instantiate :class:`plainbox.impl.checkbox.CheckBox` then call
775
16
   :meth:`plainbox.impl.checkbox.CheckBox.get_builtin_jobs()` to discover all
776
17
   known jobs. In the future this might be replaced by a step that obtains jobs
777
18
   from a named provider.
778
19
779
20
3. Instantiate :class:`plainbox.impl.runner.JobRunner` so that we can run jobs
780
21
781
22
4. Instantiate :class:`plainbox.impl.session.SessionState` so that we can keep
782
23
   track of application state.
783
24
784
25
   - Potentially restore an earlier, interrupted, testing session by calling
785
26
     :meth:`plainbox.impl.session.SessionState.restore()`
786
27
787
28
   - Potentially remove an earlier, interrupted, testing session by calling
788
29
     :meth:`plainbox.impl.session.SessionState.discard()`
789
30
790
31
   - Potentially start a new test session by calling
791
32
     :meth:`plainbox.impl.session.SessionState.open()`
792
33
793
34
5. Allow the user to select jobs that should be executed and update session
794
35
   state by calling
795
36
   :meth:`plainbox.impl.session.SessionState.update_desired_job_list()`
796
37
797
38
6. For each job in :attr:`plainbox.impl.SessionState.run_list`:
798
39
799
40
   1. Check if we want to run the job (if we have a result for it from previous
800
41
      runs) or if we must run it (for jobs that cannot be persisted across
801
42
      suspend)
802
43
803
44
   2. Check if the job can be started by looking at
804
45
      :meth:`plainbox.impl.session.JobState.can_start()`
805
46
806
47
      - optionally query for additional data on why a job cannot be started and
807
48
        present that to the user.
808
49
809
50
      - optionally abort the sequence and go to step 5 or the outer loop.
810
51
811
52
   3. Call :meth:`plainbox.impl.runner.JobRunner.run_job()` with the current
812
53
      job and store the result.
813
54
814
55
        - optionally ask the user to perform some manipulation
815
56
816
57
        - optionally ask the user to qualify the outcome
817
58
818
59
        - optionally ask the user for additional comments
819
60
820
61
   4. Call :meth:`plainbox.impl.session.SessionState.update_job_result()` to
821
62
      update readiness of jobs that depend on the outcome or output of current
822
63
      job.
823
64
824
65
   5. Call :meth:`plainbox.impl.session.SessionState.checkpoint()` to ensure
825
66
      that testing can resume after system crash or shutdown.
826
67
827
68
7. Instantiate the selected state exporter, for example
828
69
   :class:`plainbox.impl.exporters.json.JSONSessionStateExporter` so that we
829
70
   can use it to save test results.
830
71
831
72
    - optionally pass configuration options to customize the subset and the
832
73
      presentation of the session state
833
74
834
75
8. Call
835
76
   :meth:`plainbox.impl.exporters.SessionStateExporterBase.get_session_data_subset()`
836
77
   followed by :meth:`plainbox.impl.exporters.SessionStateExporterBase.dump()`
837
78
   to save results to a file.
838
79
839
80
9. Call :meth:`plainbox.impl.session.SessionState.close()` to remove any
840
81
   nonvolatile temporary storage that was needed for the session.
841
82
842
83
Essential classes
843
84
=================
844
85
845
86
:class:`~plainbox.impl.session.SessionState`
846
87
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
847
88
848
89
Class representing all state needed during a single program session.
849
90
850
91
Usage
851
92
-----
852
93
853
94
The general idea is that you feed the session with a list of known jobs and
854
95
a subset of jobs that you want to run and in return get an ordered list of
855
96
jobs to run.
856
97
857
98
It is expected that the user will select / deselect and run jobs. This
858
99
class can react to both actions by recomputing the dependency graph and
859
100
updating the read states accordingly.
860
101
861
102
As the user runs subsequent jobs the results of those jobs are exposed to
862
103
the session with :meth:`update_job_result()`. This can cause subsequent
863
104
jobs to become available (not inhibited by anything). Note that there is no
864
105
notification of changes at this time.
865
106
866
107
The session does almost nothing by itself, it learns about everything by
867
108
observing job results coming from the job runner
868
109
(:class:`plainbox.impl.runner.JobRunner`) that applications need to
869
110
instantiate.
870
111
871
112
Suspend and resume
872
113
------------------
873
114
874
115
The session can save check-point data after each job is executed. This
875
116
allows the system to survive and continue after a catastrophic failure
876
117
(broken suspend, power failure) or continue across tests that require the
877
118
machine to reboot.
878
119
879
120
.. todo::
880
121
881
122
    Create a section on suspend/resume design
882
123
883
124
Implementation notes
884
125
--------------------
885
126
886
127
Internally it ties into :class:`plainbox.impl.depmgr.DependencySolver` for
887
128
resolving dependencies. The way the session objects are used allows them to
888
129
return various problems back to the UI level - those are all the error
889
130
classes from :mod:`plainbox.impl.depmgr`:
890
131
891
132
    - :class:`plainbox.impl.depmgr.DependencyCycleError`
892
133
893
134
    - :class:`plainbox.impl.depmgr.DependencyDuplicateError`
894
135
895
136
    - :class:`plainbox.impl.depmgr.DependencyMissingError`
896
137
897
138
Normally *none* of those errors should ever happen, they are only provided
898
139
so that we don't choke when a problem really happens. Everything is checked
899
140
and verified early before starting a job so typical unit and integration
900
141
testing should capture broken job definitions (for example, with cyclic
901
142
dependencies) being added to the repository.
902
143
903
144
Implementation issues
904
145
---------------------
905
146
906
147
There are two issues that are known at this time:
907
148
908
149
* There is too much checkbox-specific knowledge which really belongs
909
150
  elsewhere. We are working to remove that so that non-checkbox jobs
910
151
  can be introduced later. There is a branch in progress that entirely
911
152
  removes that and moves it to a new concept called SessionController.
912
153
  In that design the session delegates understanding of results to a
913
154
  per-job session controller and exposes some APIs to alter the state
914
155
  that was previously internal (most notably a way to add new jobs and
915
156
  resources).
916
157
917
158
* The way jobs are currently selected is unfortunate because of local jobs
918
159
  that can add new jobs to the system. This causes considerable complexity
919
160
  at the application level where the application must check if each
920
161
  executed job is a 'local' job and re-compute the desired_job_list. This
921
162
  should be replaced by a matcher function that can be passed to
922
163
  SessionState once so that desired_job_list is re-evaluated internally
923
164
  whenever job_list changes.
924
165
925
166
926
167
:class:`~plainbox.impl.job.JobDefinition`
927
168
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
928
169
929
170
:term:`CheckBox` has a concept of a :term:`job`. Jobs are named units of
930
171
testing work that can be executed. Typical jobs range from automated CPU power
931
172
management checks, BIOS tests, semi-automated peripherals testing to all manual
932
173
validation by following a script (intended for humans).
933
174
934
175
Jobs are distributed in plain text files, formated as a loose RFC822 documents
935
176
where typically a single text file contains a few dozen different jobs that
936
177
belong to one topic, for example, all bluetooth tests.
937
178
938
179
Tests have a number of properties that will not be discussed in detail here,
939
180
they are all documented in :class:`plainbox.impl.job.JobDefinition`. From the
940
181
architecture point of view the four essential properties of a job are *name*,
941
182
*plugin* and *requires* and *depends*. Those are discussed in detail below.
942
183
943
184
JobDefinition.name
944
185
------------------
945
186
946
187
The *name* field must be unique and is referred to by other parts of the system
947
188
(such as whitelists). Typically jobs follow a simple naming pattern
948
189
'category/detail', eg, 'networking/modem_connection'. The name must be _unique_
949
190
and this is enforced by the core.
950
191
951
192
JobDefinition.plugin
952
193
--------------------
953
194
954
195
The *plugin* field is an archaism from CheckBox and a misnomer (as PlainBox
955
196
does not have any plugins). In the CheckBox architecture it would instruct the
956
197
core which plugin should process that job. In PlainBox it is a way to encode
957
198
what type of a job is being processed. There is a finite set of types that are
958
199
documented below. 
959
200
960
201
plugin == "shell"
961
202
#################
962
203
963
204
This value is used for fully automated jobs. Everything the job needs to do is
964
205
automated (preparation, execution, verification) and fully handled by the
965
206
command that is associated with a job.
966
207
967
208
plugin == "manual" 
968
209
##################
969
210
970
211
This value is used for fully manual jobs. It has no special handling in the core
971
212
apart from requiring a human-provided outcome (pass/fail classification) 
972
213
973
214
.. _local:
974
215
975
216
plugin == "local"
976
217
#################
977
218
978
219
This value is used for special job generator jobs. The output of such jobs is
979
220
interpreted as additional jobs and is identical in effect to loading such jobs
980
221
from a job definition file. 
981
222
982
223
There are two practical uses for such jobs:
983
224
984
225
* Some local jobs are used to generate a number of jobs for each object.
985
226
  This is needed where the tested machine may have a number of such objects
986
227
  and each requires unique testing. A good example is a computer where all
987
228
  network tests are explicitly "instantiated" for each network card
988
229
  present.
989
230
 
990
231
  This is a valid use case but is rather unfortunate for architecture of
991
232
  PlainBox and there is a desire to replace it with equally-expressive
992
233
  pattern jobs. The advantage is that unlike local jobs (which cannot be
993
234
  "discovered" without enduring any potential side effects that may be
994
235
  caused by the job script command) pattern jobs would allow the core to
995
236
  determine the names of jobs that can be generated and, for example,
996
237
  automatically determine that a pattern job needs to be executed as a
997
238
  dependency of a phantom (yet undetermined) job with a given name.
998
239
999
240
  The solution with "pattern" jobs may be executed in future phases of
1000
241
  PlainBox development. Currently there is no support for that at all.
1001
242
1002
243
  Currently PlainBox cannot determine job dependencies across local jobs.
1003
244
  That is, unless a local job is explicitly requested (in the desired job
1004
245
  list) PlainBox will not be able to run a job that is generated by a local
1005
246
  job at all and will treat it as if that job never existed.
1006
247
1007
248
* Some local jobs are used to create a form of informal "category".
1008
249
  Typically all such jobs have a leading and trailing double underscore,
1009
250
  for example '__audio__'. This is currently being used by CheckBox for
1010
251
  building a hierarchical tree of tests that the user may select.
1011
252
1012
253
  Since this has the same flaws as described above (for pattern jobs) it
1013
254
  will likely be replaced by an explicit category field that can be
1014
255
  specified each job.
1015
256
1016
257
plugin == "resource"
1017
258
####################
1018
259
1019
260
This value is used for special "data" or "environment" jobs. Their output is
1020
261
parsed as a list of RFC822 records and is kept by the core during a testing session.
1021
262
1022
263
They are primarily used to determine if a given job can be started. For
1023
264
example, a particular bluetooth test may use the _requires_ field to indicate
1024
265
that it depends (via a resource dependency) on a job that enumerates devices
1025
266
and that one of those devices must be a bluetooth device.
1026
267
1027
268
plugin == "user-interact"
1028
269
#########################
1029
270
1030
271
For all intents and purposes it is equivalent to "manual". The actual
1031
272
difference is that a user is expected to perform some physical manipulation
1032
273
before an automated test.
1033
274
1034
275
plugin == "user-verify"
1035
276
#######################
1036
277
1037
278
For all intents and purposes it is equivalent to "manual". The actual
1038
279
difference is that a user is expected to perform manual verification after an
1039
280
automated test.
1040
281
1041
282
JobDefinition.depends
1042
283
---------------------
1043
284
1044
285
The *depends* field is used to express dependencies between two jobs. If job A
1045
286
has depends on job B then A cannot start if B is not both finished and
1046
287
successful. PlainBox understands this dependency and can automatically sort and
1047
288
execute jobs in proper order. In many places of the code this is referred to as
1048
289
a "direct dependency" (in contrast to "resource dependency")
1049
290
1050
291
The actual syntax is not strictly specified, PlainBox interprets this field as
1051
292
a list of tokens delimited by comma or any whitespace (including newlines).
1052
293
1053
294
A job may depend on any number of other jobs. There are a number of failure
1054
295
modes associated with this feature, all of which are detected and handled by
1055
296
PlainBox. Typically they only arise when during CheckBox job development
1056
297
(editing actual job files) and are always a sign of a human error. No released
1057
298
version of CheckBox or PlainBox should ever encounter any of those issues.
1058
299
1059
300
The actual problems are:
1060
301
1061
302
* dependency cycles, where job either directly or indirectly depends on
1062
303
  itself
1063
304
1064
305
* missing dependencies where some job refers to a job that is not defined
1065
306
  anywhere.
1066
307
1067
308
* duplicate jobs where two jobs with the same name (but different
1068
309
  definition) are being introduced to the system.
1069
310
1070
311
In all of those cases the core removes the offending job and tries to work
1071
312
regardless of the problem. This is intended more as a development aid rather
1072
313
than a reliability feature as no released versions of either project should
1073
314
cause this problem.
1074
315
1075
316
JobDefinition.command
1076
317
---------------------
1077
318
1078
319
The *command* field is used when the job needs to call an external command.
1079
320
Typically all shell jobs define a command to run.
1080
321
1081
322
"Manual" jobs can also define a command to run as part of the test procedure.
1082
323
1083
324
JobDefinition.user
1084
325
------------------
1085
326
1086
327
The *user* field is used when the job requires to run as a specific user
1087
328
(e.g. root).
1088
329
1089
330
The job command will be run via pkexec to get the necessary
1090
331
permissions.
1091
332
1092
333
.. _environ:
1093
334
1094
335
JobDefinition.environ
1095
336
---------------------
1096
337
1097
338
The *environ* field is used to pass additional environmental keys from the user
1098
339
session to the new environment set up when the job command is run by another
1099
340
user (root, most of the time).
1100
341
1101
342
The actual syntax is not strictly specified, PlainBox interprets this field as
1102
343
a list of tokens delimited by comma or any whitespace (including newlines).
1103
0
344
1104
=== added file 'plainbox/docs/dev/reference.rst.OTHER'
1105
--- plainbox/docs/dev/reference.rst.OTHER	1970-01-01 00:00:00 +0000
1106
+++ plainbox/docs/dev/reference.rst.OTHER	2013-08-28 12:36:13 +0000
1107
@@ -0,0 +1,179 @@
1108
1
.. _code_reference:
1109
2
1110
3
.. toctree::
1111
4
   :maxdepth: 2
1112
5
1113
6
Code reference
1114
7
==============
1115
8
1116
9
.. note::
1117
10
1118
11
    Unless stated otherwise all API is unstable. PlainBox does not offer
1119
12
    general API stability at this time.
1120
13
1121
14
.. automodule:: plainbox
1122
15
    :members:
1123
16
    :undoc-members:
1124
17
    :show-inheritance:
1125
18
1126
19
.. automodule:: plainbox.public
1127
20
    :members:
1128
21
    :undoc-members:
1129
22
    :show-inheritance:
1130
23
1131
24
.. automodule:: plainbox.abc
1132
25
    :members:
1133
26
    :undoc-members:
1134
27
    :show-inheritance:
1135
28
1136
29
.. automodule:: plainbox.tests
1137
30
    :members:
1138
31
    :undoc-members:
1139
32
    :show-inheritance:
1140
33
1141
34
.. automodule:: plainbox.testing_utils
1142
35
    :members:
1143
36
    :undoc-members:
1144
37
    :show-inheritance:
1145
38
1146
39
.. automodule:: plainbox.testing_utils.cwd
1147
40
    :members:
1148
41
    :undoc-members:
1149
42
    :show-inheritance:
1150
43
1151
44
.. automodule:: plainbox.testing_utils.io
1152
45
    :members:
1153
46
    :undoc-members:
1154
47
    :show-inheritance:
1155
48
1156
49
.. automodule:: plainbox.testing_utils.testcases
1157
50
    :members:
1158
51
    :undoc-members:
1159
52
    :show-inheritance:
1160
53
1161
54
.. automodule:: plainbox.vendor
1162
55
    :members:
1163
56
1164
57
.. automodule:: plainbox.vendor.extcmd
1165
58
    :members:
1166
59
    :undoc-members:
1167
60
    :show-inheritance:
1168
61
1169
62
.. automodule:: plainbox.impl
1170
63
    :members:
1171
64
    :undoc-members:
1172
65
    :show-inheritance:
1173
66
1174
67
.. automodule:: plainbox.impl.commands
1175
68
    :members:
1176
69
    :undoc-members:
1177
70
    :show-inheritance:
1178
71
1179
72
.. automodule:: plainbox.impl.commands.selftest
1180
73
    :members:
1181
74
    :undoc-members:
1182
75
    :show-inheritance:
1183
76
1184
77
.. automodule:: plainbox.impl.exporter
1185
78
    :members:
1186
79
    :undoc-members:
1187
80
    :show-inheritance:
1188
81
1189
82
.. automodule:: plainbox.impl.exporter.json
1190
83
    :members:
1191
84
    :undoc-members:
1192
85
    :show-inheritance:
1193
86
1194
87
.. automodule:: plainbox.impl.exporter.rfc822
1195
88
    :members:
1196
89
    :undoc-members:
1197
90
    :show-inheritance:
1198
91
1199
92
.. automodule:: plainbox.impl.exporter.text
1200
93
    :members:
1201
94
    :undoc-members:
1202
95
    :show-inheritance:
1203
96
1204
97
.. automodule:: plainbox.impl.secure
1205
98
    :members:
1206
99
    :undoc-members:
1207
100
    :show-inheritance:
1208
101
1209
102
.. automodule:: plainbox.impl.secure.checkbox_trusted_launcher
1210
103
    :members:
1211
104
    :undoc-members:
1212
105
    :show-inheritance:
1213
106
1214
107
.. automodule:: plainbox.impl.transport
1215
108
    :members:
1216
109
    :undoc-members:
1217
110
    :show-inheritance:
1218
111
1219
112
.. automodule:: plainbox.impl.transport.certification
1220
113
    :members:
1221
114
    :undoc-members:
1222
115
    :show-inheritance:
1223
116
1224
117
.. automodule:: plainbox.impl.box
1225
118
    :members:
1226
119
    :undoc-members:
1227
120
    :show-inheritance:
1228
121
1229
122
.. automodule:: plainbox.impl.checkbox
1230
123
    :members:
1231
124
    :undoc-members:
1232
125
    :show-inheritance:
1233
126
1234
127
.. automodule:: plainbox.impl.config
1235
128
    :members:
1236
129
    :undoc-members:
1237
130
    :show-inheritance:
1238
131
1239
132
.. automodule:: plainbox.impl.depmgr
1240
133
    :members:
1241
134
    :undoc-members:
1242
135
    :show-inheritance:
1243
136
1244
137
.. automodule:: plainbox.impl.integration_tests
1245
138
    :members:
1246
139
    :undoc-members:
1247
140
    :show-inheritance:
1248
141
1249
142
.. automodule:: plainbox.impl.job
1250
143
    :members:
1251
144
    :undoc-members:
1252
145
    :show-inheritance:
1253
146
1254
147
.. automodule:: plainbox.impl.mock_job
1255
148
    :members:
1256
149
    :undoc-members:
1257
150
    :show-inheritance:
1258
151
1259
152
.. automodule:: plainbox.impl.resource
1260
153
    :members:
1261
154
    :undoc-members:
1262
155
    :show-inheritance:
1263
156
1264
157
.. automodule:: plainbox.impl.result
1265
158
    :members:
1266
159
    :undoc-members:
1267
160
    :show-inheritance:
1268
161
1269
162
.. automodule:: plainbox.impl.rfc822
1270
163
    :members:
1271
164
    :show-inheritance:
1272
165
1273
166
.. automodule:: plainbox.impl.runner
1274
167
    :members:
1275
168
    :undoc-members:
1276
169
    :show-inheritance:
1277
170
1278
171
.. automodule:: plainbox.impl.session
1279
172
    :members:
1280
173
    :undoc-members:
1281
174
    :show-inheritance:
1282
175
1283
176
.. automodule:: plainbox.impl.testing_utils
1284
177
    :members:
1285
178
    :undoc-members:
1286
179
    :show-inheritance:
1287
0
180
1288
=== added file 'plainbox/docs/dev/resources.rst.OTHER'
1289
--- plainbox/docs/dev/resources.rst.OTHER	1970-01-01 00:00:00 +0000
1290
+++ plainbox/docs/dev/resources.rst.OTHER	2013-08-28 12:36:13 +0000
1291
@@ -0,0 +1,259 @@
1292
1
Resources
1293
2
=========
1294
3
1295
4
Resources are a mechanism that allows to constrain certain :term:`job` to
1296
5
execute only on devices with appropriate hardware or software dependencies.
1297
6
This mechanism allows some types of jobs to publish resource objects to an
1298
7
abstract namespace and to a way to evaluate a resource program to determine if
1299
8
a job can be started.
1300
9
1301
10
Resources in PlainBox
1302
11
=====================
1303
12
1304
13
The following chapters explain how resources actually work in :term:`PlainBox`.
1305
14
Currently there *is* a subtle difference between this and the original
1306
15
:term:`CheckBox` implementation.
1307
16
1308
17
Resource programs
1309
18
-----------------
1310
19
1311
20
Resource programs are multi-line statements that can be embedded in job
1312
21
definitions. By far, the most common use case is to check if a required package
1313
22
is installed, and thus, the job can use it as a part of a test. A check like
1314
23
this looks like this::
1315
24
1316
25
    package.name == "fwts"
1317
26
1318
27
This resource program codifies that the job needs the ``fwts`` package to run.
1319
28
There is a companion job with the same name that interrogates the local package
1320
29
database and publishes a set of resource objects. Each such object is a
1321
30
collection of arbitrary key-value pairs. The ``package`` job simply publishes
1322
31
the ``name`` and ``version`` of each installed package but the mechanism is
1323
32
generic and applies to all resources.
1324
33
1325
34
As stated, resource programs can be multi-line, a real world example of that is
1326
35
presented below::
1327
36
1328
37
     device.category == 'CDROM'
1329
38
     optical_drive.cd == 'writable'
1330
39
1331
40
This example is much like the one above, referring to some resources, here
1332
41
coming from jobs ``device`` and ``optical_drive``. What is important to point
1333
42
out is that, as a rule of a thumb, multi line programs have an implicit ``and``
1334
43
operator between each line. This program would only evaluate to True if there
1335
44
is a writable CD-ROM available.
1336
45
1337
46
Each resource program is composed of resource expressions. Each line maps
1338
47
directly onto one expression so the example program above uses two resource
1339
48
expressions.
1340
49
1341
50
Resource expressions
1342
51
--------------------
1343
52
1344
53
Resource expressions are evaluated like normal python programs. They use all of
1345
54
the same syntax, semantics and behavior. None of the operators are overridden
1346
55
to do anything unexpected. The evaluator tries to follow the principle of least
1347
56
surprise but this is not always possible.
1348
57
1349
58
Resource expressions cannot execute arbitrary python code. In general almost
1350
59
everything is disallowed, except as noted below:
1351
60
1352
61
* Expressions can use any literals (strings, numbers, True, False, lists and tuples)
1353
62
* Expressions can use boolean operators (``and``, ``or``, ``not``)
1354
63
* Expressions can use all comparison operators
1355
64
* Expressions can use all binary and unary operators 
1356
65
* Expressions can use the set membership operator (``in``) 
1357
66
* Expressions can use read-only attribute access
1358
67
1359
68
Anything else is rejected as an invalid resource expression.
1360
69
1361
70
In addition to that, each resource expression must use exactly one variable,
1362
71
which must be used like an object with attributes. The name of that variable
1363
72
must correspond to the name of the job that generates resources. Attempts to
1364
73
use more than one variable or to not use any variables are detected early and
1365
74
rejected as invalid resource expressions.
1366
75
1367
76
The name of the variable determines which resource group to use. It must match
1368
77
the name of the job that generates such resources.
1369
78
1370
79
In the examples elsewhere in this page the  ``package`` resources are generated
1371
80
by the ``package`` job. PlainBox uses this to know which resources to try but
1372
81
also to implicitly to express dependencies so that the ``package`` job does not
1373
82
have to be explicitly selected and marked for execution prior to the job that
1374
83
in fact depends on it. This is all done automatically.
1375
84
1376
85
Evaluation
1377
86
----------
1378
87
1379
88
Due to mandatory compatibility with existing :term:`CheckBox` jobs there are
1380
89
some unexpected aspects of how evaluation is performed. Those are marked as
1381
90
**unexpected** below:
1382
91
1383
92
1. First PlainBox looks at the resource program and splits it into lines. Each
1384
93
   non-empty line is parsed and converted to a resource expression.
1385
94
   
1386
95
2. **unexpected** Each resource expression is repeatedly evaluated, once for
1387
96
   each resource from the group determined by the variable name. All exceptions
1388
97
   are silently ignored and treated as if the iteration had evaluated to False.
1389
98
   The whole resource expression evaluates to ``True`` if any of the iterations
1390
99
   evaluated to ``True``. In other words, there is an implicit ``any()`` around
1391
100
   each resource expression, iterating over all resources. 
1392
101
1393
102
3. **unexpected** The resource program evaluates to ``True`` only if all
1394
103
   resource expressions evaluated to ``True``. In other words, there is an
1395
104
   implicit ``and`` between each line.
1396
105
1397
106
Limitations
1398
107
-----------
1399
108
1400
109
The design of resource programs has the following shortcomings. The list is
1401
110
non-exhaustive, it only contains issues that we came across found not to work
1402
111
in practice.
1403
112
1404
113
Exactly one variable per expression
1405
114
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1406
115
1407
116
Each resource expression must refer to exactly one variable. This is a side
1408
117
effect of the way the evaluator works. It basically bind one object (a
1409
118
particular resource) to that variable and evaluates the expression.
1410
119
1411
120
The expression parser / syntax analyzer identifies expressions with this
1412
121
problem early and rejects them with an appropriate error message. Here are
1413
122
some examples of hypothetical expressions that exhibit this problem.
1414
123
1415
124
"I want to have mplayer and an audio device so that I can play some sounds"::
1416
125
1417
126
    device.category == "AUDIO" and package.name == "mplayer"
1418
127
1419
128
To work around this, split the expression to two separate expressions. The
1420
129
evaluator will put an implicit ``and`` between them and it will do exactly what
1421
130
you intended::
1422
131
1423
132
    device.category == "AUDIO"
1424
133
    package.name == "mplayer"
1425
134
1426
135
"I want to always run this test"::
1427
136
1428
137
    True
1429
138
1430
139
To work around this, simply remove the requirement program entirely!
1431
140
1432
141
"I want to never run this test"::
1433
142
1434
143
    False
1435
144
1436
145
To work around this remove this job from the selection. You may also use a
1437
146
special resource that produces one constant value, and check that it is equal
1438
147
to something different.
1439
148
1440
149
Exactly one resource bound to a variable at once
1441
150
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1442
151
1443
152
It's not possible to refer to two different resources, from the same resource
1444
153
group, in one resource expression. In other terms, the variable always points
1445
154
to one object, it is not a collection of objects.
1446
155
1447
156
For example, let's consider this program::
1448
157
1449
158
    package.name == 'xorg' and package.name == 'procps'
1450
159
1451
160
Seemingly the intent was to ensure that both ``xorg`` and ``procps`` are
1452
161
installed. The reason why this does not work is that at each iteration of the
1453
162
the expression evaluator, the name ``package`` refers to exactly one resource
1454
163
object. In other words, that expression is equivalent to this one::
1455
164
1456
165
    A == True and A == False
1457
166
1458
167
This type of error is not captured by our limited semantic analyzer. It will
1459
168
silently evaluate to False and inhibit the job from being stated.
1460
169
1461
170
To work around this, split the expression to two consecutive lines. As stated
1462
171
in rule 3 in the list above, there is an implicit ``and`` operator between all
1463
172
expressions. A working example that expresses the same intent looks like this::
1464
173
1465
174
    package.name == 'xorg'
1466
175
    package.name == 'procps'
1467
176
1468
177
Operator != is useless
1469
178
^^^^^^^^^^^^^^^^^^^^^^
1470
179
1471
180
This is strange at first but quickly becomes obvious once you recall rule 2
1472
181
from the list above. That rule states that the expression is evaluated
1473
182
repeatedly for each resource from a particular group and that any ``True``
1474
183
iteration marks the whole expression as ``True``).
1475
184
1476
185
Let's look at a real-world example::
1477
186
1478
187
    xinput.device_class == 'XITouchClass' and xinput.touch_mode != 'dependent'
1479
188
1480
189
So seemingly, the intent here was to have at least ``xinput`` resource with a
1481
190
``device_class`` attribute equal to ``XITouchClass`` that has ``touch_mode``
1482
191
attribute equal to anything but ``dependent``.
1483
192
1484
193
Now let's assume that we have exactly two resources in the ``xinput`` group::
1485
194
1486
195
    device_class: XITouchClass
1487
196
    touch_mode: dependant
1488
197
1489
198
    device_class: XITouchClass
1490
199
    touch_mode: something else
1491
200
1492
201
Now, this expression will evaluate to ``True``, as the second resource fulfils
1493
202
the requirements. Is this what the test designer had expected? That's hard to
1494
203
say. The problem here is that this expression can be understood as *at least
1495
204
one resource isn't something* **or** *all resources weren't something*. Both
1496
205
are equally valid desires and, depending on how the test is implemented, may or
1497
206
many not work correctly in practice.
1498
207
1499
208
Currently there is no workaround. We are considering adding a new syntax that
1500
209
would allow to specify this explicitly. The proposal is documented below as
1501
210
"implicit any(), explicit all()"
1502
211
1503
212
Everything is a string
1504
213
^^^^^^^^^^^^^^^^^^^^^^
1505
214
1506
215
Resource programs are regular python programs evaluated in unusual ways but
1507
216
all of the variables that are exposed through the resource object are strings.
1508
217
1509
218
This has considerable impact on comparison, unless you are comparing to a
1510
219
string the comparison will always silently fail as python has dynamic but
1511
220
strict, not loose types (there is no implicit type conversion). To alleviate
1512
221
this problem several type names / conversion functions are allowed in
1513
222
requirement programs. Those are:
1514
223
1515
224
* :py:class:`int`, to convert to integer numbers
1516
225
* :py:class:`float`, to convert to floating point numbers
1517
226
* :py:class:`bool`, to convert to a boolean context
1518
227
1519
228
Considered enhancements
1520
229
-----------------------
1521
230
1522
231
We are currently considering one improvement to resource programs. This would
1523
232
allow us to introduce a fix that resolves some issues in a backwards compatible
1524
233
way. Technical aspects are not yet resolved as that extension would not be
1525
234
available in :term:`CheckBox` until CheckBox can be built on top of
1526
235
:term:`PlainBox`
1527
236
1528
237
Implicit any(), explicit all()
1529
238
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1530
239
1531
240
This proposal changes the way resource expressions are evaluated.
1532
241
1533
242
The implicit ``any()`` implemented as a loop over all resources from the
1534
243
resource group designated by variable name would be configurable.
1535
244
1536
245
A developer may choose to wrap the whole expression in the ``all()`` function
1537
246
to indicate that the expression inside ``all()`` must evaluate to ``True`` for
1538
247
**all** iterations (all resources).
1539
248
1540
249
This would allow solving the case where a job can only run, for example, when a
1541
250
certain package is **not** installed.  This could be expressed as::
1542
251
1543
252
    all(package.name != 'ubuntu-desktop')
1544
253
1545
254
Resources in CheckBox
1546
255
=====================
1547
256
1548
257
The following chapters explain how resources originally worked in
1549
258
:term:`CheckBox`. Only notable differences from :term:`PlainBox` implementation
1550
259
are listed.
1551
0
260
1552
=== added file 'plainbox/docs/dev/trusted-launcher.rst'
1553
--- plainbox/docs/dev/trusted-launcher.rst	1970-01-01 00:00:00 +0000
1554
+++ plainbox/docs/dev/trusted-launcher.rst	2013-08-28 12:36:13 +0000
1555
@@ -0,0 +1,209 @@
1556
1
Running jobs as root
1557
2
====================
1558
3
1559
4
:term:`PlainBox` is started without any privilege.
1560
5
But several tests need to start commands requiring privileges.
1561
6
1562
7
Such tests will call a trusted launcher, a standalone script
1563
8
which does not depend on the :term:`PlainBox` core modules.
1564
9
`polkit <http://www.freedesktop.org/wiki/Software/polkit>`_
1565
10
will control access to system resources.
1566
11
The trusted launcher has to be started using
1567
12
`pkexec <http://www.freedesktop.org/software/polkit/docs/0.105/pkexec.1.html>`_
1568
13
so that the related policy file works as expected.
1569
14
1570
15
To avoid a security hole that allows anyone to run anything as root,
1571
16
the launcher can only run jobs installed in a system-wide directory.
1572
17
This way we are not weaken the trust system as root access is required
1573
18
to install both components (the trusted runner and jobs).
1574
19
The :term:`PlainBox` process will send an identifier which is matched by a well-known
1575
20
list in the trusted launcher. This identifier is the job hash:
1576
21
1577
22
.. code-block:: bash
1578
23
1579
24
    $ pkexec trusted-launcher JOB-HASH
1580
25
1581
26
See :meth:`plainbox.impl.secure.checkbox_trusted_launcher.BaseJob.get_checksum()` for details about job hashes.
1582
27
1583
28
Using Polkit
1584
29
^^^^^^^^^^^^
1585
30
1586
31
Available authentication methods 
1587
32
--------------------------------
1588
33
1589
34
.. note::
1590
35
1591
36
    Only applicable to the package version of PlainBox
1592
37
1593
38
PlainBox comes with two authentication methods but both aim to retain the
1594
39
granted privileges for the life of the :term:`PlainBox` process.
1595
40
1596
41
*   The first method will ask the password only once and show the following
1597
42
    agent on desktop systems (a text-based agent is available for servers):
1598
43
1599
44
    .. code-block:: text
1600
45
    
1601
46
        +-----------------------------------------------------------------------------+
1602
47
        | [X]                            Authenticate                                 |
1603
48
        +-----------------------------------------------------------------------------+
1604
49
        |                                                                             |
1605
50
        | [Icon] Please enter your password. Some tests require root access to run    |
1606
51
        |        properly. Your password will never be stored and will never be       |
1607
52
        |        submitted with test results.                                         |
1608
53
        |                                                                             |
1609
54
        |        An application is attempting to perform an action that requires      |
1610
55
        |        privileges.                                                          |
1611
56
        |        Authentication as the super user is required to perform this action. |
1612
57
        |                                                                             |
1613
58
        |        Password: [________________________________________________________] |
1614
59
        |                                                                             |
1615
60
        | [V] Details:                                                                |
1616
61
        |  Action: org.freedesktop.policykit.pkexec.run-plainbox-job                  |
1617
62
        |  Vendor: PlainBox                                                           |
1618
63
        |                                                                             |
1619
64
        |                                                     [Cancel] [Authenticate] |
1620
65
        +-----------------------------------------------------------------------------+
1621
66
1622
67
    The following policy file has to be installed in :file:`/usr/share/polkit-1/actions/`
1623
68
    on Ubuntu systems.
1624
69
    Asking the password just one time and keeps the authentication for forthcoming
1625
70
    calls is provided by the **allow_active** element and the **auth_admin_keep** value.
1626
71
    
1627
72
    Check the `polkit actions <http://www.freedesktop.org/software/polkit/docs/0.105/polkit.8.html#polkit-declaring-actions>`_
1628
73
    documentation for details about the other parameters.
1629
74
1630
75
    .. code-block:: xml
1631
76
    
1632
77
        <?xml version="1.0" encoding="UTF-8"?>
1633
78
        <!DOCTYPE policyconfig PUBLIC
1634
79
         "-//freedesktop//DTD PolicyKit Policy Configuration 1.0//EN"
1635
80
         "http://www.freedesktop.org/standards/PolicyKit/1/policyconfig.dtd">
1636
81
        <policyconfig>
1637
82
        
1638
83
          <vendor>PlainBox</vendor>
1639
84
          <vendor_url>https://launchpad.net/checkbox</vendor_url>
1640
85
          <icon_name>checkbox</icon_name>
1641
86
        
1642
87
          <action id="org.freedesktop.policykit.pkexec.run-plainbox-job">
1643
88
            <description>Run Job command</description>
1644
89
            <message>Authentication is required to run a job command.</message>
1645
90
            <defaults>
1646
91
              <allow_any>no</allow_any>
1647
92
              <allow_inactive>no</allow_inactive>
1648
93
              <allow_active>auth_admin_keep</allow_active>
1649
94
            </defaults>
1650
95
            <annotate key="org.freedesktop.policykit.exec.path">/usr/bin/checkbox-trusted-launcher</annotate>
1651
96
            <annotate key="org.freedesktop.policykit.exec.allow_gui">TRUE</annotate>
1652
97
          </action>
1653
98
        
1654
99
        </policyconfig>
1655
100
1656
101
*  The second method is only intended to be used in headless mode (like `SRU`).
1657
102
   The only difference with the above method is that **allow_active** will be set to **yes**.
1658
103
1659
104
.. note::
1660
105
1661
106
    The two policy files are available in the PlainBox :file:`contrib/` directory.
1662
107
1663
108
Environment settings with pkexec 
1664
109
--------------------------------
1665
110
1666
111
`pkexec <http://www.freedesktop.org/software/polkit/docs/0.105/pkexec.1.html>`_ 
1667
112
allows an authorized user to execute a command as another user.
1668
113
But the environment that ``command`` will run it, will be set to a minimal known
1669
114
and safe environment in order to avoid injecting code through ``LD_LIBRARY_PATH``
1670
115
or similar mechanisms.
1671
116
1672
117
However, some jobs commands require specific enviroment variables such as the
1673
118
name of an access point for a wireless test. Those kind of variables must be
1674
119
available to the trusted launcher.
1675
120
To do so, the enviromment mapping is sent to the launcher like key/value pairs
1676
121
are sent to the env(1) command:
1677
122
1678
123
.. code-block:: bash
1679
124
1680
125
    $ pkexec trusted-launcher JOB-HASH [NAME=VALUE [NAME=VALUE ...]]
1681
126
1682
127
Each NAME will be set to VALUE in the environment given that they are known
1683
128
and defined in the :ref:`JobDefinition.environ <environ>` parameter.
1684
129
1685
130
Checkbox trusted launcher
1686
131
^^^^^^^^^^^^^^^^^^^^^^^^^
1687
132
1688
133
The checkbox trusted launcher is the minimal code needed to be able to run a
1689
134
:term:`CheckBox` job command.
1690
135
1691
136
It offers base classes for the following core subclasses:
1692
137
1693
138
* :class:`plainbox.impl.rfc822.RFC822Record`
1694
139
* :class:`plainbox.impl.job.JobDefinition`
1695
140
1696
141
The only duplicated code is the RFC822 parser, where all logging features have
1697
142
been removed.
1698
143
1699
144
The :class:`plainbox.impl.secure.checkbox_trusted_launcher.Runner` class just
1700
145
executes the command process with :py:func:`os.execve`.
1701
146
1702
147
Internally the checkbox trusted launcher looks for jobs in the system locations defined in 
1703
148
:attr:`plainbox.impl.secure.checkbox_trusted_launcher.Runner.CHECKBOXES` which defaults to :file:`/usr/share/checkbox*`.
1704
149
This way the launcher can match all :term:`CheckBox` variants, like ``checkbox-oem(-.*)?``
1705
150
1706
151
Usage
1707
152
-----
1708
153
1709
154
.. code-block:: text
1710
155
1711
156
    checkbox-trusted-launcher [-h] (--hash HASH | --warmup)
1712
157
                              [--via LOCAL-JOB-HASH]
1713
158
                              [NAME=VALUE [NAME=VALUE ...]]
1714
159
    
1715
160
    positional arguments:
1716
161
      NAME=VALUE            Set each NAME to VALUE in the string environment
1717
162
    
1718
163
    optional arguments:
1719
164
      -h, --help            show this help message and exit
1720
165
      --hash HASH           job hash to match
1721
166
      --warmup              Return immediately, only useful when used with
1722
167
                            pkexec(1)
1723
168
      --via LOCAL-JOB-HASH  Local job hash to use to match the generated job
1724
169
1725
170
.. note::
1726
171
1727
172
    Check all job hashes with ``plainbox special -J``
1728
173
1729
174
As stated in the polkit chapter, only a trusted subset of the environment mapping
1730
175
will be set using :py:func:`os.execve` to run the command.
1731
176
Only the variables defined in the job environ property are allowed to avoid
1732
177
compromising the root environment.
1733
178
Needed modifications like adding ``CHECKBOX_SHARE`` and new paths to scripts are
1734
179
managed by the checkbox-trusted-launcher.
1735
180
1736
181
Authentication on PlainBox startup
1737
182
----------------------------------
1738
183
1739
184
To avoid prompting the password at the first test requiring privileges, :term:`PlainBox`
1740
185
will call the ``checkbox-trusted-launcher`` with the ``--warmup`` option.
1741
186
It's like a NOOP and it will return immediately, but thanks to the installed policy file
1742
187
the authentication will be kept.
1743
188
1744
189
.. note::
1745
190
1746
191
    When running the development version from a branch, the usual polkit
1747
192
    authentication agent will pop up to ask the password each and every time.
1748
193
    This is the only difference.
1749
194
1750
195
Special case of jobs using the CheckBox local plugin
1751
196
----------------------------------------------------
1752
197
1753
198
For jobs generated from :ref:`local <local>` jobs (e.g. disk/read_performance.*)
1754
199
the trusted launcher is started with ``--via`` meaning that we have to first
1755
200
eval a local job to find a hash match.
1756
201
Once a match is found, the job command is executed using :py:func:`os.execve`.
1757
202
1758
203
.. code-block:: bash
1759
204
1760
205
    $ pkexec checkbox-trusted-launcher --hash JOB-HASH --via LOCAL-JOB-HASH
1761
206
1762
207
.. note::
1763
208
1764
209
    it will obviously fail if any local job can ever generate another local job.
1765
0
210
1766
=== added file 'plainbox/docs/usage.rst.OTHER'
1767
--- plainbox/docs/usage.rst.OTHER	1970-01-01 00:00:00 +0000
1768
+++ plainbox/docs/usage.rst.OTHER	2013-08-28 12:36:13 +0000
1769
@@ -0,0 +1,93 @@
1770
1
.. _usage:
1771
2
1772
3
Usage
1773
4
=====
1774
5
1775
6
Currently :term:`PlainBox` has no graphical user interface. To use it you need
1776
7
to use the command line.
1777
8
1778
9
Basically there is just one command that does everything we can do so far, that
1779
10
is :command:`plainbox run`. It has a number of options that tell it which
1780
11
:term:`job` to run and what to do with results.
1781
12
1782
13
PlainBox has built-in help system so running :command:`plainbox run --help`
1783
14
will give you instant information about all the various arguments and options
1784
15
that are available. This document is not intended to replace that.
1785
16
1786
17
Running a specific job
1787
18
^^^^^^^^^^^^^^^^^^^^^^
1788
19
1789
20
To run a specific :term:`job` pass it to the ``--include-pattern`` or ``-i``
1790
21
option.
1791
22
1792
23
For example, to run the ``cpu/scaling_test`` job:
1793
24
1794
25
.. code-block:: bash
1795
26
1796
27
    $ plainbox run -i cpu/scaling_test
1797
28
1798
29
.. note::
1799
30
1800
31
    The option ``-i`` can be provided any number of times.
1801
32
1802
33
Running jobs related to a specific area
1803
34
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1804
35
1805
36
PlainBox has no concept of job categories but you can simulate that by
1806
37
running all jobs that follow a specific naming pattern. For example, to run
1807
38
all of the USB tests you can run the following command:
1808
39
1809
40
.. code-block:: bash
1810
41
1811
42
    $ plainbox run -i 'usb/.*'
1812
43
1813
44
To list all known jobs run:
1814
45
1815
46
.. code-block:: bash
1816
47
1817
48
    plainbox special --list-jobs
1818
49
1819
50
Running a white list
1820
51
^^^^^^^^^^^^^^^^^^^^
1821
52
1822
53
To run a :term:`white list` pass the ``--whitelist`` or ``-w`` option.
1823
54
1824
55
For example, to run the default white list run:
1825
56
1826
57
.. code-block:: bash
1827
58
1828
59
    $ plainbox run -w /usr/share/checkbox/data/whitelists/default.whitelist
1829
60
1830
61
Saving test results as XML
1831
62
^^^^^^^^^^^^^^^^^^^^^^^^^^
1832
63
1833
64
To generate an XML file that can be sent to the :term:`certification website`
1834
65
you need to pass two additional options:
1835
66
1836
67
1. ``--output-format=xml``
1837
68
2. ``--output-file=NAME`` where *NAME* is a file name
1838
69
1839
70
For example, to get the default certification tests ready to be submitted
1840
71
run this command:
1841
72
1842
73
.. code-block:: bash
1843
74
1844
75
    $ plainbox run --whitelist=/usr/share/checkbox/data/whitelists/default.whitelist --output-format=xml --output-file=submission.xml
1845
76
1846
77
Running stable release update tests
1847
78
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1848
79
1849
80
PlainBox has special support for running stable release updates tests in an
1850
81
automated manner. This runs all the jobs from the *sru.whitelist* and sends the
1851
82
results to the certification website.
1852
83
1853
84
To run SRU tests you will need to know the so-called :term:`Secure ID` of the
1854
85
device you are testing. Once you know that all you need to do is run:
1855
86
1856
87
.. code-block:: bash
1857
88
1858
89
    $ plainbox sru $secure_id submission.xml
1859
90
1860
91
The second argument, submission.xml, is a name of the fallback file that is
1861
92
only created when sending the data to the certification website fails to work
1862
93
for any reason.
1863
0
94
1864
=== added file 'plainbox/mk-venv.sh.OTHER'
1865
--- plainbox/mk-venv.sh.OTHER	1970-01-01 00:00:00 +0000
1866
+++ plainbox/mk-venv.sh.OTHER	2013-08-28 12:36:13 +0000
1867
@@ -0,0 +1,195 @@
1868
1
#!/bin/sh
1869
2
# Create a virtualenv for working with plainbox.
1870
3
#
1871
4
# This ensures that 'plainbox' command exists and is in PATH and that the
1872
5
# plainbox module is correctly located can be imported.
1873
6
#
1874
7
# This is how Zygmunt Krynicki works, feel free to use or adjust to your needs
1875
8
1876
9
VENV_PATH=
1877
10
install_missing=0
1878
11
# Parse arguments:
1879
12
while [ -n "$1" ]; do
1880
13
    case "$1" in
1881
14
        --help|-h)
1882
15
            echo "Usage: mk-venv.sh [LOCATION]"
1883
16
            echo ""
1884
17
            echo "Create a virtualenv for working with plainbox in LOCATION"
1885
18
            exit 0
1886
19
            ;;
1887
20
        --install-missing)
1888
21
            install_missing=1
1889
22
            shift
1890
23
            ;;
1891
24
        *)
1892
25
            if [ -z "$VENV_PATH" ]; then
1893
26
                VENV_PATH="$1"
1894
27
                shift
1895
28
            else
1896
29
                echo "Error: too many arguments: '$1'"
1897
30
                exit 1
1898
31
            fi
1899
32
            ;;
1900
33
    esac
1901
34
done
1902
35
1903
36
# Apply defaults to arguments without values
1904
37
if [ -z "$VENV_PATH" ]; then
1905
38
    # Use sensible defaults for vagrant
1906
39
    if [ "$LOGNAME" = "vagrant" ]; then
1907
40
        VENV_PATH=/tmp/venv
1908
41
    else
1909
42
        VENV_PATH=/ramdisk/venv
1910
43
    fi
1911
44
fi
1912
45
1913
46
# Do a sanity check on lsb_release that is missing on Fedora the last time I
1914
47
# had a look at it.
1915
48
if [ "x$(which lsb_release)" = "x" ]; then
1916
49
    echo "This script requires the 'lsb_release' command"
1917
50
    exit 1
1918
51
fi
1919
52
1920
53
# The code below is a mixture of Debian/Ubuntu packages and pypi packages.
1921
54
# It is designed to work on Ubuntu 12.04 or later.
1922
55
# There are _some_ differences between how each release is handled.
1923
56
#
1924
57
# Non Ubuntu systems are not tested as they don't have the required checkbox
1925
58
# package. Debian might be supported once we have JobBox and stuff like Fedora
1926
59
# would need a whole new approach but patches are welcome [CLA required] 
1927
60
if [ "$(lsb_release --short --id)" != "Ubuntu" ] && [ $(lsb_release --short --id --upstream) != "Ubuntu" ]; then
1928
61
    echo "Only Ubuntu is supported by this script."
1929
62
    echo "If you are interested in using it with your distribution"
1930
63
    echo "then please join us in #ubuntu-quality on freenode"
1931
64
    echo
1932
65
    echo "Alternatively you can use vagrant to develop plainbox"
1933
66
    echo "on any operating system, even Windows ;-)" 
1934
67
    echo
1935
68
    echo "See: http://www.vagrantup.com/ for details"
1936
69
    exit 1
1937
70
fi
1938
71
# From now on we can assume a Debian-like system
1939
72
1940
73
# Do some conditional stuff depending on the particular Ubuntu release 
1941
74
enable_system_site=0
1942
75
install_coverage=0
1943
76
install_distribute=0
1944
77
install_pip=0
1945
78
# We need:
1946
79
# python3:
1947
80
#   because that's what plainbox is written in
1948
81
# python3-dev
1949
82
#   because we may pip-install stuff as well and we want to build native extensions
1950
83
# python3-pkg-resources:
1951
84
#   because it is used by plainbox to locate files and extension points
1952
85
# python3-setuptools:
1953
86
#   because it is used by setup.py 
1954
87
# python3-lxml:
1955
88
#   because that's how we validate RealaxNG schemas
1956
89
# python3-mock:
1957
90
#   because that's what we used to construct some of our tests
1958
91
# python3-sphinx:
1959
92
#   because that's how we build our documentation
1960
93
# python-virtualenv:
1961
94
#   because that's how we create the virtualenv to work in
1962
95
# checkbox:
1963
96
#   because plainbox depends on it as a job provider 
1964
97
required_pkgs_base="python3 python3-dev python3-pkg-resources python3-setuptools python3-lxml python3-mock python3-sphinx python-virtualenv checkbox"
1965
98
1966
99
# The defaults, install everything from pip and all the base packages
1967
100
enable_system_site=1
1968
101
install_distribute=1
1969
102
install_pip=1
1970
103
install_coverage=1
1971
104
install_requests=1
1972
105
required_pkgs="$required_pkgs_base"
1973
106
1974
107
case "$(lsb_release --short --release)" in
1975
108
    12.04|0.2)
1976
109
        # Ubuntu 12.04, this is the LTS release that we have to support despite
1977
110
        # any difficulties. It has python3.2 and all of our core dependencies
1978
111
        # although some packages are old by 13.04 standards, make sure to be
1979
112
        # careful with testing against older APIs.
1980
113
        ;;
1981
114
    12.10)
1982
115
        ;;
1983
116
    13.04)
1984
117
        # On Raring we can use the system package for python3-requests
1985
118
        install_distribute=0
1986
119
        install_pip=0
1987
120
        install_requests=0
1988
121
        required_pkgs="$required_pkgs_base python3-requests"
1989
122
        ;;
1990
123
    *)
1991
124
        echo "Using this version of Ubuntu for development is not supported"
1992
125
        echo "Unsupported version: $(lsb_release --short --release)"
1993
126
        exit 1
1994
127
        ;;
1995
128
esac
1996
129
1997
130
# Check if we can create a virtualenv
1998
131
if [ ! -d $(dirname $VENV_PATH) ]; then
1999
132
    echo "This script requires $(dirname $VENV_PATH) directory to exist"
2000
133
    echo "You can use different directory by passing it as argument"
2001
134
    echo "For a quick temporary location just pass /tmp/venv"
2002
135
    exit 1
2003
136
fi
2004
137
2005
138
# Check if there's one already there
2006
139
if [ -d $VENV_PATH ]; then
2007
140
    echo "$VENV_PATH seems to already exist"
2008
141
    exit 1
2009
142
fi
2010
143
2011
144
# Ensure that each required package is installed 
2012
145
for pkg_name in $required_pkgs; do
2013
146
    # Ensure virtualenv is installed 
2014
147
    if [ "$(dpkg -s $pkg_name 2>/dev/null | grep '^Status' 2>/dev/null)" != "Status: install ok installed" ]; then
2015
148
        if [ "$install_missing" -eq 1 ]; then
2016
149
            echo "Installing required package: $pkg_name"
2017
150
            sudo apt-get install $pkg_name --yes
2018
151
        else
2019
152
            echo "Required package is not installed: '$pkg_name'"
2020
153
            echo "Either install it manually with:"
2021
154
            echo "$ sudo apt-get install $pkg_name"
2022
155
            echo "Or rerun this script with --install-missing"
2023
156
            exit 1
2024
157
        fi
2025
158
    fi
2026
159
done
2027
160
2028
161
# Create a virtualenv
2029
162
if [ $enable_system_site -eq 1 ]; then
2030
163
    virtualenv --system-site-packages -p python3 $VENV_PATH
2031
164
else
2032
165
    virtualenv -p python3 $VENV_PATH
2033
166
fi
2034
167
2035
168
# Activate it to install additional stuff
2036
169
. $VENV_PATH/bin/activate
2037
170
2038
171
# Install / upgrade distribute
2039
172
if [ $install_distribute -eq 1 ]; then
2040
173
    pip install --upgrade https://github.com/checkbox/external-tarballs/raw/master/pypi/coverage-3.6.tar.gz
2041
174
fi
2042
175
2043
176
# Install / upgrade pip
2044
177
if [ $install_pip -eq 1 ]; then
2045
178
    pip install --upgrade https://github.com/checkbox/external-tarballs/raw/master/pypi/pip-1.3.1.tar.gz
2046
179
fi
2047
180
2048
181
# Install coverage if required
2049
182
if [ $install_coverage -eq 1 ]; then
2050
183
    pip install --upgrade https://github.com/checkbox/external-tarballs/raw/master/pypi/coverage-3.6.tar.gz
2051
184
fi
2052
185
2053
186
# Install requests if required
2054
187
if [ $install_requests -eq 1 ]; then
2055
188
    pip install --upgrade https://github.com/checkbox/external-tarballs/raw/master/pypi/requests-1.1.0.tar.gz
2056
189
fi
2057
190
2058
191
# "develop" plainbox
2059
192
http_proxy=http://127.0.0.1:9/ python3 setup.py develop
2060
193
2061
194
echo "To activate your virtualenv run:"
2062
195
echo "$ . $VENV_PATH/bin/activate"
2063
0
196
2064
=== added directory 'plainbox/plainbox'
2065
=== added directory 'plainbox/plainbox/impl'
2066
=== added file 'plainbox/plainbox/impl/box.py.OTHER'
2067
--- plainbox/plainbox/impl/box.py.OTHER	1970-01-01 00:00:00 +0000
2068
+++ plainbox/plainbox/impl/box.py.OTHER	2013-08-28 12:36:13 +0000
2069
@@ -0,0 +1,130 @@
2070
1
# This file is part of Checkbox.
2071
2
#
2072
3
# Copyright 2012 Canonical Ltd.
2073
4
# Written by:
2074
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
2075
6
#
2076
7
# Checkbox is free software: you can redistribute it and/or modify
2077
8
# it under the terms of the GNU General Public License as published by
2078
9
# the Free Software Foundation, either version 3 of the License, or
2079
10
# (at your option) any later version.
2080
11
#
2081
12
# Checkbox is distributed in the hope that it will be useful,
2082
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2083
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2084
15
# GNU General Public License for more details.
2085
16
#
2086
17
# You should have received a copy of the GNU General Public License
2087
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
2088
19
2089
20
"""
2090
21
:mod:`plainbox.impl.box` -- command line interface
2091
22
==================================================
2092
23
2093
24
.. warning::
2094
25
2095
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
2096
27
"""
2097
28
2098
29
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
2099
30
from argparse import _ as argparse_gettext
2100
31
from logging import basicConfig
2101
32
from logging import getLogger
2102
33
import argparse
2103
34
import sys
2104
35
2105
36
from plainbox import __version__ as version
2106
37
from plainbox.impl.applogic import PlainBoxConfig
2107
38
from plainbox.impl.checkbox import CheckBox
2108
39
from plainbox.impl.commands.run import RunCommand
2109
40
from plainbox.impl.commands.selftest import SelfTestCommand
2110
41
from plainbox.impl.commands.special import SpecialCommand
2111
42
from plainbox.impl.commands.sru import SRUCommand
2112
43
from plainbox.impl.commands.check_config import CheckConfigCommand
2113
44
2114
45
2115
46
logger = getLogger("plainbox.box")
2116
47
2117
48
2118
49
class PlainBox:
2119
50
    """
2120
51
    High-level plainbox object
2121
52
    """
2122
53
2123
54
    def __init__(self):
2124
55
        self._checkbox = CheckBox()
2125
56
2126
57
    def main(self, argv=None):
2127
58
        # TODO: setup sane logging system that works just as well for Joe user
2128
59
        # that runs checkbox from the CD as well as for checkbox developers and
2129
60
        # custom debugging needs.  It would be perfect^Hdesirable not to create
2130
61
        # another broken, never-rotated, uncapped logging crap that kills my
2131
62
        # SSD by writing junk to ~/.cache/
2132
63
        basicConfig(level="WARNING")
2133
64
        config = PlainBoxConfig.get()
2134
65
        parser = self._construct_parser(config)
2135
66
        ns = parser.parse_args(argv)
2136
67
        # Set the desired log level
2137
68
        getLogger("").setLevel(ns.log_level)
2138
69
        # Argh the horrror!
2139
70
        #
2140
71
        # Since CPython revision cab204a79e09 (landed for python3.3)
2141
72
        # http://hg.python.org/cpython/diff/cab204a79e09/Lib/argparse.py
2142
73
        # the argparse module behaves differently than it did in python3.2
2143
74
        #
2144
75
        # In practical terms subparsers are now optional in 3.3 so all of the
2145
76
        # commands are no longer required parameters.
2146
77
        #
2147
78
        # To compensate, on python3.3 and beyond, when the user just runs
2148
79
        # plainbox without specifying the command, we manually, explicitly do
2149
80
        # what python3.2 did: call parser.error(_('too few arguments'))
2150
81
        if (sys.version_info[:2] >= (3, 3)
2151
82
                and getattr(ns, "command", None) is None):
2152
83
            parser.error(argparse_gettext("too few arguments"))
2153
84
        else:
2154
85
            return ns.command.invoked(ns)
2155
86
2156
87
    def _construct_parser(self, config):
2157
88
        parser = ArgumentParser(
2158
89
            prog="plainbox", formatter_class=ArgumentDefaultsHelpFormatter)
2159
90
        parser.add_argument(
2160
91
            "-v", "--version", action="version",
2161
92
            version="{}.{}.{}".format(*version[:3]))
2162
93
        parser.add_argument(
2163
94
            "-l", "--log-level", action="store",
2164
95
            choices=('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'),
2165
96
            default='WARNING',
2166
97
            help=argparse.SUPPRESS)
2167
98
        subparsers = parser.add_subparsers()
2168
99
        RunCommand(self._checkbox).register_parser(subparsers)
2169
100
        SpecialCommand(self._checkbox).register_parser(subparsers)
2170
101
        SelfTestCommand().register_parser(subparsers)
2171
102
        SRUCommand(self._checkbox, config).register_parser(subparsers)
2172
103
        CheckConfigCommand(config).register_parser(subparsers)
2173
104
        #group = parser.add_argument_group(title="user interface options")
2174
105
        #group.add_argument(
2175
106
        #    "-u", "--ui", action="store",
2176
107
        #    default=None, choices=('headless', 'text', 'graphics'),
2177
108
        #    help="select the UI front-end (defaults to auto)")
2178
109
        return parser
2179
110
2180
111
2181
112
def main(argv=None):
2182
113
    # Instantiate a global plainbox instance
2183
114
    # XXX: Allow one to control the checkbox= argument via
2184
115
    # environment or config.
2185
116
    box = PlainBox()
2186
117
    retval = box.main(argv)
2187
118
    raise SystemExit(retval)
2188
119
2189
120
2190
121
def get_builtin_jobs():
2191
122
    raise NotImplementedError("get_builtin_jobs() not implemented")
2192
123
2193
124
2194
125
def save(something, somewhere):
2195
126
    raise NotImplementedError("save() not implemented")
2196
127
2197
128
2198
129
def run(*args, **kwargs):
2199
130
    raise NotImplementedError("run() not implemented")
2200
0
131
2201
=== added directory 'plainbox/plainbox/impl/commands'
2202
=== added file 'plainbox/plainbox/impl/commands/checkbox.py.OTHER'
2203
--- plainbox/plainbox/impl/commands/checkbox.py.OTHER	1970-01-01 00:00:00 +0000
2204
+++ plainbox/plainbox/impl/commands/checkbox.py.OTHER	2013-08-28 12:36:13 +0000
2205
@@ -0,0 +1,100 @@
2206
1
# This file is part of Checkbox.
2207
2
#
2208
3
# Copyright 2012-2013 Canonical Ltd.
2209
4
# Written by:
2210
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
2211
6
#
2212
7
# Checkbox is free software: you can redistribute it and/or modify
2213
8
# it under the terms of the GNU General Public License as published by
2214
9
# the Free Software Foundation, either version 3 of the License, or
2215
10
# (at your option) any later version.
2216
11
#
2217
12
# Checkbox is distributed in the hope that it will be useful,
2218
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2219
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2220
15
# GNU General Public License for more details.
2221
16
#
2222
17
# You should have received a copy of the GNU General Public License
2223
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
2224
19
2225
20
"""
2226
21
:mod:`plainbox.impl.commands.checkbox` -- mix-in for checkbox commands
2227
22
======================================================================
2228
23
2229
24
.. warning::
2230
25
2231
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
2232
27
"""
2233
28
2234
29
import re
2235
30
from argparse import FileType
2236
31
2237
32
2238
33
class CheckBoxInvocationMixIn:
2239
34
2240
35
    def __init__(self, checkbox):
2241
36
        self.checkbox = checkbox
2242
37
2243
38
    def get_job_list(self, ns):
2244
39
        """
2245
40
        Load and return a list of JobDefinition instances
2246
41
        """
2247
42
        return self.checkbox.get_builtin_jobs()
2248
43
2249
44
    def _get_matching_job_list(self, ns, job_list):
2250
45
        # Find jobs that matched patterns
2251
46
        matching_job_list = []
2252
47
        # Pre-seed the include pattern list with data read from
2253
48
        # the whitelist file.
2254
49
        if ns.whitelist:
2255
50
            ns.include_pattern_list.extend([
2256
51
                pattern.strip()
2257
52
                for pattern in ns.whitelist.readlines()])
2258
53
        # Decide which of the known jobs to include
2259
54
        for job in job_list:
2260
55
            # Reject all jobs that match any of the exclude
2261
56
            # patterns, matching strictly from the start to
2262
57
            # the end of the line.
2263
58
            for pattern in ns.exclude_pattern_list:
2264
59
                regexp_pattern = r"^{pattern}$".format(pattern=pattern)
2265
60
                if re.match(regexp_pattern, job.name):
2266
61
                    break
2267
62
            else:
2268
63
                # Then accept (include) all job that matches
2269
64
                # any of include patterns, matching strictly
2270
65
                # from the start to the end of the line.
2271
66
                for pattern in ns.include_pattern_list:
2272
67
                    regexp_pattern = r"^{pattern}$".format(pattern=pattern)
2273
68
                    if re.match(regexp_pattern, job.name):
2274
69
                        matching_job_list.append(job)
2275
70
                        break
2276
71
        return matching_job_list
2277
72
2278
73
2279
74
class CheckBoxCommandMixIn:
2280
75
    """
2281
76
    Mix-in class for plainbox commands that want to discover and load checkbox
2282
77
    jobs
2283
78
    """
2284
79
2285
80
    def enhance_parser(self, parser):
2286
81
        """
2287
82
        Add common options for job selection to an existing parser
2288
83
        """
2289
84
        group = parser.add_argument_group(title="job definition options")
2290
85
        group.add_argument(
2291
86
            '-i', '--include-pattern', action="append",
2292
87
            metavar='PATTERN', default=[], dest='include_pattern_list',
2293
88
            help=("Run jobs matching the given regular expression. Matches "
2294
89
                  "from the start to the end of the line."))
2295
90
        group.add_argument(
2296
91
            '-x', '--exclude-pattern', action="append",
2297
92
            metavar="PATTERN", default=[], dest='exclude_pattern_list',
2298
93
            help=("Do not run jobs matching the given regular expression. "
2299
94
                  "Matches from the start to the end of the line."))
2300
95
        # TODO: Find a way to handle the encoding of the file
2301
96
        group.add_argument(
2302
97
            '-w', '--whitelist',
2303
98
            metavar="WHITELIST",
2304
99
            type=FileType("rt"),
2305
100
            help="Load whitelist containing run patterns")
2306
0
101
2307
=== added file 'plainbox/plainbox/impl/commands/run.py.OTHER'
2308
--- plainbox/plainbox/impl/commands/run.py.OTHER	1970-01-01 00:00:00 +0000
2309
+++ plainbox/plainbox/impl/commands/run.py.OTHER	2013-08-28 12:36:13 +0000
2310
@@ -0,0 +1,340 @@
2311
1
# This file is part of Checkbox.
2312
2
#
2313
3
# Copyright 2012-2013 Canonical Ltd.
2314
4
# Written by:
2315
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
2316
6
#
2317
7
# Checkbox is free software: you can redistribute it and/or modify
2318
8
# it under the terms of the GNU General Public License as published by
2319
9
# the Free Software Foundation, either version 3 of the License, or
2320
10
# (at your option) any later version.
2321
11
#
2322
12
# Checkbox is distributed in the hope that it will be useful,
2323
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2324
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2325
15
# GNU General Public License for more details.
2326
16
#
2327
17
# You should have received a copy of the GNU General Public License
2328
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
2329
19
2330
20
"""
2331
21
:mod:`plainbox.impl.commands.run` -- run sub-command
2332
22
====================================================
2333
23
2334
24
.. warning::
2335
25
2336
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
2337
27
"""
2338
28
2339
29
from argparse import FileType
2340
30
from logging import getLogger
2341
31
from os.path import join
2342
32
from shutil import copyfileobj
2343
33
import io
2344
34
import sys
2345
35
2346
36
from requests.exceptions import ConnectionError, InvalidSchema, HTTPError
2347
37
2348
38
from plainbox.impl.commands import PlainBoxCommand
2349
39
from plainbox.impl.commands.checkbox import CheckBoxCommandMixIn
2350
40
from plainbox.impl.commands.checkbox import CheckBoxInvocationMixIn
2351
41
from plainbox.impl.depmgr import DependencyDuplicateError
2352
42
from plainbox.impl.exporter import ByteStringStreamTranslator
2353
43
from plainbox.impl.exporter import get_all_exporters
2354
44
from plainbox.impl.result import JobResult
2355
45
from plainbox.impl.runner import JobRunner
2356
46
from plainbox.impl.runner import authenticate_warmup
2357
47
from plainbox.impl.runner import slugify
2358
48
from plainbox.impl.session import SessionState
2359
49
from plainbox.impl.transport import get_all_transports
2360
50
2361
51
2362
52
logger = getLogger("plainbox.commands.run")
2363
53
2364
54
2365
55
class RunInvocation(CheckBoxInvocationMixIn):
2366
56
2367
57
    def __init__(self, checkbox, ns):
2368
58
        super(RunInvocation, self).__init__(checkbox)
2369
59
        self.ns = ns
2370
60
2371
61
    def run(self):
2372
62
        ns = self.ns
2373
63
        if ns.output_format == '?':
2374
64
            self._print_output_format_list(ns)
2375
65
            return 0
2376
66
        elif ns.output_options == '?':
2377
67
            self._print_output_option_list(ns)
2378
68
            return 0
2379
69
        elif ns.transport == '?':
2380
70
            self._print_transport_list(ns)
2381
71
            return 0
2382
72
        else:
2383
73
            exporter = self._prepare_exporter(ns)
2384
74
            transport = self._prepare_transport(ns)
2385
75
            job_list = self.get_job_list(ns)
2386
76
            return self._run_jobs(ns, job_list, exporter, transport)
2387
77
2388
78
    def _print_output_format_list(self, ns):
2389
79
        print("Available output formats: {}".format(
2390
80
            ', '.join(get_all_exporters())))
2391
81
2392
82
    def _print_output_option_list(self, ns):
2393
83
        print("Each format may support a different set of options")
2394
84
        for name, exporter_cls in get_all_exporters().items():
2395
85
            print("{}: {}".format(
2396
86
                name, ", ".join(exporter_cls.supported_option_list)))
2397
87
2398
88
    def _print_transport_list(self, ns):
2399
89
        print("Available transports: {}".format(
2400
90
            ', '.join(get_all_transports())))
2401
91
2402
92
    def _prepare_exporter(self, ns):
2403
93
        exporter_cls = get_all_exporters()[ns.output_format]
2404
94
        if ns.output_options:
2405
95
            option_list = ns.output_options.split(',')
2406
96
        else:
2407
97
            option_list = None
2408
98
        try:
2409
99
            exporter = exporter_cls(option_list)
2410
100
        except ValueError as exc:
2411
101
            raise SystemExit(str(exc))
2412
102
        return exporter
2413
103
2414
104
    def _prepare_transport(self, ns):
2415
105
        if ns.transport not in get_all_transports():
2416
106
            return None
2417
107
        transport_cls = get_all_transports()[ns.transport]
2418
108
        try:
2419
109
            return transport_cls(ns.transport_where, ns.transport_options)
2420
110
        except ValueError as exc:
2421
111
            raise SystemExit(str(exc))
2422
112
2423
113
    def ask_for_resume(self, prompt=None, allowed=None):
2424
114
        # FIXME: Add support/callbacks for a GUI
2425
115
        if prompt is None:
2426
116
            prompt = "Do you want to resume the previous session [Y/n]? "
2427
117
        if allowed is None:
2428
118
            allowed = ('', 'y', 'Y', 'n', 'N')
2429
119
        answer = None
2430
120
        while answer not in allowed:
2431
121
            answer = input(prompt)
2432
122
        return False if answer in ('n', 'N') else True
2433
123
2434
124
    def _run_jobs(self, ns, job_list, exporter, transport=None):
2435
125
        # Ask the password before anything else in order to run jobs requiring
2436
126
        # privileges
2437
127
        print("[ Authentication ]".center(80, '='))
2438
128
        return_code = authenticate_warmup()
2439
129
        if return_code:
2440
130
            raise SystemExit(return_code)
2441
131
        # Compute the run list, this can give us notification about problems in
2442
132
        # the selected jobs. Currently we just display each problem
2443
133
        matching_job_list = self._get_matching_job_list(ns, job_list)
2444
134
        print("[ Analyzing Jobs ]".center(80, '='))
2445
135
        # Create a session that handles most of the stuff needed to run jobs
2446
136
        try:
2447
137
            session = SessionState(job_list)
2448
138
        except DependencyDuplicateError as exc:
2449
139
            # Handle possible DependencyDuplicateError that can happen if
2450
140
            # someone is using plainbox for job development.
2451
141
            print("The job database you are currently using is broken")
2452
142
            print("At least two jobs contend for the name {0}".format(
2453
143
                exc.job.name))
2454
144
            print("First job defined in: {0}".format(exc.job.origin))
2455
145
            print("Second job defined in: {0}".format(
2456
146
                exc.duplicate_job.origin))
2457
147
            raise SystemExit(exc)
2458
148
        with session.open():
2459
149
            if session.previous_session_file():
2460
150
                if self.ask_for_resume():
2461
151
                    session.resume()
2462
152
                else:
2463
153
                    session.clean()
2464
154
            self._update_desired_job_list(session, matching_job_list)
2465
155
            if (sys.stdin.isatty() and sys.stdout.isatty() and not
2466
156
                    ns.not_interactive):
2467
157
                outcome_callback = self.ask_for_outcome
2468
158
            else:
2469
159
                outcome_callback = None
2470
160
            runner = JobRunner(
2471
161
                session.session_dir,
2472
162
                session.jobs_io_log_dir,
2473
163
                outcome_callback=outcome_callback,
2474
164
                dry_run=ns.dry_run
2475
165
            )
2476
166
            self._run_jobs_with_session(ns, session, runner)
2477
167
            # Get a stream with exported session data.
2478
168
            exported_stream = io.BytesIO()
2479
169
            data_subset = exporter.get_session_data_subset(session)
2480
170
            exporter.dump(data_subset, exported_stream)
2481
171
            exported_stream.seek(0)  # Need to rewind the file, puagh
2482
172
            # Write the stream to file if requested
2483
173
            self._save_results(ns.output_file, exported_stream)
2484
174
            # Invoke the transport?
2485
175
            if transport:
2486
176
                exported_stream.seek(0)
2487
177
                try:
2488
178
                    transport.send(exported_stream.read())
2489
179
                except InvalidSchema as exc:
2490
180
                    print("Invalid destination URL: {0}".format(exc))
2491
181
                except ConnectionError as exc:
2492
182
                    print(("Unable to connect "
2493
183
                           "to destination URL: {0}").format(exc))
2494
184
                except HTTPError as exc:
2495
185
                    print(("Server returned an error when "
2496
186
                           "receiving or processing: {0}").format(exc))
2497
187
2498
188
        # FIXME: sensible return value
2499
189
        return 0
2500
190
2501
191
    def _save_results(self, output_file, input_stream):
2502
192
        if output_file is sys.stdout:
2503
193
            print("[ Results ]".center(80, '='))
2504
194
            # This requires a bit more finesse, as exporters output bytes
2505
195
            # and stdout needs a string.
2506
196
            translating_stream = ByteStringStreamTranslator(
2507
197
                output_file, "utf-8")
2508
198
            copyfileobj(input_stream, translating_stream)
2509
199
        else:
2510
200
            print("Saving results to {}".format(output_file.name))
2511
201
            copyfileobj(input_stream, output_file)
2512
202
        if output_file is not sys.stdout:
2513
203
            output_file.close()
2514
204
2515
205
    def ask_for_outcome(self, prompt=None, allowed=None):
2516
206
        if prompt is None:
2517
207
            prompt = "what is the outcome? "
2518
208
        if allowed is None:
2519
209
            allowed = (JobResult.OUTCOME_PASS,
2520
210
                       JobResult.OUTCOME_FAIL,
2521
211
                       JobResult.OUTCOME_SKIP)
2522
212
        answer = None
2523
213
        while answer not in allowed:
2524
214
            print("Allowed answers are: {}".format(", ".join(allowed)))
2525
215
            answer = input(prompt)
2526
216
        return answer
2527
217
2528
218
    def _update_desired_job_list(self, session, desired_job_list):
2529
219
        problem_list = session.update_desired_job_list(desired_job_list)
2530
220
        if problem_list:
2531
221
            print("[ Warning ]".center(80, '*'))
2532
222
            print("There were some problems with the selected jobs")
2533
223
            for problem in problem_list:
2534
224
                print(" * {}".format(problem))
2535
225
            print("Problematic jobs will not be considered")
2536
226
2537
227
    def _run_jobs_with_session(self, ns, session, runner):
2538
228
        # TODO: run all resource jobs concurrently with multiprocessing
2539
229
        # TODO: make local job discovery nicer, it would be best if
2540
230
        # desired_jobs could be managed entirely internally by SesionState. In
2541
231
        # such case the list of jobs to run would be changed during iteration
2542
232
        # but would be otherwise okay).
2543
233
        print("[ Running All Jobs ]".center(80, '='))
2544
234
        again = True
2545
235
        while again:
2546
236
            again = False
2547
237
            for job in session.run_list:
2548
238
                # Skip jobs that already have result, this is only needed when
2549
239
                # we run over the list of jobs again, after discovering new
2550
240
                # jobs via the local job output
2551
241
                if session.job_state_map[job.name].result.outcome is not None:
2552
242
                    continue
2553
243
                self._run_single_job_with_session(ns, session, runner, job)
2554
244
                session.persistent_save()
2555
245
                if job.plugin == "local":
2556
246
                    # After each local job runs rebuild the list of matching
2557
247
                    # jobs and run everything again
2558
248
                    new_matching_job_list = self._get_matching_job_list(
2559
249
                        ns, session.job_list)
2560
250
                    self._update_desired_job_list(
2561
251
                        session, new_matching_job_list)
2562
252
                    again = True
2563
253
                    break
2564
254
2565
255
    def _run_single_job_with_session(self, ns, session, runner, job):
2566
256
        print("[ {} ]".format(job.name).center(80, '-'))
2567
257
        if job.description is not None:
2568
258
            print(job.description)
2569
259
            print("^" * len(job.description.splitlines()[-1]))
2570
260
            print()
2571
261
        job_state = session.job_state_map[job.name]
2572
262
        logger.debug("Job name: %s", job.name)
2573
263
        logger.debug("Plugin: %s", job.plugin)
2574
264
        logger.debug("Direct dependencies: %s", job.get_direct_dependencies())
2575
265
        logger.debug("Resource dependencies: %s",
2576
266
                     job.get_resource_dependencies())
2577
267
        logger.debug("Resource program: %r", job.requires)
2578
268
        logger.debug("Command: %r", job.command)
2579
269
        logger.debug("Can start: %s", job_state.can_start())
2580
270
        logger.debug("Readiness: %s", job_state.get_readiness_description())
2581
271
        if job_state.can_start():
2582
272
            print("Running... (output in {}.*)".format(
2583
273
                join(session.jobs_io_log_dir, slugify(job.name))))
2584
274
            job_result = runner.run_job(job)
2585
275
            print("Outcome: {}".format(job_result.outcome))
2586
276
            print("Comments: {}".format(job_result.comments))
2587
277
        else:
2588
278
            job_result = JobResult({
2589
279
                'job': job,
2590
280
                'outcome': JobResult.OUTCOME_NOT_SUPPORTED,
2591
281
                'comments': job_state.get_readiness_description()
2592
282
            })
2593
283
        if job_result is not None:
2594
284
            session.update_job_result(job, job_result)
2595
285
2596
286
2597
287
class RunCommand(PlainBoxCommand, CheckBoxCommandMixIn):
2598
288
2599
289
    def __init__(self, checkbox):
2600
290
        self.checkbox = checkbox
2601
291
2602
292
    def invoked(self, ns):
2603
293
        return RunInvocation(self.checkbox, ns).run()
2604
294
2605
295
    def register_parser(self, subparsers):
2606
296
        parser = subparsers.add_parser("run", help="run a test job")
2607
297
        parser.set_defaults(command=self)
2608
298
        group = parser.add_argument_group(title="user interface options")
2609
299
        group.add_argument(
2610
300
            '--not-interactive', action='store_true',
2611
301
            help="Skip tests that require interactivity")
2612
302
        group.add_argument(
2613
303
            '-n', '--dry-run', action='store_true',
2614
304
            help="Don't actually run any jobs")
2615
305
        group = parser.add_argument_group("output options")
2616
306
        assert 'text' in get_all_exporters()
2617
307
        group.add_argument(
2618
308
            '-f', '--output-format', default='text',
2619
309
            metavar='FORMAT', choices=['?'] + list(
2620
310
                get_all_exporters().keys()),
2621
311
            help=('Save test results in the specified FORMAT'
2622
312
                  ' (pass ? for a list of choices)'))
2623
313
        group.add_argument(
2624
314
            '-p', '--output-options', default='',
2625
315
            metavar='OPTIONS',
2626
316
            help=('Comma-separated list of options for the export mechanism'
2627
317
                  ' (pass ? for a list of choices)'))
2628
318
        group.add_argument(
2629
319
            '-o', '--output-file', default='-',
2630
320
            metavar='FILE', type=FileType("wb"),
2631
321
            help=('Save test results to the specified FILE'
2632
322
                  ' (or to stdout if FILE is -)'))
2633
323
        group.add_argument(
2634
324
            '-t', '--transport',
2635
325
            metavar='TRANSPORT', choices=['?'] + list(
2636
326
                get_all_transports().keys()),
2637
327
            help=('use TRANSPORT to send results somewhere'
2638
328
                  ' (pass ? for a list of choices)'))
2639
329
        group.add_argument(
2640
330
            '--transport-where',
2641
331
            metavar='WHERE',
2642
332
            help=('Where to send data using the selected transport.'
2643
333
                  ' This is passed as-is and is transport-dependent.'))
2644
334
        group.add_argument(
2645
335
            '--transport-options',
2646
336
            metavar='OPTIONS',
2647
337
            help=('Comma-separated list of key-value options (k=v) to '
2648
338
                  ' be passed to the transport.'))
2649
339
        # Call enhance_parser from CheckBoxCommandMixIn
2650
340
        self.enhance_parser(parser)
2651
0
341
2652
=== added file 'plainbox/plainbox/impl/commands/special.py.OTHER'
2653
--- plainbox/plainbox/impl/commands/special.py.OTHER	1970-01-01 00:00:00 +0000
2654
+++ plainbox/plainbox/impl/commands/special.py.OTHER	2013-08-28 12:36:13 +0000
2655
@@ -0,0 +1,159 @@
2656
1
# This file is part of Checkbox.
2657
2
#
2658
3
# Copyright 2012-2013 Canonical Ltd.
2659
4
# Written by:
2660
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
2661
6
#
2662
7
# Checkbox is free software: you can redistribute it and/or modify
2663
8
# it under the terms of the GNU General Public License as published by
2664
9
# the Free Software Foundation, either version 3 of the License, or
2665
10
# (at your option) any later version.
2666
11
#
2667
12
# Checkbox is distributed in the hope that it will be useful,
2668
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2669
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2670
15
# GNU General Public License for more details.
2671
16
#
2672
17
# You should have received a copy of the GNU General Public License
2673
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
2674
19
2675
20
"""
2676
21
:mod:`plainbox.impl.commands.special` -- special sub-command
2677
22
============================================================
2678
23
2679
24
.. warning::
2680
25
2681
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
2682
27
"""
2683
28
2684
29
from logging import getLogger
2685
30
2686
31
from plainbox.impl.commands import PlainBoxCommand
2687
32
from plainbox.impl.commands.checkbox import CheckBoxCommandMixIn
2688
33
from plainbox.impl.commands.checkbox import CheckBoxInvocationMixIn
2689
34
2690
35
2691
36
logger = getLogger("plainbox.commands.special")
2692
37
2693
38
2694
39
class SpecialInvocation(CheckBoxInvocationMixIn):
2695
40
2696
41
    def __init__(self, checkbox, ns):
2697
42
        super(SpecialInvocation, self).__init__(checkbox)
2698
43
        self.ns = ns
2699
44
2700
45
    def run(self):
2701
46
        ns = self.ns
2702
47
        job_list = self.get_job_list(ns)
2703
48
        # Now either do a special action or run the jobs
2704
49
        if ns.special == "list-jobs":
2705
50
            self._print_job_list(ns, job_list)
2706
51
        elif ns.special == "list-job-hashes":
2707
52
            self._print_job_hash_list(ns, job_list)
2708
53
        elif ns.special == "list-expr":
2709
54
            self._print_expression_list(ns, job_list)
2710
55
        elif ns.special == "dep-graph":
2711
56
            self._print_dot_graph(ns, job_list)
2712
57
        # Always succeed
2713
58
        return 0
2714
59
2715
60
    def _get_matching_job_list(self, ns, job_list):
2716
61
        matching_job_list = super(
2717
62
            SpecialInvocation, self)._get_matching_job_list(ns, job_list)
2718
63
        # As a special exception, when ns.special is set and we're either
2719
64
        # listing jobs or job dependencies then when no run pattern was
2720
65
        # specified just operate on the whole set. The ns.special check
2721
66
        # prevents people starting plainbox from accidentally running _all_
2722
67
        # jobs without prompting.
2723
68
        if ns.special is not None and not ns.include_pattern_list:
2724
69
            matching_job_list = job_list
2725
70
        return matching_job_list
2726
71
2727
72
    def _print_job_list(self, ns, job_list):
2728
73
        matching_job_list = self._get_matching_job_list(ns, job_list)
2729
74
        for job in matching_job_list:
2730
75
            print("{}".format(job))
2731
76
2732
77
    def _print_job_hash_list(self, ns, job_list):
2733
78
        matching_job_list = self._get_matching_job_list(ns, job_list)
2734
79
        for job in matching_job_list:
2735
80
            print("{} {}".format(job.get_checksum(), job))
2736
81
2737
82
    def _print_expression_list(self, ns, job_list):
2738
83
        matching_job_list = self._get_matching_job_list(ns, job_list)
2739
84
        expressions = set()
2740
85
        for job in matching_job_list:
2741
86
            prog = job.get_resource_program()
2742
87
            if prog is not None:
2743
88
                for expression in prog.expression_list:
2744
89
                    expressions.add(expression.text)
2745
90
        for expression in sorted(expressions):
2746
91
            print(expression)
2747
92
2748
93
    def _print_dot_graph(self, ns, job_list):
2749
94
        matching_job_list = self._get_matching_job_list(ns, job_list)
2750
95
        print('digraph dependency_graph {')
2751
96
        print('\tnode [shape=box];')
2752
97
        for job in matching_job_list:
2753
98
            if job.plugin == "resource":
2754
99
                print('\t"{}" [shape=ellipse,color=blue];'.format(job.name))
2755
100
            elif job.plugin == "attachment":
2756
101
                print('\t"{}" [color=green];'.format(job.name))
2757
102
            elif job.plugin == "local":
2758
103
                print('\t"{}" [shape=invtriangle,color=red];'.format(
2759
104
                    job.name))
2760
105
            elif job.plugin == "shell":
2761
106
                print('\t"{}" [];'.format(job.name))
2762
107
            elif job.plugin in ("manual", "user-verify", "user-interact"):
2763
108
                print('\t"{}" [color=orange];'.format(job.name))
2764
109
            for dep_name in job.get_direct_dependencies():
2765
110
                print('\t"{}" -> "{}";'.format(job.name, dep_name))
2766
111
            prog = job.get_resource_program()
2767
112
            if ns.dot_resources and prog is not None:
2768
113
                for expression in prog.expression_list:
2769
114
                    print('\t"{}" [shape=ellipse,color=blue];'.format(
2770
115
                        expression.resource_name))
2771
116
                    print('\t"{}" -> "{}" [style=dashed, label="{}"];'.format(
2772
117
                        job.name, expression.resource_name,
2773
118
                        expression.text.replace('"', "'")))
2774
119
        print("}")
2775
120
2776
121
2777
122
class SpecialCommand(PlainBoxCommand, CheckBoxCommandMixIn):
2778
123
    """
2779
124
    Implementation of ``$ plainbox special``
2780
125
    """
2781
126
2782
127
    def __init__(self, checkbox):
2783
128
        self.checkbox = checkbox
2784
129
2785
130
    def invoked(self, ns):
2786
131
        return SpecialInvocation(self.checkbox, ns).run()
2787
132
2788
133
    def register_parser(self, subparsers):
2789
134
        parser = subparsers.add_parser(
2790
135
            "special", help="special/internal commands")
2791
136
        parser.set_defaults(command=self)
2792
137
        group = parser.add_mutually_exclusive_group(required=True)
2793
138
        group.add_argument(
2794
139
            '-j', '--list-jobs',
2795
140
            help="List jobs instead of running them",
2796
141
            action="store_const", const="list-jobs", dest="special")
2797
142
        group.add_argument(
2798
143
            '-J', '--list-job-hashes',
2799
144
            help="List jobs with hashes instead of running them",
2800
145
            action="store_const", const="list-job-hashes", dest="special")
2801
146
        group.add_argument(
2802
147
            '-e', '--list-expressions',
2803
148
            help="List all unique resource expressions",
2804
149
            action="store_const", const="list-expr", dest="special")
2805
150
        group.add_argument(
2806
151
            '-d', '--dot',
2807
152
            help="Print a graph of jobs instead of running them",
2808
153
            action="store_const", const="dep-graph", dest="special")
2809
154
        parser.add_argument(
2810
155
            '--dot-resources',
2811
156
            help="Render resource relationships (for --dot)",
2812
157
            action='store_true')
2813
158
        # Call enhance_parser from CheckBoxCommandMixIn
2814
159
        self.enhance_parser(parser)
2815
0
160
2816
=== added file 'plainbox/plainbox/impl/commands/sru.py.OTHER'
2817
--- plainbox/plainbox/impl/commands/sru.py.OTHER	1970-01-01 00:00:00 +0000
2818
+++ plainbox/plainbox/impl/commands/sru.py.OTHER	2013-08-28 12:36:13 +0000
2819
@@ -0,0 +1,271 @@
2820
1
# This file is part of Checkbox.
2821
2
#
2822
3
#
2823
4
# Copyright 2013 Canonical Ltd.
2824
5
# Written by:
2825
6
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
2826
7
#
2827
8
# Checkbox is free software: you can redistribute it and/or modify
2828
9
# it under the terms of the GNU General Public License as published by
2829
10
# the Free Software Foundation, either version 3 of the License, or
2830
11
# (at your option) any later version.
2831
12
#
2832
13
# Checkbox is distributed in the hope that it will be useful,
2833
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2834
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2835
16
# GNU General Public License for more details.
2836
17
#
2837
18
# You should have received a copy of the GNU General Public License
2838
19
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
2839
20
2840
21
"""
2841
22
:mod:`plainbox.impl.commands.sru` -- sru sub-command
2842
23
====================================================
2843
24
2844
25
.. warning::
2845
26
2846
27
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
2847
28
"""
2848
29
import logging
2849
30
import os
2850
31
import tempfile
2851
32
2852
33
from requests.exceptions import ConnectionError, InvalidSchema, HTTPError
2853
34
2854
35
from plainbox.impl.applogic import get_matching_job_list
2855
36
from plainbox.impl.applogic import run_job_if_possible
2856
37
from plainbox.impl.checkbox import WhiteList
2857
38
from plainbox.impl.commands import PlainBoxCommand
2858
39
from plainbox.impl.commands.check_config import CheckConfigInvocation
2859
40
from plainbox.impl.config import ValidationError, Unset
2860
41
from plainbox.impl.depmgr import DependencyDuplicateError
2861
42
from plainbox.impl.exporter import ByteStringStreamTranslator
2862
43
from plainbox.impl.exporter.xml import XMLSessionStateExporter
2863
44
from plainbox.impl.runner import JobRunner
2864
45
from plainbox.impl.session import SessionState
2865
46
from plainbox.impl.transport.certification import CertificationTransport
2866
47
from plainbox.impl.transport.certification import InvalidSecureIDError
2867
48
2868
49
2869
50
logger = logging.getLogger("plainbox.commands.sru")
2870
51
2871
52
2872
53
class _SRUInvocation:
2873
54
    """
2874
55
    Helper class instantiated to perform a particular invocation of the sru
2875
56
    command. Unlike the SRU command itself, this class is instantiated each
2876
57
    time.
2877
58
    """
2878
59
2879
60
    def __init__(self, checkbox, config, ns):
2880
61
        self.checkbox = checkbox
2881
62
        self.config = config
2882
63
        self.ns = ns
2883
64
        self.whitelist = WhiteList.from_file(os.path.join(
2884
65
            self.checkbox.whitelists_dir, "sru.whitelist"))
2885
66
        self.job_list = self.checkbox.get_builtin_jobs()
2886
67
        # XXX: maybe allow specifying system_id from command line?
2887
68
        self.exporter = XMLSessionStateExporter(system_id=None)
2888
69
        self.session = None
2889
70
        self.runner = None
2890
71
2891
72
    def run(self):
2892
73
        # Compute the run list, this can give us notification about problems in
2893
74
        # the selected jobs. Currently we just display each problem
2894
75
        # Create a session that handles most of the stuff needed to run jobs
2895
76
        try:
2896
77
            self.session = SessionState(self.job_list)
2897
78
        except DependencyDuplicateError as exc:
2898
79
            # Handle possible DependencyDuplicateError that can happen if
2899
80
            # someone is using plainbox for job development.
2900
81
            print("The job database you are currently using is broken")
2901
82
            print("At least two jobs contend for the name {0}".format(
2902
83
                exc.job.name))
2903
84
            print("First job defined in: {0}".format(exc.job.origin))
2904
85
            print("Second job defined in: {0}".format(
2905
86
                exc.duplicate_job.origin))
2906
87
            raise SystemExit(exc)
2907
88
        with self.session.open():
2908
89
            self._set_job_selection()
2909
90
            self.runner = JobRunner(
2910
91
                self.session.session_dir,
2911
92
                self.session.jobs_io_log_dir,
2912
93
                command_io_delegate=self,
2913
94
                outcome_callback=None,  # SRU runs are never interactive
2914
95
                dry_run=self.ns.dry_run
2915
96
            )
2916
97
            self._run_all_jobs()
2917
98
            if self.config.fallback_file is not Unset:
2918
99
                self._save_results()
2919
100
            self._submit_results()
2920
101
        # FIXME: sensible return value
2921
102
        return 0
2922
103
2923
104
    def _set_job_selection(self):
2924
105
        desired_job_list = get_matching_job_list(self.job_list, self.whitelist)
2925
106
        problem_list = self.session.update_desired_job_list(desired_job_list)
2926
107
        if problem_list:
2927
108
            logger.warning("There were some problems with the selected jobs")
2928
109
            for problem in problem_list:
2929
110
                logger.warning("- %s", problem)
2930
111
            logger.warning("Problematic jobs will not be considered")
2931
112
2932
113
    def _save_results(self):
2933
114
        print("Saving results to {0}".format(self.config.fallback_file))
2934
115
        data = self.exporter.get_session_data_subset(self.session)
2935
116
        with open(self.config.fallback_file, "wt", encoding="UTF-8") as stream:
2936
117
            translating_stream = ByteStringStreamTranslator(stream, "UTF-8")
2937
118
            self.exporter.dump(data, translating_stream)
2938
119
2939
120
    def _submit_results(self):
2940
121
        print("Submitting results to {0} for secure_id {1}".format(
2941
122
              self.config.c3_url, self.config.secure_id))
2942
123
        options_string = "secure_id={0}".format(self.config.secure_id)
2943
124
        # Create the transport object
2944
125
        try:
2945
126
            transport = CertificationTransport(
2946
127
                self.config.c3_url, options_string, self.config)
2947
128
        except InvalidSecureIDError as exc:
2948
129
            print(exc)
2949
130
            return False
2950
131
        # Prepare the data for submission
2951
132
        data = self.exporter.get_session_data_subset(self.session)
2952
133
        with tempfile.NamedTemporaryFile(mode='w+b') as stream:
2953
134
            # Dump the data to the temporary file
2954
135
            self.exporter.dump(data, stream)
2955
136
            # Flush and rewind
2956
137
            stream.flush()
2957
138
            stream.seek(0)
2958
139
            try:
2959
140
                # Send the data, reading from the temporary file
2960
141
                result = transport.send(stream)
2961
142
                if 'url' in result:
2962
143
                    print("Successfully sent, submission status at {0}".format(
2963
144
                          result['url']))
2964
145
                else:
2965
146
                    print("Successfully sent, server response: {0}".format(
2966
147
                          result))
2967
148
2968
149
            except InvalidSchema as exc:
2969
150
                print("Invalid destination URL: {0}".format(exc))
2970
151
            except ConnectionError as exc:
2971
152
                print("Unable to connect to destination URL: {0}".format(exc))
2972
153
            except HTTPError as exc:
2973
154
                print(("Server returned an error when "
2974
155
                       "receiving or processing: {0}").format(exc))
2975
156
            except IOError as exc:
2976
157
                print("Problem reading a file: {0}".format(exc))
2977
158
2978
159
    def _run_all_jobs(self):
2979
160
        again = True
2980
161
        while again:
2981
162
            again = False
2982
163
            for job in self.session.run_list:
2983
164
                # Skip jobs that already have result, this is only needed when
2984
165
                # we run over the list of jobs again, after discovering new
2985
166
                # jobs via the local job output
2986
167
                result = self.session.job_state_map[job.name].result
2987
168
                if result.outcome is not None:
2988
169
                    continue
2989
170
                self._run_single_job(job)
2990
171
                self.session.persistent_save()
2991
172
                if job.plugin == "local":
2992
173
                    # After each local job runs rebuild the list of matching
2993
174
                    # jobs and run everything again
2994
175
                    self._set_job_selection()
2995
176
                    again = True
2996
177
                    break
2997
178
2998
179
    def _run_single_job(self, job):
2999
180
        print("- {}:".format(job.name), end=' ')
3000
181
        job_state, job_result = run_job_if_possible(
3001
182
            self.session, self.runner, self.config, job)
3002
183
        print("{0}".format(job_result.outcome))
3003
184
        if job_result.comments is not None:
3004
185
            print("comments: {0}".format(job_result.comments))
3005
186
        if job_state.readiness_inhibitor_list:
3006
187
            print("inhibitors:")
3007
188
        for inhibitor in job_state.readiness_inhibitor_list:
3008
189
            print("  * {}".format(inhibitor))
3009
190
        self.session.update_job_result(job, job_result)
3010
191
3011
192
3012
193
class SRUCommand(PlainBoxCommand):
3013
194
    """
3014
195
    Command for running Stable Release Update (SRU) tests.
3015
196
3016
197
    Stable release updates are periodic fixes for nominated bugs that land in
3017
198
    existing supported Ubuntu releases. To ensure a certain level of quality
3018
199
    all SRU updates affecting hardware enablement are automatically tested
3019
200
    on a pool of certified machines.
3020
201
3021
202
    This command is _temporary_ and will eventually migrate to the checkbox
3022
203
    side. Its intended lifecycle is for the development and validation of
3023
204
    plainbox core on realistic workloads.
3024
205
    """
3025
206
3026
207
    def __init__(self, checkbox, config):
3027
208
        self.checkbox = checkbox
3028
209
        self.config = config
3029
210
3030
211
    def invoked(self, ns):
3031
212
        # Copy command-line arguments over configuration variables
3032
213
        try:
3033
214
            if ns.secure_id:
3034
215
                self.config.secure_id = ns.secure_id
3035
216
            if ns.fallback_file and ns.fallback_file is not Unset:
3036
217
                self.config.fallback_file = ns.fallback_file
3037
218
            if ns.c3_url:
3038
219
                self.config.c3_url = ns.c3_url
3039
220
        except ValidationError as exc:
3040
221
            print("Configuration problems prevent running SRU tests")
3041
222
            print(exc)
3042
223
            return 1
3043
224
        # Run check-config, if requested
3044
225
        if ns.check_config:
3045
226
            retval = CheckConfigInvocation(self.config).run()
3046
227
            if retval != 0:
3047
228
                return retval
3048
229
        return _SRUInvocation(self.checkbox, self.config, ns).run()
3049
230
3050
231
    def register_parser(self, subparsers):
3051
232
        parser = subparsers.add_parser(
3052
233
            "sru", help="run automated stable release update tests")
3053
234
        parser.set_defaults(command=self)
3054
235
        parser.add_argument(
3055
236
            "--check-config",
3056
237
            action="store_true",
3057
238
            help="Run plainbox check-config before starting")
3058
239
        group = parser.add_argument_group("sru-specific options")
3059
240
        # Set defaults from based on values from the config file
3060
241
        group.set_defaults(
3061
242
            secure_id=self.config.secure_id,
3062
243
            c3_url=self.config.c3_url,
3063
244
            fallback_file=self.config.fallback_file)
3064
245
        group.add_argument(
3065
246
            '--secure-id', metavar="SECURE-ID",
3066
247
            action='store',
3067
248
            # NOTE: --secure-id is optional only when set in a config file
3068
249
            required=self.config.secure_id is Unset,
3069
250
            help=("Associate submission with a machine using this SECURE-ID"
3070
251
                  " (%(default)s)"))
3071
252
        group.add_argument(
3072
253
            '--fallback', metavar="FILE",
3073
254
            dest='fallback_file',
3074
255
            action='store',
3075
256
            default=Unset,
3076
257
            help=("If submission fails save the test report as FILE"
3077
258
                  " (%(default)s)"))
3078
259
        group.add_argument(
3079
260
            '--destination', metavar="URL",
3080
261
            dest='c3_url',
3081
262
            action='store',
3082
263
            help=("POST the test report XML to this URL"
3083
264
                  " (%(default)s)"))
3084
265
        group = parser.add_argument_group(title="execution options")
3085
266
        group.add_argument(
3086
267
            '-n', '--dry-run',
3087
268
            action='store_true',
3088
269
            default=False,
3089
270
            help=("Skip all usual jobs."
3090
271
                  " Only local, resource and attachment jobs are started"))
3091
0
272
3092
=== added file 'plainbox/plainbox/impl/commands/test_run.py.OTHER'
3093
--- plainbox/plainbox/impl/commands/test_run.py.OTHER	1970-01-01 00:00:00 +0000
3094
+++ plainbox/plainbox/impl/commands/test_run.py.OTHER	2013-08-28 12:36:13 +0000
3095
@@ -0,0 +1,142 @@
3096
1
# This file is part of Checkbox.
3097
2
#
3098
3
# Copyright 2013 Canonical Ltd.
3099
4
# Written by:
3100
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
3101
6
#   Daniel Manrique  <roadmr@ubuntu.com>
3102
7
#
3103
8
# Checkbox is free software: you can redistribute it and/or modify
3104
9
# it under the terms of the GNU General Public License as published by
3105
10
# the Free Software Foundation, either version 3 of the License, or
3106
11
# (at your option) any later version.
3107
12
#
3108
13
# Checkbox is distributed in the hope that it will be useful,
3109
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
3110
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3111
16
# GNU General Public License for more details.
3112
17
#
3113
18
# You should have received a copy of the GNU General Public License
3114
19
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
3115
20
3116
21
"""
3117
22
plainbox.impl.commands.test_run
3118
23
===============================
3119
24
3120
25
Test definitions for plainbox.impl.run module
3121
26
"""
3122
27
3123
28
import os
3124
29
import shutil
3125
30
import tempfile
3126
31
3127
32
from inspect import cleandoc
3128
33
from mock import patch
3129
34
from unittest import TestCase
3130
35
3131
36
from plainbox.impl.box import main
3132
37
from plainbox.testing_utils.io import TestIO
3133
38
3134
39
3135
40
class TestRun(TestCase):
3136
41
3137
42
    def setUp(self):
3138
43
        # session data are kept in XDG_CACHE_HOME/plainbox/.session
3139
44
        # To avoid resuming a real session, we have to select a temporary
3140
45
        # location instead
3141
46
        self._sandbox = tempfile.mkdtemp()
3142
47
        self._env = os.environ
3143
48
        os.environ['XDG_CACHE_HOME'] = self._sandbox
3144
49
3145
50
    def test_help(self):
3146
51
        with TestIO(combined=True) as io:
3147
52
            with self.assertRaises(SystemExit) as call:
3148
53
                main(['run', '--help'])
3149
54
            self.assertEqual(call.exception.args, (0,))
3150
55
        self.maxDiff = None
3151
56
        expected = """
3152
57
        usage: plainbox run [-h] [--not-interactive] [-n] [-f FORMAT] [-p OPTIONS]
3153
58
                            [-o FILE] [-t TRANSPORT] [--transport-where WHERE]
3154
59
                            [--transport-options OPTIONS] [-i PATTERN] [-x PATTERN]
3155
60
                            [-w WHITELIST]
3156
61
3157
62
        optional arguments:
3158
63
          -h, --help            show this help message and exit
3159
64
3160
65
        user interface options:
3161
66
          --not-interactive     Skip tests that require interactivity
3162
67
          -n, --dry-run         Don't actually run any jobs
3163
68
3164
69
        output options:
3165
70
          -f FORMAT, --output-format FORMAT
3166
71
                                Save test results in the specified FORMAT (pass ? for
3167
72
                                a list of choices)
3168
73
          -p OPTIONS, --output-options OPTIONS
3169
74
                                Comma-separated list of options for the export
3170
75
                                mechanism (pass ? for a list of choices)
3171
76
          -o FILE, --output-file FILE
3172
77
                                Save test results to the specified FILE (or to stdout
3173
78
                                if FILE is -)
3174
79
          -t TRANSPORT, --transport TRANSPORT
3175
80
                                use TRANSPORT to send results somewhere (pass ? for a
3176
81
                                list of choices)
3177
82
          --transport-where WHERE
3178
83
                                Where to send data using the selected transport. This
3179
84
                                is passed as-is and is transport-dependent.
3180
85
          --transport-options OPTIONS
3181
86
                                Comma-separated list of key-value options (k=v) to be
3182
87
                                passed to the transport.
3183
88
3184
89
        job definition options:
3185
90
          -i PATTERN, --include-pattern PATTERN
3186
91
                                Run jobs matching the given regular expression.
3187
92
                                Matches from the start to the end of the line.
3188
93
          -x PATTERN, --exclude-pattern PATTERN
3189
94
                                Do not run jobs matching the given regular expression.
3190
95
                                Matches from the start to the end of the line.
3191
96
          -w WHITELIST, --whitelist WHITELIST
3192
97
                                Load whitelist containing run patterns
3193
98
        """
3194
99
        self.assertEqual(io.combined, cleandoc(expected) + "\n")
3195
100
3196
101
    def test_run_without_args(self):
3197
102
        with TestIO(combined=True) as io:
3198
103
            with self.assertRaises(SystemExit) as call:
3199
104
                with patch('plainbox.impl.commands.run.authenticate_warmup') as mock_warmup:
3200
105
                    mock_warmup.return_value = 0
3201
106
                    main(['run'])
3202
107
            self.assertEqual(call.exception.args, (0,))
3203
108
        expected = """
3204
109
        ===============================[ Authentication ]===============================
3205
110
        ===============================[ Analyzing Jobs ]===============================
3206
111
        ==============================[ Running All Jobs ]==============================
3207
112
        ==================================[ Results ]===================================
3208
113
        """
3209
114
        self.assertEqual(io.combined, cleandoc(expected) + "\n")
3210
115
3211
116
    def test_output_format_list(self):
3212
117
        with TestIO(combined=True) as io:
3213
118
            with self.assertRaises(SystemExit) as call:
3214
119
                main(['run', '--output-format=?'])
3215
120
            self.assertEqual(call.exception.args, (0,))
3216
121
        expected = """
3217
122
        Available output formats: json, rfc822, text, xml
3218
123
        """
3219
124
        self.assertEqual(io.combined, cleandoc(expected) + "\n")
3220
125
3221
126
    def test_output_option_list(self):
3222
127
        with TestIO(combined=True) as io:
3223
128
            with self.assertRaises(SystemExit) as call:
3224
129
                main(['run', '--output-option=?'])
3225
130
            self.assertEqual(call.exception.args, (0,))
3226
131
        expected = """
3227
132
        Each format may support a different set of options
3228
133
        json: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments, machine-json
3229
134
        rfc822: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments
3230
135
        text: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments
3231
136
        xml: 
3232
137
        """
3233
138
        self.assertEqual(io.combined, cleandoc(expected) + "\n")
3234
139
3235
140
    def tearDown(self):
3236
141
        shutil.rmtree(self._sandbox)
3237
142
        os.environ = self._env
3238
0
143
3239
=== added file 'plainbox/plainbox/impl/config.py.OTHER'
3240
--- plainbox/plainbox/impl/config.py.OTHER	1970-01-01 00:00:00 +0000
3241
+++ plainbox/plainbox/impl/config.py.OTHER	2013-08-28 12:36:13 +0000
3242
@@ -0,0 +1,544 @@
3243
1
# This file is part of Checkbox.
3244
2
#
3245
3
# Copyright 2013 Canonical Ltd.
3246
4
# Written by:
3247
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
3248
6
#
3249
7
# Checkbox is free software: you can redistribute it and/or modify
3250
8
# it under the terms of the GNU General Public License as published by
3251
9
# the Free Software Foundation, either version 3 of the License, or
3252
10
# (at your option) any later version.
3253
11
#
3254
12
# Checkbox is distributed in the hope that it will be useful,
3255
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
3256
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3257
15
# GNU General Public License for more details.
3258
16
#
3259
17
# You should have received a copy of the GNU General Public License
3260
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
3261
19
3262
20
"""
3263
21
:mod:`plainbox.impl.config` -- configuration
3264
22
============================================
3265
23
3266
24
.. warning::
3267
25
3268
26
    THIS MODULE DOES NOT HAVE A STABLE PUBLIC API
3269
27
"""
3270
28
3271
29
from abc import ABCMeta, abstractmethod
3272
30
import collections
3273
31
import configparser
3274
32
import logging
3275
33
import re
3276
34
3277
35
3278
36
logger = logging.getLogger("plainbox.config")
3279
37
3280
38
3281
39
class INameTracking(metaclass=ABCMeta):
3282
40
    """
3283
41
    Interface for classes that are instantiated as a part of definition of
3284
42
    another class. The purpose of this interface is to allow instances to learn
3285
43
    about the name (python identifier) that was assigned to the instance at
3286
44
    class definition time.
3287
45
3288
46
    Subclasses must define the _set_tracked_name() method.
3289
47
    """
3290
48
3291
49
    @abstractmethod
3292
50
    def _set_tracked_name(self, name):
3293
51
        """
3294
52
        Set the that corresponds to the symbol used in class definition. This
3295
53
        can be a no-op if the name was already set by other means
3296
54
        """
3297
55
3298
56
3299
57
class ConfigMetaData:
3300
58
    """
3301
59
    Class containing meta-data about a Config class
3302
60
3303
61
    Sub-classes of this class are automatically added to each Config subclass
3304
62
    as a Meta class-level attribute.
3305
63
3306
64
    This class has typically two attributes:
3307
65
3308
66
        :cvar variable_list:
3309
67
            A list of all Variable objects defined in the class
3310
68
3311
69
        :cvar section_list:
3312
70
            A list of all Section object defined in the class
3313
71
3314
72
        :cvar filename_list:
3315
73
            A list of config files (pathnames) to read on call to
3316
74
            :meth:`Config.read`
3317
75
    """
3318
76
    variable_list = []
3319
77
    section_list = []
3320
78
    filename_list = []
3321
79
3322
80
3323
81
class UnsetType:
3324
82
    """
3325
83
    Class of the Unset object
3326
84
    """
3327
85
3328
86
    def __str__(self):
3329
87
        return "unset"
3330
88
3331
89
    def __repr__(self):
3332
90
        return "Unset"
3333
91
3334
92
3335
93
Unset = UnsetType()
3336
94
3337
95
3338
96
class Variable(INameTracking):
3339
97
    """
3340
98
    Variable that can be used in a configuration systems
3341
99
    """
3342
100
3343
101
    _KIND_CHOICE = (bool, int, float, str)
3344
102
3345
103
    def __init__(self, name=None, *, section='DEFAULT', kind=str,
3346
104
                 default=Unset, validator_list=None, help_text=None):
3347
105
        # Ensure kind is correct
3348
106
        if kind not in self._KIND_CHOICE:
3349
107
            raise ValueError("unsupported kind")
3350
108
        # Ensure that we have a validator_list, even if empty
3351
109
        if validator_list is None:
3352
110
            validator_list = []
3353
111
        # Insert a KindValidator as the first validator to run
3354
112
        validator_list.insert(0, KindValidator)
3355
113
        # Assign all the attributes
3356
114
        self._name = name
3357
115
        self._section = section
3358
116
        self._kind = kind
3359
117
        self._default = default
3360
118
        self._validator_list = validator_list
3361
119
        self._help_text = help_text
3362
120
        self._validate_default_value()
3363
121
        # Workaround for Sphinx breaking if __doc__ is a property
3364
122
        self.__doc__ = self.help_text or self.__class__.__doc__
3365
123
3366
124
    def _validate_default_value(self):
3367
125
        """
3368
126
        Validate the default value, unless it is Unset
3369
127
        """
3370
128
        if self.default is Unset:
3371
129
            return
3372
130
        for validator in self.validator_list:
3373
131
            message = validator(self, self.default)
3374
132
            if message is not None:
3375
133
                raise ValidationError(self, self.default, message)
3376
134
3377
135
    def _set_tracked_name(self, name):
3378
136
        """
3379
137
        Internal method used by :meth:`ConfigMeta.__new__`
3380
138
        """
3381
139
        if self._name is None:
3382
140
            self._name = name
3383
141
3384
142
    @property
3385
143
    def name(self):
3386
144
        """
3387
145
        name of this variable
3388
146
        """
3389
147
        return self._name
3390
148
3391
149
    @property
3392
150
    def section(self):
3393
151
        """
3394
152
        name of the section this variable belongs to (in a configuration file)
3395
153
        """
3396
154
        return self._section
3397
155
3398
156
    @property
3399
157
    def kind(self):
3400
158
        """
3401
159
        the "poor man's type", can be only str (default), bool, float or int
3402
160
        """
3403
161
        return self._kind
3404
162
3405
163
    @property
3406
164
    def default(self):
3407
165
        """
3408
166
        a default value, if any
3409
167
        """
3410
168
        return self._default
3411
169
3412
170
    @property
3413
171
    def validator_list(self):
3414
172
        """
3415
173
        a optional list of :class:`Validator` instances that are enforced on
3416
174
        the value
3417
175
        """
3418
176
        return self._validator_list
3419
177
3420
178
    @property
3421
179
    def help_text(self):
3422
180
        """
3423
181
        an optional help text associated with this variable
3424
182
        """
3425
183
        return self._help_text
3426
184
3427
185
    def __repr__(self):
3428
186
        return "<Variable name:{!r}>".format(self.name)
3429
187
3430
188
    def __get__(self, instance, owner):
3431
189
        """
3432
190
        Get the value of a variable
3433
191
3434
192
        Missing variables return the default value
3435
193
        """
3436
194
        if instance is None:
3437
195
            return self
3438
196
        try:
3439
197
            return instance._get_variable(self._name)
3440
198
        except KeyError:
3441
199
            return self.default
3442
200
3443
201
    def __set__(self, instance, new_value):
3444
202
        """
3445
203
        Set the value of a variable
3446
204
3447
205
        :raises ValidationError: if the new value is incorrect
3448
206
        """
3449
207
        # Check it against all validators
3450
208
        for validator in self.validator_list:
3451
209
            message = validator(self, new_value)
3452
210
            if message is not None:
3453
211
                raise ValidationError(self, new_value, message)
3454
212
        # Assign it to the backing store of the instance
3455
213
        instance._set_variable(self.name, new_value)
3456
214
3457
215
    def __delete__(self, instance):
3458
216
        # NOTE: this is quite confusing, this method is a companion to __get__
3459
217
        # and __set__ but __del__ is entirely unrelated (object garbage
3460
218
        # collected, do final cleanup) so don't think this is a mistake
3461
219
        instance._del_variable(self._name)
3462
220
3463
221
3464
222
class Section(INameTracking):
3465
223
    """
3466
224
    A section of a configuration file.
3467
225
    """
3468
226
3469
227
    def __init__(self, name=None, *, help_text=None):
3470
228
        self._name = name
3471
229
        self._help_text = help_text
3472
230
        # Workaround for Sphinx breaking if __doc__ is a property
3473
231
        self.__doc__ = self.help_text or self.__class__.__doc__
3474
232
3475
233
    def _set_tracked_name(self, name):
3476
234
        """
3477
235
        Internal method used by :meth:`ConfigMeta.__new__`
3478
236
        """
3479
237
        if self._name is None:
3480
238
            self._name = name
3481
239
3482
240
    @property
3483
241
    def name(self):
3484
242
        """
3485
243
        name of this section
3486
244
        """
3487
245
        return self._name
3488
246
3489
247
    @property
3490
248
    def help_text(self):
3491
249
        """
3492
250
        an optional help text associated with this section
3493
251
        """
3494
252
        return self._help_text
3495
253
3496
254
    def __get__(self, instance, owner):
3497
255
        if instance is None:
3498
256
            return self
3499
257
        try:
3500
258
            return instance._get_section(self._name)
3501
259
        except KeyError:
3502
260
            return Unset
3503
261
3504
262
    def __set__(self, instance, new_value):
3505
263
        instance._set_section(self.name, new_value)
3506
264
3507
265
    def __delete__(self, instance):
3508
266
        instance._del_section(self.name)
3509
267
3510
268
3511
269
class ConfigMeta(type):
3512
270
    """
3513
271
    Meta class for all configuration classes.
3514
272
3515
273
    This meta class handles assignment of '_name' attribute to each
3516
274
    :class:`Variable` instance created in the class body.
3517
275
3518
276
    It also accumulates such instances and assigns them to variable_list in a
3519
277
    helper Meta class which is assigned back to the namespace
3520
278
    """
3521
279
3522
280
    def __new__(mcls, name, bases, namespace, **kwargs):
3523
281
        # Keep track of variables and sections from base class
3524
282
        variable_list = []
3525
283
        section_list = []
3526
284
        if 'Meta' in namespace:
3527
285
            if hasattr(namespace['Meta'], 'variable_list'):
3528
286
                variable_list = namespace['Meta'].variable_list[:]
3529
287
            if hasattr(namespace['Meta'], 'section_list'):
3530
288
                section_list = namespace['Meta'].section_list[:]
3531
289
        # Discover all Variable and Section instances
3532
290
        # defined in the class namespace
3533
291
        for name, item in namespace.items():
3534
292
            if isinstance(item, INameTracking):
3535
293
                item._set_tracked_name(name)
3536
294
            if isinstance(item, Variable):
3537
295
                variable_list.append(item)
3538
296
            elif isinstance(item, Section):
3539
297
                section_list.append(item)
3540
298
        # Get or create the class of the 'Meta' object.
3541
299
        #
3542
300
        # This class should always inherit from ConfigMetaData and whatever the
3543
301
        # user may have defined as Meta.
3544
302
        Meta_name = "Meta"
3545
303
        Meta_bases = (ConfigMetaData,)
3546
304
        Meta_ns = {
3547
305
            'variable_list': variable_list,
3548
306
            'section_list': section_list
3549
307
        }
3550
308
        if 'Meta' in namespace:
3551
309
            user_Meta_cls = namespace['Meta']
3552
310
            if not isinstance(user_Meta_cls, type):
3553
311
                raise TypeError("Meta must be a class")
3554
312
            Meta_bases = (user_Meta_cls, ConfigMetaData)
3555
313
        # Create a new type for the Meta class
3556
314
        namespace['Meta'] = type.__new__(
3557
315
            type(ConfigMetaData), Meta_name, Meta_bases, Meta_ns)
3558
316
        # Create a new type for the Config subclass
3559
317
        return type.__new__(mcls, name, bases, namespace)
3560
318
3561
319
    @classmethod
3562
320
    def __prepare__(mcls, name, bases, **kwargs):
3563
321
        return collections.OrderedDict()
3564
322
3565
323
3566
324
class PlainBoxConfigParser(configparser.ConfigParser):
3567
325
    """
3568
326
    A simple ConfigParser subclass that does not lowercase
3569
327
    key names.
3570
328
    """
3571
329
    def optionxform(self, option):
3572
330
        return option
3573
331
3574
332
3575
333
class Config(metaclass=ConfigMeta):
3576
334
    """
3577
335
    Base class for configuration systems
3578
336
3579
337
    :ivar _var:
3580
338
        storage backend for Variable definitions
3581
339
3582
340
    :ivar _section:
3583
341
        storage backend for Section definitions
3584
342
3585
343
    :ivar _filename_list:
3586
344
        list of pathnames to files that were loaded by the last call to
3587
345
        :meth:`read()`
3588
346
3589
347
    :ivar _problem_list:
3590
348
        list of :class:`ValidationError` that were detected by the last call to
3591
349
        :meth:`read()`
3592
350
    """
3593
351
3594
352
    def __init__(self):
3595
353
        """
3596
354
        Initialize an empty Config object
3597
355
        """
3598
356
        self._var = {}
3599
357
        self._section = {}
3600
358
        self._filename_list = []
3601
359
        self._problem_list = []
3602
360
3603
361
    @property
3604
362
    def problem_list(self):
3605
363
        """
3606
364
        list of :class:`ValidationError` that were detected by the last call to
3607
365
        :meth:`read()`
3608
366
        """
3609
367
        return self._problem_list
3610
368
3611
369
    @property
3612
370
    def filename_list(self):
3613
371
        """
3614
372
        list of pathnames to files that were loaded by the last call to
3615
373
        :meth:`read()`
3616
374
        """
3617
375
        return self._filename_list
3618
376
3619
377
    @classmethod
3620
378
    def get(cls):
3621
379
        """
3622
380
        Get an instance of this Config class with all the configuration loaded
3623
381
        from default locations. The locations are determined by
3624
382
        Meta.filename_list attribute.
3625
383
3626
384
        :returns: fresh :class:`Config` instance
3627
385
3628
386
        """
3629
387
        self = cls()
3630
388
        self.read(cls.Meta.filename_list)
3631
389
        return self
3632
390
3633
391
    def read(self, filename_list):
3634
392
        """
3635
393
        Load and merge settings from many files.
3636
394
3637
395
        This method tries to open each file from the list of filenames, parse
3638
396
        it as an INI file using :class:`PlainBoxConfigParser` (a simple
3639
397
        ConfigParser subclass that respects the case of key names). The list of
3640
398
        files actually accessed is saved as available as
3641
399
        :attr:`Config.filename_list`.
3642
400
3643
401
        If any problem is detected during parsing (e.g. syntax errors) those
3644
402
        are captured and added to the :attr:`Config.problem_list`.
3645
403
3646
404
        After all files are loaded each :class:`Variable` and :class:`Section`
3647
405
        defined in the :class:`Config` class is assigned with the data from the
3648
406
        merged configuration data.
3649
407
3650
408
        Any variables that cannot be assigned and raise
3651
409
        :class:`ValidationError` are ignored but the list of problems is saved.
3652
410
3653
411
        All unused configuration (extra variables that are not defined as
3654
412
        either Variable or Section class) is silently ignored.
3655
413
3656
414
        .. note::
3657
415
            This method resets :ivar:`_problem_list` and
3658
416
            :ivar:`_filename_list`.
3659
417
        """
3660
418
        parser = PlainBoxConfigParser()
3661
419
        # Reset filename list and problem list
3662
420
        self._filename_list = []
3663
421
        self._problem_list = []
3664
422
        # Try loading all of the config files
3665
423
        try:
3666
424
            self._filename_list = parser.read(filename_list)
3667
425
        except configparser.Error as exc:
3668
426
            self._problem_list.append(exc)
3669
427
        # Pick a reader function appropriate for the kind of variable
3670
428
        reader_fn = {
3671
429
            str: parser.get,
3672
430
            bool: parser.getboolean,
3673
431
            int: parser.getint,
3674
432
            float: parser.getfloat
3675
433
        }
3676
434
        # Load all variables that we know about
3677
435
        for variable in self.Meta.variable_list:
3678
436
            # Access the variable in the configuration file
3679
437
            try:
3680
438
                value = reader_fn[variable.kind](
3681
439
                    variable.section, variable.name)
3682
440
            except configparser.NoSectionError:
3683
441
                continue
3684
442
            except configparser.NoOptionError:
3685
443
                continue
3686
444
            # Try to assign it
3687
445
            try:
3688
446
                variable.__set__(self, value)
3689
447
            except ValidationError as exc:
3690
448
                self.problem_list.append(exc)
3691
449
        # Load all sections that we know about
3692
450
        for section in self.Meta.section_list:
3693
451
            try:
3694
452
                # Access the section in the configuration file
3695
453
                value = dict(parser.items(section.name))
3696
454
            except configparser.NoSectionError:
3697
455
                continue
3698
456
            # Assign it
3699
457
            section.__set__(self, value)
3700
458
3701
459
    def _get_variable(self, name):
3702
460
        """
3703
461
        Internal method called by :meth:`Variable.__get__`
3704
462
        """
3705
463
        return self._var[name]
3706
464
3707
465
    def _set_variable(self, name, value):
3708
466
        """
3709
467
        Internal method called by :meth:`Variable.__set__`
3710
468
        """
3711
469
        self._var[name] = value
3712
470
3713
471
    def _del_variable(self, name):
3714
472
        """
3715
473
        Internal method called by :meth:`Variable.__delete__`
3716
474
        """
3717
475
        del self._var[name]
3718
476
3719
477
    def _get_section(self, name):
3720
478
        """
3721
479
        Internal method called by :meth:`Section.__get__`
3722
480
        """
3723
481
        return self._section[name]
3724
482
3725
483
    def _set_section(self, name, value):
3726
484
        """
3727
485
        Internal method called by :meth:`Section.__set__`
3728
486
        """
3729
487
        self._section[name] = value
3730
488
3731
489
    def _del_section(self, name):
3732
490
        """
3733
491
        Internal method called by :meth:`Section.__delete__`
3734
492
        """
3735
493
        del self._section[name]
3736
494
3737
495
3738
496
class ValidationError(ValueError):
3739
497
    """
3740
498
    Exception raised when configuration variables fail to validate
3741
499
    """
3742
500
3743
501
    def __init__(self, variable, new_value, message):
3744
502
        self.variable = variable
3745
503
        self.new_value = new_value
3746
504
        self.message = message
3747
505
3748
506
    def __str__(self):
3749
507
        return self.message
3750
508
3751
509
3752
510
class IValidator(metaclass=ABCMeta):
3753
511
    """
3754
512
    An interface for variable vale validators
3755
513
    """
3756
514
3757
515
    @abstractmethod
3758
516
    def __call__(self, variable, new_value):
3759
517
        """
3760
518
        Check if a value is appropriate for the variable.
3761
519
3762
520
        :returns: None if everything is okay
3763
521
        :returns: string that describes the problem if the value cannot be used
3764
522
        """
3765
523
3766
524
3767
525
def KindValidator(variable, new_value):
3768
526
    """
3769
527
    A validator ensuring that values match the "kind" of the variable.
3770
528
    """
3771
529
    if not isinstance(new_value, variable.kind):
3772
530
        return "expected a {}".format(variable.kind.__name__)
3773
531
3774
532
3775
533
class PatternValidator(IValidator):
3776
534
    """
3777
535
    A validator ensuring that values match a given pattern
3778
536
    """
3779
537
3780
538
    def __init__(self, pattern_text):
3781
539
        self.pattern_text = pattern_text
3782
540
        self.pattern = re.compile(pattern_text)
3783
541
3784
542
    def __call__(self, variable, new_value):
3785
543
        if not self.pattern.match(new_value):
3786
544
            return "does not match pattern: {!r}".format(self.pattern_text)
3787
0
545
3788
=== added file 'plainbox/plainbox/impl/job.py.OTHER'
3789
--- plainbox/plainbox/impl/job.py.OTHER	1970-01-01 00:00:00 +0000
3790
+++ plainbox/plainbox/impl/job.py.OTHER	2013-08-28 12:36:13 +0000
3791
@@ -0,0 +1,259 @@
3792
1
# This file is part of Checkbox.
3793
2
#
3794
3
# Copyright 2012, 2013 Canonical Ltd.
3795
4
# Written by:
3796
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
3797
6
#
3798
7
# Checkbox is free software: you can redistribute it and/or modify
3799
8
# it under the terms of the GNU General Public License as published by
3800
9
# the Free Software Foundation, either version 3 of the License, or
3801
10
# (at your option) any later version.
3802
11
#
3803
12
# Checkbox is distributed in the hope that it will be useful,
3804
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
3805
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3806
15
# GNU General Public License for more details.
3807
16
#
3808
17
# You should have received a copy of the GNU General Public License
3809
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
3810
19
3811
20
"""
3812
21
:mod:`plainbox.impl.job` -- job definition
3813
22
==========================================
3814
23
3815
24
.. warning::
3816
25
3817
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
3818
27
"""
3819
28
3820
29
import logging
3821
30
import os
3822
31
import re
3823
32
3824
33
from plainbox.abc import IJobDefinition
3825
34
from plainbox.impl.config import Unset
3826
35
from plainbox.impl.resource import ResourceProgram
3827
36
from plainbox.impl.secure.checkbox_trusted_launcher import BaseJob
3828
37
3829
38
3830
39
logger = logging.getLogger("plainbox.job")
3831
40
3832
41
3833
42
class JobDefinition(BaseJob, IJobDefinition):
3834
43
    """
3835
44
    Job definition class.
3836
45
3837
46
    Thin wrapper around the RFC822 record that defines a checkbox job
3838
47
    definition
3839
48
    """
3840
49
3841
50
    @property
3842
51
    def name(self):
3843
52
        return self.__getattr__('name')
3844
53
3845
54
    @property
3846
55
    def requires(self):
3847
56
        try:
3848
57
            return self.__getattr__('requires')
3849
58
        except AttributeError:
3850
59
            return None
3851
60
3852
61
    @property
3853
62
    def description(self):
3854
63
        try:
3855
64
            return self.__getattr__('description')
3856
65
        except AttributeError:
3857
66
            return None
3858
67
3859
68
    @property
3860
69
    def depends(self):
3861
70
        try:
3862
71
            return self.__getattr__('depends')
3863
72
        except AttributeError:
3864
73
            return None
3865
74
3866
75
    @property
3867
76
    def via(self):
3868
77
        """
3869
78
        The checksum of the "parent" job when the current JobDefinition comes
3870
79
        from a job output using the local plugin
3871
80
        """
3872
81
        return self._via
3873
82
3874
83
    @property
3875
84
    def origin(self):
3876
85
        """
3877
86
        The Origin object associated with this JobDefinition
3878
87
3879
88
        May be None
3880
89
        """
3881
90
        return self._origin
3882
91
3883
92
    def __init__(self, data, origin=None, checkbox=None, via=None):
3884
93
        super(JobDefinition, self).__init__(data)
3885
94
        self._resource_program = None
3886
95
        self._origin = origin
3887
96
        self._checkbox = checkbox
3888
97
        self._via = via
3889
98
3890
99
    def __str__(self):
3891
100
        return self.name
3892
101
3893
102
    def __repr__(self):
3894
103
        return "<JobDefinition name:{!r} plugin:{!r}>".format(
3895
104
            self.name, self.plugin)
3896
105
3897
106
    def __getattr__(self, attr):
3898
107
        if attr in self._data:
3899
108
            return self._data[attr]
3900
109
        gettext_attr = "_{}".format(attr)
3901
110
        if gettext_attr in self._data:
3902
111
            value = self._data[gettext_attr]
3903
112
            # TODO: feed through gettext
3904
113
            return value
3905
114
        raise AttributeError(attr)
3906
115
3907
116
    def _get_persistance_subset(self):
3908
117
        state = {}
3909
118
        state['data'] = {}
3910
119
        for key, value in self._data.items():
3911
120
            state['data'][key] = value
3912
121
        if self.via is not None:
3913
122
            state['via'] = self.via
3914
123
        return state
3915
124
3916
125
    def __eq__(self, other):
3917
126
        if not isinstance(other, JobDefinition):
3918
127
            return False
3919
128
        return self.get_checksum() == other.get_checksum()
3920
129
3921
130
    def __ne__(self, other):
3922
131
        if not isinstance(other, JobDefinition):
3923
132
            return True
3924
133
        return self.get_checksum() != other.get_checksum()
3925
134
3926
135
    def get_resource_program(self):
3927
136
        """
3928
137
        Return a ResourceProgram based on the 'requires' expression.
3929
138
3930
139
        The program instance is cached in the JobDefinition and is not
3931
140
        compiled or validated on subsequent calls.
3932
141
3933
142
        Returns ResourceProgram or None
3934
143
        Raises ResourceProgramError or SyntaxError
3935
144
        """
3936
145
        if self.requires is not None and self._resource_program is None:
3937
146
            self._resource_program = ResourceProgram(self.requires)
3938
147
        return self._resource_program
3939
148
3940
149
    def get_direct_dependencies(self):
3941
150
        """
3942
151
        Compute and return a set of direct dependencies
3943
152
3944
153
        To combat a simple mistake where the jobs are space-delimited any
3945
154
        mixture of white-space (including newlines) and commas are allowed.
3946
155
        """
3947
156
        if self.depends:
3948
157
            return {name for name in re.split('[\s,]+', self.depends)}
3949
158
        else:
3950
159
            return set()
3951
160
3952
161
    def get_resource_dependencies(self):
3953
162
        """
3954
163
        Compute and return a set of resource dependencies
3955
164
        """
3956
165
        program = self.get_resource_program()
3957
166
        if program:
3958
167
            return program.required_resources
3959
168
        else:
3960
169
            return set()
3961
170
3962
171
    @classmethod
3963
172
    def from_rfc822_record(cls, record):
3964
173
        """
3965
174
        Create a JobDefinition instance from rfc822 record
3966
175
3967
176
        The record must be a RFC822Record instance.
3968
177
3969
178
        Only the 'name' and 'plugin' keys are required.
3970
179
        All other data is stored as is and is entirely optional.
3971
180
        """
3972
181
        for key in ['plugin', 'name']:
3973
182
            if key not in record.data:
3974
183
                raise ValueError(
3975
184
                    "Required record key {!r} was not found".format(key))
3976
185
        return cls(record.data, record.origin)
3977
186
3978
187
    def modify_execution_environment(self, env, session_dir, config=None):
3979
188
        """
3980
189
        Alter execution environment as required to execute this job.
3981
190
3982
191
        The environment is modified in place.
3983
192
3984
193
        The session_dir argument can be passed to scripts to know where to
3985
194
        create temporary data. This data will persist during the lifetime of
3986
195
        the session.
3987
196
3988
197
        The config argument (which defaults to None) should be a PlainBoxConfig
3989
198
        object. It is used to provide values for missing environment variables
3990
199
        that are required by the job (as expressed by the environ key in the
3991
200
        job definition file).
3992
201
3993
202
        Computes and modifies the dictionary of additional values that need to
3994
203
        be added to the base environment. Note that all changes to the
3995
204
        environment (modifications, not replacements) depend on the current
3996
205
        environment.  This may be of importance when attempting to setup the
3997
206
        test session as another user.
3998
207
3999
208
        This environment has additional PATH, PYTHONPATH entries. It also uses
4000
209
        fixed LANG so that scripts behave as expected. Lastly it sets
4001
210
        CHECKBOX_SHARE that is required by some scripts.
4002
211
        """
4003
212
        # XXX: this obviously requires a checkbox object to know where stuff is
4004
213
        # but during the transition we may not have one available.
4005
214
        assert self._checkbox is not None
4006
215
        # Use PATH that can lookup checkbox scripts
4007
216
        if self._checkbox.extra_PYTHONPATH:
4008
217
            env['PYTHONPATH'] = os.pathsep.join(
4009
218
                [self._checkbox.extra_PYTHONPATH]
4010
219
                + env.get("PYTHONPATH", "").split(os.pathsep))
4011
220
        # Update PATH so that scripts can be found
4012
221
        env['PATH'] = os.pathsep.join(
4013
222
            [self._checkbox.extra_PATH]
4014
223
            + env.get("PATH", "").split(os.pathsep))
4015
224
        # Add CHECKBOX_SHARE that is needed by one script
4016
225
        env['CHECKBOX_SHARE'] = self._checkbox.CHECKBOX_SHARE
4017
226
        # Add CHECKBOX_DATA (temporary checkbox data)
4018
227
        env['CHECKBOX_DATA'] = session_dir
4019
228
        # Inject additional variables that are requested in the config
4020
229
        if config is not None and config.environment is not Unset:
4021
230
            for env_var in config.environment:
4022
231
                # Don't override anything that is already present in the
4023
232
                # current environment. This will allow users to customize
4024
233
                # variables without editing any config files.
4025
234
                if env_var in env:
4026
235
                    continue
4027
236
                # If the environment section of the configuration file has a
4028
237
                # particular variable then copy it over.
4029
238
                env[env_var] = config.environment[env_var]
4030
239
4031
240
    def create_child_job_from_record(self, record):
4032
241
        """
4033
242
        Create a new JobDefinition from RFC822 record.
4034
243
4035
244
        This method should only be used to create additional jobs from local
4036
245
        jobs (plugin local). The intent is two-fold:
4037
246
            1) to encapsulate the sharing of the embedded checkbox reference.
4038
247
            2) to set the ``via`` attribute (to aid the trusted launcher)
4039
248
        """
4040
249
        job = self.from_rfc822_record(record)
4041
250
        job._checkbox = self._checkbox
4042
251
        job._via = self.get_checksum()
4043
252
        return job
4044
253
4045
254
    @classmethod
4046
255
    def from_json_record(cls, record):
4047
256
        """
4048
257
        Create a JobDefinition instance from JSON record
4049
258
        """
4050
259
        return cls(record['data'], via=record.get('via'))
4051
0
260
4052
=== added file 'plainbox/plainbox/impl/runner.py.OTHER'
4053
--- plainbox/plainbox/impl/runner.py.OTHER	1970-01-01 00:00:00 +0000
4054
+++ plainbox/plainbox/impl/runner.py.OTHER	2013-08-28 12:36:13 +0000
4055
@@ -0,0 +1,421 @@
4056
1
# This file is part of Checkbox.
4057
2
#
4058
3
# Copyright 2012 Canonical Ltd.
4059
4
# Written by:
4060
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
4061
6
#
4062
7
# Checkbox is free software: you can redistribute it and/or modify
4063
8
# it under the terms of the GNU General Public License as published by
4064
9
# the Free Software Foundation, either version 3 of the License, or
4065
10
# (at your option) any later version.
4066
11
#
4067
12
# Checkbox is distributed in the hope that it will be useful,
4068
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
4069
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4070
15
# GNU General Public License for more details.
4071
16
#
4072
17
# You should have received a copy of the GNU General Public License
4073
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
4074
19
4075
20
"""
4076
21
:mod:`plainbox.impl.runner` -- job runner
4077
22
=========================================
4078
23
4079
24
.. warning::
4080
25
4081
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
4082
27
"""
4083
28
4084
29
import collections
4085
30
import datetime
4086
31
import json
4087
32
import logging
4088
33
import os
4089
34
import string
4090
35
4091
36
from plainbox.vendor import extcmd
4092
37
4093
38
from plainbox.abc import IJobRunner
4094
39
from plainbox.impl.result import JobResult, IOLogRecord, IoLogEncoder
4095
40
4096
41
logger = logging.getLogger("plainbox.runner")
4097
42
4098
43
4099
44
def slugify(_string):
4100
45
    """
4101
46
    Slugify - like Django does for URL - transform a random string to a valid
4102
47
    slug that can be later used in filenames
4103
48
    """
4104
49
    valid_chars = frozenset(
4105
50
        "-_.{}{}".format(string.ascii_letters, string.digits))
4106
51
    return ''.join(c if c in valid_chars else '_' for c in _string)
4107
52
4108
53
4109
54
def io_log_write(log, stream):
4110
55
    """
4111
56
    JSON call to serialize io_log objects to disk
4112
57
    """
4113
58
    json.dump(
4114
59
        log, stream, ensure_ascii=False, indent=None, cls=IoLogEncoder,
4115
60
        separators=(',', ':'))
4116
61
4117
62
4118
63
def authenticate_warmup():
4119
64
    """
4120
65
    Call the checkbox trusted launcher in warmup mode.
4121
66
4122
67
    This will use the corresponding PolicyKit action and start the
4123
68
    authentication agent (depending on the installed policy file)
4124
69
    """
4125
70
    warmup_popen = extcmd.ExternalCommand()
4126
71
    return warmup_popen.call(
4127
72
        ['pkexec', 'checkbox-trusted-launcher', '--warmup'])
4128
73
4129
74
4130
75
class CommandIOLogBuilder(extcmd.DelegateBase):
4131
76
    """
4132
77
    Delegate for extcmd that builds io_log entries.
4133
78
4134
79
    IO log entries are records kept by JobResult.io_log and correspond to all
4135
80
    of the data that was written by called process. The format is a sequence of
4136
81
    tuples (delay, stream_name, data).
4137
82
    """
4138
83
4139
84
    def on_begin(self, args, kwargs):
4140
85
        """
4141
86
        Internal method of extcmd.DelegateBase
4142
87
4143
88
        Called when a command is being invoked.
4144
89
        Begins tracking time (relative time entries) and creates the empty
4145
90
        io_log list.
4146
91
        """
4147
92
        logger.debug("io log starting for command: %r", args)
4148
93
        self.io_log = []
4149
94
        self.last_msg = datetime.datetime.utcnow()
4150
95
4151
96
    def on_line(self, stream_name, line):
4152
97
        """
4153
98
        Internal method of IOLogBuilder
4154
99
4155
100
        Appends each line to the io_log. Maintains a timestamp of the last
4156
101
        message so that approximate delay between each piece of output can be
4157
102
        recorded as well.
4158
103
        """
4159
104
        now = datetime.datetime.utcnow()
4160
105
        delay = now - self.last_msg
4161
106
        self.last_msg = now
4162
107
        record = IOLogRecord(delay.total_seconds(), stream_name, line)
4163
108
        self.io_log.append(record)
4164
109
        logger.debug("io log captured %r", record)
4165
110
4166
111
4167
112
class CommandOutputWriter(extcmd.DelegateBase):
4168
113
    """
4169
114
    Delegate for extcmd that writes output to a file on disk.
4170
115
4171
116
    The file itself is only opened once on_begin() gets called by extcmd. This
4172
117
    makes it safe to instantiate this without worrying about dangling
4173
118
    resources.
4174
119
    """
4175
120
4176
121
    def __init__(self, stdout_path, stderr_path):
4177
122
        """
4178
123
        Initialize new writer.
4179
124
4180
125
        Just records output paths.
4181
126
        """
4182
127
        self.stdout_path = stdout_path
4183
128
        self.stderr_path = stderr_path
4184
129
4185
130
    def on_begin(self, args, kwargs):
4186
131
        """
4187
132
        Internal method of extcmd.DelegateBase
4188
133
4189
134
        Called when a command is being invoked
4190
135
        """
4191
136
        self.stdout = open(self.stdout_path, "wb")
4192
137
        self.stderr = open(self.stderr_path, "wb")
4193
138
4194
139
    def on_end(self, returncode):
4195
140
        """
4196
141
        Internal method of extcmd.DelegateBase
4197
142
4198
143
        Called when a command finishes running
4199
144
        """
4200
145
        self.stdout.close()
4201
146
        self.stderr.close()
4202
147
4203
148
    def on_line(self, stream_name, line):
4204
149
        """
4205
150
        Internal method of extcmd.DelegateBase
4206
151
4207
152
        Called for each line of output.
4208
153
        """
4209
154
        if stream_name == 'stdout':
4210
155
            self.stdout.write(line)
4211
156
        elif stream_name == 'stderr':
4212
157
            self.stderr.write(line)
4213
158
4214
159
4215
160
class FallbackCommandOutputPrinter(extcmd.DelegateBase):
4216
161
    """
4217
162
    Delegate for extcmd that prints all output to stdout.
4218
163
4219
164
    This delegate is only used as a fallback when no delegate was explicitly
4220
165
    provided to a JobRunner instance.
4221
166
    """
4222
167
4223
168
    def __init__(self, prompt):
4224
169
        self._prompt = prompt
4225
170
        self._lineno = collections.defaultdict(int)
4226
171
        self._abort = False
4227
172
4228
173
    def on_line(self, stream_name, line):
4229
174
        if self._abort:
4230
175
            return
4231
176
        self._lineno[stream_name] += 1
4232
177
        try:
4233
178
            print("(job {}, <{}:{:05}>) {}".format(
4234
179
                self._prompt, stream_name, self._lineno[stream_name],
4235
180
                line.decode('UTF-8').rstrip()))
4236
181
        except UnicodeDecodeError:
4237
182
            self._abort = True
4238
183
4239
184
4240
185
class JobRunner(IJobRunner):
4241
186
    """
4242
187
    Runner for jobs - executes jobs and produces results
4243
188
4244
189
    The runner is somewhat de-coupled from jobs and session. It still carries
4245
190
    all checkbox-specific logic about the various types of plugins.
4246
191
4247
192
    The runner consumes jobs and configuration objects and produces job result
4248
193
    objects. The runner can operate in dry-run mode, when enabled, most jobs
4249
194
    are never started. Only jobs listed in DRY_RUN_PLUGINS are executed.
4250
195
    """
4251
196
4252
197
    # List of plugins that are still executed
4253
198
    _DRY_RUN_PLUGINS = ('local', 'resource', 'attachment')
4254
199
4255
200
    def __init__(self, session_dir, jobs_io_log_dir,
4256
201
                 command_io_delegate=None, outcome_callback=None,
4257
202
                 dry_run=False):
4258
203
        """
4259
204
        Initialize a new job runner.
4260
205
4261
206
        Uses the specified session_dir as CHECKBOX_DATA environment variable.
4262
207
        Uses the specified IO delegate for extcmd.ExternalCommandWithDelegate
4263
208
        to track IO done by the called commands (optional, a simple console
4264
209
        printer is provided if missing).
4265
210
        """
4266
211
        self._session_dir = session_dir
4267
212
        self._jobs_io_log_dir = jobs_io_log_dir
4268
213
        self._command_io_delegate = command_io_delegate
4269
214
        self._outcome_callback = outcome_callback
4270
215
        self._dry_run = dry_run
4271
216
4272
217
    def run_job(self, job, config=None):
4273
218
        """
4274
219
        Run the specified job an return the result
4275
220
        """
4276
221
        logger.info("Running %r", job)
4277
222
        func_name = "_plugin_" + job.plugin.replace('-', '_')
4278
223
        try:
4279
224
            runner = getattr(self, func_name)
4280
225
        except AttributeError:
4281
226
            return JobResult({
4282
227
                'job': job,
4283
228
                'outcome': JobResult.OUTCOME_NOT_IMPLEMENTED,
4284
229
                'comment': 'This plugin is not supported'
4285
230
            })
4286
231
        else:
4287
232
            if self._dry_run and job.plugin not in self._DRY_RUN_PLUGINS:
4288
233
                return self._dry_run_result(job)
4289
234
            else:
4290
235
                return runner(job, config)
4291
236
4292
237
    def _dry_run_result(self, job):
4293
238
        """
4294
239
        Produce the result that is used when running in dry-run mode
4295
240
        """
4296
241
        return JobResult({
4297
242
            'job': job,
4298
243
            'outcome': JobResult.OUTCOME_SKIP,
4299
244
            'comments': "Job skipped in dry-run mode"
4300
245
        })
4301
246
4302
247
    def _plugin_shell(self, job, config):
4303
248
        return self._just_run_command(job, config)
4304
249
4305
250
    _plugin_attachment = _plugin_shell
4306
251
4307
252
    def _plugin_resource(self, job, config):
4308
253
        return self._just_run_command(job, config)
4309
254
4310
255
    def _plugin_local(self, job, config):
4311
256
        return self._just_run_command(job, config)
4312
257
4313
258
    def _plugin_manual(self, job, config):
4314
259
        if self._outcome_callback is None:
4315
260
            return JobResult({
4316
261
                'job': job,
4317
262
                'outcome': JobResult.OUTCOME_SKIP,
4318
263
                'comment': "non-interactive test run"
4319
264
            })
4320
265
        else:
4321
266
            result = self._just_run_command(job, config)
4322
267
            # XXX: make outcome writable
4323
268
            result._data['outcome'] = self._outcome_callback()
4324
269
            return result
4325
270
4326
271
    _plugin_user_interact = _plugin_manual
4327
272
    _plugin_user_verify = _plugin_manual
4328
273
4329
274
    def _just_run_command(self, job, config):
4330
275
        # Run the embedded command
4331
276
        return_code, io_log = self._run_command(job, config)
4332
277
        # Convert the return of the command to the outcome of the job
4333
278
        if return_code == 0:
4334
279
            outcome = JobResult.OUTCOME_PASS
4335
280
        else:
4336
281
            outcome = JobResult.OUTCOME_FAIL
4337
282
        # Create a result object and return it
4338
283
        return JobResult({
4339
284
            'job': job,
4340
285
            'outcome': outcome,
4341
286
            'return_code': return_code,
4342
287
            'io_log': io_log
4343
288
        })
4344
289
4345
290
    def _get_script_env(self, job, config=None, only_changes=False):
4346
291
        """
4347
292
        Compute the environment the script will be executed in
4348
293
        """
4349
294
        # Get a proper environment
4350
295
        env = dict(os.environ)
4351
296
        # Use non-internationalized environment
4352
297
        env['LANG'] = 'C.UTF-8'
4353
298
        # Allow the job to customize anything
4354
299
        job.modify_execution_environment(env, self._session_dir, config)
4355
300
        # If a differential environment is requested return only the subset
4356
301
        # that has been altered.
4357
302
        #
4358
303
        # XXX: This will effectively give the root user our PATH which _may_ be
4359
304
        # good bud _might_ be dangerous. This will need some peer review.
4360
305
        if only_changes:
4361
306
            return {key: value
4362
307
                    for key, value in env.items()
4363
308
                    if key not in os.environ or os.environ[key] != value
4364
309
                    or key in job.get_environ_settings()}
4365
310
        else:
4366
311
            return env
4367
312
4368
313
    def _get_command_trusted(self, job, config=None):
4369
314
        # When the job requires to run as root then elevate our permissions
4370
315
        # via pkexec(1). Since pkexec resets environment we need to somehow
4371
316
        # pass the extra things we require. To do that we pass the list of
4372
317
        # changed environment variables in addition to the job hash.
4373
318
        cmd = ['checkbox-trusted-launcher', '--hash', job.get_checksum()] + [
4374
319
            "{key}={value}".format(key=key, value=value)
4375
320
            for key, value in self._get_script_env(
4376
321
                job, config, only_changes=True
4377
322
            ).items()
4378
323
        ]
4379
324
        if job.via is not None:
4380
325
            cmd += ['--via', job.via]
4381
326
        return cmd
4382
327
4383
328
    def _get_command_src(self, job, config=None):
4384
329
        # Running PlainBox from source doesn't require the trusted launcher
4385
330
        # That's why we use the env(1)' command and pass it the list of
4386
331
        # changed environment variables.
4387
332
        # The whole pkexec and env part gets prepended to the command
4388
333
        # we were supposed to run.
4389
334
        cmd = ['env']
4390
335
        cmd += [
4391
336
            "{key}={value}".format(key=key, value=value)
4392
337
            for key, value in self._get_script_env(
4393
338
                job, only_changes=True
4394
339
            ).items()
4395
340
        ]
4396
341
        cmd += ['bash', '-c', job.command]
4397
342
        return cmd
4398
343
4399
344
    def _run_command(self, job, config):
4400
345
        """
4401
346
        Run the shell command associated with the specified job.
4402
347
4403
348
        Returns a tuple (return_code, io_log)
4404
349
        """
4405
350
        # Bail early if there is nothing do do
4406
351
        if job.command is None:
4407
352
            return None, ()
4408
353
        ui_io_delegate = self._command_io_delegate
4409
354
        # If there is no UI delegate specified create a simple
4410
355
        # delegate that logs all output to the console
4411
356
        if ui_io_delegate is None:
4412
357
            ui_io_delegate = FallbackCommandOutputPrinter(job.name)
4413
358
        # Create a delegate that writes all IO to disk
4414
359
        slug = slugify(job.name)
4415
360
        output_writer = CommandOutputWriter(
4416
361
            stdout_path=os.path.join(self._jobs_io_log_dir,
4417
362
                                     "{}.stdout".format(slug)),
4418
363
            stderr_path=os.path.join(self._jobs_io_log_dir,
4419
364
                                     "{}.stderr".format(slug)))
4420
365
        # Create a delegate that builds a log of all IO
4421
366
        io_log_builder = CommandIOLogBuilder()
4422
367
        # Create the delegate for routing IO
4423
368
        #
4424
369
        #
4425
370
        # Split the stream of data into three parts (each part is expressed as
4426
371
        # an element of extcmd.Chain()).
4427
372
        #
4428
373
        # Send the first copy of the data through bytes->text decoder and
4429
374
        # then to the UI delegate. This cold be something provided by the
4430
375
        # higher level caller or the default CommandOutputLogger.
4431
376
        #
4432
377
        # Send the second copy of the data to the _IOLogBuilder() instance that
4433
378
        # just concatenates subsequent bytes into neat time-stamped records.
4434
379
        #
4435
380
        # Send the third copy to the output writer that writes everything to
4436
381
        # disk.
4437
382
        delegate = extcmd.Chain([
4438
383
            ui_io_delegate,
4439
384
            io_log_builder,
4440
385
            output_writer])
4441
386
        logger.debug("job[%s] extcmd delegate: %r", job.name, delegate)
4442
387
        # Create a subprocess.Popen() like object that uses the delegate
4443
388
        # system to observe all IO as it occurs in real time.
4444
389
        logging_popen = extcmd.ExternalCommandWithDelegate(delegate)
4445
390
        # Start the process and wait for it to finish getting the
4446
391
        # result code. This will actually call a number of callbacks
4447
392
        # while the process is running. It will also spawn a few
4448
393
        # threads although all callbacks will be fired from a single
4449
394
        # thread (which is _not_ the main thread)
4450
395
        logger.debug("job[%s] starting command: %s", job.name, job.command)
4451
396
        if job.user is not None:
4452
397
            if job._checkbox._mode == 'src':
4453
398
                cmd = self._get_command_src(job, config)
4454
399
            else:
4455
400
                cmd = self._get_command_trusted(job, config)
4456
401
            cmd = ['pkexec', '--user', job.user] + cmd
4457
402
            logging.debug("job[%s] executing %r", job.name, cmd)
4458
403
            return_code = logging_popen.call(cmd)
4459
404
        else:
4460
405
            # XXX: sadly using /bin/sh results in broken output
4461
406
            # XXX: maybe run it both ways and raise exceptions on differences?
4462
407
            cmd = ['bash', '-c', job.command]
4463
408
            logging.debug("job[%s] executing %r", job.name, cmd)
4464
409
            return_code = logging_popen.call(
4465
410
                cmd, env=self._get_script_env(job, config))
4466
411
        logger.debug("job[%s] command return code: %r",
4467
412
                     job.name, return_code)
4468
413
        # XXX: Perhaps handle process dying from signals here
4469
414
        # When the process is killed proc.returncode is not set
4470
415
        # and another (cannot remember now) attribute is set
4471
416
        fjson = os.path.join(self._jobs_io_log_dir, "{}.json".format(slug))
4472
417
        with open(fjson, "wt") as stream:
4473
418
            io_log_write(io_log_builder.io_log, stream)
4474
419
            stream.flush()
4475
420
            os.fsync(stream.fileno())
4476
421
        return return_code, fjson
4477
0
422
4478
=== added directory 'plainbox/plainbox/impl/secure'
4479
=== added file 'plainbox/plainbox/impl/secure/checkbox_trusted_launcher.py.OTHER'
4480
--- plainbox/plainbox/impl/secure/checkbox_trusted_launcher.py.OTHER	1970-01-01 00:00:00 +0000
4481
+++ plainbox/plainbox/impl/secure/checkbox_trusted_launcher.py.OTHER	2013-08-28 12:36:13 +0000
4482
@@ -0,0 +1,395 @@
4483
1
# This file is part of Checkbox.
4484
2
#
4485
3
# Copyright 2013 Canonical Ltd.
4486
4
# Written by:
4487
5
#   Sylvain Pineau <sylvain.pineau@canonical.com>
4488
6
#
4489
7
# Checkbox is free software: you can redistribute it and/or modify
4490
8
# it under the terms of the GNU General Public License as published by
4491
9
# the Free Software Foundation, either version 3 of the License, or
4492
10
# (at your option) any later version.
4493
11
#
4494
12
# Checkbox is distributed in the hope that it will be useful,
4495
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
4496
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4497
15
# GNU General Public License for more details.
4498
16
#
4499
17
# You should have received a copy of the GNU General Public License
4500
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
4501
19
4502
20
"""
4503
21
:mod:`plainbox.impl.secure.checkbox_trusted_launcher` -- command launcher
4504
22
=========================================================================
4505
23
4506
24
.. warning::
4507
25
4508
26
    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
4509
27
"""
4510
28
4511
29
import argparse
4512
30
import collections
4513
31
import glob
4514
32
import hashlib
4515
33
import json
4516
34
import os
4517
35
import re
4518
36
import subprocess
4519
37
from inspect import cleandoc
4520
38
4521
39
4522
40
class BaseJob:
4523
41
    """
4524
42
    Base Job definition class.
4525
43
    """
4526
44
4527
45
    @property
4528
46
    def plugin(self):
4529
47
        return self.__getattr__('plugin')
4530
48
4531
49
    @property
4532
50
    def command(self):
4533
51
        try:
4534
52
            return self.__getattr__('command')
4535
53
        except AttributeError:
4536
54
            return None
4537
55
4538
56
    @property
4539
57
    def environ(self):
4540
58
        try:
4541
59
            return self.__getattr__('environ')
4542
60
        except AttributeError:
4543
61
            return None
4544
62
4545
63
    @property
4546
64
    def user(self):
4547
65
        try:
4548
66
            return self.__getattr__('user')
4549
67
        except AttributeError:
4550
68
            return None
4551
69
4552
70
    def __init__(self, data):
4553
71
        self._data = data
4554
72
4555
73
    def __getattr__(self, attr):
4556
74
        if attr in self._data:
4557
75
            return self._data[attr]
4558
76
        raise AttributeError(attr)
4559
77
4560
78
    def get_checksum(self):
4561
79
        """
4562
80
        Compute a checksum of the job definition.
4563
81
4564
82
        This method can be used to compute the checksum of the canonical form
4565
83
        of the job definition.  The canonical form is the UTF-8 encoded JSON
4566
84
        serialization of the data that makes up the full definition of the job
4567
85
        (all keys and values). The JSON serialization uses no indent and
4568
86
        minimal separators.
4569
87
4570
88
        The checksum is defined as the SHA256 hash of the canonical form.
4571
89
        """
4572
90
        # Ideally we'd use simplejson.dumps() with sorted keys to get
4573
91
        # predictable serialization but that's another dependency. To get
4574
92
        # something simple that is equally reliable, just sort all the keys
4575
93
        # manually and ask standard json to serialize that..
4576
94
        sorted_data = collections.OrderedDict(sorted(self._data.items()))
4577
95
        # Compute the canonical form which is arbitrarily defined as sorted
4578
96
        # json text with default indent and separator settings.
4579
97
        canonical_form = json.dumps(
4580
98
            sorted_data, indent=None, separators=(',', ':'))
4581
99
        # Compute the sha256 hash of the UTF-8 encoding of the canonical form
4582
100
        # and return the hex digest as the checksum that can be displayed.
4583
101
        return hashlib.sha256(canonical_form.encode('UTF-8')).hexdigest()
4584
102
4585
103
    def get_environ_settings(self):
4586
104
        """
4587
105
        Return a set of requested environment variables
4588
106
        """
4589
107
        if self.environ is not None:
4590
108
            return {variable for variable in re.split('[\s,]+', self.environ)}
4591
109
        else:
4592
110
            return set()
4593
111
4594
112
    def modify_execution_environment(self, environ, packages):
4595
113
        """
4596
114
        Compute the environment the script will be executed in
4597
115
        """
4598
116
        # Get a proper environment
4599
117
        env = dict(os.environ)
4600
118
        # Use non-internationalized environment
4601
119
        env['LANG'] = 'C.UTF-8'
4602
120
        # Create CHECKBOX*_SHARE for every checkbox related packages
4603
121
        # Add their respective script directory to the PATH variable
4604
122
        # giving precedence to those located in /usr/lib/
4605
123
        for path in packages:
4606
124
            basename = os.path.basename(path)
4607
125
            env[basename.upper().replace('-', '_') + '_SHARE'] = path
4608
126
            # Update PATH so that scripts can be found
4609
127
            env['PATH'] = os.pathsep.join([
4610
128
                os.path.join('usr', 'lib', basename, 'bin'),
4611
129
                os.path.join(path, 'scripts')]
4612
130
                + env.get("PATH", "").split(os.pathsep))
4613
131
        if 'CHECKBOX_DATA' in env:
4614
132
            env['CHECKBOX_DATA'] = environ['CHECKBOX_DATA']
4615
133
        # Add new environment variables only if they are defined in the
4616
134
        # job environ property
4617
135
        for key in self.get_environ_settings():
4618
136
            if key in environ:
4619
137
                env[key] = environ[key]
4620
138
        return env
4621
139
4622
140
4623
141
class BaseRFC822Record:
4624
142
    """
4625
143
    Base class for tracking RFC822 records
4626
144
4627
145
    This is a simple container for the dictionary of data.
4628
146
    """
4629
147
4630
148
    def __init__(self, data):
4631
149
        self._data = data
4632
150
4633
151
    @property
4634
152
    def data(self):
4635
153
        """
4636
154
        The data set (dictionary)
4637
155
        """
4638
156
        return self._data
4639
157
4640
158
4641
159
class RFC822SyntaxError(SyntaxError):
4642
160
    """
4643
161
    SyntaxError subclass for RFC822 parsing functions
4644
162
    """
4645
163
4646
164
    def __init__(self, filename, lineno, msg):
4647
165
        self.filename = filename
4648
166
        self.lineno = lineno
4649
167
        self.msg = msg
4650
168
4651
169
4652
170
def load_rfc822_records(stream, data_cls=dict):
4653
171
    """
4654
172
    Load a sequence of rfc822-like records from a text stream.
4655
173
4656
174
    Each record consists of any number of key-value pairs. Subsequent records
4657
175
    are separated by one blank line. A record key may have a multi-line value
4658
176
    if the line starts with whitespace character.
4659
177
4660
178
    Returns a list of subsequent values as instances BaseRFC822Record class. If
4661
179
    the optional data_cls argument is collections.OrderedDict then the values
4662
180
    retain their original ordering.
4663
181
    """
4664
182
    return list(gen_rfc822_records(stream, data_cls))
4665
183
4666
184
4667
185
def gen_rfc822_records(stream, data_cls=dict):
4668
186
    """
4669
187
    Load a sequence of rfc822-like records from a text stream.
4670
188
4671
189
    Each record consists of any number of key-value pairs. Subsequent records
4672
190
    are separated by one blank line. A record key may have a multi-line value
4673
191
    if the line starts with whitespace character.
4674
192
4675
193
    Returns a list of subsequent values as instances BaseRFC822Record class. If
4676
194
    the optional data_cls argument is collections.OrderedDict then the values
4677
195
    retain their original ordering.
4678
196
    """
4679
197
    record = None
4680
198
    data = None
4681
199
    key = None
4682
200
    value_list = None
4683
201
4684
202
    def _syntax_error(msg):
4685
203
        """
4686
204
        Report a syntax error in the current line
4687
205
        """
4688
206
        try:
4689
207
            filename = stream.name
4690
208
        except AttributeError:
4691
209
            filename = None
4692
210
        return RFC822SyntaxError(filename, lineno, msg)
4693
211
4694
212
    def _new_record():
4695
213
        """
4696
214
        Reset local state to track new record
4697
215
        """
4698
216
        nonlocal key
4699
217
        nonlocal value_list
4700
218
        nonlocal record
4701
219
        nonlocal data
4702
220
        key = None
4703
221
        value_list = None
4704
222
        data = data_cls()
4705
223
        record = BaseRFC822Record(data)
4706
224
4707
225
    def _commit_key_value_if_needed():
4708
226
        """
4709
227
        Finalize the most recently seen key: value pair
4710
228
        """
4711
229
        nonlocal key
4712
230
        if key is not None:
4713
231
            data[key] = cleandoc('\n'.join(value_list))
4714
232
            key = None
4715
233
4716
234
    # Start with an empty record
4717
235
    _new_record()
4718
236
    # Iterate over subsequent lines of the stream
4719
237
    for lineno, line in enumerate(stream, start=1):
4720
238
        # Treat empty lines as record separators
4721
239
        if line.strip() == "":
4722
240
            # Commit the current record so that the multi-line value of the
4723
241
            # last key, if any, is saved as a string
4724
242
            _commit_key_value_if_needed()
4725
243
            # If data is non-empty, yield the record, this allows us to safely
4726
244
            # use newlines for formatting
4727
245
            if data:
4728
246
                yield record
4729
247
            # Reset local state so that we can build a new record
4730
248
            _new_record()
4731
249
        # Treat lines staring with whitespace as multi-line continuation of the
4732
250
        # most recently seen key-value
4733
251
        elif line.startswith(" "):
4734
252
            if key is None:
4735
253
                # If we have not seen any keys yet then this is a syntax error
4736
254
                raise _syntax_error("Unexpected multi-line value")
4737
255
            # Append the current line to the list of values of the most recent
4738
256
            # key. This prevents quadratic complexity of string concatenation
4739
257
            if line == " .\n":
4740
258
                value_list.append(" ")
4741
259
            elif line == " ..\n":
4742
260
                value_list.append(" .")
4743
261
            else:
4744
262
                value_list.append(line.rstrip())
4745
263
        # Treat lines with a colon as new key-value pairs
4746
264
        elif ":" in line:
4747
265
            # Since we have a new, key-value pair we need to commit any
4748
266
            # previous key that we may have (regardless of multi-line or
4749
267
            # single-line values).
4750
268
            _commit_key_value_if_needed()
4751
269
            # Parse the line by splitting on the colon, get rid of additional
4752
270
            # whitespace from both key and the value
4753
271
            key, value = line.split(":", 1)
4754
272
            key = key.strip()
4755
273
            value = value.strip()
4756
274
            # Check if the key already exist in this message
4757
275
            if key in record.data:
4758
276
                raise _syntax_error((
4759
277
                    "Job has a duplicate key {!r} "
4760
278
                    "with old value {!r} and new value {!r}").format(
4761
279
                        key, record.data[key], value))
4762
280
            # Construct initial value list out of the (only) value that we have
4763
281
            # so far. Additional multi-line values will just append to
4764
282
            # value_list
4765
283
            value_list = [value]
4766
284
        # Treat all other lines as syntax errors
4767
285
        else:
4768
286
            raise _syntax_error("Unexpected non-empty line")
4769
287
    # Make sure to commit the last key from the record
4770
288
    _commit_key_value_if_needed()
4771
289
    # Once we've seen the whole file return the last record, if any
4772
290
    if data:
4773
291
        yield record
4774
292
4775
293
4776
294
class Runner:
4777
295
    """
4778
296
    Runner for jobs
4779
297
4780
298
    Executes the command process and pipes back stdout/stderr
4781
299
    """
4782
300
4783
301
    CHECKBOXES = "/usr/share/checkbox*"
4784
302
4785
303
    def __init__(self, builtin_jobs=[], packages=[]):
4786
304
        # List of all available jobs in system-wide locations
4787
305
        self.builtin_jobs = builtin_jobs
4788
306
        # List of all checkbox variants, like checkbox-oem(-.*)?
4789
307
        self.packages = packages
4790
308
4791
309
    def path_expand(self, path):
4792
310
        for p in glob.glob(path):
4793
311
            self.packages.append(p)
4794
312
            for dirpath, dirs, filenames in os.walk(os.path.join(p, 'jobs')):
4795
313
                for name in filenames:
4796
314
                    if name.endswith(".txt"):
4797
315
                        yield os.path.join(dirpath, name)
4798
316
4799
317
    def main(self, argv=None):
4800
318
        parser = argparse.ArgumentParser(prog="checkbox-trusted-launcher")
4801
319
        group = parser.add_mutually_exclusive_group(required=True)
4802
320
        group.add_argument('--hash', metavar='HASH', help='job hash to match')
4803
321
        group.add_argument(
4804
322
            '--warmup',
4805
323
            action='store_true',
4806
324
            help='Return immediately, only useful when used with pkexec(1)')
4807
325
        parser.add_argument(
4808
326
            '--via',
4809
327
            metavar='LOCAL-JOB-HASH',
4810
328
            dest='via_hash',
4811
329
            help='Local job hash to use to match the generated job')
4812
330
        parser.add_argument(
4813
331
            'ENV', metavar='NAME=VALUE', nargs='*',
4814
332
            help='Set each NAME to VALUE in the string environment')
4815
333
        args = parser.parse_args(argv)
4816
334
4817
335
        if args.warmup:
4818
336
            return 0
4819
337
4820
338
        for filename in self.path_expand(self.CHECKBOXES):
4821
339
            stream = open(filename, "r", encoding="utf-8")
4822
340
            for message in load_rfc822_records(stream):
4823
341
                self.builtin_jobs.append(BaseJob(message.data))
4824
342
            stream.close()
4825
343
        lookup_list = [j for j in self.builtin_jobs if j.user]
4826
344
4827
345
        args.ENV = dict(item.split('=') for item in args.ENV)
4828
346
4829
347
        if args.via_hash is not None:
4830
348
            local_list = [j for j in self.builtin_jobs if j.plugin == 'local']
4831
349
            desired_job_list = [j for j in local_list
4832
350
                                if j.get_checksum() == args.via_hash]
4833
351
            if desired_job_list:
4834
352
                via_job = desired_job_list.pop()
4835
353
                via_job_result = subprocess.Popen(
4836
354
                    via_job.command,
4837
355
                    shell=True,
4838
356
                    universal_newlines=True,
4839
357
                    stdout=subprocess.PIPE,
4840
358
                    env=via_job.modify_execution_environment(
4841
359
                        args.ENV,
4842
360
                        self.packages)
4843
361
                )
4844
362
                try:
4845
363
                    for message in load_rfc822_records(via_job_result.stdout):
4846
364
                        lookup_list.append(BaseJob(message.data))
4847
365
                finally:
4848
366
                    # Always call Popen.wait() in order to avoid zombies
4849
367
                    via_job_result.stdout.close()
4850
368
                    via_job_result.wait()
4851
369
4852
370
        try:
4853
371
            target_job = [j for j in lookup_list
4854
372
                          if j.get_checksum() == args.hash][0]
4855
373
        except IndexError:
4856
374
            return "Job not found"
4857
375
        try:
4858
376
            os.execve(
4859
377
                '/bin/bash',
4860
378
                ['bash', '-c', target_job.command],
4861
379
                target_job.modify_execution_environment(
4862
380
                    args.ENV,
4863
381
                    self.packages)
4864
382
            )
4865
383
        # if execve doesn't fail, it never returns...
4866
384
        except OSError:
4867
385
            return "Fatal error"
4868
386
        finally:
4869
387
            return "Fatal error"
4870
388
4871
389
4872
390
def main(argv=None):
4873
391
    """
4874
392
    Entry point for the checkbox trusted launcher
4875
393
    """
4876
394
    runner = Runner()
4877
395
    raise SystemExit(runner.main(argv))
4878
0
396
4879
=== added file 'plainbox/plainbox/impl/secure/test_checkbox_trusted_launcher.py.OTHER'
4880
--- plainbox/plainbox/impl/secure/test_checkbox_trusted_launcher.py.OTHER	1970-01-01 00:00:00 +0000
4881
+++ plainbox/plainbox/impl/secure/test_checkbox_trusted_launcher.py.OTHER	2013-08-28 12:36:13 +0000
4882
@@ -0,0 +1,280 @@
4883
1
# This file is part of Checkbox.
4884
2
#
4885
3
# Copyright 2013 Canonical Ltd.
4886
4
# Written by:
4887
5
#   Sylvain Pineau <sylvain.pineau@canonical.com>
4888
6
#
4889
7
# Checkbox is free software: you can redistribute it and/or modify
4890
8
# it under the terms of the GNU General Public License as published by
4891
9
# the Free Software Foundation, either version 3 of the License, or
4892
10
# (at your option) any later version.
4893
11
#
4894
12
# Checkbox is distributed in the hope that it will be useful,
4895
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
4896
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4897
15
# GNU General Public License for more details.
4898
16
#
4899
17
# You should have received a copy of the GNU General Public License
4900
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
4901
19
4902
20
"""
4903
21
plainbox.impl.secure.test_checkbox_trusted_launcher
4904
22
===================================================
4905
23
4906
24
Test definitions for plainbox.impl.secure.checkbox_trusted_launcher module
4907
25
"""
4908
26
4909
27
import os
4910
28
4911
29
from inspect import cleandoc
4912
30
from io import StringIO
4913
31
from mock import Mock, patch
4914
32
from tempfile import NamedTemporaryFile, TemporaryDirectory
4915
33
from unittest import TestCase
4916
34
4917
35
from plainbox.impl.secure.checkbox_trusted_launcher import BaseJob
4918
36
from plainbox.impl.secure.checkbox_trusted_launcher import load_rfc822_records
4919
37
from plainbox.impl.secure.checkbox_trusted_launcher import main
4920
38
from plainbox.impl.secure.checkbox_trusted_launcher import Runner
4921
39
from plainbox.impl.test_rfc822 import RFC822ParserTestsMixIn
4922
40
from plainbox.testing_utils.io import TestIO
4923
41
from plainbox.testing_utils.testcases import TestCaseWithParameters
4924
42
4925
43
4926
44
class TestJobDefinition(TestCase):
4927
45
4928
46
    def setUp(self):
4929
47
        self._full_record = {
4930
48
            'plugin': 'plugin',
4931
49
            'command': 'command',
4932
50
            'environ': 'environ',
4933
51
            'user': 'user'
4934
52
        }
4935
53
        self._min_record = {
4936
54
            'plugin': 'plugin',
4937
55
            'name': 'name',
4938
56
        }
4939
57
4940
58
    def test_smoke_full_record(self):
4941
59
        job = BaseJob(self._full_record)
4942
60
        self.assertEqual(job.plugin, "plugin")
4943
61
        self.assertEqual(job.command, "command")
4944
62
        self.assertEqual(job.environ, "environ")
4945
63
        self.assertEqual(job.user, "user")
4946
64
4947
65
    def test_smoke_min_record(self):
4948
66
        job = BaseJob(self._min_record)
4949
67
        self.assertEqual(job.plugin, "plugin")
4950
68
        self.assertEqual(job.command, None)
4951
69
        self.assertEqual(job.environ, None)
4952
70
        self.assertEqual(job.user, None)
4953
71
4954
72
    def test_checksum_smoke(self):
4955
73
        job1 = BaseJob({'plugin': 'plugin', 'user': 'root'})
4956
74
        identical_to_job1 = BaseJob({'plugin': 'plugin', 'user': 'root'})
4957
75
        # Two distinct but identical jobs have the same checksum
4958
76
        self.assertEqual(job1.get_checksum(), identical_to_job1.get_checksum())
4959
77
        job2 = BaseJob({'plugin': 'plugin', 'user': 'anonymous'})
4960
78
        # Two jobs with different definitions have different checksum
4961
79
        self.assertNotEqual(job1.get_checksum(), job2.get_checksum())
4962
80
        # The checksum is stable and does not change over time
4963
81
        self.assertEqual(
4964
82
            job1.get_checksum(),
4965
83
            "c47cc3719061e4df0010d061e6f20d3d046071fd467d02d093a03068d2f33400")
4966
84
4967
85
4968
86
class ParsingTests(TestCaseWithParameters):
4969
87
4970
88
    parameter_names = ('glue',)
4971
89
    parameter_values = (
4972
90
        ('commas',),
4973
91
        ('spaces',),
4974
92
        ('tabs',),
4975
93
        ('newlines',),
4976
94
        ('spaces_and_commas',),
4977
95
        ('multiple_spaces',),
4978
96
        ('multiple_commas',)
4979
97
    )
4980
98
    parameters_keymap = {
4981
99
        'commas': ',',
4982
100
        'spaces': ' ',
4983
101
        'tabs': '\t',
4984
102
        'newlines': '\n',
4985
103
        'spaces_and_commas': ', ',
4986
104
        'multiple_spaces': '   ',
4987
105
        'multiple_commas': ',,,,'
4988
106
    }
4989
107
4990
108
    def test_environ_parsing_with_various_separators(self):
4991
109
        job = BaseJob({
4992
110
            'name': 'name',
4993
111
            'plugin': 'plugin',
4994
112
            'environ': self.parameters_keymap[
4995
113
                self.parameters.glue].join(['foo', 'bar', 'froz'])})
4996
114
        expected = set({'foo', 'bar', 'froz'})
4997
115
        observed = job.get_environ_settings()
4998
116
        self.assertEqual(expected, observed)
4999
117
5000
118
    def test_environ_parsing_empty(self):
Status:	Needs review
Proposed branch:	lp:~ubuntu-branches/ubuntu/saucy/checkbox/saucy-proposed-201308281228
Merge into:	lp:ubuntu/saucy-proposed/checkbox
Diff against target:	7511 lines (+5851/-0) (has conflicts) 141 files modified debian/changelog (+64/-0) debian/po/ast.po (+5/-0) debian/po/cs.po (+5/-0) debian/po/de.po (+5/-0) debian/po/en_AU.po (+5/-0) debian/po/en_GB.po (+5/-0) debian/po/es.po (+5/-0) debian/po/fr.po (+5/-0) debian/po/gl.po (+5/-0) debian/po/he.po (+5/-0) debian/po/hu.po (+5/-0) debian/po/id.po (+5/-0) debian/po/it.po (+5/-0) debian/po/ja.po (+5/-0) debian/po/nl.po (+5/-0) debian/po/oc.po (+5/-0) debian/po/pl.po (+5/-0) debian/po/pt_BR.po (+5/-0) debian/po/ro.po (+5/-0) debian/po/ru.po (+5/-0) debian/po/tr.po (+5/-0) debian/po/uk.po (+5/-0) debian/po/zh_CN.po (+5/-0) debian/po/zh_TW.po (+5/-0) jobs/mediacard.txt.in (+91/-0) jobs/resource.txt.in (+6/-0) plainbox/MANIFEST.in.OTHER (+9/-0) plainbox/contrib/policykit_auth_admin_keep/org.freedesktop.policykit.pkexec.policy (+30/-0) plainbox/contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy.OTHER (+29/-0) plainbox/docs/dev/architecture.rst.OTHER (+40/-0) plainbox/docs/dev/old.rst.OTHER (+343/-0) plainbox/docs/dev/reference.rst.OTHER (+179/-0) plainbox/docs/dev/resources.rst.OTHER (+259/-0) plainbox/docs/dev/trusted-launcher.rst (+209/-0) plainbox/docs/usage.rst.OTHER (+93/-0) plainbox/mk-venv.sh.OTHER (+195/-0) plainbox/plainbox/impl/box.py.OTHER (+130/-0) plainbox/plainbox/impl/commands/checkbox.py.OTHER (+100/-0) plainbox/plainbox/impl/commands/run.py.OTHER (+340/-0) plainbox/plainbox/impl/commands/special.py.OTHER (+159/-0) plainbox/plainbox/impl/commands/sru.py.OTHER (+271/-0) plainbox/plainbox/impl/commands/test_run.py.OTHER (+142/-0) plainbox/plainbox/impl/config.py.OTHER (+544/-0) plainbox/plainbox/impl/job.py.OTHER (+259/-0) plainbox/plainbox/impl/runner.py.OTHER (+421/-0) plainbox/plainbox/impl/secure/checkbox_trusted_launcher.py.OTHER (+395/-0) plainbox/plainbox/impl/secure/test_checkbox_trusted_launcher.py.OTHER (+280/-0) plainbox/plainbox/impl/test_box.py.OTHER (+260/-0) plainbox/plainbox/impl/test_job.py.OTHER (+370/-0) plainbox/setup.py.OTHER (+60/-0) po/ace.po (+5/-0) po/af.po (+5/-0) po/am.po (+5/-0) po/ar.po (+5/-0) po/ast.po (+5/-0) po/az.po (+5/-0) po/be.po (+5/-0) po/bg.po (+5/-0) po/bn.po (+5/-0) po/bo.po (+5/-0) po/br.po (+5/-0) po/bs.po (+5/-0) po/ca.po (+5/-0) po/ca@valencia.po (+5/-0) po/ckb.po (+5/-0) po/cs.po (+5/-0) po/cy.po (+5/-0) po/da.po (+5/-0) po/de.po (+5/-0) po/dv.po (+5/-0) po/el.po (+5/-0) po/en_AU.po (+5/-0) po/en_CA.po (+5/-0) po/en_GB.po (+5/-0) po/eo.po (+5/-0) po/es.po (+5/-0) po/et.po (+5/-0) po/eu.po (+5/-0) po/fa.po (+5/-0) po/fi.po (+5/-0) po/fr.po (+5/-0) po/ga.po (+5/-0) po/gd.po (+5/-0) po/gl.po (+5/-0) po/he.po (+5/-0) po/hi.po (+5/-0) po/hr.po (+5/-0) po/hu.po (+5/-0) po/hy.po (+5/-0) po/id.po (+5/-0) po/is.po (+5/-0) po/it.po (+5/-0) po/ja.po (+5/-0) po/jbo.po (+5/-0) po/ka.po (+5/-0) po/kk.po (+5/-0) po/km.po (+5/-0) po/kn.po (+5/-0) po/ko.po (+5/-0) po/ku.po (+5/-0) po/ky.po (+5/-0) po/lt.po (+5/-0) po/lv.po (+5/-0) po/mk.po (+5/-0) po/ml.po (+5/-0) po/mr.po (+5/-0) po/ms.po (+5/-0) po/my.po (+5/-0) po/nb.po (+5/-0) po/nds.po (+5/-0) po/ne.po (+5/-0) po/nl.po (+5/-0) po/nn.po (+5/-0) po/oc.po (+5/-0) po/pl.po (+5/-0) po/ps.po (+5/-0) po/pt.po (+5/-0) po/pt_BR.po (+5/-0) po/ro.po (+5/-0) po/ru.po (+5/-0) po/sd.po (+5/-0) po/shn.po (+5/-0) po/si.po (+5/-0) po/sk.po (+5/-0) po/sl.po (+5/-0) po/sq.po (+5/-0) po/sr.po (+5/-0) po/sv.po (+5/-0) po/ta.po (+5/-0) po/te.po (+5/-0) po/th.po (+5/-0) po/tr.po (+5/-0) po/ug.po (+5/-0) po/uk.po (+5/-0) po/ur.po (+5/-0) po/uz.po (+5/-0) po/vi.po (+5/-0) po/zh_CN.po (+5/-0) po/zh_HK.po (+5/-0) po/zh_TW.po (+5/-0) scripts/color_depth_info (+8/-0) Text conflict in debian/changelog Text conflict in debian/po/ast.po Text conflict in debian/po/cs.po Text conflict in debian/po/de.po Text conflict in debian/po/en_AU.po Text conflict in debian/po/en_GB.po Text conflict in debian/po/es.po Text conflict in debian/po/fr.po Text conflict in debian/po/gl.po Text conflict in debian/po/he.po Text conflict in debian/po/hu.po Text conflict in debian/po/id.po Text conflict in debian/po/it.po Text conflict in debian/po/ja.po Text conflict in debian/po/nl.po Text conflict in debian/po/oc.po Text conflict in debian/po/pl.po Text conflict in debian/po/pt_BR.po Text conflict in debian/po/ro.po Text conflict in debian/po/ru.po Text conflict in debian/po/tr.po Text conflict in debian/po/uk.po Text conflict in debian/po/zh_CN.po Text conflict in debian/po/zh_TW.po Text conflict in jobs/mediacard.txt.in Conflict adding files to plainbox. Created directory. Conflict because plainbox is not versioned, but has versioned children. Versioned directory. Contents conflict in plainbox/MANIFEST.in Contents conflict in plainbox/contrib/policykit_yes/org.freedesktop.policykit.pkexec.policy Conflict adding files to plainbox/docs. Created directory. Conflict because plainbox/docs is not versioned, but has versioned children. Versioned directory. Conflict adding files to plainbox/docs/dev. Created directory. Conflict because plainbox/docs/dev is not versioned, but has versioned children. Versioned directory. Contents conflict in plainbox/docs/dev/architecture.rst Contents conflict in plainbox/docs/dev/old.rst Contents conflict in plainbox/docs/dev/reference.rst Contents conflict in plainbox/docs/dev/resources.rst Contents conflict in plainbox/docs/usage.rst Contents conflict in plainbox/mk-venv.sh Conflict adding files to plainbox/plainbox. Created directory. Conflict because plainbox/plainbox is not versioned, but has versioned children. Versioned directory. Conflict adding files to plainbox/plainbox/impl. Created directory. Conflict because plainbox/plainbox/impl is not versioned, but has versioned children. Versioned directory. Contents conflict in plainbox/plainbox/impl/box.py Conflict adding files to plainbox/plainbox/impl/commands. Created directory. Conflict because plainbox/plainbox/impl/commands is not versioned, but has versioned children. Versioned directory. Contents conflict in plainbox/plainbox/impl/commands/checkbox.py Contents conflict in plainbox/plainbox/impl/commands/run.py Contents conflict in plainbox/plainbox/impl/commands/special.py Contents conflict in plainbox/plainbox/impl/commands/sru.py Contents conflict in plainbox/plainbox/impl/commands/test_run.py Contents conflict in plainbox/plainbox/impl/config.py Contents conflict in plainbox/plainbox/impl/job.py Contents conflict in plainbox/plainbox/impl/runner.py Conflict adding files to plainbox/plainbox/impl/secure. Created directory. Conflict because plainbox/plainbox/impl/secure is not versioned, but has versioned children. Versioned directory. Contents conflict in plainbox/plainbox/impl/secure/checkbox_trusted_launcher.py Contents conflict in plainbox/plainbox/impl/secure/test_checkbox_trusted_launcher.py Contents conflict in plainbox/plainbox/impl/test_box.py Contents conflict in plainbox/plainbox/impl/test_job.py Contents conflict in plainbox/setup.py Text conflict in po/ace.po Text conflict in po/af.po Text conflict in po/am.po Text conflict in po/ar.po Text conflict in po/ast.po Text conflict in po/az.po Text conflict in po/be.po Text conflict in po/bg.po Text conflict in po/bn.po Text conflict in po/bo.po Text conflict in po/br.po Text conflict in po/bs.po Text conflict in po/ca.po Text conflict in po/ca@valencia.po Text conflict in po/ckb.po Text conflict in po/cs.po Text conflict in po/cy.po Text conflict in po/da.po Text conflict in po/de.po Text conflict in po/dv.po Text conflict in po/el.po Text conflict in po/en_AU.po Text conflict in po/en_CA.po Text conflict in po/en_GB.po Text conflict in po/eo.po Text conflict in po/es.po Text conflict in po/et.po Text conflict in po/eu.po Text conflict in po/fa.po Text conflict in po/fi.po Text conflict in po/fr.po Text conflict in po/ga.po Text conflict in po/gd.po Text conflict in po/gl.po Text conflict in po/he.po Text conflict in po/hi.po Text conflict in po/hr.po Text conflict in po/hu.po Text conflict in po/hy.po Text conflict in po/id.po Text conflict in po/is.po Text conflict in po/it.po Text conflict in po/ja.po Text conflict in po/jbo.po Text conflict in po/ka.po Text conflict in po/kk.po Text conflict in po/km.po Text conflict in po/kn.po Text conflict in po/ko.po Text conflict in po/ku.po Text conflict in po/ky.po Text conflict in po/lt.po Text conflict in po/lv.po Text conflict in po/mk.po Text conflict in po/ml.po Text conflict in po/mr.po Text conflict in po/ms.po Text conflict in po/my.po Text conflict in po/nb.po Text conflict in po/nds.po Text conflict in po/ne.po Text conflict in po/nl.po Text conflict in po/nn.po Text conflict in po/oc.po Text conflict in po/pl.po Text conflict in po/ps.po Text conflict in po/pt.po Text conflict in po/pt_BR.po Text conflict in po/ro.po Text conflict in po/ru.po Text conflict in po/sd.po Text conflict in po/shn.po Text conflict in po/si.po Text conflict in po/sk.po Text conflict in po/sl.po Text conflict in po/sq.po Text conflict in po/sr.po Text conflict in po/sv.po Text conflict in po/ta.po Text conflict in po/te.po Text conflict in po/th.po Text conflict in po/tr.po Text conflict in po/ug.po Text conflict in po/uk.po Text conflict in po/ur.po Text conflict in po/uz.po Text conflict in po/vi.po Text conflict in po/zh_CN.po Text conflict in po/zh_HK.po Text conflict in po/zh_TW.po Text conflict in scripts/color_depth_info
To merge this branch:	bzr merge lp:~ubuntu-branches/ubuntu/saucy/checkbox/saucy-proposed-201308281228
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Ubuntu Development Team		2013-08-28	Pending
Review via email: mp+182624@code.launchpad.net