| commit | a1e9e2aea35e0b11189f18bda9a566da8e88289a | [log] [tgz] |
|---|---|---|
| author | William A. Kennington III <wak@google.com> | Sat Jun 23 13:33:25 2018 -0700 |
| committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | Mon Jul 09 18:20:42 2018 +0000 |
| tree | 0f3f085d93223ea6e216f6aee173d55731d5f62d | |
| parent | 977d4d48aaf85730c99238da649b5488fd1b02dd [diff] |
test/message/append: Use googletest and mocks
The current test case depends on the system running a dbus daemon that
our test case can register and run a service with. It runs in multiple
threads and requires using raw sd_bus_message calls to determine if the
appends worked correctly. When systemd 237 becomes the minimum version
we could rely on message sealing and other new public members to deal
with the daemon issues. However, it will be a while before we can make
that the default version.
Lets mock out the expectations for the underlying sd_bus_message calls
to validate that we will build correct objects when using our
message.append() calls.
Tested:
Converted the tests from the old test cases to this new format
keeping very similar test functionality. Tests still pass.
Change-Id: Iafc8662389fe60ca2d519abfe472c61292f3239a
Signed-off-by: William A. Kennington III <wak@google.com>
sdbusplus contains two parts:
The sdbusplus library requires sd-bus, which is contained in libsystemd.
The sdbus++ application requires python and the python libraries mako and py-inflection.
The sdbusplus library builds on top of the sd-bus library to create a modern C++ API for D-Bus. The library attempts to be as lightweight as possible, usually compiling to exactly the sd-bus API calls that would have been necessary, while also providing compile-time type-safety and memory leak protection afforded by modern C++ practices.
Consider the following code:
auto b = bus::new_system();
auto m = b.new_method_call("org.freedesktop.login1",
"/org/freedesktop/login1",
"org.freedesktop.login1.Manager",
"ListUsers");
auto reply = b.call(m);
std::vector<std::tuple<uint32_t, std::string, message::object_path>> users;
reply.read(users);
In a few, relatively succinct, C++ lines this snippet will create a D-Bus connection to the system bus, and call the systemd login manager to get a list of active users. The message and bus objects are automatically freed when they leave scope and the message format strings are generated at compile time based on the types being read. Compare this to the corresponding server code within logind.
In general, the library attempts to mimic the naming conventions of the sd-bus library: ex. sd_bus_call becomes sdbusplus::bus::call, sd_bus_get_unique_name becomes sdbusplus::bus::get_unique_name, sd_bus_message_get_signature becomes sdbusplus::message::get_signature, etc. This allows a relatively straight-forward translation back to the sd-bus functions for looking up the manpage details.
sdbusplus also contains a bindings generator tool: sdbus++. The purpose of a bindings generator is to reduce the boilerplate associated with creating D-Bus server or client applications. When creating a server application, rather than creating sd-bus vtables and writing C-style functions to handle each vtable callback, you can create a small YAML file to define your D-Bus interface and the sdbus++ tool will create a C++ class that implements your D-Bus interface. This class has a set of virtual functions for each method and property, which you can overload to create your own customized behavior for the interface.
There are currently two types of YAML files: interface and error. Interfaces are used to create server and client D-Bus interfaces. Errors are used to define C++ exceptions which can be thrown and will automatically turn into D-Bus error responses.
[[ D-Bus client bindings are not yet implemented. See openbmc/openbmc#851. ]]
The path of your file will be the interface name. For example, for an interface org.freedesktop.Example, you would create the files org/freedesktop/Example.interface.yaml and org/freedesktop/Example.errors.yaml] for interfaces and errors respectively. These can then be used to generate the server and error bindings:
sdbus++ interface server-header org.freedesktop.Example > \
org/freedesktop/Example/server.hpp
sdbus++ interface server-cpp org.freedesktop.Example > \
org/freedesktop/Example/server.cpp
sdbus++ error exception-header org.freedesktop.Example > \
org/freedesktop/Example/error.hpp \
sdbus++ error exception-cpp org.freedesktop.Example > \
org/freedesktop/Example/error.cpp
Markdown-based documentation can also be generated from the interface and exception files:
sdbus++ interface markdown org.freedesktop.Example > \
org/freedesktop/Example.md
sdbus++ error markdown org.freedesktop.Example >> \
org/freedesktop/Example.md
See the example/Makefile.am for more details.