1
=== added directory 'jobbox'
2
=== added file 'jobbox/COPYING'
3
--- jobbox/COPYING	1970-01-01 00:00:00 +0000
4
+++ jobbox/COPYING	2013-11-11 15:04:58 +0000
5
@@ -0,0 +1,674 @@
6
1
                    GNU GENERAL PUBLIC LICENSE
7
2
                       Version 3, 29 June 2007
8
3
9
4
 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
10
5
 Everyone is permitted to copy and distribute verbatim copies
11
6
 of this license document, but changing it is not allowed.
12
7
13
8
                            Preamble
14
9
15
10
  The GNU General Public License is a free, copyleft license for
16
11
software and other kinds of works.
17
12
18
13
  The licenses for most software and other practical works are designed
19
14
to take away your freedom to share and change the works.  By contrast,
20
15
the GNU General Public License is intended to guarantee your freedom to
21
16
share and change all versions of a program--to make sure it remains free
22
17
software for all its users.  We, the Free Software Foundation, use the
23
18
GNU General Public License for most of our software; it applies also to
24
19
any other work released this way by its authors.  You can apply it to
25
20
your programs, too.
26
21
27
22
  When we speak of free software, we are referring to freedom, not
28
23
price.  Our General Public Licenses are designed to make sure that you
29
24
have the freedom to distribute copies of free software (and charge for
30
25
them if you wish), that you receive source code or can get it if you
31
26
want it, that you can change the software or use pieces of it in new
32
27
free programs, and that you know you can do these things.
33
28
34
29
  To protect your rights, we need to prevent others from denying you
35
30
these rights or asking you to surrender the rights.  Therefore, you have
36
31
certain responsibilities if you distribute copies of the software, or if
37
32
you modify it: responsibilities to respect the freedom of others.
38
33
39
34
  For example, if you distribute copies of such a program, whether
40
35
gratis or for a fee, you must pass on to the recipients the same
41
36
freedoms that you received.  You must make sure that they, too, receive
42
37
or can get the source code.  And you must show them these terms so they
43
38
know their rights.
44
39
45
40
  Developers that use the GNU GPL protect your rights with two steps:
46
41
(1) assert copyright on the software, and (2) offer you this License
47
42
giving you legal permission to copy, distribute and/or modify it.
48
43
49
44
  For the developers' and authors' protection, the GPL clearly explains
50
45
that there is no warranty for this free software.  For both users' and
51
46
authors' sake, the GPL requires that modified versions be marked as
52
47
changed, so that their problems will not be attributed erroneously to
53
48
authors of previous versions.
54
49
55
50
  Some devices are designed to deny users access to install or run
56
51
modified versions of the software inside them, although the manufacturer
57
52
can do so.  This is fundamentally incompatible with the aim of
58
53
protecting users' freedom to change the software.  The systematic
59
54
pattern of such abuse occurs in the area of products for individuals to
60
55
use, which is precisely where it is most unacceptable.  Therefore, we
61
56
have designed this version of the GPL to prohibit the practice for those
62
57
products.  If such problems arise substantially in other domains, we
63
58
stand ready to extend this provision to those domains in future versions
64
59
of the GPL, as needed to protect the freedom of users.
65
60
66
61
  Finally, every program is threatened constantly by software patents.
67
62
States should not allow patents to restrict development and use of
68
63
software on general-purpose computers, but in those that do, we wish to
69
64
avoid the special danger that patents applied to a free program could
70
65
make it effectively proprietary.  To prevent this, the GPL assures that
71
66
patents cannot be used to render the program non-free.
72
67
73
68
  The precise terms and conditions for copying, distribution and
74
69
modification follow.
75
70
76
71
                       TERMS AND CONDITIONS
77
72
78
73
  0. Definitions.
79
74
80
75
  "This License" refers to version 3 of the GNU General Public License.
81
76
82
77
  "Copyright" also means copyright-like laws that apply to other kinds of
83
78
works, such as semiconductor masks.
84
79
85
80
  "The Program" refers to any copyrightable work licensed under this
86
81
License.  Each licensee is addressed as "you".  "Licensees" and
87
82
"recipients" may be individuals or organizations.
88
83
89
84
  To "modify" a work means to copy from or adapt all or part of the work
90
85
in a fashion requiring copyright permission, other than the making of an
91
86
exact copy.  The resulting work is called a "modified version" of the
92
87
earlier work or a work "based on" the earlier work.
93
88
94
89
  A "covered work" means either the unmodified Program or a work based
95
90
on the Program.
96
91
97
92
  To "propagate" a work means to do anything with it that, without
98
93
permission, would make you directly or secondarily liable for
99
94
infringement under applicable copyright law, except executing it on a
100
95
computer or modifying a private copy.  Propagation includes copying,
101
96
distribution (with or without modification), making available to the
102
97
public, and in some countries other activities as well.
103
98
104
99
  To "convey" a work means any kind of propagation that enables other
105
100
parties to make or receive copies.  Mere interaction with a user through
106
101
a computer network, with no transfer of a copy, is not conveying.
107
102
108
103
  An interactive user interface displays "Appropriate Legal Notices"
109
104
to the extent that it includes a convenient and prominently visible
110
105
feature that (1) displays an appropriate copyright notice, and (2)
111
106
tells the user that there is no warranty for the work (except to the
112
107
extent that warranties are provided), that licensees may convey the
113
108
work under this License, and how to view a copy of this License.  If
114
109
the interface presents a list of user commands or options, such as a
115
110
menu, a prominent item in the list meets this criterion.
116
111
117
112
  1. Source Code.
118
113
119
114
  The "source code" for a work means the preferred form of the work
120
115
for making modifications to it.  "Object code" means any non-source
121
116
form of a work.
122
117
123
118
  A "Standard Interface" means an interface that either is an official
124
119
standard defined by a recognized standards body, or, in the case of
125
120
interfaces specified for a particular programming language, one that
126
121
is widely used among developers working in that language.
127
122
128
123
  The "System Libraries" of an executable work include anything, other
129
124
than the work as a whole, that (a) is included in the normal form of
130
125
packaging a Major Component, but which is not part of that Major
131
126
Component, and (b) serves only to enable use of the work with that
132
127
Major Component, or to implement a Standard Interface for which an
133
128
implementation is available to the public in source code form.  A
134
129
"Major Component", in this context, means a major essential component
135
130
(kernel, window system, and so on) of the specific operating system
136
131
(if any) on which the executable work runs, or a compiler used to
137
132
produce the work, or an object code interpreter used to run it.
138
133
139
134
  The "Corresponding Source" for a work in object code form means all
140
135
the source code needed to generate, install, and (for an executable
141
136
work) run the object code and to modify the work, including scripts to
142
137
control those activities.  However, it does not include the work's
143
138
System Libraries, or general-purpose tools or generally available free
144
139
programs which are used unmodified in performing those activities but
145
140
which are not part of the work.  For example, Corresponding Source
146
141
includes interface definition files associated with source files for
147
142
the work, and the source code for shared libraries and dynamically
148
143
linked subprograms that the work is specifically designed to require,
149
144
such as by intimate data communication or control flow between those
150
145
subprograms and other parts of the work.
151
146
152
147
  The Corresponding Source need not include anything that users
153
148
can regenerate automatically from other parts of the Corresponding
154
149
Source.
155
150
156
151
  The Corresponding Source for a work in source code form is that
157
152
same work.
158
153
159
154
  2. Basic Permissions.
160
155
161
156
  All rights granted under this License are granted for the term of
162
157
copyright on the Program, and are irrevocable provided the stated
163
158
conditions are met.  This License explicitly affirms your unlimited
164
159
permission to run the unmodified Program.  The output from running a
165
160
covered work is covered by this License only if the output, given its
166
161
content, constitutes a covered work.  This License acknowledges your
167
162
rights of fair use or other equivalent, as provided by copyright law.
168
163
169
164
  You may make, run and propagate covered works that you do not
170
165
convey, without conditions so long as your license otherwise remains
171
166
in force.  You may convey covered works to others for the sole purpose
172
167
of having them make modifications exclusively for you, or provide you
173
168
with facilities for running those works, provided that you comply with
174
169
the terms of this License in conveying all material for which you do
175
170
not control copyright.  Those thus making or running the covered works
176
171
for you must do so exclusively on your behalf, under your direction
177
172
and control, on terms that prohibit them from making any copies of
178
173
your copyrighted material outside their relationship with you.
179
174
180
175
  Conveying under any other circumstances is permitted solely under
181
176
the conditions stated below.  Sublicensing is not allowed; section 10
182
177
makes it unnecessary.
183
178
184
179
  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
185
180
186
181
  No covered work shall be deemed part of an effective technological
187
182
measure under any applicable law fulfilling obligations under article
188
183
11 of the WIPO copyright treaty adopted on 20 December 1996, or
189
184
similar laws prohibiting or restricting circumvention of such
190
185
measures.
191
186
192
187
  When you convey a covered work, you waive any legal power to forbid
193
188
circumvention of technological measures to the extent such circumvention
194
189
is effected by exercising rights under this License with respect to
195
190
the covered work, and you disclaim any intention to limit operation or
196
191
modification of the work as a means of enforcing, against the work's
197
192
users, your or third parties' legal rights to forbid circumvention of
198
193
technological measures.
199
194
200
195
  4. Conveying Verbatim Copies.
201
196
202
197
  You may convey verbatim copies of the Program's source code as you
203
198
receive it, in any medium, provided that you conspicuously and
204
199
appropriately publish on each copy an appropriate copyright notice;
205
200
keep intact all notices stating that this License and any
206
201
non-permissive terms added in accord with section 7 apply to the code;
207
202
keep intact all notices of the absence of any warranty; and give all
208
203
recipients a copy of this License along with the Program.
209
204
210
205
  You may charge any price or no price for each copy that you convey,
211
206
and you may offer support or warranty protection for a fee.
212
207
213
208
  5. Conveying Modified Source Versions.
214
209
215
210
  You may convey a work based on the Program, or the modifications to
216
211
produce it from the Program, in the form of source code under the
217
212
terms of section 4, provided that you also meet all of these conditions:
218
213
219
214
    a) The work must carry prominent notices stating that you modified
220
215
    it, and giving a relevant date.
221
216
222
217
    b) The work must carry prominent notices stating that it is
223
218
    released under this License and any conditions added under section
224
219
    7.  This requirement modifies the requirement in section 4 to
225
220
    "keep intact all notices".
226
221
227
222
    c) You must license the entire work, as a whole, under this
228
223
    License to anyone who comes into possession of a copy.  This
229
224
    License will therefore apply, along with any applicable section 7
230
225
    additional terms, to the whole of the work, and all its parts,
231
226
    regardless of how they are packaged.  This License gives no
232
227
    permission to license the work in any other way, but it does not
233
228
    invalidate such permission if you have separately received it.
234
229
235
230
    d) If the work has interactive user interfaces, each must display
236
231
    Appropriate Legal Notices; however, if the Program has interactive
237
232
    interfaces that do not display Appropriate Legal Notices, your
238
233
    work need not make them do so.
239
234
240
235
  A compilation of a covered work with other separate and independent
241
236
works, which are not by their nature extensions of the covered work,
242
237
and which are not combined with it such as to form a larger program,
243
238
in or on a volume of a storage or distribution medium, is called an
244
239
"aggregate" if the compilation and its resulting copyright are not
245
240
used to limit the access or legal rights of the compilation's users
246
241
beyond what the individual works permit.  Inclusion of a covered work
247
242
in an aggregate does not cause this License to apply to the other
248
243
parts of the aggregate.
249
244
250
245
  6. Conveying Non-Source Forms.
251
246
252
247
  You may convey a covered work in object code form under the terms
253
248
of sections 4 and 5, provided that you also convey the
254
249
machine-readable Corresponding Source under the terms of this License,
255
250
in one of these ways:
256
251
257
252
    a) Convey the object code in, or embodied in, a physical product
258
253
    (including a physical distribution medium), accompanied by the
259
254
    Corresponding Source fixed on a durable physical medium
260
255
    customarily used for software interchange.
261
256
262
257
    b) Convey the object code in, or embodied in, a physical product
263
258
    (including a physical distribution medium), accompanied by a
264
259
    written offer, valid for at least three years and valid for as
265
260
    long as you offer spare parts or customer support for that product
266
261
    model, to give anyone who possesses the object code either (1) a
267
262
    copy of the Corresponding Source for all the software in the
268
263
    product that is covered by this License, on a durable physical
269
264
    medium customarily used for software interchange, for a price no
270
265
    more than your reasonable cost of physically performing this
271
266
    conveying of source, or (2) access to copy the
272
267
    Corresponding Source from a network server at no charge.
273
268
274
269
    c) Convey individual copies of the object code with a copy of the
275
270
    written offer to provide the Corresponding Source.  This
276
271
    alternative is allowed only occasionally and noncommercially, and
277
272
    only if you received the object code with such an offer, in accord
278
273
    with subsection 6b.
279
274
280
275
    d) Convey the object code by offering access from a designated
281
276
    place (gratis or for a charge), and offer equivalent access to the
282
277
    Corresponding Source in the same way through the same place at no
283
278
    further charge.  You need not require recipients to copy the
284
279
    Corresponding Source along with the object code.  If the place to
285
280
    copy the object code is a network server, the Corresponding Source
286
281
    may be on a different server (operated by you or a third party)
287
282
    that supports equivalent copying facilities, provided you maintain
288
283
    clear directions next to the object code saying where to find the
289
284
    Corresponding Source.  Regardless of what server hosts the
290
285
    Corresponding Source, you remain obligated to ensure that it is
291
286
    available for as long as needed to satisfy these requirements.
292
287
293
288
    e) Convey the object code using peer-to-peer transmission, provided
294
289
    you inform other peers where the object code and Corresponding
295
290
    Source of the work are being offered to the general public at no
296
291
    charge under subsection 6d.
297
292
298
293
  A separable portion of the object code, whose source code is excluded
299
294
from the Corresponding Source as a System Library, need not be
300
295
included in conveying the object code work.
301
296
302
297
  A "User Product" is either (1) a "consumer product", which means any
303
298
tangible personal property which is normally used for personal, family,
304
299
or household purposes, or (2) anything designed or sold for incorporation
305
300
into a dwelling.  In determining whether a product is a consumer product,
306
301
doubtful cases shall be resolved in favor of coverage.  For a particular
307
302
product received by a particular user, "normally used" refers to a
308
303
typical or common use of that class of product, regardless of the status
309
304
of the particular user or of the way in which the particular user
310
305
actually uses, or expects or is expected to use, the product.  A product
311
306
is a consumer product regardless of whether the product has substantial
312
307
commercial, industrial or non-consumer uses, unless such uses represent
313
308
the only significant mode of use of the product.
314
309
315
310
  "Installation Information" for a User Product means any methods,
316
311
procedures, authorization keys, or other information required to install
317
312
and execute modified versions of a covered work in that User Product from
318
313
a modified version of its Corresponding Source.  The information must
319
314
suffice to ensure that the continued functioning of the modified object
320
315
code is in no case prevented or interfered with solely because
321
316
modification has been made.
322
317
323
318
  If you convey an object code work under this section in, or with, or
324
319
specifically for use in, a User Product, and the conveying occurs as
325
320
part of a transaction in which the right of possession and use of the
326
321
User Product is transferred to the recipient in perpetuity or for a
327
322
fixed term (regardless of how the transaction is characterized), the
328
323
Corresponding Source conveyed under this section must be accompanied
329
324
by the Installation Information.  But this requirement does not apply
330
325
if neither you nor any third party retains the ability to install
331
326
modified object code on the User Product (for example, the work has
332
327
been installed in ROM).
333
328
334
329
  The requirement to provide Installation Information does not include a
335
330
requirement to continue to provide support service, warranty, or updates
336
331
for a work that has been modified or installed by the recipient, or for
337
332
the User Product in which it has been modified or installed.  Access to a
338
333
network may be denied when the modification itself materially and
339
334
adversely affects the operation of the network or violates the rules and
340
335
protocols for communication across the network.
341
336
342
337
  Corresponding Source conveyed, and Installation Information provided,
343
338
in accord with this section must be in a format that is publicly
344
339
documented (and with an implementation available to the public in
345
340
source code form), and must require no special password or key for
346
341
unpacking, reading or copying.
347
342
348
343
  7. Additional Terms.
349
344
350
345
  "Additional permissions" are terms that supplement the terms of this
351
346
License by making exceptions from one or more of its conditions.
352
347
Additional permissions that are applicable to the entire Program shall
353
348
be treated as though they were included in this License, to the extent
354
349
that they are valid under applicable law.  If additional permissions
355
350
apply only to part of the Program, that part may be used separately
356
351
under those permissions, but the entire Program remains governed by
357
352
this License without regard to the additional permissions.
358
353
359
354
  When you convey a copy of a covered work, you may at your option
360
355
remove any additional permissions from that copy, or from any part of
361
356
it.  (Additional permissions may be written to require their own
362
357
removal in certain cases when you modify the work.)  You may place
363
358
additional permissions on material, added by you to a covered work,
364
359
for which you have or can give appropriate copyright permission.
365
360
366
361
  Notwithstanding any other provision of this License, for material you
367
362
add to a covered work, you may (if authorized by the copyright holders of
368
363
that material) supplement the terms of this License with terms:
369
364
370
365
    a) Disclaiming warranty or limiting liability differently from the
371
366
    terms of sections 15 and 16 of this License; or
372
367
373
368
    b) Requiring preservation of specified reasonable legal notices or
374
369
    author attributions in that material or in the Appropriate Legal
375
370
    Notices displayed by works containing it; or
376
371
377
372
    c) Prohibiting misrepresentation of the origin of that material, or
378
373
    requiring that modified versions of such material be marked in
379
374
    reasonable ways as different from the original version; or
380
375
381
376
    d) Limiting the use for publicity purposes of names of licensors or
382
377
    authors of the material; or
383
378
384
379
    e) Declining to grant rights under trademark law for use of some
385
380
    trade names, trademarks, or service marks; or
386
381
387
382
    f) Requiring indemnification of licensors and authors of that
388
383
    material by anyone who conveys the material (or modified versions of
389
384
    it) with contractual assumptions of liability to the recipient, for
390
385
    any liability that these contractual assumptions directly impose on
391
386
    those licensors and authors.
392
387
393
388
  All other non-permissive additional terms are considered "further
394
389
restrictions" within the meaning of section 10.  If the Program as you
395
390
received it, or any part of it, contains a notice stating that it is
396
391
governed by this License along with a term that is a further
397
392
restriction, you may remove that term.  If a license document contains
398
393
a further restriction but permits relicensing or conveying under this
399
394
License, you may add to a covered work material governed by the terms
400
395
of that license document, provided that the further restriction does
401
396
not survive such relicensing or conveying.
402
397
403
398
  If you add terms to a covered work in accord with this section, you
404
399
must place, in the relevant source files, a statement of the
405
400
additional terms that apply to those files, or a notice indicating
406
401
where to find the applicable terms.
407
402
408
403
  Additional terms, permissive or non-permissive, may be stated in the
409
404
form of a separately written license, or stated as exceptions;
410
405
the above requirements apply either way.
411
406
412
407
  8. Termination.
413
408
414
409
  You may not propagate or modify a covered work except as expressly
415
410
provided under this License.  Any attempt otherwise to propagate or
416
411
modify it is void, and will automatically terminate your rights under
417
412
this License (including any patent licenses granted under the third
418
413
paragraph of section 11).
419
414
420
415
  However, if you cease all violation of this License, then your
421
416
license from a particular copyright holder is reinstated (a)
422
417
provisionally, unless and until the copyright holder explicitly and
423
418
finally terminates your license, and (b) permanently, if the copyright
424
419
holder fails to notify you of the violation by some reasonable means
425
420
prior to 60 days after the cessation.
426
421
427
422
  Moreover, your license from a particular copyright holder is
428
423
reinstated permanently if the copyright holder notifies you of the
429
424
violation by some reasonable means, this is the first time you have
430
425
received notice of violation of this License (for any work) from that
431
426
copyright holder, and you cure the violation prior to 30 days after
432
427
your receipt of the notice.
433
428
434
429
  Termination of your rights under this section does not terminate the
435
430
licenses of parties who have received copies or rights from you under
436
431
this License.  If your rights have been terminated and not permanently
437
432
reinstated, you do not qualify to receive new licenses for the same
438
433
material under section 10.
439
434
440
435
  9. Acceptance Not Required for Having Copies.
441
436
442
437
  You are not required to accept this License in order to receive or
443
438
run a copy of the Program.  Ancillary propagation of a covered work
444
439
occurring solely as a consequence of using peer-to-peer transmission
445
440
to receive a copy likewise does not require acceptance.  However,
446
441
nothing other than this License grants you permission to propagate or
447
442
modify any covered work.  These actions infringe copyright if you do
448
443
not accept this License.  Therefore, by modifying or propagating a
449
444
covered work, you indicate your acceptance of this License to do so.
450
445
451
446
  10. Automatic Licensing of Downstream Recipients.
452
447
453
448
  Each time you convey a covered work, the recipient automatically
454
449
receives a license from the original licensors, to run, modify and
455
450
propagate that work, subject to this License.  You are not responsible
456
451
for enforcing compliance by third parties with this License.
457
452
458
453
  An "entity transaction" is a transaction transferring control of an
459
454
organization, or substantially all assets of one, or subdividing an
460
455
organization, or merging organizations.  If propagation of a covered
461
456
work results from an entity transaction, each party to that
462
457
transaction who receives a copy of the work also receives whatever
463
458
licenses to the work the party's predecessor in interest had or could
464
459
give under the previous paragraph, plus a right to possession of the
465
460
Corresponding Source of the work from the predecessor in interest, if
466
461
the predecessor has it or can get it with reasonable efforts.
467
462
468
463
  You may not impose any further restrictions on the exercise of the
469
464
rights granted or affirmed under this License.  For example, you may
470
465
not impose a license fee, royalty, or other charge for exercise of
471
466
rights granted under this License, and you may not initiate litigation
472
467
(including a cross-claim or counterclaim in a lawsuit) alleging that
473
468
any patent claim is infringed by making, using, selling, offering for
474
469
sale, or importing the Program or any portion of it.
475
470
476
471
  11. Patents.
477
472
478
473
  A "contributor" is a copyright holder who authorizes use under this
479
474
License of the Program or a work on which the Program is based.  The
480
475
work thus licensed is called the contributor's "contributor version".
481
476
482
477
  A contributor's "essential patent claims" are all patent claims
483
478
owned or controlled by the contributor, whether already acquired or
484
479
hereafter acquired, that would be infringed by some manner, permitted
485
480
by this License, of making, using, or selling its contributor version,
486
481
but do not include claims that would be infringed only as a
487
482
consequence of further modification of the contributor version.  For
488
483
purposes of this definition, "control" includes the right to grant
489
484
patent sublicenses in a manner consistent with the requirements of
490
485
this License.
491
486
492
487
  Each contributor grants you a non-exclusive, worldwide, royalty-free
493
488
patent license under the contributor's essential patent claims, to
494
489
make, use, sell, offer for sale, import and otherwise run, modify and
495
490
propagate the contents of its contributor version.
496
491
497
492
  In the following three paragraphs, a "patent license" is any express
498
493
agreement or commitment, however denominated, not to enforce a patent
499
494
(such as an express permission to practice a patent or covenant not to
500
495
sue for patent infringement).  To "grant" such a patent license to a
501
496
party means to make such an agreement or commitment not to enforce a
502
497
patent against the party.
503
498
504
499
  If you convey a covered work, knowingly relying on a patent license,
505
500
and the Corresponding Source of the work is not available for anyone
506
501
to copy, free of charge and under the terms of this License, through a
507
502
publicly available network server or other readily accessible means,
508
503
then you must either (1) cause the Corresponding Source to be so
509
504
available, or (2) arrange to deprive yourself of the benefit of the
510
505
patent license for this particular work, or (3) arrange, in a manner
511
506
consistent with the requirements of this License, to extend the patent
512
507
license to downstream recipients.  "Knowingly relying" means you have
513
508
actual knowledge that, but for the patent license, your conveying the
514
509
covered work in a country, or your recipient's use of the covered work
515
510
in a country, would infringe one or more identifiable patents in that
516
511
country that you have reason to believe are valid.
517
512
518
513
  If, pursuant to or in connection with a single transaction or
519
514
arrangement, you convey, or propagate by procuring conveyance of, a
520
515
covered work, and grant a patent license to some of the parties
521
516
receiving the covered work authorizing them to use, propagate, modify
522
517
or convey a specific copy of the covered work, then the patent license
523
518
you grant is automatically extended to all recipients of the covered
524
519
work and works based on it.
525
520
526
521
  A patent license is "discriminatory" if it does not include within
527
522
the scope of its coverage, prohibits the exercise of, or is
528
523
conditioned on the non-exercise of one or more of the rights that are
529
524
specifically granted under this License.  You may not convey a covered
530
525
work if you are a party to an arrangement with a third party that is
531
526
in the business of distributing software, under which you make payment
532
527
to the third party based on the extent of your activity of conveying
533
528
the work, and under which the third party grants, to any of the
534
529
parties who would receive the covered work from you, a discriminatory
535
530
patent license (a) in connection with copies of the covered work
536
531
conveyed by you (or copies made from those copies), or (b) primarily
537
532
for and in connection with specific products or compilations that
538
533
contain the covered work, unless you entered into that arrangement,
539
534
or that patent license was granted, prior to 28 March 2007.
540
535
541
536
  Nothing in this License shall be construed as excluding or limiting
542
537
any implied license or other defenses to infringement that may
543
538
otherwise be available to you under applicable patent law.
544
539
545
540
  12. No Surrender of Others' Freedom.
546
541
547
542
  If conditions are imposed on you (whether by court order, agreement or
548
543
otherwise) that contradict the conditions of this License, they do not
549
544
excuse you from the conditions of this License.  If you cannot convey a
550
545
covered work so as to satisfy simultaneously your obligations under this
551
546
License and any other pertinent obligations, then as a consequence you may
552
547
not convey it at all.  For example, if you agree to terms that obligate you
553
548
to collect a royalty for further conveying from those to whom you convey
554
549
the Program, the only way you could satisfy both those terms and this
555
550
License would be to refrain entirely from conveying the Program.
556
551
557
552
  13. Use with the GNU Affero General Public License.
558
553
559
554
  Notwithstanding any other provision of this License, you have
560
555
permission to link or combine any covered work with a work licensed
561
556
under version 3 of the GNU Affero General Public License into a single
562
557
combined work, and to convey the resulting work.  The terms of this
563
558
License will continue to apply to the part which is the covered work,
564
559
but the special requirements of the GNU Affero General Public License,
565
560
section 13, concerning interaction through a network will apply to the
566
561
combination as such.
567
562
568
563
  14. Revised Versions of this License.
569
564
570
565
  The Free Software Foundation may publish revised and/or new versions of
571
566
the GNU General Public License from time to time.  Such new versions will
572
567
be similar in spirit to the present version, but may differ in detail to
573
568
address new problems or concerns.
574
569
575
570
  Each version is given a distinguishing version number.  If the
576
571
Program specifies that a certain numbered version of the GNU General
577
572
Public License "or any later version" applies to it, you have the
578
573
option of following the terms and conditions either of that numbered
579
574
version or of any later version published by the Free Software
580
575
Foundation.  If the Program does not specify a version number of the
581
576
GNU General Public License, you may choose any version ever published
582
577
by the Free Software Foundation.
583
578
584
579
  If the Program specifies that a proxy can decide which future
585
580
versions of the GNU General Public License can be used, that proxy's
586
581
public statement of acceptance of a version permanently authorizes you
587
582
to choose that version for the Program.
588
583
589
584
  Later license versions may give you additional or different
590
585
permissions.  However, no additional obligations are imposed on any
591
586
author or copyright holder as a result of your choosing to follow a
592
587
later version.
593
588
594
589
  15. Disclaimer of Warranty.
595
590
596
591
  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
597
592
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
598
593
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
599
594
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
600
595
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
601
596
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
602
597
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
603
598
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
604
599
605
600
  16. Limitation of Liability.
606
601
607
602
  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
608
603
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
609
604
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
610
605
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
611
606
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
612
607
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
613
608
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
614
609
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
615
610
SUCH DAMAGES.
616
611
617
612
  17. Interpretation of Sections 15 and 16.
618
613
619
614
  If the disclaimer of warranty and limitation of liability provided
620
615
above cannot be given local legal effect according to their terms,
621
616
reviewing courts shall apply local law that most closely approximates
622
617
an absolute waiver of all civil liability in connection with the
623
618
Program, unless a warranty or assumption of liability accompanies a
624
619
copy of the Program in return for a fee.
625
620
626
621
                     END OF TERMS AND CONDITIONS
627
622
628
623
            How to Apply These Terms to Your New Programs
629
624
630
625
  If you develop a new program, and you want it to be of the greatest
631
626
possible use to the public, the best way to achieve this is to make it
632
627
free software which everyone can redistribute and change under these terms.
633
628
634
629
  To do so, attach the following notices to the program.  It is safest
635
630
to attach them to the start of each source file to most effectively
636
631
state the exclusion of warranty; and each file should have at least
637
632
the "copyright" line and a pointer to where the full notice is found.
638
633
639
634
    <one line to give the program's name and a brief idea of what it does.>
640
635
    Copyright (C) <year>  <name of author>
641
636
642
637
    This program is free software: you can redistribute it and/or modify
643
638
    it under the terms of the GNU General Public License as published by
644
639
    the Free Software Foundation, either version 3 of the License, or
645
640
    (at your option) any later version.
646
641
647
642
    This program is distributed in the hope that it will be useful,
648
643
    but WITHOUT ANY WARRANTY; without even the implied warranty of
649
644
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
650
645
    GNU General Public License for more details.
651
646
652
647
    You should have received a copy of the GNU General Public License
653
648
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
654
649
655
650
Also add information on how to contact you by electronic and paper mail.
656
651
657
652
  If the program does terminal interaction, make it output a short
658
653
notice like this when it starts in an interactive mode:
659
654
660
655
    <program>  Copyright (C) <year>  <name of author>
661
656
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
662
657
    This is free software, and you are welcome to redistribute it
663
658
    under certain conditions; type `show c' for details.
664
659
665
660
The hypothetical commands `show w' and `show c' should show the appropriate
666
661
parts of the General Public License.  Of course, your program's commands
667
662
might be different; for a GUI interface, you would use an "about box".
668
663
669
664
  You should also get your employer (if you work as a programmer) or school,
670
665
if any, to sign a "copyright disclaimer" for the program, if necessary.
671
666
For more information on this, and how to apply and follow the GNU GPL, see
672
667
<http://www.gnu.org/licenses/>.
673
668
674
669
  The GNU General Public License does not permit incorporating your program
675
670
into proprietary programs.  If your program is a subroutine library, you
676
671
may consider it more useful to permit linking proprietary applications with
677
672
the library.  If this is what you want to do, use the GNU Lesser General
678
673
Public License instead of this License.  But first, please read
679
674
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
680
0
675
681
=== added file 'jobbox/MANIFEST.in'
682
--- jobbox/MANIFEST.in	1970-01-01 00:00:00 +0000
683
+++ jobbox/MANIFEST.in	2013-11-11 15:04:58 +0000
684
@@ -0,0 +1,4 @@
685
1
include README.md
686
2
include COPYING
687
3
recursive-include docs *.rst
688
4
include docs/conf.py
689
0
5
690
=== added file 'jobbox/README.md'
691
--- jobbox/README.md	1970-01-01 00:00:00 +0000
692
+++ jobbox/README.md	2013-11-11 15:04:58 +0000
693
@@ -0,0 +1,9 @@
694
1
JobBox
695
2
======
696
3
697
4
JobBox is a collection of jobs for PlainBox and CheckBox
698
5
699
6
Status of JobBox
700
7
================
701
8
702
9
JobBox is currently in planning stages and has no code or jobs whatsoever.
703
0
10
704
=== added directory 'jobbox/docs'
705
=== added file 'jobbox/docs/changelog.rst'
706
--- jobbox/docs/changelog.rst	1970-01-01 00:00:00 +0000
707
+++ jobbox/docs/changelog.rst	2013-11-11 15:04:58 +0000
708
@@ -0,0 +1,12 @@
709
1
ChangeLog
710
2
=========
711
3
712
4
.. note::
713
5
    This changelog contains only a summary of changes. For a more accurate
714
6
    accounting of development history please inspect the source history
715
7
    directly.
716
8
717
9
PlainBox 0.1 (unreleased)
718
10
^^^^^^^^^^^^^^^^^^^^^^^^^
719
11
720
12
* Initial release
721
0
13
722
=== added file 'jobbox/docs/conf.py'
723
--- jobbox/docs/conf.py	1970-01-01 00:00:00 +0000
724
+++ jobbox/docs/conf.py	2013-11-11 15:04:58 +0000
725
@@ -0,0 +1,243 @@
726
1
#!/usr/bin/env python3
727
2
# -*- coding: utf-8 -*-
728
3
#
729
4
# JobBox documentation build configuration file, created by
730
5
# sphinx-quickstart on Wed Feb 13 11:18:39 2013.
731
6
#
732
7
# This file is execfile()d with the current directory set to its containing dir.
733
8
#
734
9
# Note that not all possible configuration values are present in this
735
10
# autogenerated file.
736
11
#
737
12
# All configuration values have a default; values that are commented out
738
13
# serve to show the default.
739
14
740
15
import sys, os
741
16
742
17
# If extensions (or modules to document with autodoc) are in another directory,
743
18
# add these directories to sys.path here. If the directory is relative to the
744
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
745
20
#sys.path.insert(0, os.path.abspath('.'))
746
21
747
22
# -- General configuration -----------------------------------------------------
748
23
749
24
# If your documentation needs a minimal Sphinx version, state it here.
750
25
#needs_sphinx = '1.0'
751
26
752
27
# Add any Sphinx extension module names here, as strings. They can be extensions
753
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
754
29
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
755
30
756
31
# Add any paths that contain templates here, relative to this directory.
757
32
templates_path = ['_templates']
758
33
759
34
# The suffix of source filenames.
760
35
source_suffix = '.rst'
761
36
762
37
# The encoding of source files.
763
38
#source_encoding = 'utf-8-sig'
764
39
765
40
# The master toctree document.
766
41
master_doc = 'index'
767
42
768
43
# General information about the project.
769
44
project = 'JobBox'
770
45
copyright = '2013, Zygmunt Krynicki'
771
46
772
47
# The version info for the project you're documenting, acts as replacement for
773
48
# |version| and |release|, also used in various other places throughout the
774
49
# built documents.
775
50
#
776
51
# The short X.Y version.
777
52
version = '0.1'
778
53
# The full version, including alpha/beta/rc tags.
779
54
release = '0.1'
780
55
781
56
# The language for content autogenerated by Sphinx. Refer to documentation
782
57
# for a list of supported languages.
783
58
#language = None
784
59
785
60
# There are two options for replacing |today|: either, you set today to some
786
61
# non-false value, then it is used:
787
62
#today = ''
788
63
# Else, today_fmt is used as the format for a strftime call.
789
64
#today_fmt = '%B %d, %Y'
790
65
791
66
# List of patterns, relative to source directory, that match files and
792
67
# directories to ignore when looking for source files.
793
68
exclude_patterns = []
794
69
795
70
# The reST default role (used for this markup: `text`) to use for all documents.
796
71
#default_role = None
797
72
798
73
# If true, '()' will be appended to :func: etc. cross-reference text.
799
74
#add_function_parentheses = True
800
75
801
76
# If true, the current module name will be prepended to all description
802
77
# unit titles (such as .. function::).
803
78
#add_module_names = True
804
79
805
80
# If true, sectionauthor and moduleauthor directives will be shown in the
806
81
# output. They are ignored by default.
807
82
#show_authors = False
808
83
809
84
# The name of the Pygments (syntax highlighting) style to use.
810
85
pygments_style = 'sphinx'
811
86
812
87
# A list of ignored prefixes for module index sorting.
813
88
#modindex_common_prefix = []
814
89
815
90
816
91
# -- Options for HTML output ---------------------------------------------------
817
92
818
93
# The theme to use for HTML and HTML Help pages.  See the documentation for
819
94
# a list of builtin themes.
820
95
html_theme = 'default'
821
96
822
97
# Theme options are theme-specific and customize the look and feel of a theme
823
98
# further.  For a list of options available for each theme, see the
824
99
# documentation.
825
100
#html_theme_options = {}
826
101
827
102
# Add any paths that contain custom themes here, relative to this directory.
828
103
#html_theme_path = []
829
104
830
105
# The name for this set of Sphinx documents.  If None, it defaults to
831
106
# "<project> v<release> documentation".
832
107
#html_title = None
833
108
834
109
# A shorter title for the navigation bar.  Default is the same as html_title.
835
110
#html_short_title = None
836
111
837
112
# The name of an image file (relative to this directory) to place at the top
838
113
# of the sidebar.
839
114
#html_logo = None
840
115
841
116
# The name of an image file (within the static path) to use as favicon of the
842
117
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
843
118
# pixels large.
844
119
#html_favicon = None
845
120
846
121
# Add any paths that contain custom static files (such as style sheets) here,
847
122
# relative to this directory. They are copied after the builtin static files,
848
123
# so a file named "default.css" will overwrite the builtin "default.css".
849
124
html_static_path = ['_static']
850
125
851
126
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
852
127
# using the given strftime format.
853
128
#html_last_updated_fmt = '%b %d, %Y'
854
129
855
130
# If true, SmartyPants will be used to convert quotes and dashes to
856
131
# typographically correct entities.
857
132
#html_use_smartypants = True
858
133
859
134
# Custom sidebar templates, maps document names to template names.
860
135
#html_sidebars = {}
861
136
862
137
# Additional templates that should be rendered to pages, maps page names to
863
138
# template names.
864
139
#html_additional_pages = {}
865
140
866
141
# If false, no module index is generated.
867
142
#html_domain_indices = True
868
143
869
144
# If false, no index is generated.
870
145
#html_use_index = True
871
146
872
147
# If true, the index is split into individual pages for each letter.
873
148
#html_split_index = False
874
149
875
150
# If true, links to the reST sources are added to the pages.
876
151
#html_show_sourcelink = True
877
152
878
153
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
879
154
#html_show_sphinx = True
880
155
881
156
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
882
157
#html_show_copyright = True
883
158
884
159
# If true, an OpenSearch description file will be output, and all pages will
885
160
# contain a <link> tag referring to it.  The value of this option must be the
886
161
# base URL from which the finished HTML is served.
887
162
#html_use_opensearch = ''
888
163
889
164
# This is the file name suffix for HTML files (e.g. ".xhtml").
890
165
#html_file_suffix = None
891
166
892
167
# Output file base name for HTML help builder.
893
168
htmlhelp_basename = 'JobBoxdoc'
894
169
895
170
896
171
# -- Options for LaTeX output --------------------------------------------------
897
172
898
173
latex_elements = {
899
174
# The paper size ('letterpaper' or 'a4paper').
900
175
#'papersize': 'letterpaper',
901
176
902
177
# The font size ('10pt', '11pt' or '12pt').
903
178
#'pointsize': '10pt',
904
179
905
180
# Additional stuff for the LaTeX preamble.
906
181
#'preamble': '',
907
182
}
908
183
909
184
# Grouping the document tree into LaTeX files. List of tuples
910
185
# (source start file, target name, title, author, documentclass [howto/manual]).
911
186
latex_documents = [
912
187
  ('index', 'JobBox.tex', 'JobBox Documentation',
913
188
   'Zygmunt Krynicki', 'manual'),
914
189
]
915
190
916
191
# The name of an image file (relative to this directory) to place at the top of
917
192
# the title page.
918
193
#latex_logo = None
919
194
920
195
# For "manual" documents, if this is true, then toplevel headings are parts,
921
196
# not chapters.
922
197
#latex_use_parts = False
923
198
924
199
# If true, show page references after internal links.
925
200
#latex_show_pagerefs = False
926
201
927
202
# If true, show URL addresses after external links.
928
203
#latex_show_urls = False
929
204
930
205
# Documents to append as an appendix to all manuals.
931
206
#latex_appendices = []
932
207
933
208
# If false, no module index is generated.
934
209
#latex_domain_indices = True
935
210
936
211
937
212
# -- Options for manual page output --------------------------------------------
938
213
939
214
# One entry per manual page. List of tuples
940
215
# (source start file, name, description, authors, manual section).
941
216
man_pages = [
942
217
    ('index', 'jobbox', 'JobBox Documentation',
943
218
     ['Zygmunt Krynicki'], 1)
944
219
]
945
220
946
221
# If true, show URL addresses after external links.
947
222
#man_show_urls = False
948
223
949
224
950
225
# -- Options for Texinfo output ------------------------------------------------
951
226
952
227
# Grouping the document tree into Texinfo files. List of tuples
953
228
# (source start file, target name, title, author,
954
229
#  dir menu entry, description, category)
955
230
texinfo_documents = [
956
231
  ('index', 'JobBox', 'JobBox Documentation',
957
232
   'Zygmunt Krynicki', 'JobBox', 'One line description of project.',
958
233
   'Miscellaneous'),
959
234
]
960
235
961
236
# Documents to append as an appendix to all manuals.
962
237
#texinfo_appendices = []
963
238
964
239
# If false, no module index is generated.
965
240
#texinfo_domain_indices = True
966
241
967
242
# How to display URL addresses: 'footnote', 'no', or 'inline'.
968
243
#texinfo_show_urls = 'footnote'
969
0
244
970
=== added file 'jobbox/docs/coverage.rst'
971
--- jobbox/docs/coverage.rst	1970-01-01 00:00:00 +0000
972
+++ jobbox/docs/coverage.rst	2013-11-11 15:04:58 +0000
973
@@ -0,0 +1,74 @@
974
1
Job Coverage
975
2
============
976
3
977
4
This document summarizes job / test coverage as provided by JobBox
978
5
979
6
Hardware Jobs
980
7
^^^^^^^^^^^^^
981
8
982
9
============= ====================================== ========================
983
10
Category Name          Hardware in scope                   Description
984
11
============= ====================================== ========================
985
12
audio         Sound card, headphone jacks, etc       basic functionality tests
986
13
benchmarks    CPUs, GPUs, Disks, Network             assorted benchmarks
987
14
bluetooth     Bluetooth hardware                     basic functionality tests
988
15
camera        video input devices, webcams           basic functionality tests 
989
16
cpu           CPU                                    basic cpu features
990
17
disk          Hard drives and SSD                    basic functionality and capacity tests
991
18
esata         eSATA-connected disks
992
19
expresscard   Express cards
993
20
fingerprint   Fingerprint scanners
994
21
firewire      Firewire-connected disks
995
22
floppy        Floppy disks
996
23
graphics      Integrated and discrete GPUSs
997
24
input         Mouse, touchpad and touchscreen
998
25
keys          Special hardware keys
999
26
led           Indicator LEDs
1000
27
mediacard     Memory card readers (SD, uSD, xD)
1001
28
memory        RAM
1002
29
monitor       CRT and LCD monitors
1003
30
networking    Ethernet, WiFI and modem
1004
31
optical       optical drives (CDs, DVDs)
1005
32
peripheral    external printer and modem tests
1006
33
stress        entire machine                         extended stress testing
1007
34
============= ====================================== ========================
1008
35
1009
36
Software Jobs 
1010
37
^^^^^^^^^^^^^
1011
38
1012
39
================= ==========================
1013
40
Category Name         Software in scope
1014
41
================= ==========================
1015
42
codecs            software audio codecs
1016
43
daemons           essential system daemons 
1017
44
install           apt-get and oem-config
1018
45
panel_clock_test  date and time display and control 
1019
46
panel_reboot      reboot control
1020
47
piglit            various piglit tests (graphics)
1021
48
rendercheck       various rendercheck tests (graphics)
1022
49
server-services   typical server services
1023
50
================= ==========================
1024
51
1025
52
Power management jobs
1026
53
^^^^^^^^^^^^^^^^^^^^^
1027
54
1028
55
================ ==========================
1029
56
Category Name           Description 
1030
57
================ ==========================
1031
58
hibernate        whole-system suspend-to-disk
1032
59
suspend          whole-system suspend-to-ram
1033
60
power-management fine-grained ACPI tests
1034
61
================ ==========================
1035
62
1036
63
Misc jobs
1037
64
^^^^^^^^^
1038
65
1039
66
============= ==========================
1040
67
Category Name        Description
1041
68
============= ==========================
1042
69
info          hardware information logs 
1043
70
local         local jobs (checkbox legacy)
1044
71
miscellanea   other assorted jobs
1045
72
resource      software and hardware probes that enable specific tests
1046
73
smoke         smoke tests for checkbox job management
1047
74
============= ==========================
1048
0
75
1049
=== added file 'jobbox/docs/glossary.rst'
1050
--- jobbox/docs/glossary.rst	1970-01-01 00:00:00 +0000
1051
+++ jobbox/docs/glossary.rst	2013-11-11 15:04:58 +0000
1052
@@ -0,0 +1,2 @@
1053
1
Glossary
1054
2
========
1055
0
3
1056
=== added file 'jobbox/docs/index.rst'
1057
--- jobbox/docs/index.rst	1970-01-01 00:00:00 +0000
1058
+++ jobbox/docs/index.rst	2013-11-11 15:04:58 +0000
1059
@@ -0,0 +1,51 @@
1060
1
.. JobBox documentation master file, created by
1061
2
   sphinx-quickstart on Wed Feb 13 11:18:39 2013.
1062
3
   You can adapt this file completely to your liking, but it should at least
1063
4
   contain the root `toctree` directive.
1064
5
1065
6
JobBox
1066
7
======
1067
8
1068
9
JobBox is a collection of tests that aim to cover all aspects of modern
1069
10
computer hardware. It is intended to be used alongside with CheckBox and
1070
11
PlainBox projects as a source of actual **data**.
1071
12
1072
13
The name *JobBox* is a wordplay that matches the naming scheme of the CheckBox
1073
14
project group. The *job* part refers to CheckBox *jobs* which represent the
1074
15
smallest piece of testing that can be performed. In essence, JobBox is just a
1075
16
box with jobs.
1076
17
1077
18
Installation
1078
19
^^^^^^^^^^^^
1079
20
1080
21
JobBox can be installed from a :abbr:`PPA (Personal Package Archive)`
1081
22
(recommended) or :abbr:`pypi (python package index)` on Ubuntu Precise (12.04)
1082
23
or newer.
1083
24
1084
25
.. code-block:: bash
1085
26
1086
27
    $ sudo add-apt-repository ppa:checkbox-dev/ppa && sudo apt-get update && sudo apt-get install jobbox 
1087
28
1088
29
Using JobBox
1089
30
^^^^^^^^^^^^
1090
31
1091
32
JobBox is a dependency of PlainBox and CheckBox. It will be used automatically
1092
33
whenever those tools are used.
1093
34
1094
35
Table of contents
1095
36
=================
1096
37
1097
38
.. toctree::
1098
39
   :maxdepth: 2
1099
40
1100
41
   jobspec.rst
1101
42
   coverage.rst
1102
43
   glossary.rst
1103
44
   changelog.rst
1104
45
1105
46
Indices and tables
1106
47
==================
1107
48
1108
49
* :ref:`genindex`
1109
50
* :ref:`modindex`
1110
51
* :ref:`search`
1111
0
52
1112
=== added file 'jobbox/docs/jobspec.rst'
1113
--- jobbox/docs/jobspec.rst	1970-01-01 00:00:00 +0000
1114
+++ jobbox/docs/jobspec.rst	2013-11-11 15:04:58 +0000
1115
@@ -0,0 +1,340 @@
1116
1
Job Specification
1117
2
=================
1118
3
1119
4
CheckBox Job Definition
1120
5
^^^^^^^^^^^^^^^^^^^^^^^
1121
6
1122
7
.. todo::
1123
8
    Move checkbox job definitions here or refer to them using intersphinx
1124
9
    syntax. Initially we may have a reference to plainbox that actually
1125
10
    documents what those jobs do.
1126
11
1127
12
JobBox Job Definition 
1128
13
^^^^^^^^^^^^^^^^^^^^^
1129
14
1130
15
JobBox jobs are a proposed evolution of CheckBox jobs. The intent is to retain
1131
16
compatibility with existing jobs, provide simple migration path and to address
1132
17
the shortcomings of existing CheckBox job definition system.
1133
18
1134
19
JobBox jobs are defined as a structure with key (field) - value pairs. The
1135
20
following fields are defined by this document. They are typically stored just
1136
21
as CheckBox jobs, in RFC-822 records.
1137
22
1138
23
name
1139
24
----
1140
25
1141
26
Unique job name, same as in CheckBox.
1142
27
1143
28
This field is used to identify and refer to each job. The name has to
1144
29
be unique. This can be simplified by using vendor name spaces.
1145
30
1146
31
vendor-namespace
1147
32
----------------
1148
33
1149
34
Implicit prefix of the job name.
1150
35
1151
36
This field has no corresponding representation in CheckBox.
1152
37
1153
38
The intent is to allow for an ecosystem of job provides to freely collaborate
1154
39
in one environment without the fear of name collisions.
1155
40
1156
41
This mechanism allows each job vendor to ensure that the key requirement of job
1157
42
*name* to be globally unique is easy to enforce.
1158
43
1159
44
Implicitly all jobs inherit a vendor namespace from the document that defines
1160
45
them. This allows the cumbersome vendor string to be mostly forgotten about in
1161
46
normal development or usage.
1162
47
1163
48
The syntax is of the vendor namespace string **MUST** follow the pattern
1164
49
``year:reverse-domain-name:namespace`` where ``year`` is a non-abbreviated
1165
50
year, ``reverse-domain-name`` is a name of a domain controlled by the vendor
1166
51
written down in the reverse domain name notation while ``namespace`` is an
1167
52
arbitrary string assigned by the vendor. Vendors **MUST** control the DNS
1168
53
domain name at the time the vendor namespace is being defined. The ``year``
1169
54
component allows the system to meaningfully refer to the
1170
55
``reverse-domain-name`` while ensuring that the eternal ownership of a DNS
1171
56
domain name is not a prerequisite.
1172
57
1173
58
.. note::
1174
59
1175
60
    For the Canonical Hardware Certification Team, the vendor namespace is
1176
61
    ``2013:com.canonical:pes/hardware-certification``
1177
62
1178
63
classifiers
1179
64
-----------
1180
65
1181
66
List of classifiers. See :term:`classifiers`.
1182
67
1183
68
This allows scenario editors and testers to pick tests applicable to a
1184
69
particular class of software or hardware. Classifiers allow job developers to
1185
70
associate a set of hierarchical labels to each job.
1186
71
1187
72
This is a replacement of the implicit category association informally defined
1188
73
by the job ``name`` (which typically follows a ``category/name`` pattern) and
1189
74
the equally informal abuse of :term:`local plugin` jobs to use ``__category__``
1190
75
jobs to put generated jobs into some category.
1191
76
1192
77
The improvement over the base idea is that a job may naturally belong to
1193
78
multiple categories, such as being a *hardware:monitor*,
1194
79
*functionality:suspend* test that is typically performed on
1195
80
*target-environment:desktop* and *target-environment:laptop* as well as
1196
81
*target-environment:smart-screen* and belonging to the general
1197
82
*category:power-management*. This was impossible to express in the previous
1198
83
system and while no concrete usage patterns are recommended it believed that
1199
84
introduction of this capability will result in definition of official
1200
85
classifiers and usage patterns in which they are applied. 
1201
86
1202
87
summary
1203
88
-------
1204
89
1205
90
Human-readable, short, one line summary of the job.
1206
91
1207
92
This field is intended for :term:`scenario` developers that wish to assemble a
1208
93
scenario out of the library of available test. Keeping the summary short and
1209
94
one-line will allow efficient representation of tests as a list of items. The
1210
95
summary may be more descriptive than the raw job name might otherwise be.
1211
96
1212
97
description
1213
98
-----------
1214
99
1215
100
Human-readable description of arbitrary size.
1216
101
1217
102
This field is always displayed to the test operator. It may contain
1218
103
instructions vital for the proper verification of the outcome of the test.
1219
104
1220
105
.. note::
1221
106
1222
107
    Perhaps we want to split the description (which is something we could
1223
108
    display on websites and scenario editors) from actual instructions for the
1224
109
    test operator.
1225
110
1226
111
startup
1227
112
-------
1228
113
1229
114
Keyword identifying how a test job is started.
1230
115
1231
116
The default value is ``immediate``.
1232
117
1233
118
The allowed values are:
1234
119
1235
120
``immediate``
1236
121
    The job can be started immediately.
1237
122
   
1238
123
``triggered``
1239
124
    The job needs to be started explicitly by the test operator. This is
1240
125
    intended for things that may be timing-sensitive or may require the tester
1241
126
    to understand the necessary manipulations that he or she may have to
1242
127
    perform ahead of time.
1243
128
1244
129
    The test operator may select to skip certain tests, in that case the
1245
130
    :term:`outcome` is ``skip``.
1246
131
1247
132
This is a replacement for a collection of CheckBox plugin types, including
1248
133
``manual``, ``shell``, ``user-verify`` and ``user-interact``.
1249
134
    
1250
135
verification
1251
136
------------
1252
137
1253
138
Keyword identifying how a test job is qualified as passing or failing.
1254
139
1255
140
The default value is ``automatic``.
1256
141
1257
142
The allowed values are:
1258
143
1259
144
``automatic``
1260
145
    The outcome is automatically verified based on the return status of the
1261
146
    command or script embedded into the job. Depending on the return code the
1262
147
    :term:`outcome` of a job is either ``pass`` or ``fail``
1263
148
1264
149
``manual``
1265
150
    The outcome is manually verified by asking a question to the user.
1266
151
    Typically this question is a form of yes-or-no question. Depending on the
1267
152
    input from the test operator the :term:`outcome` of a job is either
1268
153
    ``pass`` or ``fail``. 
1269
154
1270
155
script
1271
156
------
1272
157
1273
158
A :program:`bash` script to execute.
1274
159
1275
160
There is no default value.
1276
161
1277
162
The script can be a multi-line command that is executed as a part of this job
1278
163
on :term:`job startup`. The script can be as long as desired but it is
1279
164
suggested to keep it reasonably short and transform overly complicated scripts
1280
165
to actual standalone programs so that they can be treated as every other piece
1281
166
of software.
1282
167
1283
168
The output and return code of the script may affect the rest of the system. See
1284
169
the ``script-output`` and ``verification`` fields. 
1285
170
1286
171
script-output
1287
172
-------------
1288
173
1289
174
A keyword identifying what to do with the output produced by the script.
1290
175
1291
176
The default value is ``hide``.
1292
177
1293
178
The allowed values are:
1294
179
1295
180
``hide``
1296
181
    Both stdout and stderr are hidden from the tester.
1297
182
   
1298
183
    The test operator may choose to reveal the output and inspect it if needed.
1299
184
    The output is not stored after all testing is finished.
1300
185
1301
186
    This is a replacement for CheckBox :term:`shell plugin`.
1302
187
1303
188
    The improvement over the base idea is that not all commands produce
1304
189
    interesting output that should be immediately displayed. Except for jobs
1305
190
    that require the test operator to carefully read the output this provides a
1306
191
    good default value without compromising on the ability to access this data
1307
192
    in all cases, if required. 
1308
193
1309
194
``reveal``
1310
195
    Both stdout and stderr are displayed to the tester.
1311
196
   
1312
197
    The test operator may choose to hide the output. The output is not stored
1313
198
    after all testing is finished.
1314
199
1315
200
    This is a replacement for CheckBox :term:`shell plugin`.
1316
201
1317
202
    The improvement over the base idea is that it allows to identify jobs that
1318
203
    depend on the test operator being able to see their output. Such scripts
1319
204
    may be subject to extra scrutiny or localization requirements to ensure
1320
205
    testers can comprehend the output if that is required by the test.
1321
206
1322
207
``attach-text``
1323
208
    The stdout is converted to a text attachment.
1324
209
   
1325
210
    All of the bytes produced on stdout must form a valid Unicode string
1326
211
    encoded with UTF-8. Any characters that cannot be interpreted as UTF-8 are
1327
212
    replaced with supplementary characters.
1328
213
1329
214
    The stderr is discarded.
1330
215
1331
216
    This is a replacement for CheckBox :term:`attachment plugin`.
1332
217
    
1333
218
    The improvement over the base idea is that we clearly differentiate text
1334
219
    and binary attachments and there is a well-defined strategy for handling
1335
220
    corrupted output.
1336
221
1337
222
``attach-binary``
1338
223
    The stdout is converted to a binary attachment.
1339
224
   
1340
225
    The stderr is discarded.
1341
226
1342
227
    When using ``attach-binary`` you **MUST** also set the
1343
228
    ``attachment-mime-type`` field.
1344
229
1345
230
    This is a replacement for CheckBox :term:`attachment plugin`.
1346
231
1347
232
    The improvement over the base idea is that we clearly differentiate text
1348
233
    and binary attachments and there is a way to specify MIME type which may
1349
234
    aid test reviewers and downstream storage systems. For example a web-based
1350
235
    test result browser may offer to download or display attachments in a way
1351
236
    optimized to their content.
1352
237
1353
238
``parse-resource``
1354
239
    The stdout is converted to text as described in ``attach-text`` and
1355
240
    parsed as list of RFC-822 records separated by an empty line. The result
1356
241
    is interpreted as a list of :term:`resource definitions`.
1357
242
   
1358
243
    The stderr is discarded.
1359
244
1360
245
    This is a replacement for CheckBox :term:`resource plugin`.
1361
246
1362
247
``parse-job``
1363
248
    The stdout is converted to text as described in ``attach-text`` and
1364
249
    parsed as a list of RFC-822 records separated by an empty line. The
1365
250
    result is interpreted as a list of :term:`job definitions`.
1366
251
1367
252
    The stderr is discarded.
1368
253
1369
254
    When using ``parse-job`` you **MUST** define ``parse-job-pattern`` to
1370
255
    indicate the naming pattern of jobs that **MAY** be generated by the
1371
256
    script. Jobs that are parsed but do not match that pattern are discarded.
1372
257
1373
258
    This is a replacement for CheckBox :term:`local plugin`.
1374
259
   
1375
260
    The improvement over the base idea is that it allows PlainBox to build a
1376
261
    full graph of all jobs and automatically discover job dependencies without
1377
262
    executing any code.
1378
263
1379
264
parse-job-pattern
1380
265
-----------------
1381
266
1382
267
The pattern of jobs that may be defined by this job.
1383
268
1384
269
There is no default value.
1385
270
1386
271
This field describes the pattern of jobs names that may be defined by a job
1387
272
using ``script-output`` equal to ``parse-job``.
1388
273
1389
274
The pattern **MUST** be a valid job name and **MUST NOT** have a
1390
275
``vendor-namespace`` (in that it can only generate jobs in the same vendor
1391
276
namespace as the job definition that embeds the ``script``). This ensures that
1392
277
no cross-vendor job generation is possible and in turn that each vendor can
1393
278
enforce and control their namespace.
1394
279
1395
280
The pattern **SHOULD** include at least one ``wildcard``. The syntax of the
1396
281
wildcard is ``{NAME}`` where ``NAME`` is the name of the wildcard.
1397
282
1398
283
.. note::
1399
284
    A job that generates arbitrary jobs using a match-everything pattern such
1400
285
    as ``{}`` will be rejected in practice. For details see the rules on
1401
286
    pattern job collisions. The rule states that if two jobs contend to
1402
287
    generate the same job then the shortest pattern (not including the name of
1403
288
    each wildcard) is discarded. This allows to resolve conflicts by allowing
1404
289
    most-specialized pattern to win.
1405
290
1406
291
attachment-mime-type
1407
292
--------------------
1408
293
1409
294
The :term:`MIME` type of attachment generated by this job.
1410
295
1411
296
There is no default value.
1412
297
1413
298
This field is mandatory to jobs that have ``script-output`` equal to
1414
299
``attach-binary``.
1415
300
1416
301
user
1417
302
----
1418
303
1419
304
Name of the system user the script should be executed as.
1420
305
1421
306
There is no default value.
1422
307
1423
308
This is typically used to run certain scripts as ``root``.
1424
309
1425
310
depends
1426
311
-------
1427
312
1428
313
A list of job names that describe test-level dependencies of the job.
1429
314
1430
315
There is no default value.
1431
316
1432
317
The list of dependencies must refer to existing jobs from the same vendor or
1433
318
fully qualified jobs from any vendor. The job is :term:`ready` when **ALL** the
1434
319
term:`outcome` of all referenced jobs is ``pass``.
1435
320
1436
321
The list **MAY** refer to a job generated by a job using ``script-output``
1437
322
equal to ``parse-job``. Jobs with unknown dependencies (not defined anywhere in
1438
323
the system) are removed from consideration. Jobs that have circular
1439
324
dependencies are also removed from consideration.
1440
325
1441
326
When the dependency is not met the :term:`outcome` of a job is ``fail``
1442
327
1443
328
requires
1444
329
--------
1445
330
1446
331
A list of :term:`requirement programs` that describe system-level dependencies
1447
332
of the job.
1448
333
1449
334
There is no default value.
1450
335
1451
336
The list of dependencies is evaluated against all :term:`resources`. The job is
1452
337
:term:`ready` when **ALL** resource programs evaluate to true.
1453
338
1454
339
When the dependency is not met the :term:`outcome` of a job is
1455
340
``not-supported``
1456
0
341
1457
=== added directory 'jobbox/jobbox'
1458
=== added file 'jobbox/jobbox/__init__.py'
1459
--- jobbox/jobbox/__init__.py	1970-01-01 00:00:00 +0000
1460
+++ jobbox/jobbox/__init__.py	2013-11-11 15:04:58 +0000
1461
@@ -0,0 +1,20 @@
1462
1
# This file is part of Checkbox.
1463
2
#
1464
3
# Copyright 2013 Canonical Ltd.
1465
4
# Written by:
1466
5
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
1467
6
#
1468
7
# Checkbox is free software: you can redistribute it and/or modify
1469
8
# it under the terms of the GNU General Public License as published by
1470
9
# the Free Software Foundation, either version 3 of the License, or
1471
10
# (at your option) any later version.
1472
11
#
1473
12
# Checkbox is distributed in the hope that it will be useful,
1474
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1475
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1476
15
# GNU General Public License for more details.
1477
16
#
1478
17
# You should have received a copy of the GNU General Public License
1479
18
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
1480
19
1481
20
__version__ = (0, 1, 0, 'dev', 0)
1482
0
21
1483
=== added file 'jobbox/setup.cfg'
1484
--- jobbox/setup.cfg	1970-01-01 00:00:00 +0000
1485
+++ jobbox/setup.cfg	2013-11-11 15:04:58 +0000
1486
@@ -0,0 +1,5 @@
1487
1
[upload]
1488
2
sign=True
1489
3
1490
4
[upload_docs]
1491
5
upload-dir=build/sphinx/html
1492
0
6
1493
=== added file 'jobbox/setup.py'
1494
--- jobbox/setup.py	1970-01-01 00:00:00 +0000
1495
+++ jobbox/setup.py	2013-11-11 15:04:58 +0000
1496
@@ -0,0 +1,32 @@
1497
1
#!/usr/bin/env python3
1498
2
# This file is part of Checkbox.
1499
3
#
1500
4
# Copyright 2013 Canonical Ltd.
1501
5
# Written by:
1502
6
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
1503
7
#
1504
8
# Checkbox is free software: you can redistribute it and/or modify
1505
9
# it under the terms of the GNU General Public License as published by
1506
10
# the Free Software Foundation, either version 3 of the License, or
1507
11
# (at your option) any later version.
1508
12
#
1509
13
# Checkbox is distributed in the hope that it will be useful,
1510
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1511
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1512
16
# GNU General Public License for more details.
1513
17
#
1514
18
# You should have received a copy of the GNU General Public License
1515
19
# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
1516
20
1517
21
1518
22
from setuptools import setup, find_packages
1519
23
1520
24
1521
25
setup(
1522
26
    name="jobbox",
1523
27
    version="0.1",
1524
28
    packages=find_packages(),
1525
29
    author="Zygmunt Krynicki",
1526
30
    author_email="zygmunt.krynicki@canonical.com",
1527
31
    license="GPLv3+",
1528
32
    description="Jobs for PlainBox")
1529
0
33
1530
=== modified file 'setup.py'
1531
--- setup.py	2013-11-08 21:55:38 +0000
1532
+++ setup.py	2013-11-11 15:04:58 +0000
1533
@@ -30,7 +30,7 @@
1534
30
import subprocess
30
import subprocess
1535
31
import sys
31
import sys
1536
32
32
1538
33
delegate_to = ['plainbox', 'checkbox-ng']
33
delegate_to = ['plainbox', 'checkbox-ng', 'jobbox']
1539
34
try:
34
try:
1540
35
    base = os.path.dirname(__file__)
35
    base = os.path.dirname(__file__)
1541
36
    for target_dir in delegate_to:
36
    for target_dir in delegate_to:
Status:	Work in progress
Proposed branch:	lp:~zyga/checkbox/jobbox
Merge into:	lp:checkbox
Diff against target:	1541 lines (+1467/-1) 13 files modified jobbox/COPYING (+674/-0) jobbox/MANIFEST.in (+4/-0) jobbox/README.md (+9/-0) jobbox/docs/changelog.rst (+12/-0) jobbox/docs/conf.py (+243/-0) jobbox/docs/coverage.rst (+74/-0) jobbox/docs/glossary.rst (+2/-0) jobbox/docs/index.rst (+51/-0) jobbox/docs/jobspec.rst (+340/-0) jobbox/jobbox/__init__.py (+20/-0) jobbox/setup.cfg (+5/-0) jobbox/setup.py (+32/-0) setup.py (+1/-1)
To merge this branch:	bzr merge lp:~zyga/checkbox/jobbox
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Checkbox Developers		2013-05-20	Pending
Review via email: mp+164752@code.launchpad.net