Skip to content

Commit

Permalink
KVM README update: Add lkvs as a seperate test provider for avocado-vt (
Browse files Browse the repository at this point in the history
#227)

KVM README.md update: Add lkvs as a seperate test provider for avocado-vt,
Add execution guideline and contribution guideline.

---------

Signed-off-by: Xudong Hao <[email protected]>
  • Loading branch information
xhao22 authored May 22, 2024
1 parent 3974e01 commit 79c8a0e
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions KVM/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,71 @@ More details please refer to following.
## KVM Features
* [demo](demo/README.md)
(TODO)


## How to run KVM test
lkvs KVM is a seperate test provider for avocado/avocado-vt.

1) Install avocado and avocado-vt
```
pip install --user avocado-framework
pip install --user git+https://github.com/avocado-framework/avocado-vt
```
2) Download lkvs in test machine
```
git clone https://github.com/intel/lkvs.git
```
3) Create a new test provider file for lkvs test repo, put the file
in the installed test provider folder. like:
```
cat /root/avocado/data/avocado-vt/virttest/test-providers.d/myprovider.ini
```

```
[provider]
uri: file:///home/foo/lkvs
[qemu]
subdir: KVM/qemu/
```
4) Setup test into the real avocado-vt configuration file
```
avocado vt-bootstrap
avocado list |grep myprovider
```
For example: avocado-vt type_specific.myprovider.boot_td

5) Run test
```
avocado run boot_td
```

## Contributions quick start guide

1) Fork this repo on github
2) Create a new topic branch for your work
3) Create a new test provider file in your virt test repo,
like:
```
cp io-github-autotest-qemu.ini myprovider.ini
```

```
[provider]
uri: file:///home/foo/lkvs
[qemu]
subdir: KVM/qemu/
```
You can optionally delete temporarily the
`io-github-autotest-qemu.ini` file, just so you don't have test
conflicts. Then you can develop your new test code, run it
using virt test, and commit your changes.

4) Make sure you have [inspektor installed](https://github.com/autotest/inspektor#inspektor)
5) Run:
```
inspekt checkall --disable-style E501,E265,W601,E402,E722,E741 --no-license-check
```
6) Fix any problems
7) Push your changes and submit a pull request
8) That's it.

0 comments on commit 79c8a0e

Please sign in to comment.