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