automated-tests/README.md

   1 Testing environment   {#auto_testing}
   2 ===================
   3
   4 The current 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. The tests remain compatible with the previous TET test suite.
   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     CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
  50     make -j8 install
  51
  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! )
  53
  54 Further note that, for the following, your gcov version must match the version of the compiler.
  55
  56 Building the tests
  57 ------------------
  58
  59 Run the following commands:
  60
  61     cd automated-tests
  62     ./build.sh
  63
  64 This will build dali and dali-internal test sets.
  65
  66 Test sets can be built individually:
  67
  68     ./build.sh dali
  69
  70 They can also be built without regenerating test case scripts (Useful for quicker rebuilds)
  71
  72     ./build.sh -n dali-internal
  73
  74 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
  75
  76     ./build.sh -n -r dali-internal
  77
  78
  79 Executing the tests
  80 -------------------
  81
  82 To see a list of all of the options:
  83
  84     ./execute.sh -h
  85
  86 To execute tests, cd into automated-tests and run
  87
  88     ./execute.sh
  89
  90 To execute a subset of tests, you can run individual test sets, e.g.
  91
  92     ./execute.sh dali
  93
  94 To execute a specific test, just pass it on the command line:
  95
  96     ./execute.sh UtcDaliActorNew
  97
  98 To execute a matching subset of tests, use the prefix option:
  99
 100     ./execute.sh -p UtcDaliActor
 101
 102 will execute all tests that start with the prefix "UtcDaliActor".
 103
 104 To use test kit lite, (which is very slow),
 105
 106     ./execute.sh -s
 107
 108 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
 109
 110     firefox --new-window summary.xml
 111
 112 To get full coverage output (you need to first build dali libraries with
 113 --coverage), run
 114
 115     ./coverage.sh
 116
 117 To check the coverage of your patch, (the build server uses its own copy
 118 of these scripts), you can use
 119
 120     ./patch-coverage.pl -q [diff-spec]
 121
 122 to get a summary, or
 123
 124     ./patch-coverage.pl [diff-spec]
 125
 126 to get textual output, or
 127
 128     ./patch-coverage.pl -o out.html [diff-spec]
 129
 130 to get HTML output (used by build server).
 131
 132 diff-spec is any refspec accepted by git-diff. If it's left out, it creates
 133 a refspec to the latest commit, or uses the index/working tree.
 134
 135
 136
 137 Testing on target
 138 =================
 139
 140 To build for target, first build and install dali-core, dali-adaptor and dali-toolkit.
 141
 142 You will need to install libconfig-tiny-perl:
 143
 144 sudo apt-get install libconfig-tiny-perl
 145
 146 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` ).
 147 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
 148
 149 For Dali Core, cd into automated-tests, and use:
 150
 151 sudo ./tcbuild build dali
 152
 153     sudo ./tcbuild build dali
 154     ./tcbuild install dali
 155
 156 Ensure your handset's filesystem is writable:
 157
 158     sdb shell su -c "change-booting-mode.sh --update"
 159
 160 To execute tests, cd into automated-tests and run
 161
 162     tct-mgr
 163
 164 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.
 165 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.
 166
 167 You can find the output files under /opt/tct/manager/result/
 168
 169
 170 Adding tests
 171 ============
 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 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.
 191
 192 You can use the previous TET api, e.g. `tet_infoline`, `tet_result` and our test check methods `DALI_TEST_CHECK`, `DALI_TEST_EQUALS`, etc.
 193
 194 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
 195
 196 If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
 197 section of CMakeLists.txt (this is also parsed by an awk script prior to building)
 198
 199 Good Practices
 200 --------------
 201 Use DALI_TEST_EQUALS to test actual value against expected value, like this:
 202
 203     DALI_TEST_EQUALS( actor.GetProperty< float >( Actor::Property::COLOR_ALPHA ), 0.9f, TEST_LOCATION );
 204
 205 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:
 206
 207     DALI_TEST_GREATER( textureBindIndex[1], textureBindIndex[2], TEST_LOCATION );
 208
 209 When doing negative tests where your code uses DALI_ASSERT_ALWAYS, use the DALI_TEST_ASSERTION macro, like below:
 210
 211     DALI_TEST_ASSERTION(
 212     {
 213         animation.AnimateTo( Property( actor, Actor::Property::PARENT_ORIGIN ), targetParentOrigin );
 214     }, "IsPropertyAnimatable( index )" );
 215
 216 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.
 217
 218 Note, DALI_ASSERT_DEBUG cannot be tested as tests execute against release version of the code.
 219
 220 Use additional scope to control the life of stack allocated objects, such as DALi handles
 221
 222     // try reparenting an orphaned child
 223     {
 224         Actor temporaryParent = Actor::New();
 225         temporaryParent.Add( child );
 226         DALI_TEST_EQUALS( parent2.GetChildCount(), 0u, TEST_LOCATION );
 227     }
 228     // temporaryParent has now died, reparent the orphaned child
 229     parent2.Add( child );
 230     DALI_TEST_EQUALS( parent2.GetChildCount(), 1u, TEST_LOCATION );
 231
 232 Always test the output of your test by making your code fail!!!
 233
 234 Debugging
 235 =========
 236
 237 On desktop, you can debug the tests by running gdb on the test program:
 238
 239     $ cd automated-tests
 240     $ ./execute.sh -d <TestCase>
 241     gdb> r <TestCase>
 242
 243 replace `<TestCase>` with the name of the failing testcase.
 244
 245 For example, using testcase UtcDaliActorAddP from the dali-core test suite:
 246
 247     $ ./execute.sh -d UtcDaliActorAddP
 248     gdb> r UtcDaliActorAddP
 249
 250
 251 On target, you can re-install the test RPM and associated debug RPMs manually using
 252
 253     sdb push <test-package>.rpm /tmp
 254
 255 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:
 256
 257     chsmack -e "^" /usr/bin/gdb
 258     chsmack -e "^" /opt/usr/bin/tct-dali-core/tct-dali-core
 259
 260 then run it under gdb as above.
 261
 262
 263 Troubleshooting
 264 ===============
 265
 266 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)
 267
 268 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.
 269
 270 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