1 Testing environment {#auto_testing}
4 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.
6 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)
11 There are usage instructions and installation instructions on the Tizen.org website [here](http://download.tizen.org/tct/2.2.1/Manual/Web_TCT_2.2.1_User_Guide_v1.0.pdf)
13 These are device specific instructions, however, installing the test suite will also provide the relevant packages for running tests on Ubuntu ( follow the first block of quickstart instructions below ).
15 If you are planning on running tests on device, then flash your handset with latest image, or turn off ssh: `set_usb_debug.sh --mtp-sdb` and plug it in, then follow the quickstart instructions repeated below.
17 Multi-language locale environment
18 ---------------------------------
20 Locales for English and Arabic must be installed to pass some test cases:
26 Installing fonts required by tests
27 ----------------------------------
29 The test suite requires certain fonts in the repository to be installed:
32 $ cp -r resources/fonts/* ~/.fonts/
38 For target or desktop testing:
41 wget http://download.tizen.org/tct/2.2.1/2.2.1_r1/web-tct_2.2.1_r1.tar.gz
42 sudo tar xzf web-tct_2.2.1_r1.tar.gz
43 cd web-tct_2.2.1_r1/tools
44 sudo -E ./tct-config-host.sh
47 If you are planning on running tests on device, then plug in your freshly flashed device and run the following commands:
49 sudo apt-get install sdb
50 ./tct-config-device.sh
52 **NOTE:** After flashing a handset, you will need to run this step of the installation again.
57 Building libraries with coverage options
58 ----------------------------------------
60 Building dali toolkit:
62 cd dali-toolkit # the location of your dali-toolkit repository
66 git clean -fxd . # Only do this in the build folder
67 CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
70 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! )
72 Further note that, for the following, your gcov version must match the version of the compiler.
77 Run the following commands:
82 This will build each of the test sets found under automated-tests/src.
84 Test sets can be built individually:
86 ./build.sh dali-toolkit
88 They can also be built without regenerating test case scripts (Useful for quicker rebuilds)
90 ./build.sh -n dali-toolkit-internal
92 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
94 ./build.sh -n -r dali-scene3d
100 To see a list of all of the options:
104 To execute tests, cd into automated-tests and run
108 To execute a subset of tests, you can run individual test sets, e.g.
112 To execute a specific test, just pass it on the command line:
114 ./execute.sh UtcDaliImageViewNewP
116 To execute a matching subset of tests, use the prefix option:
118 ./execute.sh -p UtcDaliImageView
120 will execute all tests that start with the prefix "UtcDaliImageView".
122 To use test kit lite, (which is very slow),
126 To see the test kit lite results, copy the style folder from web-tct_2.2.1_r1/tools/tct-mgr/style into automated-tests and run
128 firefox --new-window summary.xml
130 To get full coverage output (you need to first build dali libraries with
135 To check the coverage of your patch, (the build server uses its own copy
136 of these scripts), you can use
138 ./patch-coverage.pl -q [diff-spec]
142 ./patch-coverage.pl [diff-spec]
144 to get textual output, or
146 ./patch-coverage.pl -o out.html [diff-spec]
148 to get HTML output (used by build server).
150 diff-spec is any refspec accepted by git-diff. If it's left out, it creates
151 a refspec to the latest commit, or uses the index/working tree.
157 To build for target, first build and install dali-core, dali-adaptor and dali-toolkit.
159 You will need to install libconfig-tiny-perl:
161 sudo apt-get install libconfig-tiny-perl
163 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` ).
164 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
167 For Dali Toolkit, cd into automated-tests, and use:
169 sudo ./tcbuild build dali-physics
170 sudo ./tcbuild build dali-scene3d
171 sudo ./tcbuild build dali-scene3d-internal
172 sudo ./tcbuild build dali-shader-generator
173 sudo ./tcbuild build dali-toolkit
174 sudo ./tcbuild build dali-toolkit-internal
175 sudo ./tcbuild build dali-toolkit-styling
176 sudo ./tcbuild build dali-toolkit-third-party
177 ./tcbuild install dali-physics
178 ./tcbuild install dali-scene3d
179 ./tcbuild install dali-scene3d-internal
180 ./tcbuild install dali-shader-generator
181 ./tcbuild install dali-toolkit
182 ./tcbuild install dali-toolkit-internal
183 ./tcbuild install dali-toolkit-styling
184 ./tcbuild install dali-toolkit-third-party
186 Ensure your handset's filesystem is writable:
188 sdb shell su -c "change-booting-mode.sh --update"
190 To execute tests, cd into automated-tests and run
194 This will bring up the java test suite program. You should see the Plan pane with a list of all tests in. Select the tct-dali-core-tests. and you will be offered a dialog to choose a test plan: either create a new one or use temp.
195 Select dali test suite, and click Run, then "Create a new plan", and call it "Dali-Core" or some such. It will now run the dali-test suite.
197 You can find the output files under /opt/tct/manager/result/
206 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.
211 If you are adding test cases to existing files, then all you need to do is create functions with the method signature
213 int UtcTestcase(void)
215 TestApplication application;
220 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.
222 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.
224 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
226 If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
227 section of CMakeLists.txt (this is also parsed by an awk script prior to building)
231 Use DALI_TEST_EQUALS to test actual value against expected value, like this:
233 DALI_TEST_EQUALS( actor.GetProperty< float >( Actor::Property::COLOR_ALPHA ), 0.9f, TEST_LOCATION );
235 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:
237 DALI_TEST_GREATER( textureBindIndex[1], textureBindIndex[2], TEST_LOCATION );
239 When doing negative tests where your code uses DALI_ASSERT_ALWAYS, use the DALI_TEST_ASSERTION macro, like below:
243 animation.AnimateTo( Property( actor, Actor::Property::PARENT_ORIGIN ), targetParentOrigin );
244 }, "IsPropertyAnimatable( index )" );
246 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.
248 Note, DALI_ASSERT_DEBUG cannot be tested as tests execute against release version of the code.
250 Use additional scope to control the life of stack allocated objects, such as DALi handles
252 // try reparenting an orphaned child
254 Actor temporaryParent = Actor::New();
255 temporaryParent.Add( child );
256 DALI_TEST_EQUALS( parent2.GetChildCount(), 0u, TEST_LOCATION );
258 // temporaryParent has now died, reparent the orphaned child
259 parent2.Add( child );
260 DALI_TEST_EQUALS( parent2.GetChildCount(), 1u, TEST_LOCATION );
262 Always test the output of your test by making your code fail!!!
267 On desktop, you can debug the tests by running gdb on the test program:
270 $ ./execute.sh -d <TestCase>
273 replace `<TestCase>` with the name of the failing testcase.
275 For example, using testcase UtcDaliControlBackgroundProperties from the dali-toolkit test suite:
277 $ ./execute.sh -d UtcDaliControlBackgroundProperties
278 gdb> r UtcDaliControlBackgroundProperties
281 On target, you can re-install the test RPM and associated debug RPMs manually using
283 sdb push <test-package>.rpm /tmp
285 After installing the rpm and it's debug RPMs, you can find the executable in /opt/usr/bin/tct-dali-core. First ensure you have smack permissions set:
287 chsmack -e "^" /usr/bin/gdb
288 chsmack -e "^" /opt/usr/bin/tct-dali-toolkit-core/tct-dali-toolkit-core
290 then run it under gdb as above.
296 If when running tct-mgr tests, if "Health-Check get" fails and leaves a white screen on the device, you will need to run `tct-config-device.sh` from your `web-tct/tools` directory (wherever you untarred it) and power cycle your handset. If that still fails, you can work-around the issue by running "`mkdir –p /opt/usr/media/Documents/tct/`" on target – you may also need to kill the getCapabilities app from App Manager on the handset)
298 If the test results show that the test cases fail with "Undefined reference to XXX", it means you have probably failed to update the dali packages on target.
300 If all the tests are failing then make sure that you have enabled the engineering mode on the target with the 'change-booting-mode.sh --update' command in sdb shell, as the tests may not have installed correctly