1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#
# Copyright (C) 2010, Nokia <ivan.frade@nokia.com>
# Copyright (C) 2018-2020, Sam Thursfield <sam@afuera.me.uk>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
Fixtures used by the Tracker functional-tests.
"""
import gi
gi.require_version('Tracker', '3.0')
from gi.repository import Gio, GLib
from gi.repository import Tracker
import contextlib
import logging
import os
import pathlib
import multiprocessing
import shutil
import subprocess
import sys
import tempfile
import unittest as ut
import trackertestutils.helpers
import configuration as cfg
log = logging.getLogger(__name__)
def tracker_test_main():
"""Entry point that all functional-test modules must call."""
if cfg.tests_verbose():
# Output all logs to stderr
logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)
else:
# Output some messages from D-Bus daemon to stderr by default. In practice,
# only errors and warnings should be output here unless the environment
# contains G_MESSAGES_DEBUG=.
handler_stderr = logging.StreamHandler(stream=sys.stderr)
handler_stderr.addFilter(logging.Filter('trackertestutils.dbusdaemon.stderr'))
handler_stdout = logging.StreamHandler(stream=sys.stderr)
handler_stdout.addFilter(logging.Filter('trackertestutils.dbusdaemon.stdout'))
logging.basicConfig(level=logging.INFO,
handlers=[handler_stderr, handler_stdout],
format='%(message)s')
ut.main(verbosity=2)
class TrackerSparqlDirectTest(ut.TestCase):
"""
Fixture for tests using a direct (local) connection to a Tracker database.
"""
@classmethod
def setUpClass(self):
self.tmpdir = tempfile.mkdtemp(prefix='tracker-test-')
try:
self.conn = Tracker.SparqlConnection.new(
Tracker.SparqlConnectionFlags.NONE,
Gio.File.new_for_path(self.tmpdir),
Gio.File.new_for_path(cfg.ontologies_dir()),
None)
self.tracker = trackertestutils.helpers.StoreHelper(self.conn)
except Exception:
shutil.rmtree(self.tmpdir, ignore_errors=True)
raise
@classmethod
def tearDownClass(self):
self.conn.close()
shutil.rmtree(self.tmpdir, ignore_errors=True)
class TrackerSparqlBusTest (ut.TestCase):
"""
Fixture for tests using a D-Bus connection to a Tracker database.
The database is managed by a separate subprocess, spawned during the
fixture setup.
"""
@classmethod
def database_process_fn(self, message_queue):
# This runs in a separate process and provides a clean Tracker database
# exported over D-Bus to the main test process.
log.info("Started database subprocess")
bus = Gio.bus_get_sync(Gio.BusType.SESSION, None)
conn = Tracker.SparqlConnection.new(
Tracker.SparqlConnectionFlags.NONE,
Gio.File.new_for_path(self.tmpdir),
Gio.File.new_for_path(cfg.ontologies_dir()),
None)
endpoint = Tracker.EndpointDBus.new(conn, bus, None, None)
message_queue.put(bus.get_unique_name())
loop = GLib.MainLoop.new(None, False)
loop.run()
@classmethod
def setUpClass(self):
self.tmpdir = tempfile.mkdtemp(prefix='tracker-test-')
message_queue = multiprocessing.Queue()
self.process = multiprocessing.Process(target=self.database_process_fn,
args=(message_queue,))
try:
self.process.start()
service_name = message_queue.get()
log.debug("Got service name: %s", service_name)
self.conn = Tracker.SparqlConnection.bus_new(service_name, None, None)
self.tracker = trackertestutils.helpers.StoreHelper(self.conn)
except Exception as e:
self.process.terminate()
shutil.rmtree(self.tmpdir, ignore_errors=True)
raise
@classmethod
def tearDownClass(self):
self.conn.close()
self.process.terminate()
shutil.rmtree(self.tmpdir, ignore_errors=True)
class CliError(Exception):
pass
class TrackerCommandLineTestCase(ut.TestCase):
def setUp(self):
self.env = os.environ.copy()
path = self.env.get('PATH', []).split(':')
self.env['PATH'] = ':'.join([cfg.cli_dir()] + path)
self.env['TRACKER_CLI_SUBCOMMANDS_DIR'] = os.path.join(cfg.cli_dir(), 'subcommands')
@contextlib.contextmanager
def tmpdir(self):
try:
dirpath = tempfile.mkdtemp()
yield pathlib.Path(dirpath)
finally:
shutil.rmtree(dirpath, ignore_errors=True)
def data_path(self, filename):
test_data = pathlib.Path(__file__).parent.joinpath('test-data')
return test_data.joinpath(filename)
def run_cli(self, command):
command = [str(c) for c in command]
log.info("Running: %s", ' '.join(command))
result = subprocess.run(command, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, env=self.env)
if len(result.stdout) > 0:
log.debug("stdout: %s", result.stdout)
if len(result.stderr) > 0:
log.debug("stderr: %s", result.stderr)
if result.returncode != 0:
raise CliError('\n'.join([
"CLI command failed.",
"Command: %s" % ' '.join(command),
"Error: %s" % result.stderr.decode('utf-8')]))
return result.stdout.decode('utf-8')
|
