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
|
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""Utility methods and classes for testing IDL passes."""
from __future__ import absolute_import, print_function, unicode_literals
import unittest
from typing import Any, Tuple
if __name__ == 'testcase':
import sys
from os import path
sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))
from context import idl
else:
from .context import idl
def errors_to_str(errors):
# type: (idl.errors.ParserErrorCollection) -> unicode
"""Dump the list of errors as a multiline text string."""
if errors is not None:
return "\n".join(errors.to_list())
return "<empty>"
class NothingImportResolver(idl.parser.ImportResolverBase):
"""An import resolver that does nothing."""
def resolve(self, base_file, imported_file_name):
# type: (unicode, unicode) -> unicode
"""Return the complete path to an imported file name."""
raise NotImplementedError()
def open(self, imported_file_name):
# type: (unicode) -> Any
"""Return an io.Stream for the requested file."""
raise NotImplementedError()
class IDLTestcase(unittest.TestCase):
"""IDL Test case base class."""
def _parse(self, doc_str, resolver):
# type: (unicode, idl.parser.ImportResolverBase) -> idl.syntax.IDLParsedSpec
"""Parse a document and throw a unittest failure if it fails to parse as a valid YAML document."""
try:
return idl.parser.parse(doc_str, "unknown", resolver)
except: # pylint: disable=bare-except
self.fail("Failed to parse document:\n%s" % (doc_str))
def _assert_parse(self, doc_str, parsed_doc):
# type: (unicode, idl.syntax.IDLParsedSpec) -> None
"""Assert a document parsed correctly by the IDL compiler and returned no errors."""
self.assertIsNone(parsed_doc.errors,
"Expected no parser errors\nFor document:\n%s\nReceived errors:\n\n%s" %
(doc_str, errors_to_str(parsed_doc.errors)))
self.assertIsNotNone(parsed_doc.spec, "Expected a parsed doc")
def assert_parse(self, doc_str, resolver=NothingImportResolver()):
# type: (unicode, idl.parser.ImportResolverBase) -> None
"""Assert a document parsed correctly by the IDL compiler and returned no errors."""
parsed_doc = self._parse(doc_str, resolver)
self._assert_parse(doc_str, parsed_doc)
def assert_parse_fail(self, doc_str, error_id, multiple=False,
resolver=NothingImportResolver()):
# type: (unicode, unicode, bool, idl.parser.ImportResolverBase) -> None
"""
Assert a document parsed correctly by the YAML parser, but not the by the IDL compiler.
Asserts only one error is found in the document to make future IDL changes easier.
"""
parsed_doc = self._parse(doc_str, resolver)
self.assertIsNone(parsed_doc.spec, "Expected no parsed doc")
self.assertIsNotNone(parsed_doc.errors, "Expected parser errors")
# Assert that negative test cases are only testing one fault in a test.
# This is impossible to assert for all tests though.
self.assertTrue(
multiple or parsed_doc.errors.count() == 1,
"For document:\n%s\nExpected only error message '%s' but received multiple errors:\n\n%s"
% (doc_str, error_id, errors_to_str(parsed_doc.errors)))
self.assertTrue(
parsed_doc.errors.contains(error_id),
"For document:\n%s\nExpected error message '%s' but received only errors:\n %s" %
(doc_str, error_id, errors_to_str(parsed_doc.errors)))
def assert_bind(self, doc_str, resolver=NothingImportResolver()):
# type: (unicode, idl.parser.ImportResolverBase) -> idl.ast.IDLBoundSpec
"""Assert a document parsed and bound correctly by the IDL compiler and returned no errors."""
parsed_doc = self._parse(doc_str, resolver)
self._assert_parse(doc_str, parsed_doc)
bound_doc = idl.binder.bind(parsed_doc.spec)
self.assertIsNone(bound_doc.errors,
"Expected no binder errors\nFor document:\n%s\nReceived errors:\n\n%s" %
(doc_str, errors_to_str(bound_doc.errors)))
self.assertIsNotNone(bound_doc.spec, "Expected a bound doc")
return bound_doc.spec
def assert_bind_fail(self, doc_str, error_id, resolver=NothingImportResolver()):
# type: (unicode, unicode, idl.parser.ImportResolverBase) -> None
"""
Assert a document parsed correctly by the YAML parser and IDL parser, but not bound by the IDL binder.
Asserts only one error is found in the document to make future IDL changes easier.
"""
parsed_doc = self._parse(doc_str, resolver)
self._assert_parse(doc_str, parsed_doc)
bound_doc = idl.binder.bind(parsed_doc.spec)
self.assertIsNone(bound_doc.spec, "Expected no bound doc\nFor document:\n%s\n" % (doc_str))
self.assertIsNotNone(bound_doc.errors, "Expected binder errors")
# Assert that negative test cases are only testing one fault in a test.
self.assertTrue(
bound_doc.errors.count() == 1,
"For document:\n%s\nExpected only error message '%s' but received multiple errors:\n\n%s"
% (doc_str, error_id, errors_to_str(bound_doc.errors)))
self.assertTrue(
bound_doc.errors.contains(error_id),
"For document:\n%s\nExpected error message '%s' but received only errors:\n %s" %
(doc_str, error_id, errors_to_str(bound_doc.errors)))
def assert_generate(self, doc_str, resolver=NothingImportResolver()):
# type: (unicode, idl.parser.ImportResolverBase) -> Tuple[unicode,unicode]
"""Assert a document parsed, bound, and generated correctly by the IDL compiler."""
spec = self.assert_bind(doc_str, resolver)
header = idl.generator.generate_header_str(spec)
source = idl.generator.generate_source_str(spec, "fake", "fake_header")
return (header, source)
|
