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