1 Testing environment {#auto_testing}
4 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.
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.
20 For target or desktop testing:
23 wget http://download.tizen.org/tct/2.2.1/2.2.1_r1/web-tct_2.2.1_r1.tar.gz
24 sudo tar xzf web-tct_2.2.1_r1.tar.gz
25 cd web-tct_2.2.1_r1/tools
26 sudo -E ./tct-config-host.sh
29 If you are planning on running tests on device, then plug in your freshly flashed device and run the following commands:
31 sudo apt-get install sdb
32 ./tct-config-device.sh
34 **NOTE:** After flashing a handset, you will need to run this step of the installation again.
39 Building libraries with coverage options
40 ----------------------------------------
42 Building dali adaptor:
44 cd dali-adaptor # the location of your dali-adaptor repository
48 git clean -fxd . # Only do this in the build folder
49 CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
52 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! )
54 Further note that, for the following, your gcov version must match the version of the compiler.
59 Run the following commands:
64 This will build dali-adaptor, dali-adaptor-internal and dali-platform-abstraction test sets.
66 Test sets can be built individually:
68 ./build.sh dali-adaptor
70 They can also be built without regenerating test case scripts (Useful for quicker rebuilds)
72 ./build.sh -n dali-adaptor
74 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
76 ./build.sh -n -r dali-adaptor
82 To see a list of all of the options:
86 To execute tests, cd into automated-tests and run
90 This will execute dali and dali-internal test sets. Note that the output summary for the first will be printed before running the second.
92 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
96 To use test kit lite, (which is very slow),
100 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
102 firefox --new-window summary.xml
104 To execute a subset of tests, you can run individual test sets, e.g.
106 ./execute.sh dali-adaptor
108 To get full coverage output (you need to first build dali libraries with
113 To check the coverage of your patch, (the build server uses its own copy
114 of these scripts), you can use
116 ./patch-coverage.pl -q [diff-spec]
120 ./patch-coverage.pl [diff-spec]
122 to get textual output, or
124 ./patch-coverage.pl -o out.html [diff-spec]
126 to get HTML output (used by build server).
128 diff-spec is any refspec accepted by git-diff. If it's left out, it creates
129 a refspec to the latest commit, or uses the index/working tree.
135 To build for target, first build and install dali-core, dali-adaptor and dali-toolkit.
137 You will need to install libconfig-tiny-perl:
139 sudo apt-get install libconfig-tiny-perl
141 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` ).
142 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
144 For Dali Adaptor, cd into automated-tests, and use:
146 sudo ./tcbuild build dali-adaptor
147 sudo ./tcbuild build dali-adaptor-internal
148 sudo ./tcbuild build dali-platform-abstraction
149 ./tcbuild install dali-adaptor
150 ./tcbuild install dali-adaptor-internal
151 ./tcbuild install dali-platform-abstraction
153 Ensure your handset's filesystem is writable:
155 sdb shell su -c "change-booting-mode.sh --update"
157 To execute tests, cd into automated-tests and run
161 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.
162 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.
164 You can find the output files under /opt/tct/manager/result/
173 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.
178 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-adaptor-internal test suite.
183 If you are adding test cases to existing files, then all you need to do is create functions with the method signature
185 int UtcTestcase(void)
187 TestApplication application;
192 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.
194 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.
196 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
198 If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
199 section of CMakeLists.txt (this is also parsed by an awk script prior to building)
203 Use DALI_TEST_EQUALS to test actual value against expected value, like this:
205 DALI_TEST_EQUALS( actor.GetProperty< float >( Actor::Property::COLOR_ALPHA ), 0.9f, TEST_LOCATION );
207 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:
209 DALI_TEST_GREATER( textureBindIndex[1], textureBindIndex[2], TEST_LOCATION );
211 When doing negative tests where your code uses DALI_ASSERT_ALWAYS, use the DALI_TEST_ASSERTION macro, like below:
215 animation.AnimateTo( Property( actor, Actor::Property::PARENT_ORIGIN ), targetParentOrigin );
216 }, "IsPropertyAnimatable( index )" );
218 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.
220 Note, DALI_ASSERT_DEBUG cannot be tested as tests execute against release version of the code.
222 Use additional scope to control the life of stack allocated objects, such as DALi handles
224 // try reparenting an orphaned child
226 Actor temporaryParent = Actor::New();
227 temporaryParent.Add( child );
228 DALI_TEST_EQUALS( parent2.GetChildCount(), 0u, TEST_LOCATION );
230 // temporaryParent has now died, reparent the orphaned child
231 parent2.Add( child );
232 DALI_TEST_EQUALS( parent2.GetChildCount(), 1u, TEST_LOCATION );
234 Always test the output of your test by making your code fail!!!
239 On desktop, you can debug the tests by running gdb on the test program:
242 $ gdb build/src/dali-adaptor/tct-dali-adaptor-core
245 replace `<TestCase>` with the name of the failing testcase.
247 For example, using testcase UtcDaliLoadCompletion from the dali-platform-abstraction test suite:
249 $ gdb build/src/dali-platform-abstraction/tct-dali-platform-abstraction-core
250 gdb> r UtcDaliLoadCompletion
253 On target, you can re-install the test RPM and associated debug RPMs manually using
255 sdb push <test-package>.rpm /tmp
257 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:
259 chsmack -e "^" /usr/bin/gdb
260 chsmack -e "^" /opt/usr/bin/tct-dali-adaptor-core/tct-dali-adaptor-core
262 then run it under gdb as above.
268 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)
270 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.
272 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.