aboutsummaryrefslogtreecommitdiff
path: root/tests/utils
diff options
context:
space:
mode:
Diffstat (limited to 'tests/utils')
-rw-r--r--tests/utils/adbd-server.h148
-rw-r--r--tests/utils/dbus-types.h47
-rw-r--r--tests/utils/glib-fixture.h203
-rw-r--r--tests/utils/qmain.cpp60
-rw-r--r--tests/utils/test-dbus-fixture.h106
5 files changed, 564 insertions, 0 deletions
diff --git a/tests/utils/adbd-server.h b/tests/utils/adbd-server.h
new file mode 100644
index 0000000..740faaa
--- /dev/null
+++ b/tests/utils/adbd-server.h
@@ -0,0 +1,148 @@
+/*
+ * Copyright 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ * Charles Kerr <charles.kerr@canonical.com>
+ */
+
+#include <gio/gio.h>
+#include <gio/gunixsocketaddress.h>
+
+#include <string>
+#include <thread>
+#include <vector>
+
+
+/**
+ * A Mock ADBD server.
+ *
+ * Binds to a local domain socket, sends public key requests across it,
+ * and reads back the client's responses.
+ */
+class GAdbdServer
+{
+public:
+
+ GAdbdServer(const std::string& socket_path,
+ const std::vector<std::string>& requests):
+ m_requests{requests},
+ m_socket_path{socket_path},
+ m_cancellable{g_cancellable_new()},
+ m_worker_thread{&GAdbdServer::worker_func, this}
+ {
+ }
+
+ ~GAdbdServer()
+ {
+ // tell the worker thread to stop whatever it's doing and exit.
+ g_cancellable_cancel(m_cancellable);
+ m_worker_thread.join();
+ g_clear_object(&m_cancellable);
+ }
+
+ const std::vector<std::string> m_requests;
+ std::vector<std::string> m_responses;
+
+private:
+
+ void worker_func() // runs in worker thread
+ {
+ auto server_socket = create_server_socket(m_socket_path);
+ auto requests = m_requests;
+
+ GError* error {};
+ g_socket_listen (server_socket, &error);
+ g_assert_no_error (error);
+
+ while (!g_cancellable_is_cancelled(m_cancellable) && !requests.empty())
+ {
+ // wait for a client connection
+ g_message("GAdbdServer::Impl::worker_func() calling g_socket_accept()");
+ auto client_socket = g_socket_accept(server_socket, m_cancellable, &error);
+ if (error != nullptr) {
+ if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
+ g_warning("GAdbdServer: Error accepting socket connection: %s", error->message);
+ g_clear_error(&error);
+ break;
+ }
+
+ // pop the next request off the stack
+ auto request = requests.front();
+ requests.erase(requests.begin());
+
+ // send the request
+ g_message("GAdbdServer::Impl::worker_func() sending req [%s]", request.c_str());
+ g_socket_send(client_socket,
+ request.c_str(),
+ request.size(),
+ m_cancellable,
+ &error);
+ if (error != nullptr) {
+ if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
+ g_warning("GAdbdServer: Error sending request: %s", error->message);
+ g_clear_error(&error);
+ g_clear_object(&client_socket);
+ break;
+ }
+
+ // read the response
+ g_message("GAdbdServer::Impl::worker_func() reading response");
+ char buf[4096];
+ const auto n_bytes = g_socket_receive(client_socket,
+ buf,
+ sizeof(buf),
+ m_cancellable,
+ &error);
+ if (error != nullptr) {
+ if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
+ g_warning("GAdbdServer: Error reading response: %s", error->message);
+ g_clear_error(&error);
+ g_clear_object(&client_socket);
+ break;
+ }
+ const std::string response(buf, std::string::size_type(n_bytes));
+ g_message("server got response: %s", response.c_str());
+ m_responses.push_back(response);
+
+ // cleanup
+ g_clear_object(&client_socket);
+ }
+
+ g_clear_object(&server_socket);
+ }
+
+ // bind to a local domain socket
+ static GSocket* create_server_socket(const std::string& socket_path)
+ {
+ GError* error {};
+ auto socket = g_socket_new(G_SOCKET_FAMILY_UNIX,
+ G_SOCKET_TYPE_STREAM,
+ G_SOCKET_PROTOCOL_DEFAULT,
+ &error);
+ g_assert_no_error(error);
+ auto address = g_unix_socket_address_new (socket_path.c_str());
+ g_socket_bind (socket, address, false, &error);
+ g_assert_no_error (error);
+ g_clear_object (&address);
+
+ return socket;
+ }
+
+ const std::string m_socket_path;
+ GCancellable* m_cancellable = nullptr;
+ std::thread m_worker_thread;
+};
+
+
diff --git a/tests/utils/dbus-types.h b/tests/utils/dbus-types.h
new file mode 100644
index 0000000..c2dfb81
--- /dev/null
+++ b/tests/utils/dbus-types.h
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2013-2016 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Pete Woods <pete.woods@canonical.com>
+ */
+
+#pragma once
+
+#include <QDBusMetaType>
+#include <QtCore>
+#include <QString>
+#include <QVariantMap>
+
+typedef QMap<QString, QVariantMap> QVariantDictMap;
+Q_DECLARE_METATYPE(QVariantDictMap)
+
+typedef QMap<QString, QString> QStringMap;
+Q_DECLARE_METATYPE(QStringMap)
+
+namespace DBusTypes
+{
+ inline void registerMetaTypes()
+ {
+ qRegisterMetaType<QVariantDictMap>("QVariantDictMap");
+ qRegisterMetaType<QStringMap>("QStringMap");
+
+ qDBusRegisterMetaType<QVariantDictMap>();
+ qDBusRegisterMetaType<QStringMap>();
+ }
+ static constexpr char const* NOTIFY_DBUS_NAME = "org.freedesktop.Notifications";
+
+ static constexpr char const* NOTIFY_DBUS_INTERFACE = "org.freedesktop.Notifications";
+
+ static constexpr char const* NOTIFY_DBUS_PATH = "/org/freedesktop/Notifications";
+}
diff --git a/tests/utils/glib-fixture.h b/tests/utils/glib-fixture.h
new file mode 100644
index 0000000..ccdeccd
--- /dev/null
+++ b/tests/utils/glib-fixture.h
@@ -0,0 +1,203 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ * Charles Kerr <charles.kerr@canonical.com>
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <functional> // std::function
+#include <map>
+#include <memory> // std::shared_ptr
+
+#include <glib.h>
+#include <glib/gstdio.h>
+#include <gio/gio.h>
+
+#include <gtest/gtest.h>
+
+#include <locale.h> // setlocale()
+
+class GlibFixture : public ::testing::Test
+{
+ public:
+
+ virtual ~GlibFixture() =default;
+
+ protected:
+
+ virtual void SetUp() override
+ {
+ setlocale(LC_ALL, "C.UTF-8");
+
+ loop = g_main_loop_new(nullptr, false);
+
+#ifdef SCHEMA_DIR
+ // only use local, temporary settings
+ g_assert(g_setenv("GSETTINGS_SCHEMA_DIR", SCHEMA_DIR, true));
+ g_assert(g_setenv("GSETTINGS_BACKEND", "memory", true));
+ g_debug("SCHEMA_DIR is %s", SCHEMA_DIR);
+#endif
+
+ // fail on unexpected messages from this domain
+ g_log_set_fatal_mask(G_LOG_DOMAIN, G_LOG_LEVEL_WARNING);
+
+ g_unsetenv("DISPLAY");
+
+ }
+
+ virtual void TearDown() override
+ {
+ g_test_assert_expected_messages ();
+
+ g_clear_pointer(&loop, g_main_loop_unref);
+ }
+
+ void expectLogMessage (const gchar *domain, GLogLevelFlags level, const gchar *pattern)
+ {
+ g_test_expect_message (domain, level, pattern);
+ }
+
+ private:
+
+ static gboolean
+ wait_for_signal__timeout(gpointer name)
+ {
+ g_error("%s: timed out waiting for signal '%s'", G_STRLOC, static_cast<const char*>(name));
+ return G_SOURCE_REMOVE;
+ }
+
+ static gboolean
+ wait_msec__timeout(gpointer loop)
+ {
+ g_main_loop_quit(static_cast<GMainLoop*>(loop));
+ return G_SOURCE_CONTINUE;
+ }
+
+ protected:
+
+ /* convenience func to loop while waiting for a GObject's signal */
+ void wait_for_signal(gpointer o, const gchar * signal, guint timeout_seconds=5)
+ {
+ // wait for the signal or for timeout, whichever comes first
+ const auto handler_id = g_signal_connect_swapped(o, signal,
+ G_CALLBACK(g_main_loop_quit),
+ loop);
+ const auto timeout_id = g_timeout_add_seconds(timeout_seconds,
+ wait_for_signal__timeout,
+ loop);
+ g_main_loop_run(loop);
+ g_source_remove(timeout_id);
+ g_signal_handler_disconnect(o, handler_id);
+ }
+
+ /* convenience func to loop for N msec */
+ void wait_msec(guint msec=50)
+ {
+ const auto id = g_timeout_add(msec, wait_msec__timeout, loop);
+ g_main_loop_run(loop);
+ g_source_remove(id);
+ }
+
+ bool wait_for(std::function<bool()> test_function, guint timeout_msec=1000)
+ {
+ auto timer = std::shared_ptr<GTimer>(g_timer_new(), [](GTimer* t){g_timer_destroy(t);});
+ const auto timeout_sec = timeout_msec / 1000.0;
+ for (;;) {
+ if (test_function())
+ return true;
+ //g_message("%f ... %f", g_timer_elapsed(timer.get(), nullptr), timeout_sec);
+ if (g_timer_elapsed(timer.get(), nullptr) >= timeout_sec)
+ return false;
+ wait_msec();
+ }
+ }
+
+ bool wait_for_name_owned(GDBusConnection* connection,
+ const gchar* name,
+ guint timeout_msec=1000,
+ GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+ {
+ struct Data {
+ GMainLoop* loop = nullptr;
+ bool owned = false;
+ };
+ Data data;
+
+ auto on_name_appeared = [](GDBusConnection* /*connection*/,
+ const gchar* /*name_*/,
+ const gchar* name_owner,
+ gpointer gdata)
+ {
+ if (name_owner == nullptr)
+ return;
+ auto tmp = static_cast<Data*>(gdata);
+ tmp->owned = true;
+ g_main_loop_quit(tmp->loop);
+ };
+
+ const auto timeout_id = g_timeout_add(timeout_msec, wait_msec__timeout, loop);
+ data.loop = loop;
+ const auto watch_id = g_bus_watch_name_on_connection(connection,
+ name,
+ flags,
+ on_name_appeared,
+ nullptr, /* name_vanished */
+ &data,
+ nullptr); /* user_data_free_func */
+ g_main_loop_run(loop);
+
+ g_bus_unwatch_name(watch_id);
+ g_source_remove(timeout_id);
+
+ return data.owned;
+ }
+
+ void EXPECT_NAME_OWNED_EVENTUALLY(GDBusConnection* connection,
+ const gchar* name,
+ guint timeout_msec=1000,
+ GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+ {
+ EXPECT_TRUE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+ }
+
+ void EXPECT_NAME_NOT_OWNED_EVENTUALLY(GDBusConnection* connection,
+ const gchar* name,
+ guint timeout_msec=1000,
+ GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+ {
+ EXPECT_FALSE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+ }
+
+ void ASSERT_NAME_OWNED_EVENTUALLY(GDBusConnection* connection,
+ const gchar* name,
+ guint timeout_msec=1000,
+ GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+ {
+ ASSERT_TRUE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+ }
+
+ void ASSERT_NAME_NOT_OWNED_EVENTUALLY(GDBusConnection* connection,
+ const gchar* name,
+ guint timeout_msec=1000,
+ GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+ {
+ ASSERT_FALSE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+ }
+
+ GMainLoop * loop;
+};
+
diff --git a/tests/utils/qmain.cpp b/tests/utils/qmain.cpp
new file mode 100644
index 0000000..72a49b1
--- /dev/null
+++ b/tests/utils/qmain.cpp
@@ -0,0 +1,60 @@
+/*
+ * Copyright © 2014 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/>.
+ *
+ * Authors:
+ * Pete Woods <pete.woods@canonical.com>
+ */
+
+//#include <config.h>
+
+#include <QCoreApplication>
+#include <QTimer>
+#include <gtest/gtest.h>
+
+#include <libqtdbusmock/DBusMock.h>
+
+using namespace QtDBusMock;
+
+class Runner: public QObject
+{
+ Q_OBJECT
+public Q_SLOTS:
+ void run()
+ {
+ QCoreApplication::exit(RUN_ALL_TESTS());
+ }
+};
+
+int main(int argc, char **argv)
+{
+ qputenv("LANG", "C.UTF-8");
+ unsetenv("LC_ALL");
+
+ // boilerplate i18n
+ setlocale(LC_ALL, "");
+ bindtextdomain(GETTEXT_PACKAGE, GNOMELOCALEDIR);
+ textdomain(GETTEXT_PACKAGE);
+
+ QCoreApplication application(argc, argv);
+ DBusMock::registerMetaTypes();
+ ::testing::InitGoogleTest(&argc, argv);
+
+ Runner runner;
+ QTimer::singleShot(0, &runner, SLOT(run()));
+
+ return application.exec();
+}
+
+#include "qmain.moc"
diff --git a/tests/utils/test-dbus-fixture.h b/tests/utils/test-dbus-fixture.h
new file mode 100644
index 0000000..3947e58
--- /dev/null
+++ b/tests/utils/test-dbus-fixture.h
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ * Charles Kerr <charles.kerr@canonical.com>
+ */
+
+#pragma once
+
+#include "glib-fixture.h"
+
+/***
+****
+***/
+
+class TestDBusFixture: public GlibFixture
+{
+ public:
+
+ TestDBusFixture() =default;
+ virtual ~TestDBusFixture() =default;
+
+ explicit TestDBusFixture(const std::vector<std::string>& service_dirs_in): service_dirs(service_dirs_in) {}
+
+ private:
+
+ typedef GlibFixture super;
+
+ static void
+ on_bus_opened (GObject* /*object*/, GAsyncResult * res, gpointer gself)
+ {
+ auto self = static_cast<TestDBusFixture*>(gself);
+
+ GError * err = 0;
+ self->system_bus = g_bus_get_finish (res, &err);
+ g_assert_no_error (err);
+
+ g_main_loop_quit (self->loop);
+ }
+
+ static void
+ on_bus_closed (GObject* /*object*/, GAsyncResult * res, gpointer gself)
+ {
+ auto self = static_cast<TestDBusFixture*>(gself);
+
+ GError * err = 0;
+ g_dbus_connection_close_finish (self->system_bus, res, &err);
+ g_assert_no_error (err);
+
+ g_main_loop_quit (self->loop);
+ }
+
+ protected:
+
+ GTestDBus * test_dbus = nullptr;
+ GDBusConnection * system_bus = nullptr;
+ const std::vector<std::string> service_dirs;
+
+ virtual void SetUp() override
+ {
+ super::SetUp ();
+
+ // pull up a test dbus
+ test_dbus = g_test_dbus_new (G_TEST_DBUS_NONE);
+ for (const auto& dir : service_dirs)
+ g_test_dbus_add_service_dir (test_dbus, dir.c_str());
+ g_test_dbus_up (test_dbus);
+ const char * address = g_test_dbus_get_bus_address (test_dbus);
+ g_setenv ("DBUS_SYSTEM_BUS_ADDRESS", address, true);
+ g_setenv ("DBUS_SESSION_BUS_ADDRESS", address, true);
+ g_debug ("test_dbus's address is %s", address);
+
+ // wait for the GDBusConnection before returning
+ g_bus_get (G_BUS_TYPE_SYSTEM, nullptr, on_bus_opened, this);
+ g_main_loop_run (loop);
+ }
+
+ virtual void TearDown() override
+ {
+ wait_msec();
+
+ // close the system bus
+ g_dbus_connection_close(system_bus, nullptr, on_bus_closed, this);
+ g_main_loop_run(loop);
+ g_clear_object(&system_bus);
+
+ // tear down the test dbus
+ g_test_dbus_down(test_dbus);
+ g_clear_object(&test_dbus);
+
+ super::TearDown();
+ }
+};
+
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 07:29:43 +0000