Merge branch 'tizen' into security-manager

[platform/core/test/security-tests.git] / README

diff --git a/README b/README
index 65b2928..c946fe7 100644 (file)
--- a/README
+++ b/README
@@ -26,6 +26,10 @@ security-manager
 cynara
   cynara-test
 
+There are also inner-tests for testing complex security-tests framework
+mechanisms with binary:
+  security-tests-inner-test
+
 ==HOW TO RUN===================================================================
 
 Each test suite may be run with options:
@@ -152,13 +156,32 @@ dpl-test-framework
     RUNNER_ERROR_MSG
           Print error message using red color.
 
+--Defer macros-----------------------------------------------------------------
+Used to defer throwing TestException exceptions (TestFailed, TestIgnored)
+by catching them and rethrowing later. This mechanism can help in breaking
+test and passing test result from places where throwing exceptions
+is not allowed
+
+dpl-test-framework
+  test_runner.h
+    RUNNER_DEFER_TRYCATCH
+          Catches thrown TestException exceptions and stores them in TestRunner
+          structures for later use. This macro works only inside deffered scope
+          defined by RUNNER_DEFER_SCOPE, otherwise it won't catch exceptions
+    RUNNER_DEFER_SCOPE
+          Defines deferred scope. All RUNNER_DEFER_TRYCATCH macros used inside
+          the scope catch and save TestException exceptions. After scope is left
+          all saved exceptions take part in setting result of test. If there
+          is no any uncaught exception then additionally first of saved
+          exceptions is thrown.
+
 --Collectors-------------------------------------------------------------------
 Collectors are classes which collect test results. Each class does it differently.
 Collectors can be registered by --output parameter (see HOW TO RUN section) but
 there is also another collector created to write summary.
 
-tests-common
-  summary_collector.h
+dpl-test-framework
+  test_results_collector_summary.h
     SummaryCollector
           Collector writing tests summary. Call SummaryCollector::Register() to
           register it