###############################
How to run the regression tests
###############################

1) Create a new file named: '.autosubmitrc'

2) The '.autosubmitrc' file should contain:

    [database]
    path = $PATH_TO_PROJECT/test/regression/db
    filename = autosubmit.db

    [local]
    path = $PATH_TO_PROJECT/test/regression/db

3) Review the credentials on the platforms config file of each test
or in the 'default_conf' directory

4) Run the 'tests_runner.py' file:

python tests_runner.py

NOTE: Remember that you need to have the Autosubmit installed before running these tests


##############################
How to enable the verbose mode
##############################

If you want to get all the outputs from the tests, you have to define an environment variable:

export AS_TEST_VERBOSE=DEBUG


###############################
How to disable the verbose mode
###############################

The regression test suite is check if there is an environment variable named 'AS_TEST_VERBOSE', so:

unset AS_TEST_VERBOSE

should be enough.


#############################
How to skip one or more tests
#############################

The 'test_runner' script allows an argument to skip some tests from the regression test suite.
So you can run it with the argument '--exclude' to skip some tests:

python tests_runner.py --exclude "test1 test2 test3"

As you can see on the example above, the list should be passed between quotes (") and the items
should be separated by a whitespace. Just to remind, the name of the tests should be the same as the
section on the 'tests.conf' file.


##########################
How to run only some tests
##########################

The 'test_runner' script allows an argument to run only some tests from the regression test suite.
So you can run it with the argument '--only' to determine which tests you wanna run:

python tests_runner.py --only "test1 test2 test3"

As you can see on the example above, the list should be passed between quotes (") and the items
should be separated by a whitespace. Just to remind, the name of the tests should be the same as the
section on the 'tests.conf' file.


#####################
How to add a new test
#####################

1) Create a folder with the test files (configuration and sources) following the same structure
as the other test folders.

2) Add the new test configuration in the `tests.conf` file following the same INI style.
