|
3 | 3 | Start using kirk |
4 | 4 | ================ |
5 | 5 |
|
6 | | -The tool works out of the box by running `kirk` script. |
| 6 | +The tool works out of the box by running ``kirk`` script. |
7 | 7 | Minimum python requirement is 3.6+ and *optional* dependences are the following: |
8 | 8 |
|
9 | 9 | - `asyncssh <https://pypi.org/project/asyncssh/>`_ for SSH support |
10 | 10 | - `msgpack <https://pypi.org/project/msgpack/>`_ for LTX support |
11 | 11 |
|
12 | | -`kirk` will detect if dependences are installed and activate the corresponding |
13 | | -support. If no dependences are provided by the OS's package manager, |
14 | | -`virtualenv` can be used to install them: |
| 12 | +kirk will detect if dependences are installed and activate the corresponding |
| 13 | +support. |
| 14 | + |
| 15 | +To use kirk via git repository: |
15 | 16 |
|
16 | 17 | .. code-block:: bash |
17 | 18 |
|
18 | | - # download source code |
19 | 19 | git clone git@github.com:acerv/kirk.git |
20 | | - cd kirk |
21 | | -
|
22 | | - # create your virtual environment (python-3.6+) |
23 | | - virtualenv .venv |
| 20 | + export PATH=$PATH:$PWD/kirk |
24 | 21 |
|
25 | | - # activate virtualenv |
26 | | - source .venv/bin/activate |
| 22 | + kirk --help |
27 | 23 |
|
28 | | - # SSH support |
29 | | - pip install asyncssh |
| 24 | +kirk is also present in `pypi <https://pypi.org/project/kirk>`_ and it can be |
| 25 | +installed via ``pip`` command: |
30 | 26 |
|
31 | | - # LTX support |
32 | | - pip install msgpack |
| 27 | +.. code-block:: bash |
33 | 28 |
|
34 | | - # run kirk |
35 | | - ./kirk --help |
| 29 | + pip install --user kirk |
36 | 30 |
|
37 | 31 | Some basic commands are the following: |
38 | 32 |
|
39 | 33 | .. code-block:: bash |
40 | 34 |
|
41 | 35 | # run LTP syscalls testing suite on host |
42 | | - ./kirk --run-suite syscalls |
| 36 | + kirk --run-suite syscalls |
43 | 37 |
|
44 | 38 | # run LTP syscalls testing suite on qemu VM |
45 | | - ./kirk --sut qemu:image=folder/image.qcow2:user=root:password=root \ |
| 39 | + kirk --sut qemu:image=folder/image.qcow2:user=root:password=root \ |
46 | 40 | --run-suite syscalls |
47 | 41 |
|
48 | 42 | # run LTP syscalls testing suite via SSH |
49 | | - ./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \ |
| 43 | + kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \ |
50 | 44 | --run-suite syscalls |
51 | 45 |
|
52 | 46 | # run LTP syscalls testing suite in parallel on host using 16 workers |
53 | | - ./kirk --run-suite syscalls --workers 16 |
| 47 | + kirk --run-suite syscalls --workers 16 |
54 | 48 |
|
55 | 49 | # run LTP syscalls testing suite in parallel via SSH using 16 workers |
56 | | - ./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \ |
| 50 | + kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \ |
57 | 51 | --run-suite syscalls --workers 16 |
58 | 52 |
|
59 | 53 | # pass environment variables (list of key=value separated by ':') |
60 | | - ./kirk --run-suite net.features \ |
| 54 | + kirk --run-suite net.features \ |
61 | 55 | --env 'VIRT_PERF_THRESHOLD=180:LTP_NET_FEATURES_IGNORE_PERFORMANCE_FAILURE=1' |
62 | 56 |
|
63 | 57 | It's possible to run a single command before running testing suites using |
64 | | -`--run-command` option as following: |
| 58 | +``--run-command`` option as following: |
65 | 59 |
|
66 | 60 | .. code-block:: bash |
67 | 61 |
|
68 | | - ./kirk --run-command /mnt/setup.sh \ |
| 62 | + kirk --run-command ./setup_sut.sh \ |
69 | 63 | --sut qemu:image=folder/image.qcow |
70 | 64 |
|
0 commit comments