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
|
#!/usr/bin/env python3
# Copyright 2020 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Tests compiling and importing Python protos on the fly."""
from pathlib import Path
import tempfile
import unittest
from pw_protobuf_compiler import python_protos
PROTO_1 = """\
syntax = "proto3";
package pw.protobuf_compiler.test1;
message SomeMessage {
uint32 magic_number = 1;
}
message AnotherMessage {
enum Result {
FAILED = 0;
FAILED_MISERABLY = 1;
I_DONT_WANT_TO_TALK_ABOUT_IT = 2;
}
Result result = 1;
string payload = 2;
}
service PublicService {
rpc Unary(SomeMessage) returns (AnotherMessage) {}
rpc ServerStreaming(SomeMessage) returns (stream AnotherMessage) {}
rpc ClientStreaming(stream SomeMessage) returns (AnotherMessage) {}
rpc BidiStreaming(stream SomeMessage) returns (stream AnotherMessage) {}
}
"""
PROTO_2 = """\
syntax = "proto2";
package pw.protobuf_compiler.test2;
message Request {
optional float magic_number = 1;
}
message Response {
}
service Alpha {
rpc Unary(Request) returns (Response) {}
}
service Bravo {
rpc BidiStreaming(stream Request) returns (stream Response) {}
}
"""
PROTO_3 = """\
syntax = "proto3";
package pw.protobuf_compiler.test2;
enum Greeting {
YO = 0;
HI = 1;
}
message Hello {
repeated int64 value = 1;
Greeting hi = 2;
}
"""
class TestCompileAndImport(unittest.TestCase):
def setUp(self):
self._proto_dir = tempfile.TemporaryDirectory(prefix='proto_test')
self._protos = []
for i, contents in enumerate([PROTO_1, PROTO_2, PROTO_3], 1):
self._protos.append(Path(self._proto_dir.name, f'test_{i}.proto'))
self._protos[-1].write_text(contents)
def tearDown(self):
self._proto_dir.cleanup()
def test_compile_to_temp_dir_and_import(self):
modules = {
m.DESCRIPTOR.name: m
for m in python_protos.compile_and_import(self._protos)
}
self.assertEqual(3, len(modules))
# Make sure the protobuf modules contain what we expect them to.
mod = modules['test_1.proto']
self.assertEqual(
4, len(mod.DESCRIPTOR.services_by_name['PublicService'].methods))
mod = modules['test_2.proto']
self.assertEqual(mod.Request(magic_number=1.5).magic_number, 1.5)
self.assertEqual(2, len(mod.DESCRIPTOR.services_by_name))
mod = modules['test_3.proto']
self.assertEqual(mod.Hello(value=[123, 456]).value, [123, 456])
class TestProtoLibrary(TestCompileAndImport):
"""Tests the Library class."""
def setUp(self):
super().setUp()
self._library = python_protos.Library(
python_protos.compile_and_import(self._protos))
def test_packages_can_access_messages(self):
msg = self._library.packages.pw.protobuf_compiler.test1.SomeMessage
self.assertEqual(msg(magic_number=123).magic_number, 123)
def test_packages_finds_across_modules(self):
msg = self._library.packages.pw.protobuf_compiler.test2.Request
self.assertEqual(msg(magic_number=50).magic_number, 50)
val = self._library.packages.pw.protobuf_compiler.test2.YO
self.assertEqual(val, 0)
def test_packages_invalid_name(self):
with self.assertRaises(AttributeError):
_ = self._library.packages.nothing
with self.assertRaises(AttributeError):
_ = self._library.packages.pw.NOT_HERE
with self.assertRaises(AttributeError):
_ = self._library.packages.pw.protobuf_compiler.test1.NotARealMsg
def test_access_modules_by_package(self):
test1 = self._library.modules_by_package['pw.protobuf_compiler.test1']
self.assertEqual(len(test1), 1)
self.assertEqual(test1[0].AnotherMessage.Result.Value('FAILED'), 0)
test2 = self._library.modules_by_package['pw.protobuf_compiler.test2']
self.assertEqual(len(test2), 2)
def test_access_modules_by_package_unkonwn(self):
with self.assertRaises(KeyError):
_ = self._library.modules_by_package['pw.not_real']
def test_library_from_strings(self):
# Replace the package to avoid conflicts with the other proto imports
new_protos = [
p.replace('pw.protobuf_compiler', 'proto.library.test')
for p in [PROTO_1, PROTO_2, PROTO_3]
]
library = python_protos.Library.from_strings(new_protos)
# Make sure we can safely import the same proto contents multiple times.
library = python_protos.Library.from_strings(new_protos)
msg = library.packages.proto.library.test.test2.Request
self.assertEqual(msg(magic_number=50).magic_number, 50)
val = library.packages.proto.library.test.test2.YO
self.assertEqual(val, 0)
if __name__ == '__main__':
unittest.main()
|
