Commit 9fff6ab0 authored by Corentin Noël's avatar Corentin Noël
Browse files

Remove references to singularity

Singularity is not a thing anymore. Also update the links to their latest locations.

Move README to README.md at the same time.
parent 41a4806d
== LAVA QA Tool ==
# LAVA QA Tool
Command line tool for LAVA quality assurance tasks.
=== Install software from upstream code ===
## Install software from upstream code
$ git clone git+ssh://git.collabora.co.uk/git/singularity/tools/lqa.git
$ cd lqa/
$ sudo python setup.py install
```sh
git clone https://gitlab.collabora.com/collabora/lqa.git
cd lqa/
sudo python setup.py install
```
=== Install software from Debian package ===
The lqa package is built at Collabora OBS:
https://build.collabora.co.uk/package/show?package=lqa&project=collabora%3Apublic%3Atools
And it 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 ===
## Usage example
LAVA is just an automated framework to push in jobs, then those jobs run
the useful test case definitions.
For Singularity OS, the test and job 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.
The `examples/lqa.yaml` file is provided as an example that the developer
must update before lqa usage and place it into the directory `$HOME/.config/`.
......@@ -40,14 +22,16 @@ Extra examples on jobs are also provided in the `examples` directory.
Now for the real usage, tests can be run in a lot against certain image:
$ lqa --log-file /var/log/lqa-sin-validator.log \
submit \
-g examples/profiles.yaml \
--all-profiles \
-t image_date:150305-004801 \
templates/*.json
```sh
lqa --log-file lqa-sin-validator.log \
submit \
-g examples/profiles.yaml \
--all-profiles \
-t image_date:150305-004801 \
examples/templates/*.json
```
The previous example will run all jobs from `templates/*.json`,
The previous example will run all jobs from `examples/templates/*.json`,
using the configuration file `$HOME/.config/lqa.yaml`, for all profiles
configured in the file `examples/profiles.yaml`. The image to be used will
be the one with timestamp `150305-004801` and actions will be logged at
......@@ -56,18 +40,17 @@ be the one with timestamp `150305-004801` and actions will be logged at
If the `lqa.yaml` configuration file is located in another directory,
the `--config` or `-c` options can be used like:
$ lqa --config examples/lqa.yaml \
--log-file /var/log/lqa-sin-validator.log \
submit \
-g examples/profiles.yaml \
--all-profiles \
-t image_date:150305-004801 \
templates/*.json
The previous example will run all jobs in `templates/*.json`, using
```sh
lqa --config examples/lqa.yaml \
--log-file lqa-sin-validator.log \
submit \
-g examples/profiles.yaml \
--all-profiles \
-t image_date:150305-004801 \
examples/templates/*.json
```
The previous example will run all jobs in `examples/templates/*.json`, using
the configuration file `examples/lqa.yaml`, for all profiles configured
in the file `examples/profiles.yaml`. The image to be used will be the one
with timestamp `150305-004801` and actions will be logged at `lqa-sin-validator.log`.
B&I/QA Team
singularity@lists.collabora.co.uk
......@@ -29,7 +29,7 @@ setup(
description='LAVA QA command line tool',
author='Luis Araujo',
author_email='luis.araujo@collabora.co.uk',
url='http://cgit.collabora.com/git/singularity/tools/lqa.git/',
url='https://gitlab.collabora.com/collabora/lqa',
packages=find_packages(),
classifiers = [
'Operating System :: OS Independent',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment