summaryrefslogtreecommitdiff
path: root/README
blob: 808a2ad87fc843161516e0ec69f3c355d15e0c43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

== LAVA QA Tool ==

Command line tool for LAVA quality assurance tasks.

=== Obtain latest software copy ===

	Latest software can be found at:
	  git+ssh://git.collabora.co.uk/git/singularity/tools/lqa.git

=== Install software from upstream code ===

	$ cd lqa/
	$ sudo python setup.py install

=== Install software from Debian package ===

	lqa package is built at Collabora OBS
	  https://build.collabora.co.uk/package/show?package=lqa&project=collabora%3Apublic%3Atools

	lqa package is published at Collabora repositories
	  deb https://repositories.collabora.co.uk/obs/debian/ <SUITE> tools

	where <SUITE> can be wheezy, jessie or precise.

=== Usage example ===

	Check LAVA quick start guide
	  https://wiki.collabora.co.uk/LAVA/UserGuide

	LAVA is just an automated framework to push in jobs, then those jobs run
    the useful test case definitions. This two concepts, jobs and definitions
    are separated repositories.

	For Singularity OS, the jobs can be found at:
	  http://cgit.collabora.com/git/singularity/qa/test-jobs.git/
	  git+ssh://git.collabora.co.uk/git/singularity/qa/test-jobs.git

	For Singularity OS, the test case definitions are found at:
	  http://cgit.collabora.com/git/singularity/qa/test-definitions.git/
	  git+ssh://git.collabora.co.uk/git/singularity/qa/test-definitions.git

	For other projects, those might reuse test-definitions, but probably need a
    separated test-jobs tree. Check with team responsible for that project.

	At the moment test-jobs need to be checked out before submitting and path
    must be added to lqa configuration file. (see template-dir)

	Once you got test-jobs checkout you can configure lqa to use those.
    For Singularity OS, lava-conf.yaml file is provided as an example that
    developer must update before lqa usage and place into /etc/lqa/ directory.

	Extra example on jobs are also provided in the example directory.

	Now for the real usage, tests can be run in a lot against certain image:

      $ lqa \
        -c /etc/lqa/lava-conf.yaml \
        --all-profiles \
        -t image-date:150305-004801 \
        --submit-job \
        --log-file /var/log/lqa-sin-validator.log

	The previous example will run all jobs (within template-dir path), 
    using the configuration file lava-conf.yaml, for all profiles configured
    in yaml file. The image to be used will be the one with 150305-004801
    timestamp and actions logged at lqa-sin-validator.log.

      $ lqa \
        -j templates/*.json \
        -c /etc/lqa/lava-conf.yaml \
        --all-profiles \
        -t image-date:150305-004801 \
        --submit-job \
        --log-file /var/log/lqa-sin-validator.log

	The previous example will run all jobs in templates/*.json path (within
    template-dir path), using the configuration file lava-conf.yaml, for all
    profiles configured in yaml file. The image to be used will be the one
    with 150305-004801 timestamp and actions logged at lqa-sin-validator.log.


B&I/QA Team
singularity@lists.collabora.co.uk

Last update: 2015-03-05