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