diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index bd7f249337..685564cfe4 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -660,6 +660,7 @@ INPUT = main.dox \ ingest.dox \ contentViewer.dox \ report.dox \ + regressionTesting.dox \ ../../Case/src \ ../../CoreComponentInterfaces/src \ ../../CoreComponents/src \ @@ -672,7 +673,8 @@ INPUT = main.dox \ ../../MenuActions/src \ ../../RecentActivity/src \ ../../Report/src \ - ../../Testing/src + ../../Testing/src \ + ../../thunderbirdparser/src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/docs/doxygen/regressionTesting.dox b/docs/doxygen/regressionTesting.dox new file mode 100644 index 0000000000..89b4bd623e --- /dev/null +++ b/docs/doxygen/regressionTesting.dox @@ -0,0 +1,32 @@ +/*! \page regression_test_page Regression Testing + +\section regression_test_overview Overview + +Autopsy uses Netbeans and Jelly testing framework for regression testing. +Testing is driven by invoking UI actions via Jelly framework. + +Currently, Autopsy regression testing automates the following: + +- creating a case +- adding an image +- configuring ingest +- running ingest + +The tests can be invoked using ant regression-test + +There is a python script in Testing/script/regression.py that wraps around "ant regression-test" +and runs a test for every disk image it finds. + +regression.py also does regression test result validation by comparing the test result with the golden standards +for the image. + + +\section regression_test_setup Setting up regression testing + +\section regression_test_running Running regression testing + +\section regression_test_update Updating golden standards + + +*/ +