72d74730f04d9b8d33bee0b5c6a3dc36846a46c0
[platform/core/uifw/dali-toolkit.git] / automated-tests / README.md
1 Testing environment   {#auto_testing}
2 ===================
3
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.
5
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)
7
8 Installation
9 ------------
10
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)
12
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 ).
14
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.
16
17 Multi-language locale environment
18 ---------------------------------
19
20 Locales for English and Arabic must be installed to pass some test cases:
21
22 $ sudo locale-gen en
23 $ sudo locale-gen ar
24 $ sudo update-locale
25
26
27 Quickstart
28 ----------
29
30 For target or desktop testing:
31
32     cd ~/Packages
33     wget http://download.tizen.org/tct/2.2.1/2.2.1_r1/web-tct_2.2.1_r1.tar.gz
34     sudo tar xzf web-tct_2.2.1_r1.tar.gz
35     cd web-tct_2.2.1_r1/tools
36     sudo -E ./tct-config-host.sh
37
38
39 If you are planning on running tests on device, then plug in your freshly flashed device and run the following commands:
40
41     sudo apt-get install sdb
42     ./tct-config-device.sh
43
44 **NOTE:** After flashing a handset, you will need to run this step of the installation again.
45
46 Testing on desktop
47 ==================
48
49 Building libraries with coverage options
50 ----------------------------------------
51
52 Building dali core:
53
54     cd dali-core  # the location of your dali-core repository
55     cd build/tizen
56     export CC=gcc
57     export CXX=g++
58     git clean -fxd . # Only do this in the build folder
59     autoreconf --install
60     CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' ./configure --prefix=$DESKTOP_PREFIX --enable-debug
61     make -j8 install
62
63 Repeat for dali-adaptor and toolkit.
64
65 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! )
66
67 Building the tests
68 ------------------
69
70 Run the following commands:
71
72     cd automated-tests
73     ./build.sh
74
75 This will build dali-toolkit and dali-toolkit-internal test sets.
76
77 Test sets can be built individually:
78
79     ./build.sh dali-toolkit
80
81 They can also be built without regenerating test case scripts (Useful for quicker rebuilds)
82
83     ./build.sh -n dali-toolkit-internal
84
85 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
86
87     ./build.sh -n -r dali-toolkit-internal
88
89
90 Executing the tests
91 -------------------
92
93 To see a list of all of the options:
94
95     ./execute.sh -h
96
97 To execute tests, cd into automated-tests and run
98
99     ./execute.sh
100
101 This will execute dali and dali-internal test sets. Note that the output summary for the first will be printed before running the second.
102
103 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
104
105     ./execute.sh -S
106
107 To use test kit lite, (which is very slow),
108
109     ./execute.sh -s
110
111 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
112
113     firefox --new-window summary.xml
114
115 To execute a subset of tests, you can run individual test sets, e.g.
116
117     ./execute.sh dali-toolkit
118
119 To get coverage output (you need to first build dali libraries with
120 --coverage), run
121
122     ./coverage.sh
123
124
125 Testing on target
126 =================
127
128 To build for target, first build and install dali-core, dali-adaptor and dali-toolkit, then build dali-capi without --keep-packs option.
129
130 You will need to install libconfig-tiny-perl:
131
132 sudo apt-get install libconfig-tiny-perl
133
134 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` ).
135 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
136
137 For core Dali cd into automated-tests, and use:
138
139 sudo ./tcbuild build dali
140
141     sudo ./tcbuild build dali
142     ./tcbuild install dali
143
144 For Dali Adaptor, cd into automated-tests, and use:
145
146     sudo ./tcbuild build dali-adaptor
147     sudo ./tcbuild build dali-platform-abstraction
148     ./tcbuild install dali-adaptor
149     ./tcbuild install dali-platform-abstraction
150
151 Ensure your handset's filesystem is writable:
152
153     sdb shell su -c "change-booting-mode.sh --update"
154
155 To execute tests, cd into automated-tests and run
156
157     tct-mgr
158
159 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.
160 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.
161
162 You can find the output files under /opt/tct/manager/result/
163
164
165 Adding tests
166 ============
167
168 To Managed API
169 --------------
170
171 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.
172
173 For internal API
174 ----------------
175
176 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.
177
178 General
179 -------
180
181 If you are adding test cases to existing files, then all you need to do is create functions with the method signature
182
183     int UtcTestcase(void)
184     {
185       TestApplication application;
186       ...
187       END_TEST;
188     }
189
190
191 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.
192
193 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.
194
195 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
196
197 If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
198 section of CMakeLists.txt (this is also parsed by an awk script prior to building)
199
200 Debugging
201 =========
202
203 On desktop, you can debug the tests by running gdb on the test program:
204
205     $ cd automated-tests
206     $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
207     gdb> r <TestCase>
208
209 replace `<TestCase>` with the name of the failing testcase.
210
211 For example, using testcase UtcDaliControlBackgroundProperties from the dali-toolkit test suite:
212
213     $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
214     gdb> r UtcDaliControlBackgroundProperties
215
216
217 On target, you can re-install the test RPM and associated debug RPMs manually using
218
219     sdb push <test-package>.rpm /tmp
220
221 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:
222
223     chsmack -e "^" /usr/bin/gdb
224     chsmack -e "^" /opt/usr/bin/tct-dali-toolkit-core/tct-dali-toolkit-core
225
226 then run it under gdb as above.
227
228
229 Troubleshooting
230 ===============
231
232 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)
233
234 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.
235
236 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