.. Redant documentation master file, created by
   sphinx-quickstart on Wed Mar 10 20:48:51 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


 
======
Redant
======

.. _Github: https://github.com/srijan-sivakumar/Redant


Structure
=========
- redant_libs: consists of the libs and ops that will help in running the test cases.
- tests: holds the test cases. Add any new test cases here.
   
To start Working  
================

1. Clone the odinControl inside the RedAnt_Test. [This is temporary. Once odinControl is converted into a python package we won't need this step]. You can directly call the rexe from the odinControl or use a directory rexe where you can put **__init__.py** and **rexe.py** and hence call the file.
   
2. Create a **Utilities** folder and add **conf.yaml** file [This is temporary as well just for testing. Once we are ready with the components we just need to connect them.]
   OR
   You can also call the conf.yaml from the odinControl. I have used it here just to indicate the independence of each component. But reusability of existing files won't hurt. :sweat_smile:
   
   
STEP-BY_STEP procedure to run:
==============================

1. Clone the repo.

.. code-block:: bash

   $ git clone [your fork for this repo]

2. Create a virtual environment

.. code-block:: bash

   $ virtualenv <virtual_env_name>

3. Activate the virtual-env

.. code-block:: bash

   $ source <virtual_env_name>/bin/activate

4.

.. code-block:: bash  

   $ cd [the-fork]

5.

.. code-block:: bash

   $ pip3 install -r requirements.txt

6.

.. code-block:: bash

   $ mkdir Utilities && touch Utilities/conf.yaml

7. Add the following in *conf.yaml*:

.. code-block:: bash

   host_list: [server IPs]
   user: "user"
   passwd: "pass"

   
8. Use the thread_runner.py to run the sample test case.
   
.. code-block:: bash

   $ python3 thread_runner.py -t tests/test_sample_tc.py -tf test_fn -c <path_to_conf_file>.
   
9. Log files can be found at /tmp/redant.log [ default path ]. For more options, run
   
.. code-block:: bash

   $ python3 thread_runner.py --help

Table Of Contents
=================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`