automated-tests/README.md

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