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 toolkit:
  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     CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
  68     make -j8 install
  69
  70 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! )
  71
  72 Further note that, for the following, your gcov version must match the version of the compiler.
  73
  74 Building the tests
  75 ------------------
  76
  77 Run the following commands:
  78
  79     cd automated-tests
  80     ./build.sh
  81
  82 This will build dali-toolkit and dali-toolkit-internal test sets.
  83
  84 Test sets can be built individually:
  85
  86     ./build.sh dali-toolkit
  87
  88 They can also be built without regenerating test case scripts (Useful for quicker rebuilds)
  89
  90     ./build.sh -n dali-toolkit-internal
  91
  92 Or without cleaning down the build area (Useful for fast build/run/debug cycles)
  93
  94     ./build.sh -n -r dali-toolkit-internal
  95
  96
  97 Executing the tests
  98 -------------------
  99
 100 To see a list of all of the options:
 101
 102     ./execute.sh -h
 103
 104 To execute tests, cd into automated-tests and run
 105
 106     ./execute.sh
 107
 108 This will execute dali and dali-internal test sets. Note that the output summary for the first will be printed before running the second.
 109
 110 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
 111
 112     ./execute.sh -S
 113
 114 To use test kit lite, (which is very slow),
 115
 116     ./execute.sh -s
 117
 118 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
 119
 120     firefox --new-window summary.xml
 121
 122 To execute a subset of tests, you can run individual test sets, e.g.
 123
 124     ./execute.sh dali-toolkit
 125
 126 To get coverage output (you need to first build dali libraries with
 127 --coverage), run
 128
 129     ./coverage.sh
 130
 131
 132 Testing on target
 133 =================
 134
 135 To build for target, first build and install dali-core, dali-adaptor and dali-toolkit, then build dali-capi without --keep-packs option.
 136
 137 You will need to install libconfig-tiny-perl:
 138
 139 sudo apt-get install libconfig-tiny-perl
 140
 141 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` ).
 142 To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`).
 143
 144 For core Dali cd into automated-tests, and use:
 145
 146 sudo ./tcbuild build dali
 147
 148     sudo ./tcbuild build dali
 149     ./tcbuild install dali
 150
 151 For Dali Adaptor, cd into automated-tests, and use:
 152
 153     sudo ./tcbuild build dali-adaptor
 154     sudo ./tcbuild build dali-platform-abstraction
 155     ./tcbuild install dali-adaptor
 156     ./tcbuild install dali-platform-abstraction
 157
 158 Ensure your handset's filesystem is writable:
 159
 160     sdb shell su -c "change-booting-mode.sh --update"
 161
 162 To execute tests, cd into automated-tests and run
 163
 164     tct-mgr
 165
 166 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.
 167 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.
 168
 169 You can find the output files under /opt/tct/manager/result/
 170
 171
 172 Adding tests
 173 ============
 174
 175 To Managed API
 176 --------------
 177
 178 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.
 179
 180 For internal API
 181 ----------------
 182
 183 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.
 184
 185 General
 186 -------
 187
 188 If you are adding test cases to existing files, then all you need to do is create functions with the method signature
 189
 190     int UtcTestcase(void)
 191     {
 192       TestApplication application;
 193       ...
 194       END_TEST;
 195     }
 196
 197 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.
 198
 199 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.
 200
 201 If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace.
 202
 203 If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES...
 204 section of CMakeLists.txt (this is also parsed by an awk script prior to building)
 205
 206 Good Practices
 207 --------------
 208 Use DALI_TEST_EQUALS to test actual value against expected value, like this:
 209
 210     DALI_TEST_EQUALS( actor.GetProperty< float >( Actor::Property::COLOR_ALPHA ), 0.9f, TEST_LOCATION );
 211
 212 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:
 213
 214     DALI_TEST_GREATER( textureBindIndex[1], textureBindIndex[2], TEST_LOCATION );
 215
 216 When doing negative tests where your code uses DALI_ASSERT_ALWAYS, use the DALI_TEST_ASSERTION macro, like below:
 217
 218     DALI_TEST_ASSERTION(
 219     {
 220         animation.AnimateTo( Property( actor, Actor::Property::PARENT_ORIGIN ), targetParentOrigin );
 221     }, "IsPropertyAnimatable( index )" );
 222
 223 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.
 224
 225 Note, DALI_ASSERT_DEBUG cannot be tested as tests execute against release version of the code.
 226
 227 Use additional scope to control the life of stack allocated objects, such as DALi handles
 228
 229     // try reparenting an orphaned child
 230     {
 231         Actor temporaryParent = Actor::New();
 232         temporaryParent.Add( child );
 233         DALI_TEST_EQUALS( parent2.GetChildCount(), 0u, TEST_LOCATION );
 234     }
 235     // temporaryParent has now died, reparent the orphaned child
 236     parent2.Add( child );
 237     DALI_TEST_EQUALS( parent2.GetChildCount(), 1u, TEST_LOCATION );
 238
 239 Always test the output of your test by making your code fail!!!
 240
 241 Debugging
 242 =========
 243
 244 On desktop, you can debug the tests by running gdb on the test program:
 245
 246     $ cd automated-tests
 247     $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
 248     gdb> r <TestCase>
 249
 250 replace `<TestCase>` with the name of the failing testcase.
 251
 252 For example, using testcase UtcDaliControlBackgroundProperties from the dali-toolkit test suite:
 253
 254     $ gdb build/src/dali-toolkit/tct-dali-toolkit-core
 255     gdb> r UtcDaliControlBackgroundProperties
 256
 257
 258 On target, you can re-install the test RPM and associated debug RPMs manually using
 259
 260     sdb push <test-package>.rpm /tmp
 261
 262 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:
 263
 264     chsmack -e "^" /usr/bin/gdb
 265     chsmack -e "^" /opt/usr/bin/tct-dali-toolkit-core/tct-dali-toolkit-core
 266
 267 then run it under gdb as above.
 268
 269
 270 Troubleshooting
 271 ===============
 272
 273 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)
 274
 275 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.
 276
 277 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