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)
export CC=gcc
export CXX=g++
git clean -fxd . # Only do this in the build folder
- autoreconf --install
- CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' ./configure --prefix=$DESKTOP_PREFIX --enable-debug
+ CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
make -j8 install
-Repeat for dali-adaptor and toolkit.
-
Note, you __must__ use a local build and not a distributed build, and you __must__ also build with debug enabled to allow *DALI_ASSERT_DEBUG* to trigger on wrong behaviour ( Which should always be a test case failure! )
+Further note that, for the following, your gcov version must match the version of the compiler.
+
Building the tests
------------------
./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:
-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
+ ./execute.sh UtcDaliActorNew
- ./execute.sh -S
+To execute a matching subset of tests, use the prefix option:
+
+ ./execute.sh -p UtcDaliActor
+
+will execute all tests that start with the prefix "UtcDaliActor".
To use test kit lite, (which is very slow),
firefox --new-window summary.xml
-To execute a subset of tests, you can run individual test sets, e.g.
-
- ./execute.sh dali
-
-To get coverage output (you need to first build dali libraries with
+To get full coverage output (you need to first build dali libraries with
--coverage), run
./coverage.sh
+To check the coverage of your patch, (the build server uses its own copy
+of these scripts), you can use
+
+ ./patch-coverage.pl -q [diff-spec]
+
+to get a summary, or
+
+ ./patch-coverage.pl [diff-spec]
+
+to get textual output, or
+
+ ./patch-coverage.pl -o out.html [diff-spec]
+
+to get HTML output (used by build server).
+
+diff-spec is any refspec accepted by git-diff. If it's left out, it creates
+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:
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:
+For Dali Core, 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
-
Ensure your handset's filesystem is writable:
sdb shell su -c "change-booting-mode.sh --update"
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
----------------
END_TEST;
}
+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.
-Note that **there must be no extra whitespace in the method signature** (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.
-
-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.
If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
section of CMakeLists.txt (this is also parsed by an awk script prior to building)
+Good Practices
+--------------
+Use DALI_TEST_EQUALS to test actual value against expected value, like this:
+
+ DALI_TEST_EQUALS( actor.GetProperty< float >( Actor::Property::COLOR_ALPHA ), 0.9f, TEST_LOCATION );
+
+This will speed up debugging in case the test some day fails. There is also a variant to test that value is greater than expected:
+
+ DALI_TEST_GREATER( textureBindIndex[1], textureBindIndex[2], TEST_LOCATION );
+
+When doing negative tests where your code uses DALI_ASSERT_ALWAYS, use the DALI_TEST_ASSERTION macro, like below:
+
+ DALI_TEST_ASSERTION(
+ {
+ animation.AnimateTo( Property( actor, Actor::Property::PARENT_ORIGIN ), targetParentOrigin );
+ }, "IsPropertyAnimatable( index )" );
+
+This macro will catch the DALi Exception and check that the correct assert message was included. It will also fail the test in case the assert did not occur. It also reduces the amount of false positive error logging whilst the is being thrown making it easier to see the real errors.
+
+Note, DALI_ASSERT_DEBUG cannot be tested as tests execute against release version of the code.
+
+Use additional scope to control the life of stack allocated objects, such as DALi handles
+
+ // try reparenting an orphaned child
+ {
+ Actor temporaryParent = Actor::New();
+ temporaryParent.Add( child );
+ DALI_TEST_EQUALS( parent2.GetChildCount(), 0u, TEST_LOCATION );
+ }
+ // temporaryParent has now died, reparent the orphaned child
+ parent2.Add( child );
+ DALI_TEST_EQUALS( parent2.GetChildCount(), 1u, TEST_LOCATION );
+
+Always test the output of your test by making your code fail!!!
+
Debugging
=========
On desktop, you can debug the tests by running gdb on the test program:
$ cd automated-tests
- $ gdb build/src/dali/tct-dali-core
+ $ ./execute.sh -d <TestCase>
gdb> r <TestCase>
replace `<TestCase>` with the name of the failing testcase.
For example, using testcase UtcDaliActorAddP from the dali-core test suite:
- $ gdb build/src/dali/tct-dali-core
+ $ ./execute.sh -d UtcDaliActorAddP
gdb> r UtcDaliActorAddP