redant

    ____  __________  ___    _   ________
   / __ \/ ____/ __ \/   |  / | / /_  __/
  / /_/ / __/ / / / / /| | /  |/ / / /   
 / _, _/ /___/ /_/ / ___ |/ /|  / / /    
/_/ |_/_____/_____/_/  |_/_/ |_/ /_/     
                                         

usage: redant_main.py [-h] -c CONFIG_FILE -t TEST_DIR [-sp] [-l LOG_DIR]
                      [-ll LOG_LEVEL] [-cc CONCUR_COUNT] [-rf RESULT_PATH]
                      [-xls EXCEL_SHEET]

Redant test framework main script.

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_FILE, --config CONFIG_FILE
                        Config file(s) to read.
  -t TEST_DIR, --test-dir TEST_DIR
                        The test directory where TC(s) exist
  -sp, --specific-test-path
                        Path of the specific test to be run from tests/
  -l LOG_DIR, --log-dir LOG_DIR
                        The directory wherein log will be stored.
  -ll LOG_LEVEL, --log-level LOG_LEVEL
                        The log level. Default log level is Info
  -cc CONCUR_COUNT, --concurrency-count CONCUR_COUNT
                        Number of concurrent test runs. Default is 2.
  -rf RESULT_PATH, --result-file RESULT_PATH
                        Result file. Default value is None
  -xls EXCEL_SHEET, --excel-sheet EXCEL_SHEET
                        Spreadsheet for result. Default value is NULL

The architects of any project won't be there forever with it ( not everyone has the luxury to be a BDFL ), hence it is important to have the thought process documented so that one doesn't need to go through the code. We for one believe in proper documentation. The very idea of developers and engineers being spartans who understand logic only from code is what we feel as . We need to be civilized humans and make it easy for the next person coming in to just glance at what it is, why it is and how it is.

For those who want a pure markdown experience and a deeper dive...

Readme Docs

For those who want to take the red pill, this is where you go, the Readme index contains all the thought process, decision making and everything documented right from a variable, data structure to why some things are the way they are. So if you are ready to take the leap to learn the ugly truth ( kidding! ), this is where you go. But on the other hand, if you just want to learn about how to get things running and that's it, take the blue pill.

• Red Pill Index
• Blue Pill Index

Contents

• Set up
• Those looking to get into the action of migrating test cases
• Detailed Design

Set up

To start Working:

1. Clone redant repo.

2. Populate the conf.yaml with relevant server and client details..

STEP-BY-STEP procedure to run:

1. git clone [your fork for this repo]
2. Create a virtual environment : virtualenv <virtual_env_name>
3. Activate the virtual-env : source <virtual_env_name>/bin/activate
4. cd [the-fork]
5. Run pip3 install -r requirements.txt
6. To run the sample TC, just run the below cmd after populating the config file with relevant values. The command has to be run from the main redant reository. The tests path should be given with respect to the redant directory. python3 ./core/redant_main.py -c ./core/parsing/config.yml -t tests/example/
7. Log files can be found at /tmp/redant.log [ default path ]. For more options, run python3 ./core/redant_main.py --help

The logging is specific to a TC run. So when a user gives a specific base dir for logging when invoking redant_main.py, that directory will inturn contain the following dirs, -> functional -> performance -> example

Now, based on the invocation, directory of a component will be created inside the functional and performace dirs. And inside the component directory, the Test case specific directory will be created which inturn will contain volume specific log files. So for example to see the log files of a test case which is, functional/<gluster_component>/<test_name>/test_sample.py one would have to go to the directory, <base_log_dir>/<time_stamp>/functional/<gluster_component>/test_sample, which will inturn contain the log files specific to volume type.

In addition to running TCs from within a suite, either performance or functional or even under a more granular level of component, one can select to run a specific TC also. To do this, one simply has to use the -sp flag while invoking redant and instead of the directory path provide the path of the TC. For example, python3 core/redant_main.py -c core/parsing/config.yml -t tests/example/sample_component

One can also run the scripts given under the tools dir which will reduce the lengthy commands to be typed out everytime. Check out the README.md at the link Tools-README

Those looking to get into the action of migrating test cases

Please refer the doc : migratingTC.md

Design Document

Redant Design Doc