Spoorthy Priya Yerabolu 0e599be5fc sanitycheck: Updating README file

Updated readme with coverage commands and
organization of tests

Signed-off-by: Spoorthy Priya Yerabolu <spoorthy.priya.yerabolu@intel.com>

2020-07-09 16:03:57 -05:00

Sanitycheck Testing

Running the tests require the environment variable ZEPHYR_BASE to be set.

Sanitycheck Testsuite are located in $ZEPHYR_BASE/scripts/tests directory with all the data files in $ZEPHYR_BASE/scripts/test_data directory.

Dependencies

Install all the dependencies using

pip install -r $ZEPHYR_BASE/scripts/tests/sanitycheck/requirements.txt

The testcases can be executed from the root directory using

pytest $ZEPHYR_BASE/scripts/tests/sanitycheck

The coverage for all the tests can be run using the command below. This will collect all the tests available.

coverage run -m pytest $ZEPHYR_BASE/scripts/tests/sanitycheck/

Then we can generate the coverage report for just sanitylib script using

coverage report -m $ZEPHYR_BASE/scripts/sanity_chk/sanitylib.py

To generate the coverage report for sanitycheck script use below command

coverage report -m $ZEPHYR_BASE/scripts/sanitycheck

The html coverage report for sanitycheck can be generated using

coverage html sanitycheck

If needed,the full coverage html report can be generated in every run of "pytest" in the tests directory using configuration file (setup.cfg).

conftest.py: Contains common fixtures for use in testing the sanitycheck tool.
test_sanitycheck.py : Contains basic testcases for environment variables, verifying testcase & platform schema's.
test_testsuite_class.py : Contains testcases for Testsuite class (except reporting functionality) in sanitylib.py.
test_testinstance.py : Contains testcases for Testinstance and Testcase class.
test_reporting_testsuite.py : Contains testcases for reporting fucntionality of Testsuite class of sanitycheck.