From 5043d5991fb46428a0b4517477eca4fa09be9426 Mon Sep 17 00:00:00 2001 From: Shivam Thakur <70829776+shivamcandela@users.noreply.github.com> Date: Sun, 20 Feb 2022 13:05:28 +0530 Subject: [PATCH] Wifi 7172 (#397) * Updating Readme with setup Instructions * Fixed the README.md for setting up instructions Signed-off-by: shivam --- README.md | 69 ++++++++++++++++--------------------------------------- 1 file changed, 20 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index f305bf34a..936b12eb0 100644 --- a/README.md +++ b/README.md @@ -117,66 +117,37 @@ All code must be written in python 3 and conform to PEP 8 style guide. The test |── README.md -/* Pytest framework and testcases information */ ``` -### Setup Instructions - -#### Step 1 - -Set up the repository in your base directory of choice. Currently, it is -important to clone the wlan-lanforge-scripts repository and link to wlan-testing -directory (The sync_repos.bash provides that linkage). - -```shell +# Test Automation Setup Instructions +``` +# Let's assume '~/automation' directory for setting wlan-testing +cd ~/ +mkdir automation +cd automation git clone https://github.com/Telecominfraproject/wlan-testing git clone https://github.com/Telecominfraproject/wlan-lanforge-scripts - -Make sure this directory structure exists -├── wlan-lanforge-scripts -├── wlan-testing - cd wlan-testing - ./sync_repos.bash -``` - -#### Step 2 - -Please ensure you follow the steps outlined in [here](./libs/controller/README.md) - -```shell -Lets add the TIP pypi repository by following the below steps: - mkdir ~/.pip echo "[global]" > ~/.pip/pip.conf echo "index-url = https://pypi.org/simple" >> ~/.pip/pip.conf echo "extra-index-url = https://tip-read:tip-read@tip.jfrog.io/artifactory/api/pypi/tip-wlan-python-pypi-local/simple" >> ~/.pip/pip.conf -``` - -#### Step 3 - -Please ensure you have python version >= 3 is required. Double check this by running "python --version" command. - -```shell -User this to check "python --version" - -Lets Install the Python Packages needed - pip3 install -r requirements.txt + +cd tests +vim configuration.py # Setup your testbed data info here + +# Check if everything is good +pytest --collect-only + + +# for visualizing allure reports, Install nodejs +# Set Java home + +# install allure command +npm install -g allure-commandline --save-dev + ``` -#### Step 4 - -Setup configuration.py file -This file is autogenerated by Quali-Lab-Orchestration -You can custom create the configuration file, by following the sample configuration data structure (tests/configuration.py) - -#### Step 5 - -You are all set, - -To verify that everything is working, - -cd wlan-testing/tests -pytest -m test_connection -s -vvv ### Executing and Contributing new test cases