Projects/PIM/Akonadi/Testing - Revision history

Mamarok: added category

2012-04-10T13:27:15Z

added category

Neverendingo: Text replace - "" to ""

2011-06-30T10:20:15Z

Text replace - "<syntaxhighlight lang="make">" to "<syntaxhighlight lang="cmake">"

Neverendingo: /* Non-Interactive Use */

2011-06-29T20:01:15Z

‎Non-Interactive Use

Neverendingo: /* Creating Testrunner Environments */

2011-06-29T20:00:50Z

‎Creating Testrunner Environments

Neverendingo: Text replace - "`" to ""`


2011-06-29T19:57:01Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 19:57, 29 June 2011
			
Line 28:
Line 28:
  The environment description file (''config.xml'')looks like this:   The environment description file (''config.xml'')looks like this:
    
− <code xml> + <syntaxhighlight lang="xml">
  <config>   <config>
     <!--  path to KDE configuration ($KDEHOME) -->      <!--  path to KDE configuration ($KDEHOME) -->



Neverendingo: Text replace - "" to ""

2011-06-29T19:50:46Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 19:50, 29 June 2011
			
Line 52:
Line 52:
  Global configuration files can be provided in the same way, ''akonadi-firstrunrc'' as shown below is in particular useful to avoid the Akonadi default setup mechanism interfering with the test:   Global configuration files can be provided in the same way, ''akonadi-firstrunrc'' as shown below is in particular useful to avoid the Akonadi default setup mechanism interfering with the test:
    
− <code ini> + <syntaxhighlight lang="ini">
  [ProcessedDefaults]   [ProcessedDefaults]
  defaultaddressbook=done   defaultaddressbook=done
Line 60:
Line 60:
  Same for ''kdedrc'' which allows to disable kbuilsycoca4. That can greatly speed up tests.   Same for ''kdedrc'' which allows to disable kbuilsycoca4. That can greatly speed up tests.
    
− <code ini> + <syntaxhighlight lang="ini">
  [General]   [General]
  CheckSycoca=false   CheckSycoca=false



Neverendingo: Text replace - "" to ""

2011-06-29T19:48:49Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 19:48, 29 June 2011
			
Line 76:
Line 76:
  First, start the testrunner:   First, start the testrunner:
    
− <code bash> + <syntaxhighlight lang="bash">
  $ akonaditest -c config.xml --testenv /path/to/testenvironment.sh &   $ akonaditest -c config.xml --testenv /path/to/testenvironment.sh &
  </syntaxhighlight>   </syntaxhighlight>
Line 84:
Line 84:
  Once the setup is complete, it creates a shell script containing the necessary environment variable changes to switch into the test environment:   Once the setup is complete, it creates a shell script containing the necessary environment variable changes to switch into the test environment:
    
− <code bash> + <syntaxhighlight lang="bash">
  $ source /path/to/testenvironment.sh   $ source /path/to/testenvironment.sh
  </syntaxhighlight>   </syntaxhighlight>
Line 92:
Line 92:
  To terminate and cleanup the test environment, run:   To terminate and cleanup the test environment, run:
    
− <code bash> + <syntaxhighlight lang="bash">
  $ shutdown-testenvironment   $ shutdown-testenvironment
  </syntaxhighlight>   </syntaxhighlight>
Line 102:
Line 102:
  ''kdepimlibs/akonadi/tests'' uses the Akonadi Testrunner to run unittests in an isolated environment. For automated usage, the testrunner can be used in a non-interactive way:   ''kdepimlibs/akonadi/tests'' uses the Akonadi Testrunner to run unittests in an isolated environment. For automated usage, the testrunner can be used in a non-interactive way:
    
− <code bash> + <syntaxhighlight lang="bash">
  $ akonaditest -c config.xml <comand> <params>   $ akonaditest -c config.xml <comand> <params>
  </syntaxhighlight>   </syntaxhighlight>
Line 182:
Line 182:
  The tests can be run automatically using ctest/make test as usual.  To run a single test manually, it needs to be executed using the Akonadi testrunner:   The tests can be run automatically using ctest/make test as usual.  To run a single test manually, it needs to be executed using the Akonadi testrunner:
    
− <code bash> + <syntaxhighlight lang="bash">
  $ cd kdepimlibs/akonadi/test   $ cd kdepimlibs/akonadi/test
  $ akonaditest -c unittest/config.xml $BUILDDIR/test_executable.shell   $ akonaditest -c unittest/config.xml $BUILDDIR/test_executable.shell



Neverendingo: Text replace - "" to ""
2011-06-29T19:42:28Z
Text replace - "</code>" to "</syntaxhighlight>"

				
				
				
				
			
			← Older revision
			Revision as of 19:42, 29 June 2011
			
Line 24:
Line 24:
  unittestenv/kdehome/testdata.xml   unittestenv/kdehome/testdata.xml
  unittestenv/xdgconfig   unittestenv/xdgconfig
− </code> + </syntaxhighlight>
    
  The environment description file (''config.xml'')looks like this:   The environment description file (''config.xml'')looks like this:
Line 43:
Line 43:
     <envvar name="AKONADI_DISABLE_AGENT_AUTOSTART">true</envvar>      <envvar name="AKONADI_DISABLE_AGENT_AUTOSTART">true</envvar>
  </config>   </config>
− </code> + </syntaxhighlight>
    
  The first three elements define the relevant paths inside the environment data, relative to the ''config.xml'' file.   The first three elements define the relevant paths inside the environment data, relative to the ''config.xml'' file.
Line 56:
Line 56:
  defaultaddressbook=done   defaultaddressbook=done
  defaultcalendar=done   defaultcalendar=done
− </code> + </syntaxhighlight>
    
  Same for ''kdedrc'' which allows to disable kbuilsycoca4. That can greatly speed up tests.   Same for ''kdedrc'' which allows to disable kbuilsycoca4. That can greatly speed up tests.
Line 64:
Line 64:
  CheckSycoca=false   CheckSycoca=false
  CheckFileStamps=false   CheckFileStamps=false
− </code> + </syntaxhighlight>
    
  The ''&lt;envvar&gt;'' element allows you to set arbitrary environment variables inside the test environment. One useful example is ''AKONADI_DISABLE_AGENT_AUTOSTART'' which will prevent the Akonadi server from starting autostart agents, which can further speed up the setup process.   The ''&lt;envvar&gt;'' element allows you to set arbitrary environment variables inside the test environment. One useful example is ''AKONADI_DISABLE_AGENT_AUTOSTART'' which will prevent the Akonadi server from starting autostart agents, which can further speed up the setup process.
Line 78:
Line 78:
  <code bash>   <code bash>
  $ akonaditest -c config.xml --testenv /path/to/testenvironment.sh &   $ akonaditest -c config.xml --testenv /path/to/testenvironment.sh &
− </code> + </syntaxhighlight>
    
  '''Note''': Although the testenv parameter is not required, it makes life a bit easier when testing manual. If you don't pass it the script will be generated in a temporary dir and is therefore a bit harder to find.   '''Note''': Although the testenv parameter is not required, it makes life a bit easier when testing manual. If you don't pass it the script will be generated in a temporary dir and is therefore a bit harder to find.
Line 86:
Line 86:
  <code bash>   <code bash>
  $ source /path/to/testenvironment.sh   $ source /path/to/testenvironment.sh
− </code> + </syntaxhighlight>
    
  The environment variables of the current shell are then changed to point to the test environment (eg. KDEHOME, DBUS_*, etc.). Every Akonadi application run in that shell operates on the Akonadi server of the test environment.   The environment variables of the current shell are then changed to point to the test environment (eg. KDEHOME, DBUS_*, etc.). Every Akonadi application run in that shell operates on the Akonadi server of the test environment.
Line 94:
Line 94:
  <code bash>   <code bash>
  $ shutdown-testenvironment   $ shutdown-testenvironment
− </code> + </syntaxhighlight>
    
  Note that your shell afterwards still points to the (now no longer existing) test environment and might not work as expected anymore.   Note that your shell afterwards still points to the (now no longer existing) test environment and might not work as expected anymore.
Line 104:
Line 104:
  <code bash>   <code bash>
  $ akonaditest -c config.xml <comand> <params>   $ akonaditest -c config.xml <comand> <params>
− </code> + </syntaxhighlight>
    
  The testrunner will run ''command params'' within the isolated environment and terminate afterwards.   The testrunner will run ''command params'' within the isolated environment and terminate afterwards.
Line 139:
Line 139:
     )      )
  endmacro(add_akonadi_isolated_test)   endmacro(add_akonadi_isolated_test)
− </code> + </syntaxhighlight>
    
  Using QtTest unittests with KDE extensions (''QTEST_KDEMAIN'') together with the testrunner is problematic as they modify some of the environment variables     Using QtTest unittests with KDE extensions (''QTEST_KDEMAIN'') together with the testrunner is problematic as they modify some of the environment variables  
Line 148:
Line 148:
    
  QTEST_AKONADIMAIN( MyTest, NoGUI )   QTEST_AKONADIMAIN( MyTest, NoGUI )
− </code> + </syntaxhighlight>
    
  = KNUT Test Data Resource =   = KNUT Test Data Resource =
Line 185:
Line 185:
  $ cd kdepimlibs/akonadi/test   $ cd kdepimlibs/akonadi/test
  $ akonaditest -c unittest/config.xml $BUILDDIR/test_executable.shell   $ akonaditest -c unittest/config.xml $BUILDDIR/test_executable.shell
− </code> + </syntaxhighlight>
    
  == kdepim/akonadi ==   == kdepim/akonadi ==



Neverendingo: Text replace - "" to ""

2011-06-29T19:38:58Z
Text replace - "<code cpp>" to "<syntaxhighlight lang="cpp">"

				
				
				
				
			
			← Older revision
			Revision as of 19:38, 29 June 2011
			
Line 144:
Line 144:
  set by the testrunner. Instead, use the following:   set by the testrunner. Instead, use the following:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  #include <qtest_akonadi.h>   #include <qtest_akonadi.h>
    



Vkrause: /* Creating Testrunner Environments */
2009-08-31T11:37:13Z
‎Creating Testrunner Environments

				
				
				
				
			
			← Older revision
			Revision as of 11:37, 31 August 2009
			
Line 40:
Line 40:
     <!-- load resources of the specified types -->      <!-- load resources of the specified types -->
     <agent synchronize="true">akonadi_knut_resource</agent>      <agent synchronize="true">akonadi_knut_resource</agent>
  +   <!-- set environment variables -->
  +   <envvar name="AKONADI_DISABLE_AGENT_AUTOSTART">true</envvar>
  </config>   </config>
  </code>   </code>
Line 63:
Line 65:
  CheckFileStamps=false   CheckFileStamps=false
  </code>   </code>
  + 
  + The ''&lt;envvar&gt;'' element allows you to set arbitrary environment variables inside the test environment. One useful example is ''AKONADI_DISABLE_AGENT_AUTOSTART'' which will prevent the Akonadi server from starting autostart agents, which can further speed up the setup process.
    
  == Using the Testrunner ==   == Using the Testrunner ==

← Older revision		Revision as of 13:27, 10 April 2012
Line 1:		Line 1:
		+	[[Category:Testing]]
		+
	This page describes the Akonadi test and benchmark facilities.		This page describes the Akonadi test and benchmark facilities.

@@ Line 110: / Line 110: @@
 This can be used from within CMake (example based on ''kdepimlibs/akonadi/tests''):
-<syntaxhighlight lang="make">
+<syntaxhighlight lang="cmake">
 macro(add_akonadi_isolated_test _source)
    set(_test ${_source})

@@ Line 110: / Line 110: @@
 This can be used from within CMake (example based on ''kdepimlibs/akonadi/tests''):
-<code>
+<syntaxhighlight lang="make">
 macro(add_akonadi_isolated_test _source)
    set(_test ${_source})

@@ Line 13: / Line 13: @@
 Here is an example listing based on the environment used for the libakonadi unittests:
-<code>
+<syntaxhighlight lang="bash">
 unittestenv/
 unittestenv/config.xml