summaryrefslogtreecommitdiff
path: root/HACKING.md
diff options
context:
space:
mode:
authorSam Thursfield <sam@afuera.me.uk>2020-04-05 21:00:09 +0200
committerSam Thursfield <sam@afuera.me.uk>2020-04-12 14:47:35 +0200
commit34ee520365ec6763579efbc2eb50e6bc6a9d0cf4 (patch)
treef562408dc86c3faf278845f940e504b106170b6a /HACKING.md
parent157702edc650ea7aef43c55d972dab1ef22f4252 (diff)
downloadtracker-34ee520365ec6763579efbc2eb50e6bc6a9d0cf4.tar.gz
HACKING.md: Add info on automated testing
This replaces the wiki page https://wiki.gnome.org/Projects/Tracker/Testing
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/HACKING.md b/HACKING.md
index dea503369..6396b3c80 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -1,4 +1,27 @@
-# Logging
+# Tracker HACKING guide
+
+This file contains information useful for developers who want to improve
+the tracker and tracker-miners projects.
+
+## Automated testing
+
+You can run the Tracker testsuite using the `meson test` command.
+
+Tracker runs the tests automatically in GitLab CI. The .gitlab-ci.yml file
+controls this. Here are the latest tests that were run:
+
+ * https://gitlab.gnome.org/GNOME/tracker/pipelines
+ * https://gitlab.gnome.org/GNOME/tracker-miners/pipelines
+
+Some distros also run the test suite, including these:
+
+ * Ubuntu autopkgtest: https://autopkgtest.ubuntu.com/packages/tracker/
+ * Debian builds: https://buildd.debian.org/status/package.php?p=tracker
+ * Debian reproducible-builds: https://tests.reproducible-builds.org/tracker/
+
+OpenSuSE do automated whole-system testing that includes the GNOME desktop for their Tumbleweed rolling release distro: https://openqa.opensuse.org/group_overview/1
+
+## Logging
The following environment variables control logging from Tracker daemons:
@@ -30,7 +53,7 @@ When working with GitLab CI, you can use the
to set the values of these variables and increase the verbosity of the tests in
CI.
-# Attaching a debugger to Tracker daemons
+## Attaching a debugger to Tracker daemons
Tracker daemons are not started directly. Instead they are started by the D-Bus
daemon by request. When using the run-uninstalled script or the
@@ -48,7 +71,7 @@ option to avoid your process being killed by the test runner. When you see
the 'Pausing' message, run the `gdb attach``command in another terminal within
10 seconds.
-# Running Tracker daemons under Valgrind
+## Running Tracker daemons under Valgrind
The Tracker daemons are launched using D-Bus autolaunch. When running them from
the source tree using the run-uninstalled script or the functional-tests, the