Difference between revisions of "KDE PIM/Akonadi/Testing"

Jump to: navigation, search
(Adding section for developer tools and sub section for Akonadiconsole)
(Move the developer tools part to the already existing dedicated page)
Line 1: Line 1:
= Akonadi Developer Tools =
== Akonadi Console ==
Akonadi Console is a tool for developers working with Akonadi or on Akonadi itself.
It provides GUI for
* managing agents and resources
* retrieving, checking and even manipulating data
* monitoring communication between Akonadi server and its clients
* convenience access to the database used by the server
=== Managing Agents ===
This facility is basically a GUI for [http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/classAkonadi_1_1AgentManager.html Akonadi::AgentManager] and [http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/classAkonadi_1_1AgentInstance.html Akonadi::AgentInstance].
It enables the developer to quickly add or remove agents from the currently running Akonadi system, to check an agent's basic properties and status, etc.
While most of these actions can also be performed through end user GUI, e.g. KDE's Systemsettings, this is usually quicker and it provides more detailed information.
{{tip|The '''Synchronize''' action menu can be used to just synchronize the collection tree, basically a convenient way for a resource developer to call just the '''retrieveCollections()''' method.}}
=== Collections and Items ===
This facility shows all Akonadi collections, how they are organized as a tree and their items and enables the developer to perform actions on these entities.
Developers working on agents can use this perform the most common tasks such as
* retrieving items: see the context menu of collection entries, basically a call to the respective resource's '''retrieveItems()''' method
* retrieve item payloads: either by clicking on an item or, for certain type such as contacts by switching the item view's mode to the respective data type.
* copy and delete items: see the context menu of item entries
* modify items: e.g. by changing the serialized form of the item on the '''Raw Payload''' tab
without having to go through an end user application.
Developers working on end user applications can use this to simulate respective changes by other clients and to check whether changes done by the application itself are correctly applied to the shared data.
{{tip|If a newly added resource's collections do not show up in the collection tree, it might be necessary to explicitly synchronize it. This functionality is available on the '''Agents''' tab.}}}
=== Monitoring Akonadi Communication ===
This facility allows to monitor the Akonadi data protocol based communication between client sessions and the server. It contains commands, responses and the data transported between the two sides.
{{note|Since this can slow down operations it is disabled by default and has to be enabled manually when needed.}}
=== Access to the Server Database ===
Akonadi uses a SQL database for keeping relations such as which collection an item is in, properties such as MIME types, etc. as well as cached item payload data.
Since this is quite internal to the Akonadi server, it will most likely only be interesting to people working on Akonadi, not for developers working with Akonadi.
The database browser can query and display the database tables used by Akonadi.
The database console enables developers to directly send commands to the database engine.
= Akonadi Test and Benchmark Infrastructure =
= Akonadi Test and Benchmark Infrastructure =

Revision as of 12:37, 21 February 2009

Akonadi Test and Benchmark Infrastructure

Akonadi Testrunner

Igor's GSoC project, found in kdepimlibs/akonadi/tests/testrunner. The Akonadi Testrunner sets up an isolated Akonadi server (which implies a separated D-Bus server) based on an environment configuration file.

Creating Testrunner Environments

A testrunner environment consists of two components: a set of configuration and data files and a XML description file of the environment.

Here is an example listing based on the environment used for the libakonadi unittests:

unittestenv/ unittestenv/config.xml unittestenv/xdglocal unittestenv/kdehome unittestenv/kdehome/share unittestenv/kdehome/share/config unittestenv/kdehome/share/config/akonadi-firstrunrc unittestenv/kdehome/share/config/akonadi_knut_resource_0rc unittestenv/kdehome/testdata.xml unittestenv/xdgconfig

The environment description file (config.xml)looks like this:


 <agent synchronize="true">akonadi_knut_resource</agent>


The first three elements define the relevant paths inside the environment data, relative to the config.xml file. The <agent> element can be used to create instances of the specified agent (multiple such elements are allowed). If the agent is a resource, it can also be synced initially by adding the synchronize="true" attribute. Tests will not be launched before the syncing has been complete in this case.

Agents set up in this way can be configured by simply providing the corresponding configuration file in $KDEHOME, such as akonadi_knut_resource_0rc in our example.

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:

[ProcessedDefaults] defaultaddressbook=done defaultcalendar=done

Using the Testrunner

Interactive Use

For manual usage, the testrunner provides an interactive mode in which it sets up the environment and provides a way to "switch" into it.

First, start the testrunner:

$ akonaditest -c config.xml &

Once the setup is complete, it creates a shell script containing the necessary environment variable changes to switch into the test environment:

$ source testenvironment.sh

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.

To terminate and cleanup the test environment, run:

$ shutdown-testenvironment

Note that your shell afterwards still points to the (now no longer existing) test environment and might not work as expected anymore.

Non-Interactive Use

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:

$ akonaditest -c config.xml <comand> <params>

The testrunner will run command params within the isolated environment and terminate afterwards.

This can be used from within CMake (example based on kdepimlibs/akonadi/tests):

macro(add_akonadi_isolated_test _source)

 set(_test ${_source})
 get_filename_component(_name ${_source} NAME_WE)
 kde4_add_executable(${_name} TEST ${_test})
   akonadi-kde akonadi-kmime ${QT_QTTEST_LIBRARY}
 # based on kde4_add_unit_test
 if (WIN32)
   get_target_property( _loc ${_name} LOCATION )
   set(_executable ${_loc}.bat)
 else (WIN32)
   set(_executable ${EXECUTABLE_OUTPUT_PATH}/${_name})
 endif (WIN32)
 if (UNIX)
   set(_executable ${_executable}.shell)
 endif (UNIX)
 find_program(_testrunner akonaditest)
 add_test( libakonadi-${_name} 
   ${_testrunner} -c


Using QtTest unittests with KDE extensions (QTEST_KDEMAIN) together with the testrunner is problematic as they modify some of the environment variables set by the testrunner. Instead, use the following:

  1. include <qtest_akonadi.h>


KNUT Test Data Resource

In kdepim/akonadi/resources, fully featured resource that operates on a single XML file. File format is decribed in knut.xsd and follows closely the internal structure of Akonadi. New files can be created in eg. Akonadiconsole by creating a resource and specifying a non-existing file.

Akonadi Scriptable Resource

Second part of Igor's GSoC project, currently in playground/pim/akonaditest.


Akonadi Benchmarker

In kdepimlibs/akonadi/test, part of Robert's thesis.



Akonadi Server

Usable without installation, run with ctest/make test as usual.


These tests use the Akonadi Testrunner, the test environment is found in kdepimlibs/akonadi/tests/unittestenv.


The tests do not yet completely work without having certain components installed, namely:

  • Akonadi Server
  • KNUT resource

Running the tests

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:

$ cd kdepimlibs/akonadi/test $ akonaditest -c unittest/config.xml $BUILDDIR/test_executable.shell


Are there any? TODO