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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
#
# Copyright (C) 2010, Nokia <ivan.frade@nokia.com>
# Copyright (C) 2018-2019, 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.
#
"""
For a collection of files, call the extractor and check that the expected
metadata is extracted. Load dynamically the test information from a data
directory (containing xxx.expected files)
"""
import gi
gi.require_version("Tsparql", "3.0")
from gi.repository import Gio
from gi.repository import Tsparql
import json
import os
import shutil
import sys
import tempfile
import unittest as ut
import configuration as cfg
import fixtures
class GenericExtractionTestCase(fixtures.TrackerExtractTestCase):
"""
Test checks if the tracker extractor is able to retrieve metadata
"""
def __init__(self, methodName="runTest", descfile=None):
"""
Descfile is the description file in a relative path
"""
self.descfile = descfile
try:
with open(descfile) as f:
self.spec = json.load(f)
except ValueError as e:
self.fail("Error loading %s: %s" % (descfile, e))
# Add a method to the class called after the description file
methodName = descfile.lower()[: -len(".expected")].replace(" ", "_")[-60:]
if self.spec["test"].get("ExpectedFailure", False):
setattr(self, methodName, self.expected_failure_test_extraction)
else:
setattr(self, methodName, self.generic_test_extraction)
super(GenericExtractionTestCase, self).__init__(methodName)
def __get_bugnumber(self):
return self.spec["test"].get("Bugzilla")
def validate_sparql_update(self, sparql):
"""Create a temporary database and run the given SPARQL update.
This gives us a smoke test to detect any situation where the
extractor generates invalid SPARQL.
"""
cancellable = None
ontology = Tsparql.sparql_get_ontology_nepomuk()
db = Tsparql.SparqlConnection.new(
Tsparql.SparqlConnectionFlags.NONE,
None, # create in-memory database,
ontology,
cancellable,
)
db.update(sparql, cancellable)
def generic_test_extraction(self):
abs_description = os.path.abspath(self.descfile)
# Filename contains the file to extract, in a relative path to the description file
desc_root, desc_file = os.path.split(abs_description)
filename_to_extract = self.spec["test"]["Filename"]
self.file_to_extract = os.path.join(desc_root, filename_to_extract)
tmpdir = tempfile.mkdtemp(prefix="tracker-extract-test-")
try:
extra_env = cfg.test_environment(tmpdir)
if "metadata" in self.spec:
jsonld = fixtures.get_tracker_extract_output(
extra_env, self.file_to_extract, output_format="json-ld"
)
self.__assert_extraction_ok(jsonld)
sparql = fixtures.get_tracker_extract_output(
extra_env, self.file_to_extract, output_format="sparql"
)
self.validate_sparql_update(sparql)
else:
# No output data is expected for this file
jsonld = None
try:
jsonld = fixtures.get_tracker_extract_output(
extra_env, self.file_to_extract, output_format="json-ld"
)
self.assertEqual(jsonld["@graph"], [])
except RuntimeError as re:
print ('# Got expected error message: %s' % str(re).replace('\n', '\\n'))
finally:
shutil.rmtree(tmpdir, ignore_errors=True)
@ut.expectedFailure
def expected_failure_test_extraction(self):
self.generic_test_extraction()
if self.__get_bugnumber():
raise Exception(
"Unexpected success. Maybe bug: "
+ self.__get_bugnumber()
+ " has been fixed?"
)
else:
raise Exception("Unexpected success. Check " + self.rel_description)
def __assert_extraction_ok(self, result):
try:
self.assert_extract_result_matches_spec(
self.spec["metadata"], result, self.file_to_extract, self.descfile
)
except AssertionError:
print("\ntracker-extract returned: %s" % json.dumps(result, indent=4))
raise
def run_suite(suite):
if cfg.tap_protocol_enabled():
try:
from tap import TAPTestRunner
runner = TAPTestRunner()
runner.set_stream(True)
except ImportError as e:
log.error("No TAP test runner found: %s", e)
raise
else:
runner = ut.TextTestRunner(verbosity=1)
result = runner.run(suite)
sys.exit(not result.wasSuccessful())
def run_all():
##
# Traverse the TEST_DATA_PATH directory looking for .description files
# Add a new TestCase to the suite per .description file and run the suite.
#
# Is we do this inside a single TestCase an error in one test would stop the whole
# testing.
##
if os.path.exists(os.getcwd() + "/test-extraction-data"):
# Use local directory if available
TEST_DATA_PATH = os.getcwd() + "/test-extraction-data"
else:
TEST_DATA_PATH = os.path.join(
cfg.DATADIR, "tracker-tests", "test-extraction-data"
)
print("Loading test descriptions from", TEST_DATA_PATH)
extractionTestSuite = ut.TestSuite()
for root, dirs, files in os.walk(TEST_DATA_PATH):
descriptions = [os.path.join(root, f) for f in files if f.endswith("expected")]
for descfile in descriptions:
tc = GenericExtractionTestCase(descfile=descfile)
extractionTestSuite.addTest(tc)
run_suite(extractionTestSuite)
def run_one(filename):
##
# Run just one .description file
##
description = os.path.join(os.getcwd(), filename)
extractionTestSuite = ut.TestSuite()
tc = GenericExtractionTestCase(descfile=description)
extractionTestSuite.addTest(tc)
run_suite(extractionTestSuite)
try:
if len(sys.argv) == 2:
run_one(sys.argv[1])
elif len(sys.argv) == 1:
run_all()
else:
raise RuntimeError("Too many arguments.")
except RuntimeError as e:
sys.stderr.write("ERROR: %s\n" % e)
sys.exit(1)
|
