From 79c8a0e7d2a2f53ffec8ce41bc401aef50265f05 Mon Sep 17 00:00:00 2001
From: xhao22 <xudong.hao@intel.com>
Date: Wed, 22 May 2024 09:02:49 +0800
Subject: [PATCH] KVM README update: Add lkvs as a seperate test provider for
 avocado-vt (#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 <xudong.hao@intel.com>
---
 KVM/README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/KVM/README.md b/KVM/README.md
index a2214973..95d7a7c7 100644
--- a/KVM/README.md
+++ b/KVM/README.md
@@ -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.
+