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