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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# test_samples.py
#
# Copyright 2021 James Westman <james@jwestman.net>
#
# This file is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 3 of the
# License, or (at your option) any later version.
#
# This file 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# SPDX-License-Identifier: LGPL-3.0-or-later
import os
import unittest
from pathlib import Path
import gi
gi.require_version("Gtk", "4.0")
from gi.repository import Gtk
from blueprintcompiler import decompiler, parser, tokenizer, utils
from blueprintcompiler.ast_utils import AstNode
from blueprintcompiler.completions import complete
from blueprintcompiler.errors import (
CompileError,
DeprecatedWarning,
MultipleErrors,
PrintableError,
)
from blueprintcompiler.lsp import LanguageServer
from blueprintcompiler.outputs.xml import XmlOutput
class TestSamples(unittest.TestCase):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.maxDiff = None
self.have_adw_1_4 = False
self.have_adw_1_5 = False
try:
import gi
gi.require_version("Adw", "1")
from gi.repository import Adw
Adw.init()
if Adw.MINOR_VERSION >= 4:
self.have_adw_1_4 = True
if Adw.MINOR_VERSION >= 5:
self.have_adw_1_5 = True
except:
pass
def assert_ast_doesnt_crash(self, text, tokens, ast: AstNode):
lsp = LanguageServer()
for i in range(len(text)):
ast.get_docs(i)
for i in range(len(text)):
list(complete(lsp, ast, tokens, i))
for i in range(len(text)):
ast.get_reference(i)
ast.get_document_symbols()
def assert_sample(self, name, skip_run=False):
print(f'assert_sample("{name}", skip_run={skip_run})')
try:
with open((Path(__file__).parent / f"samples/{name}.blp").resolve()) as f:
blueprint = f.read()
with open((Path(__file__).parent / f"samples/{name}.ui").resolve()) as f:
expected = f.read()
tokens = tokenizer.tokenize(blueprint)
ast, errors, warnings = parser.parse(tokens)
# Ignore deprecation warnings because some of the things we're testing
# are deprecated
warnings = [
warning
for warning in warnings
if not isinstance(warning, DeprecatedWarning)
]
if errors:
raise errors
if len(warnings):
raise MultipleErrors(warnings)
xml = XmlOutput()
actual = xml.emit(ast)
self.assertEqual(actual.strip(), expected.strip())
self.assert_ast_doesnt_crash(blueprint, tokens, ast)
except PrintableError as e: # pragma: no cover
e.pretty_print(name + ".blp", blueprint)
raise AssertionError()
# Make sure the sample runs
if not skip_run:
Gtk.Builder.new_from_string(actual, -1)
def assert_sample_error(self, name):
print(f'assert_sample_error("{name}")')
try:
with open(
(Path(__file__).parent / f"sample_errors/{name}.blp").resolve()
) as f:
blueprint = f.read()
with open(
(Path(__file__).parent / f"sample_errors/{name}.err").resolve()
) as f:
expected = f.read()
tokens = tokenizer.tokenize(blueprint)
ast, errors, warnings = parser.parse(tokens)
if ast is not None:
self.assert_ast_doesnt_crash(blueprint, tokens, ast)
if errors:
raise errors
if len(ast.errors):
raise MultipleErrors(ast.errors)
if len(warnings):
raise MultipleErrors(warnings)
except PrintableError as e:
# Ignore deprecation warnings because new versions of libraries can introduce
# new deprecations, which would cause the tests to fail
errors = [
error
for error in (e.errors if isinstance(e, MultipleErrors) else [e])
if (name == "deprecations" or not isinstance(error, DeprecatedWarning))
]
def error_str(error: CompileError):
line, col = utils.idx_to_pos(error.range.start + 1, blueprint)
len = error.range.length
return ",".join([str(line + 1), str(col), str(len), error.message])
actual = "\n".join([error_str(error) for error in errors])
self.assertEqual(actual.strip(), expected.strip())
else: # pragma: no cover
raise AssertionError("Expected a compiler error, but none was emitted")
def assert_decompile(self, name):
print(f'assert_decompile("{name}")')
try:
if os.path.exists(
(Path(__file__).parent / f"samples/{name}_dec.blp").resolve()
):
with open(
(Path(__file__).parent / f"samples/{name}_dec.blp").resolve()
) as f:
expected = f.read().strip()
else:
with open(
(Path(__file__).parent / f"samples/{name}.blp").resolve()
) as f:
expected = f.read().strip()
name = name.removesuffix("_dec")
ui_path = (Path(__file__).parent / f"samples/{name}.ui").resolve()
actual = decompiler.decompile(ui_path).strip()
self.assertEqual(actual, expected)
except PrintableError as e: # pragma: no cover
e.pretty_print(name + ".blp", expected)
raise AssertionError()
def test_samples(self):
# list the samples directory
samples = [f.stem for f in Path(__file__).parent.glob("samples/*.blp")]
samples.sort()
for sample in samples:
REQUIRE_ADW_1_4 = ["adw_breakpoint"]
REQUIRE_ADW_1_5 = [
"adw_alertdialog_responses",
"adw_alert_dialog_duplicate_flags",
]
SKIP_RUN = [
"adw_breakpoint_template",
"expr_closure",
"expr_closure_args",
"expr_value_closure",
"parseable",
"signal",
"signal_not_swapped",
"signal_template_object",
"template",
"template_binding",
"template_binding_extern",
"template_bind_property",
"template_id",
"template_no_parent",
"template_orphan",
"template_simple_binding",
"typeof",
"unchecked_class",
]
# Decompiler-only tests
SKIP_COMPILE = ["issue_177", "issue_187", "translator_comments"]
SKIP_DECOMPILE = [
# Comments are not preserved in either direction
"comments",
]
if sample in REQUIRE_ADW_1_4 and not self.have_adw_1_4:
continue
if sample in REQUIRE_ADW_1_5 and not self.have_adw_1_5:
continue
with self.subTest(sample):
if sample not in SKIP_COMPILE and not sample.endswith("_dec"):
self.assert_sample(sample, skip_run=sample in SKIP_RUN)
with self.subTest("decompile/" + sample):
if sample not in SKIP_DECOMPILE:
self.assert_decompile(sample)
# list the sample_errors directory
sample_errors = [
f.stem for f in Path(__file__).parent.glob("sample_errors/*.blp")
]
sample_errors.sort()
for sample_error in sample_errors:
if sample_error in REQUIRE_ADW_1_4 and not self.have_adw_1_4:
continue
if sample_error in REQUIRE_ADW_1_5 and not self.have_adw_1_5:
continue
with self.subTest(sample_error):
self.assert_sample_error(sample_error)
|
