====================
Interactive terminal
====================

Tests are located in the :code:`src/ska_low_sps_testsuite/functional_tests` directory and can be executed from the command line using the
python script :code:`interactive_terminal.py` in the :code:`interactive_terminal` directory with the following supported arguments:

.. code-block::

    Options:
      -h, --help            show this help message and exit
      --config=CONFIG       Station configuration file [default: None]
      --test_parameter=TEST_PARAMETER
                            Test Parameter file [default: None]
      -t TEST_TODO, --test=TEST_TODO
                            Test to be executed [default: All]
      -p                    Print available tests and exit [default: False]
      -i, --interactive     Interactive execution mode [default: False]
      --init                Initialise station before performing tests, ignored in
                            interactive mode [default: False]
      --log_level=LOG_LEVEL
                            Specify the log level [default: STEP]

Example usage
=============

Navigate to tests directory:

.. code-block::

    pushd src/ska_low_sps_testsuite/functional_tests/interactive_terminal

**NOTE:** Ensure you have followed the installation instructions and activated the correct virtual environment before continuing.

Execute the interactive terminal in interactive mode with a specified station configuration file:

.. code-block::

    python interactive_terminal.py --config=config.yml -i

For example on RAL :code:`te7dastardly` you could launch in interactive mode. Here you can select tests to run, to
initialise the station or to start the internal signal generator.

.. code-block::

    python interactive_terminal.py --config=/opt/sps/config/ral_subrack_te7dastardly.yml -i

Or initialise and run all tests from start to finish without interactive mode. This is equivalent to
executing :code:`station.py --config=config.yml -IPB` before starting the tests.

.. code-block::

    python interactive_terminal.py --config=/opt/sps/config/ral_subrack_te7dastardly.yml --init

Or initialise station and run a specified test:

.. code-block::

    python interactive_terminal.py --config=/opt/sps/config/ral_subrack_te7dastardly.yml --init --test=INIT_STATION

**NOTE:** The DAQ ethernet interface for the tests will be determined automatically from the destination IP addresses in the station config.