Skip to content

Commit 8f960fc

Browse files
committed
README: remove any reference to external frameworks
Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
1 parent d337eee commit 8f960fc

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ What is Kirk?
22
=============
33

44
Kirk application is a fork of [runltp-ng](https://github.com/linux-test-project/runltp-ng)
5-
and it aims to merge multiple Linux testing frameworks in one tool, providing
5+
and it's the official Linux Test Project runner, providing
66
support for remote testing via Qemu, SSH, LTX, parallel execution and much more.
77

88
Host information
@@ -84,35 +84,31 @@ support. If no dependences are provided by the OS's package manager,
8484
Some basic commands are the following:
8585

8686
# run LTP syscalls testing suite on host
87-
./kirk --framework ltp --run-suite syscalls
87+
./kirk --run-suite syscalls
8888

8989
# run LTP syscalls testing suite on qemu VM
90-
./kirk --framework ltp \
91-
--sut qemu:image=folder/image.qcow2:user=root:password=root \
90+
./kirk --sut qemu:image=folder/image.qcow2:user=root:password=root \
9291
--run-suite syscalls
9392

9493
# run LTP syscalls testing suite via SSH
95-
./kirk --framework ltp \
96-
--sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
94+
./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
9795
--run-suite syscalls
9896

9997
# run LTP syscalls testing suite in parallel on host using 16 workers
100-
./kirk --framework ltp --run-suite syscalls --workers 16
98+
./kirk --run-suite syscalls --workers 16
10199

102100
# run LTP syscalls testing suite in parallel via SSH using 16 workers
103-
./kirk --framework ltp \
104-
--sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
101+
./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
105102
--run-suite syscalls --workers 16
106103

107104
# pass environment variables (list of key=value separated by ':')
108-
./kirk --framework ltp --run-suite net.features \
105+
./kirk --run-suite net.features \
109106
--env 'VIRT_PERF_THRESHOLD=180:LTP_NET_FEATURES_IGNORE_PERFORMANCE_FAILURE=1'
110107

111108
It's possible to run a single command before running testing suites using
112109
`--run-command` option as following:
113110

114-
./kirk --framework ltp \
115-
--run-command /mnt/setup.sh \
111+
./kirk --run-command /mnt/setup.sh \
116112
--sut qemu:image=folder/image.qcow2:virtfs=/home/user/tests:user=root:password=root \
117113
--run-suite syscalls
118114

@@ -124,8 +120,7 @@ In certain cases, `kirk` sessions can be restored. This can be really helpful
124120
when we need to restore the last session after a system crash:
125121

126122
# restore the latest session
127-
./kirk --framework ltp \
128-
--restore /tmp/kirk.<username>/latest \
123+
./kirk --restore /tmp/kirk.<username>/latest \
129124
--run-suite syscalls
130125

131126
Setting up console for Qemu
@@ -155,16 +150,6 @@ Once a new SUT class is implemented and placed inside the `libkirk` folder,
155150
`kirk -s help` command can be used to see if application correctly
156151
recognise it.
157152

158-
Implementing Framework
159-
======================
160-
161-
Every testing framework has it's own setup, defining tests folders, data and
162-
variables. For this reason, `Framework` class provides a generic API that, once
163-
implemented, permits to define a specific testing framework. The class
164-
implementation must be included inside the `libkirk` folder and it will be
165-
used as an abstraction layer between `kirk` scheduler and the specific testing
166-
framework.
167-
168153
Development
169154
===========
170155

0 commit comments

Comments
 (0)