← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to providers/plainbox-provider-hwcollect/README.md

  • Committer: Sylvain Pineau
  • Date: 2014-07-29 16:05:54 UTC
  • mto: This revision was merged to the branch mainline in revision 3149.
  • Revision ID: sylvain.pineau@canonical.com-20140729160554-qev8887xbunn9tmi
checkbox-ng:launchers:checkbox-cli: The checkbox-cli launcher

Running the default whitelist (with the suite selection screen skipped)

Show diffs side-by-side

added added

removed removed

Lines of Context:
providers/plainbox-provider-hwcollect/README.md
1
 
Skeleton for a new PlainBox provider
2
 
====================================
3
 
 
4
 
This is a skeleton PlainBox provider that was generated using
5
 
``plainbox startprovider ...``.
6
 
 
7
 
It is just the starting point, there is nothing here of value to you
8
 
yet. If you know how this works then just remove this file along with
9
 
other example content and start working on your new tests,
10
 
otherwise, read on.
11
 
 
12
 
Inside the ``jobs/`` directory you will find several files that define
13
 
a number of "jobs" (more than one job per file actually). A job, in
14
 
PlainBox parlance, is the smallest piece of executable test code. Each
15
 
job has a name and a number of other attributes.
16
 
 
17
 
Jobs can be arranged in lists, test plans if you will that are known
18
 
as "whitelists". Those are defined in the ``whitelists/`` directory,
19
 
this time one per file. You can create as many whitelists as you need,
20
 
referring to arbitrary subsets of your jobs.
21
 
 
22
 
Then there are the ``bin/`` and ``data/`` directories. Those are
23
 
entirely for custom content you may need. You can put arbitrary
24
 
executables in ``bin/``, and those will be available to your job
25
 
definitions. Similarly you can keep any data your jobs might need
26
 
inside the ``data/`` directory. Referring to that directory at runtime
27
 
is a little bit trickier but one of the examples generated in this
28
 
skeleton shows how to do that.
29
 
 
30
 
Lastly there is the ``manage.py`` script. It requires python3 to run.
31
 
It depends on the python3-plainbox Debian package (or just the
32
 
PlainBox 0.5 upstream package) installed. This script can automate and
33
 
simplify a number of tasks that you will want to do as a test
34
 
developer.
35
 
 
36
 
Run ``./manage.py --help`` to see what sub-commands are available. You
37
 
can additionally pass ``--help`` to each sub command, for example
38
 
``./manage.py install --help`` will print the description of the
39
 
install command and all the arguments it supports.
40
 
 
41
 
That is it for now. You should check out the official documentation
42
 
for test authors at
43
 
http://plainbox.readthedocs.org/en/latest/author/index.html
44
 
 
45
 
If you find bugs or would like to see additional features developed
46
 
you can file bugs on the parent project page:
47
 
https://bugs.launchpad.net/checkbox/+filebug
 
 
b'\\ No newline at end of file'