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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/*
* Copyright © 2012 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser 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 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/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*/
#include <core/dbus/compiler.h>
#include <core/dbus/generator.h>
#include <core/dbus/generator_configuration.h>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <cstdlib>
#include <fstream>
// local includes to access testing data
#include "test_data.h"
namespace dbus = core::dbus;
namespace
{
struct ParserInspector
{
MOCK_METHOD1(on_node, void(const dbus::IntrospectionParser::Node&));
MOCK_METHOD0(on_node_done, void());
MOCK_METHOD1(on_interface, void(const dbus::IntrospectionParser::Interface&));
MOCK_METHOD0(on_interface_done, void());
MOCK_METHOD1(on_method, void(const dbus::IntrospectionParser::Method&));
MOCK_METHOD0(on_method_done, void());
MOCK_METHOD1(on_property, void(const dbus::IntrospectionParser::Property&));
MOCK_METHOD1(on_signal, void(const dbus::IntrospectionParser::Signal&));
MOCK_METHOD0(on_signal_done, void());
MOCK_METHOD1(on_argument, void(const dbus::IntrospectionParser::Argument&));
MOCK_METHOD0(on_argument_done, void());
MOCK_METHOD1(on_annotation, void(const dbus::IntrospectionParser::Annotation&));
MOCK_METHOD0(on_annotation_done, void());
};
struct MockGenerator : public dbus::Generator
{
MOCK_METHOD3(invoke_for_model_with_configuration,
bool(
const std::shared_ptr<dbus::Compiler::Element>&,
std::istream&,
const dbus::GeneratorConfiguration&));
};
void ensure_test_introspection_file(const std::string& fn)
{
std::ofstream out(fn.c_str());
out << "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"" << std::endl
<< "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">" << std::endl
<< "<node name=\"/core/sample_object\">" << std::endl
<< " <interface name=\"org.freedesktop.SampleInterface\">" << std::endl
<< " <method name=\"Frobate\">" << std::endl
<< " <arg name=\"foo\" type=\"i\" direction=\"in\"/>" << std::endl
<< " <arg name=\"bar\" type=\"s\" direction=\"out\"/>" << std::endl
<< " <arg name=\"baz\" type=\"a{us}\" direction=\"out\"/>" << std::endl
<< " <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>" << std::endl
<< " </method>" << std::endl
<< " <method name=\"Bazify\">" << std::endl
<< " <arg name=\"bar\" type=\"(iiu)\" direction=\"in\"/>" << std::endl
<< " <arg name=\"bar\" type=\"v\" direction=\"out\"/>" << std::endl
<< " </method>" << std::endl
<< " <method name=\"Mogrify\">" << std::endl
<< " <arg name=\"bar\" type=\"(iiav)\" direction=\"in\"/>" << std::endl
<< " </method>" << std::endl
<< " <signal name=\"Changed\">" << std::endl
<< " <arg name=\"new_value\" type=\"b\"/>" << std::endl
<< " </signal>" << std::endl
<< " <property name=\"Bar\" type=\"y\" access=\"readwrite\"/>" << std::endl
<< " </interface>" << std::endl
<< " <node name=\"child_of_sample_object\"/>" << std::endl
<< " <node name=\"another_child_of_sample_object\"/>" << std::endl
<< " </node>" << std::endl;
}
}
TEST(IntrospectionParser, invoking_parser_reports_elements_correctly)
{
using namespace ::testing;
const std::string tmp_fn(__PRETTY_FUNCTION__);
std::remove(tmp_fn.c_str());
ensure_test_introspection_file(tmp_fn);
dbus::IntrospectionParser parser;
NiceMock<ParserInspector> inspector;
parser.on_node(std::bind(&ParserInspector::on_node, &inspector, std::placeholders::_1));
parser.on_node_done(std::bind(&ParserInspector::on_node_done, &inspector));
parser.on_interface(std::bind(&ParserInspector::on_interface, &inspector, std::placeholders::_1));
parser.on_interface_done(std::bind(&ParserInspector::on_interface_done, &inspector));
parser.on_method(std::bind(&ParserInspector::on_method, &inspector, std::placeholders::_1));
parser.on_method_done(std::bind(&ParserInspector::on_method_done, &inspector));
parser.on_property(std::bind(&ParserInspector::on_property, &inspector, std::placeholders::_1));
parser.on_signal(std::bind(&ParserInspector::on_signal, &inspector, std::placeholders::_1));
parser.on_signal_done(std::bind(&ParserInspector::on_signal_done, &inspector));
parser.on_argument(std::bind(&ParserInspector::on_argument, &inspector, std::placeholders::_1));
parser.on_argument_done(std::bind(&ParserInspector::on_argument_done, &inspector));
parser.on_annotation(std::bind(&ParserInspector::on_annotation, &inspector, std::placeholders::_1));
parser.on_annotation_done(std::bind(&ParserInspector::on_annotation_done, &inspector));
EXPECT_CALL(inspector, on_node(_)).Times(Exactly(3));
EXPECT_CALL(inspector, on_node_done()).Times(Exactly(3));
EXPECT_CALL(inspector, on_interface(_)).Times(Exactly(1));
EXPECT_CALL(inspector, on_interface_done()).Times(Exactly(1));
EXPECT_CALL(inspector, on_method(_)).Times(Exactly(3));
EXPECT_CALL(inspector, on_method_done()).Times(Exactly(3));
EXPECT_CALL(inspector, on_property(_)).Times(Exactly(1));
EXPECT_CALL(inspector, on_signal(_)).Times(Exactly(1));
EXPECT_CALL(inspector, on_signal_done()).Times(Exactly(1));
EXPECT_CALL(inspector, on_argument(_)).Times(Exactly(7));
EXPECT_CALL(inspector, on_annotation(_)).Times(Exactly(1));
EXPECT_TRUE(parser.invoke_for(tmp_fn));
}
TEST(IntrospectionCompiler, invoking_the_compiler_triggers_the_generator)
{
using namespace ::testing;
const std::string tmp_fn(__PRETTY_FUNCTION__);
std::remove(tmp_fn.c_str());
ensure_test_introspection_file(tmp_fn);
auto parser = std::make_shared<dbus::IntrospectionParser>();
NiceMock<MockGenerator> generator;
EXPECT_CALL(generator, invoke_for_model_with_configuration(_, _, _));
dbus::Compiler compiler(parser,
std::shared_ptr<dbus::Generator>(&generator,
[](dbus::Generator*){}));
EXPECT_NO_THROW(compiler.process_introspection_file_with_generator_config(
tmp_fn,
dbus::Generator::default_configuration()));
}
namespace
{
struct StubGenerator : public dbus::Generator
{
int node_count = 0;
int interface_count = 0;
int method_count = 0;
int signal_count = 0;
int property_count = 0;
int annotation_count = 0;
int argument_count = 0;
bool invoke_for_model_with_configuration(
const std::shared_ptr<dbus::Compiler::Element>& element,
std::istream&,
const dbus::GeneratorConfiguration&)
{
auto visitor = [this](const dbus::Compiler::Element& element)
{
switch(element.type())
{
case dbus::Compiler::Element::Type::node:
node_count++;
break;
case dbus::Compiler::Element::Type::interface:
interface_count++;
break;
case dbus::Compiler::Element::Type::method:
method_count++;
break;
case dbus::Compiler::Element::Type::signal:
signal_count++;
break;
case dbus::Compiler::Element::Type::property:
property_count++;
break;
case dbus::Compiler::Element::Type::argument:
argument_count++;
break;
case dbus::Compiler::Element::Type::annotation:
annotation_count++;
break;
}
};
static const std::function<void(const dbus::Compiler::Element&)> ignored{};
element->apply(ignored, visitor, ignored);
return true;
}
};
}
TEST(IntrospectionGenerator, receives_correct_tree_from_compiler)
{
using namespace ::testing;
const std::string tmp_fn(__PRETTY_FUNCTION__);
std::remove(tmp_fn.c_str());
ensure_test_introspection_file(tmp_fn);
auto parser = std::make_shared<dbus::IntrospectionParser>();
auto generator = std::make_shared<StubGenerator>();
dbus::Compiler compiler(parser, generator);
EXPECT_NO_THROW(compiler.process_introspection_file_with_generator_config(
tmp_fn,
dbus::Generator::default_configuration()));
EXPECT_EQ(3, generator->node_count);
EXPECT_EQ(1, generator->interface_count);
EXPECT_EQ(3, generator->method_count);
EXPECT_EQ(1, generator->signal_count);
EXPECT_EQ(1, generator->property_count);
EXPECT_EQ(7, generator->argument_count);
EXPECT_EQ(1, generator->annotation_count);
}
TEST(IntrospectionGenerator, generates_correct_protocol_definition_header_file)
{
using namespace ::testing;
const std::string tmp_fn(__PRETTY_FUNCTION__);
std::remove(tmp_fn.c_str());
ensure_test_introspection_file(tmp_fn);
auto parser = std::make_shared<dbus::IntrospectionParser>();
auto generator = std::make_shared<dbus::Generator>();
dbus::Compiler compiler(parser, generator);
EXPECT_NO_THROW(compiler.process_introspection_file_with_generator_config(
tmp_fn,
dbus::Generator::default_configuration()));
const std::string protocol_header_file_name{"SampleInterface.h"};
}
TEST(CompilerMain, generates_correct_protocol_definition_header_file_for_com_canonical_user_metrics)
{
const char* argv[] =
{
"dbus-cppc",
core::testing::com::canonical::user_metrics_introspection_file()
};
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::com::canonical::url_dispatcher_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::cdma_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::firmware_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::card_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::contact_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::hso_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::network_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::sms_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
argv[1] = core::testing::org::freedesktop::modem_manager::modem::gsm::ussd_introspection_file();
EXPECT_EQ(EXIT_SUCCESS, dbus::Compiler::main(2, argv));
}
|
