/usr/local/stat_watch/texts/ Current File: //usr/local/stat_watch/texts/help_tests.txt
TESTING STAT WATCH FUNCTIONALITY

Included with Stat Watch is a series of tests to verify that it is functioning as anticipated. These tests can be run with the executable '/usr/local/stat_watch/tests/test.sh'


USAGE

/usr/local/stat_watch/tests/test.sh
    - Iterate through all of the tests present
    - If any of the tests fail, stop at that point and leave working files intact so that the user can examine them and assess what caused the test to fail

/usr/local/stat_watch/tests/test.sh [TEST SCRIPT]
    - Run only the tests from specific test scripts
    - Multiple file names can be given, but all must be scripts within the /usr/local/stat_watch/tests/ directory

/usr/local/stat_watch/tests/test.sh --list
    - Just lists what each of the tests does
    - When used with any other arguments, "--list" must come first

/usr/local/stat_watch/tests/test.sh --skip [TEST SCRIPT]
    - Run all of the test scripts present, except for any specified
    - Multiple file names can be given, but all must be scripts within the /usr/local/stat_watch/tests/ directory

/usr/local/stat_watch/tests/test.sh --start [TEST SCRIPT]
    - Process the tests scripts that are present in order, starting with the test script specified
    - When using "--start" and "--skip", "--start" must be declared first

/usr/local/stat_watch/tests/test.sh --help
    - Outputs this text


FILES

/usr/local/stat_watch/tests/test.sh -
    - The script that iterates through and runs the test scripts

/usr/local/stat_watch/tests/tests_include.shf -
    - A file containing functions that are used across multiple tests

/usr/local/stat_watch/tests/tests_001.sh - 
    - One of the test scripts
    - Test scripts must be named in the following format:
        - "tests_", followed by a string composed only of numbers and/or underscores, followed by a period, followed by the appropriate file extension
    - These files should be not be executable; test.sh will give them execute permissions one-by-one as it runs them, and remove them when they have finished

/usr/local/stat_watch/tests/skipped_tests_001.sh -
    - When ever any test is designated to be skipped, this is accomplished by renaming it such that its file name begins with "skipped_"
    - When test.sh is run, before starting any of the tests, it renames any test files so that "skipped_" is removed from the beginning of their name

/usr/local/stat_watch/tests/tests_pre.sh -
    - If this script is present, it will be run before any tests
    - Unlike with the test scripts, this must be a .sh file

/usr/local/stat_watch/tests/tests_post.sh -
    - If this script is present, it will be run after the conclusion of all tests
        - If any of the tests fail, this script will not be run
    - Unlike with the test scripts, this must be a .sh file

/usr/local/stat_watch/tests/working -
    - This directory contains working files for the current test script. When ever possible, tests should not alter files outside of this directory
    - This directory is removed when test.sh successfully completes all tests; it should only be present if a test has failed


ENVIRONMENT VARIABLES

The testing process makes the following Environment Varialbes available to the test scripts that it runs:

"d_PROGRAM" -
    - Points to the installation directory of Stat Watch (typically /usr/local/stat_watch)

"d_PROGRAM_TESTS" - 
    - Points to "$d_PROGRAM"/tests

"d_PROGRAM_TESTS_WORKING" - 
    - Points to "$d_PROGRAM_TESTS"/working