[Tizen] Support asan build option
[platform/core/uifw/dali-toolkit.git] / automated-tests / README.md
index 590571d..f58ffdb 100644 (file)
@@ -1,7 +1,7 @@
 Testing environment   {#auto_testing}
 ===================
 
-The new test environment from Tizen is the Web-TCT test suite. This was written for testing web components, but can easily be used for testing Dali.
+The current test environment from Tizen is the Web-TCT test suite. This was written for testing web components, but can easily be used for testing Dali. The tests remain compatible with the previous TET test suite.
 
 Each of the DALi repositories, **dali-core**, **dali-adaptor** and **dali-toolkit**, have their own test suites under the `automated-tests` folder. Within the src folder are a number of secondary folders - these correspond to 'API' tests  and internal (for desktop testing only)
 
@@ -59,7 +59,7 @@ Building libraries with coverage options
 
 Building dali toolkit:
 
-    cd dali-core  # the location of your dali-core repository
+    cd dali-toolkit  # the location of your dali-toolkit repository
     cd build/tizen
     export CC=gcc
     export CXX=g++
@@ -79,7 +79,7 @@ Run the following commands:
     cd automated-tests
     ./build.sh
 
-This will build dali-toolkit and dali-toolkit-internal test sets.
+This will build each of the test sets found under automated-tests/src.
 
 Test sets can be built individually:
 
@@ -91,7 +91,7 @@ They can also be built without regenerating test case scripts (Useful for quicke
 
 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
 
-    ./build.sh -n -r dali-toolkit-internal
+    ./build.sh -n -r dali-scene3d
 
 
 Executing the tests
@@ -105,11 +105,19 @@ To execute tests, cd into automated-tests and run
 
     ./execute.sh
 
-This will execute dali and dali-internal test sets. Note that the output summary for the first will be printed before running the second.
+To execute a subset of tests, you can run individual test sets, e.g.
+
+    ./execute.sh dali
+
+To execute a specific test, just pass it on the command line:
+
+    ./execute.sh UtcDaliImageViewNewP
 
-By default the tests execute in parallel, which is faster but does not produce any test case output files.  Use this to execute the tests in series and log test output to stdout/err
+To execute a matching subset of tests, use the prefix option:
 
-    ./execute.sh -S
+    ./execute.sh -p UtcDaliImageView
+
+will execute all tests that start with the prefix "UtcDaliImageView".
 
 To use test kit lite, (which is very slow),
 
@@ -119,10 +127,6 @@ To see the test kit lite results, copy the style folder from web-tct_2.2.1_r1/to
 
     firefox --new-window summary.xml
 
-To execute a subset of tests, you can run individual test sets, e.g.
-
-    ./execute.sh dali-toolkit
-
 To get full coverage output (you need to first build dali libraries with
 --coverage), run
 
@@ -150,7 +154,7 @@ a refspec to the latest commit, or uses the index/working tree.
 Testing on target
 =================
 
-To build for target, first build and install dali-core, dali-adaptor and dali-toolkit, then build dali-capi without --keep-packs option.
+To build for target, first build and install dali-core, dali-adaptor and dali-toolkit.
 
 You will need to install libconfig-tiny-perl:
 
@@ -159,19 +163,25 @@ sudo apt-get install libconfig-tiny-perl
 If you use a non-standard `GBS_ROOT` then you will need to edit the tcbuild script to match your configuration - change line 96 and add a -B option with your GBS-ROOT path (line 96 = `gbs build -A armv7l --spec core-$1-tests.spec --include-all --keep-packs` ).
 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
 
-For core Dali cd into automated-tests, and use:
-
-sudo ./tcbuild build dali
-
-    sudo ./tcbuild build dali
-    ./tcbuild install dali
-
-For Dali Adaptor, cd into automated-tests, and use:
 
-    sudo ./tcbuild build dali-adaptor
-    sudo ./tcbuild build dali-platform-abstraction
-    ./tcbuild install dali-adaptor
-    ./tcbuild install dali-platform-abstraction
+For Dali Toolkit, cd into automated-tests, and use:
+
+    sudo ./tcbuild build dali-physics
+    sudo ./tcbuild build dali-scene3d
+    sudo ./tcbuild build dali-scene3d-internal
+    sudo ./tcbuild build dali-shader-generator
+    sudo ./tcbuild build dali-toolkit
+    sudo ./tcbuild build dali-toolkit-internal
+    sudo ./tcbuild build dali-toolkit-styling
+    sudo ./tcbuild build dali-toolkit-third-party
+    ./tcbuild install dali-physics
+    ./tcbuild install dali-scene3d
+    ./tcbuild install dali-scene3d-internal
+    ./tcbuild install dali-shader-generator
+    ./tcbuild install dali-toolkit
+    ./tcbuild install dali-toolkit-internal
+    ./tcbuild install dali-toolkit-styling
+    ./tcbuild install dali-toolkit-third-party
 
 Ensure your handset's filesystem is writable:
 
@@ -190,15 +200,10 @@ You can find the output files under /opt/tct/manager/result/
 Adding tests
 ============
 
-To Managed API
---------------
-
-If you are adding test cases for new or existing managed API (CAPI), you need to add your changes to the src/dali mirror, and copy your change to the managed test suite in core-api. You need to inform HQ of your update.
-
 For internal API
 ----------------
 
-If you are adding tests for internal API, then this will only work on desktop, and you should add your tests to the src/dali-internal test suite.
+If you are adding tests for internal API, then this will only work on desktop, and you should add your tests to the src/dali-toolkit-internal test suite.
 
 General
 -------
@@ -214,7 +219,7 @@ If you are adding test cases to existing files, then all you need to do is creat
 
 Note that **the parentheses in the method signature must not be empty** (i.e., it must violate our coding convention and follow __exactly__ this pattern: `int UtcDaliMyTestcaseName(void)`), as it's parsed by an awk script to auto-generate the testcase arrays in the main header file. Neither may any comments on the same line contain empty parentheses.
 
-You can contine to use the TET api, e.g. `tet_infoline`, `tet_result` and our test check methods `DALI_TEST_CHECK`, `DALI_TEST_EQUALS`, etc.
+You can use the previous TET api, e.g. `tet_infoline`, `tet_result` and our test check methods `DALI_TEST_CHECK`, `DALI_TEST_EQUALS`, etc.
 
 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
 
@@ -262,14 +267,14 @@ Debugging
 On desktop, you can debug the tests by running gdb on the test program:
 
     $ cd automated-tests
-    $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
+    $ ./execute.sh -d <TestCase>
     gdb> r <TestCase>
 
 replace `<TestCase>` with the name of the failing testcase.
 
 For example, using testcase UtcDaliControlBackgroundProperties from the dali-toolkit test suite:
 
-    $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
+    $ ./execute.sh -d UtcDaliControlBackgroundProperties
     gdb> r UtcDaliControlBackgroundProperties