From 29e1d6b49dab1ad36d29a26c990602873bb7e46d Mon Sep 17 00:00:00 2001 From: David Steele Date: Fri, 7 Nov 2014 13:25:08 +0000 Subject: [PATCH] Added readme and doxygen link for installing automated tests Change-Id: I33dce2fdf67c8023f0f422a3f33ecc42a21e0d12 Signed-off-by: David Steele --- automated-tests/README.md | 225 +++++++++++++++++++++++++++++++++++ automated-tests/scripts/add_style.pl | 5 +- build/tizen/docs/dali.doxy.in | 2 + docs/content/main-page.h | 2 + 4 files changed, 233 insertions(+), 1 deletion(-) create mode 100644 automated-tests/README.md diff --git a/automated-tests/README.md b/automated-tests/README.md new file mode 100644 index 0000000..19e7203 --- /dev/null +++ b/automated-tests/README.md @@ -0,0 +1,225 @@ +Testing environment {#auto_testing} +=================== + +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. + +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 'managed' tests (for testing the frozen API for products), unmanaged tests (tests for other APIs) and internal (for desktop testing only) + +Installation +------------ + +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) + +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 ). + +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. + +Quickstart +---------- + +For target or desktop testing: + + cd ~/Packages + wget http://download.tizen.org/tct/2.2.1/2.2.1_r1/web-tct_2.2.1_r1.tar.gz + sudo tar xzf web-tct_2.2.1_r1.tar.gz + cd web-tct_2.2.1_r1/tools + sudo -E ./tct-config-host.sh + + +If you are planning on running tests on device, then plug in your freshly flashed device and run the following commands: + + sudo apt-get install sdb + ./tct-config-device.sh + +**NOTE:** After flashing a handset, you will need to run this step of the installation again. + +Testing on desktop +================== + +Building libraries with coverage options +---------------------------------------- + +Building dali core: + + cd dali-core # the location of your dali-core repository + cd build/tizen + export CC=gcc + export CXX=g++ + git clean -fxd . # Only do this in the build folder + autoreconf --install + CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' ./configure --prefix=$DESKTOP_PREFIX --enable-debug + make -j8 install + +Repeat for dali-adaptor and toolkit. + +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! ) + +Building the tests +------------------ + +Run the following commands: + + cd automated-tests + ./build.sh + +This will build dali, dali-unmanaged and dali-internal test sets. + +Test sets can be built individually: + + ./build.sh dali-unmanaged + +They can also be built without regenerating test case scripts (Useful for quicker rebuilds) + + ./build.sh -n dali-internal + +Or without cleaning down the build area (Useful for fast build/run/debug cycles) + + ./build.sh -n -r dali-internal + + +Executing the tests +------------------- + +To execute tests, cd into automated-tests and run + + ./execute.sh + +This will execute dali, dali-unmanaged and dali-internal test sets. Note that the output summary for the first will be printed before running the second. + +To execute a subset of tests, you can run individual test sets, e.g. + + ./execute.sh dali + +or for finer granularity, specify a test source file: + + ./execute.sh dali utc-Dali-Actor.cpp + +To see the results, you can open the summary.xml in firefox. + + firefox --new-window summary.xml + +To get coverage output, run + + ./coverage.sh + + +Testing on target +================= + +To build for target, first build and install dali-core, dali-adaptor and dali-toolkit, then build dali-capi without --keep-packs option. + +You will need to install libconfig-tiny-perl: + +sudo apt-get install libconfig-tiny-perl + +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` ). +To install on device from a non-standard GBS_ROOT, also modify line 28 (`RPM_DIR="$HOME/GBS-ROOT/local/repos/$PROFILE/armv7l/RPMS"`). + +For core Dali cd into automated-tests, and use: + +sudo ./tcbuild build dali + + sudo ./tcbuild build dali-unmanaged + ./tcbuild install dali + ./tcbuild install dali-unmanaged + +For Dali Adaptor, cd into automated-tests, and use: + + sudo ./tcbuild build dali-adaptor + sudo ./tcbuild build dali-adaptor-unmanaged # < Currently failing as needs a ".spec" file. + sudo ./tcbuild build dali-platform-abstraction + ./tcbuild install dali-adaptor + ./tcbuild install dali-adaptor-unmanaged + ./tcbuild install dali-platform-abstraction + +Ensure your handset's filesystem is writable: + + sdb shell su -c "change-booting-mode.sh --update" + +To execute tests, cd into automated-tests and run + + tct-mgr + +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 tct-dali-unmanaged-tests. and you will be offered a dialog to choose a test plan: either create a new one or use temp. +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. + +You can find the output files under /opt/tct/manager/result/ + + +Adding tests +============ + +To Managed API +-------------- + +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. + +To Unmanaged API +---------------- + +If you are adding test cases for unmanaged API, you need to add your changes to the src/dali-unmanaged test suite. + +For internal API +---------------- + +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. + +General +------- + +If you are adding test cases to existing files, then all you need to do is create functions with the method signature + + int UtcTestcase(void) + { + TestApplication application; + ... + END_TEST; + } + + +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. + +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. + +If you need any non-test methods or variables, ensure they are wrapped in an anonymous namespace. + +If you are adding new test files, then you need to add the filename to the SET(TC_SOURCES... +section of CMakeLists.txt (this is also parsed by an awk script prior to building) + +Debugging +========= + +On desktop, you can debug the tests by running gdb on the test program: + + $ cd automated-tests + $ gdb build/src/dali/tct-dali-core + gdb> r + +replace `` with the name of the failing testcase. + +For example, using testcase UtcDaliNinePatch01 from the dali-core unmanaged test suite: + + $ gdb build/src/dali-unmanaged/tct-dali-unmanaged-core + gdb> r UtcDaliNinePatch01 + + +On target, you can re-install the test RPM and associated debug RPMs manually using + + sdb push .rpm /tmp + +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: + + chsmack -e "^" /usr/bin/gdb + chsmack -e "^" /opt/usr/bin/tct-dali-core/tct-dali-core + +then run it under gdb as above. + + +Troubleshooting +=============== + +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) + +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. + +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. diff --git a/automated-tests/scripts/add_style.pl b/automated-tests/scripts/add_style.pl index 95888f9..e958842 100755 --- a/automated-tests/scripts/add_style.pl +++ b/automated-tests/scripts/add_style.pl @@ -19,7 +19,10 @@ print RESULTS_OUT $fline; print RESULTS_OUT "\n"; while() { - print RESULTS_OUT $_; + if( ! /xml-stylesheet/ ) + { + print RESULTS_OUT $_; + } } close RESULTS_OUT; close RESULTS; diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index ba01ad5..762e66c 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -554,6 +554,7 @@ WARN_LOGFILE = INPUT = @DOXYGEN_DOCS_DIR@/content \ ../../../../dali-toolkit/base/dali-toolkit/public-api \ ../../../../dali-toolkit/optional/dali-toolkit/public-api \ + ../../../automated-tests/README.md \ @prefix@/include/dali # This tag can be used to specify the character encoding of the source files @@ -595,6 +596,7 @@ FILE_PATTERNS = *.c \ *.php3 \ *.inc \ *.m \ + *.md \ *.mm \ *.dox \ *.py \ diff --git a/docs/content/main-page.h b/docs/content/main-page.h index 61619dd..1d2b483 100644 --- a/docs/content/main-page.h +++ b/docs/content/main-page.h @@ -69,6 +69,8 @@ * - \link texture-atlases Texture Atlases \endlink * - \link Texture_Compression Compressing Textures \endlink * + * \section Testing + * See [Automated Tests](@ref auto_testing) for instructions. */ /*! \page scene-graph -- 2.7.4