Merge lp:~xavi-garcia-mena/keeper/fakes-and-integration-tests into lp:keeper

[Xavi Garcia]

Moved and merged fake helpers and created integration tests directory.

Moved and merged fake helpers and created integration tests directory.

Created the tests/fakes directory containing a merge of simple-helper and fake-backup-helper.
Moved test-helper.sh to tests/fakes

Removed src/simple-helper

Created tests/integration/tests, containing the upstart and full integration tests for helpers (helpers_test).

Removed simple-helper from the debian installation.

[Charles Kerr (charlesk)]

Great work!

review: Approve

=== modified file 'debian/keeper.install'
--- debian/keeper.install	2016-07-11 14:55:36 +0000
+++ debian/keeper.install	2016-07-27 10:18:45 +0000
@@ -1,4 +1,3 @@
 usr/lib/*/keeper/keeper-service
-usr/lib/*/keeper/simple-helper
 usr/lib/*/ubuntu-app-launch/backup-helper/exec-tool
 usr/lib/*/keeper/keeper-tar-create

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2016-07-22 04:01:28 +0000
+++ src/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -9,7 +9,6 @@
 add_subdirectory(util)
 add_subdirectory(helper)
 add_subdirectory(storage-framework)
-add_subdirectory(simple-helper)
 add_subdirectory(tar)
 
 set(

=== removed directory 'src/simple-helper'
=== removed file 'src/simple-helper/CMakeLists.txt'
--- src/simple-helper/CMakeLists.txt	2016-06-21 13:06:11 +0000
+++ src/simple-helper/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,22 +0,0 @@
-include_directories("${CMAKE_SOURCE_DIR}/src")
-include_directories("${CMAKE_BINARY_DIR}/src/qdbus-stubs")
-include_directories("${CMAKE_SOURCE_DIR}/src/qdbus-stubs")
-
-add_executable(
-  simple-helper
-  main.cpp
-)
-
-target_link_libraries(
-  simple-helper
-  qdbus-stubs
-  Qt5::Core
-  Qt5::DBus
-  Qt5::Network
-)
-
-install(
-  TARGETS
-    simple-helper
-  RUNTIME DESTINATION ${CMAKE_INSTALL_FULL_PKGLIBEXECDIR}
-)
\ No newline at end of file

=== removed file 'src/simple-helper/main.cpp'
--- src/simple-helper/main.cpp	2016-07-13 00:25:01 +0000
+++ src/simple-helper/main.cpp	1970-01-01 00:00:00 +0000
@@ -1,94 +0,0 @@
-/*
- * Copyright (C) 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 <[e-mail]>
- * 			Xavi Garcia <[e-mail]>
- */
-#include <dbus-types.h>
-
-#include "keeper_helper_interface.h"
-#include "simple-helper-defs.h"
-
-#include <QCoreApplication>
-#include <QDBusConnection>
-#include <QDBusUnixFileDescriptor>
-#include <QLocalSocket>
-
-#include <libintl.h>
-#include <cstdlib>
-#include <ctime>
-
-int
-main(int argc, char **argv)
-{
-    QCoreApplication app(argc, argv);
-    std::srand(unsigned(std::time(nullptr)));
-
-    // boilerplate locale
-    bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
-    setlocale(LC_ALL, "");
-    bindtextdomain(GETTEXT_PACKAGE, LOCALE_DIR);
-    textdomain(GETTEXT_PACKAGE);
-
-    QScopedPointer<DBusInterfaceKeeperHelper> helperInterface(
-        new DBusInterfaceKeeperHelper(
-            DBusTypes::KEEPER_SERVICE,
-            DBusTypes::KEEPER_HELPER_PATH,
-            QDBusConnection::sessionBus()
-        )
-    );
-
-    const quint64 n_bytes = sizeof(SIMPLE_HELPER_TEXT_TO_WRITE);
-    qDebug("simple helper calling Helper.StartBackup(%zu)", size_t(n_bytes));
-    auto reply = helperInterface->StartBackup(n_bytes);
-    reply.waitForFinished();
-
-    if (!reply.isValid())
-    {
-        qWarning() << "Error getting backup socket: " << reply.error().message();
-    }
-    else
-    {
-        auto backupSocket = reply.value().fileDescriptor();
-        qDebug() << "I've got the following socket descriptor: " << backupSocket;
-
-        QLocalSocket localSocket;
-        localSocket.setSocketDescriptor(backupSocket);
-        QByteArray writeme (SIMPLE_HELPER_TEXT_TO_WRITE, sizeof(SIMPLE_HELPER_TEXT_TO_WRITE));
-        qDebug() << "Wrote" << localSocket.write(writeme) << "bytes to it.";
-        localSocket.flush();
-        localSocket.disconnectFromServer();
-
-
-        QFile markFile(SIMPLE_HELPER_MARK_FILE_PATH);
-        markFile.open(QFile::WriteOnly);
-        markFile.close();
-        // this is just used when we need to simulate that the helper has finished
-        // when not running the full setup with upstart
-//        qDebug() << "Finishing...";
-//        QDBusReply<void> finishResp = keeperInterface->call(QLatin1String("finish"));
-//
-//        if (!finishResp.isValid())
-//        {
-//            qWarning() << "Error finishing: " << finishResp.error().message();
-//        }
-//        else
-//        {
-//            qDebug() << "Finished.";
-//        }
-    }
-
-    return 0;
-}

=== removed file 'src/simple-helper/simple-helper-defs.h'
--- src/simple-helper/simple-helper-defs.h	2016-06-30 13:01:31 +0000
+++ src/simple-helper/simple-helper-defs.h	1970-01-01 00:00:00 +0000
@@ -1,26 +0,0 @@
-/*
- * Copyright (C) 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 <[e-mail]>
- * 			Xavi Garcia <[e-mail]>
- */
-#pragma once
-
-namespace
-{
-constexpr char const SIMPLE_HELPER_MARK_FILE_PATH[] = "/tmp/simple-helper-finished";
-constexpr char const SIMPLE_HELPER_TEXT_TO_WRITE[] = "This is a test";
-
-}

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2016-07-22 13:47:58 +0000
+++ tests/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -14,6 +14,25 @@
 ###  Service DBusMock
 ###
 
+set(
+    BACKUP_HELPER
+    fake-backup-helper
+)
+
+set(KEEPER_TAR_CREATE_BIN ${CMAKE_BINARY_DIR}/src/tar/keeper-tar-create)
+set(KEEPER_TAR_CREATE_INVOKE ${CMAKE_CURRENT_BINARY_DIR}/tar/keeper-tar-create-invoke.sh)
+
+add_definitions(
+  -DCMAKE_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}"
+  -DCMAKE_BINARY_DIR="${CMAKE_CURRENT_BINARY_DIR}"
+  -DTEST_SIMPLE_HELPER="${CMAKE_BINARY_DIR}/tests/fakes/${BACKUP_HELPER}"
+  -DKEEPER_SERVICE_BIN="${CMAKE_BINARY_DIR}/src/service/keeper-service"
+  -DKEEPER_CLIENT_BIN="${CMAKE_BINARY_DIR}/src/cli/keeper"
+  -DTEST_SIMPLE_HELPER_SH="${CMAKE_SOURCE_DIR}/tests/fakes/helper-test.sh"
+  -DKEEPER_TAR_CREATE_BIN="${KEEPER_TAR_CREATE_BIN}"
+  -DKEEPER_TAR_CREATE_INVOKE="${KEEPER_TAR_CREATE_INVOKE}"
+)
+
 set(SERVICE_TEMPLATE_FILE "${CMAKE_CURRENT_SOURCE_DIR}/com_canonical_keeper.py")
 add_definitions(-DSERVICE_TEMPLATE_FILE="${SERVICE_TEMPLATE_FILE}")
 
@@ -54,6 +73,8 @@
 add_subdirectory(dbusmock)
 add_subdirectory(unit)
 add_subdirectory(utils)
+add_subdirectory(fakes)
+add_subdirectory(integration)
 
 set(
   UNIT_TEST_TARGETS

=== modified file 'tests/dbusmock/CMakeLists.txt'
--- tests/dbusmock/CMakeLists.txt	2016-07-15 01:15:39 +0000
+++ tests/dbusmock/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -20,23 +20,6 @@
 ###
 
 set(
-    BACKUP_HELPER
-    fake-backup-helper
-)
-
-add_executable(
-    ${BACKUP_HELPER}
-    fake-backup-helper.cpp
-)
-target_link_libraries(
-    ${BACKUP_HELPER}
-    ${LINK_LIBS}
-)
-
-###
-###
-
-set(
     TEST_NAME
     keeper-template-test
 )
@@ -48,7 +31,7 @@
 
 set_property(
     SOURCE keeper-template-test.cpp
-    PROPERTIES APPEND_STRING PROPERTY COMPILE_DEFINITIONS FAKE_BACKUP_HELPER_EXEC=\"${CMAKE_CURRENT_BINARY_DIR}/${BACKUP_HELPER}\"
+    PROPERTIES APPEND_STRING PROPERTY COMPILE_DEFINITIONS FAKE_BACKUP_HELPER_EXEC=\"${CMAKE_BINARY_DIR}/tests/fakes/${BACKUP_HELPER}\"
 )
 
 target_link_libraries(

=== modified file 'tests/dbusmock/keeper-template-test.cpp'
--- tests/dbusmock/keeper-template-test.cpp	2016-07-22 14:13:45 +0000
+++ tests/dbusmock/keeper-template-test.cpp	2016-07-27 10:18:45 +0000
@@ -17,7 +17,7 @@
  *   Charles Kerr <[e-mail]>
  */
 
-#include "fake-backup-helper.h"
+#include "tests/fakes/fake-backup-helper.h"
 
 #include "tests/utils/keeper-dbusmock-fixture.h"
 

=== added directory 'tests/fakes'
=== added file 'tests/fakes/CMakeLists.txt'
--- tests/fakes/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/fakes/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -0,0 +1,29 @@
+
+include_directories(
+    ${CMAKE_SOURCE_DIR}/src
+    ${CMAKE_BINARY_DIR}/src
+)
+
+set(
+    LINK_LIBS
+    qdbus-stubs
+    ${TEST_DEPENDENCIES_LDFLAGS}
+    test-utils
+    Qt5::Core
+    Qt5::DBus
+    Qt5::Network
+    ${GTEST_LIBRARIES}
+    ${GMOCK_LIBRARIES}
+)
+
+###
+###
+
+add_executable(
+    ${BACKUP_HELPER}
+    fake-backup-helper.cpp
+)
+target_link_libraries(
+    ${BACKUP_HELPER}
+    ${LINK_LIBS}
+)

=== renamed file 'tests/dbusmock/fake-backup-helper.cpp' => 'tests/fakes/fake-backup-helper.cpp'
--- tests/dbusmock/fake-backup-helper.cpp	2016-07-15 01:15:39 +0000
+++ tests/fakes/fake-backup-helper.cpp	2016-07-27 10:18:45 +0000
@@ -59,5 +59,10 @@
     qDebug() << "wrote" << sock.write(blob) << "bytes";
     sock.flush();
 
+    // create the mark file so we can check when it finished without upstart
+    QFile markFile(SIMPLE_HELPER_MARK_FILE_PATH);
+    markFile.open(QFile::WriteOnly);
+    markFile.close();
+
     return EXIT_SUCCESS;
 }

=== renamed file 'tests/dbusmock/fake-backup-helper.h' => 'tests/fakes/fake-backup-helper.h'
--- tests/dbusmock/fake-backup-helper.h	2016-07-15 01:15:39 +0000
+++ tests/fakes/fake-backup-helper.h	2016-07-27 10:18:45 +0000
@@ -19,6 +19,8 @@
 
 #pragma once
 
+namespace
+{
 static const char* FAKE_BACKUP_HELPER_PAYLOAD = R"(
     Oh mmm I know a place
     Ain't nobody cryin'
@@ -36,3 +38,7 @@
     Oh-oh! Let me take you there! (I'll take you there)
     Play your, play your piano now
 )";
+
+static char const SIMPLE_HELPER_MARK_FILE_PATH[] = "/tmp/simple-helper-finished";
+
+}

=== renamed file 'src/simple-helper/helper-test.sh' => 'tests/fakes/helper-test.sh'
=== added directory 'tests/integration'
=== added file 'tests/integration/CMakeLists.txt'
--- tests/integration/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/integration/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -0,0 +1,15 @@
+set(
+  INTEGRATION_TEST_LIBRARIES
+  backup-helper
+  test-utils
+  keeperservice
+  keepertar
+  qdbus-stubs
+  ${SERVICE_DEPS_LDFLAGS}
+  ${HELPERS_TEST_DEPS_LDFLAGS}
+  ${TEST_DEPENDENCIES_LDFLAGS}
+  ${GTEST_LIBRARIES}
+  ${GMOCK_LIBRARIES}
+)
+
+add_subdirectory(helpers)

=== added directory 'tests/integration/helpers'
=== added file 'tests/integration/helpers/CMakeLists.txt'
--- tests/integration/helpers/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/integration/helpers/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -0,0 +1,59 @@
+
+#
+# helpers-test
+#
+
+pkg_check_modules(HELPERS_TEST_DEPS REQUIRED
+  ubuntu-app-launch-2
+  properties-cpp
+  dbustest-1>=14.04.0
+  glib-2.0>=2.26
+  gio-2.0>=2.26
+  gio-unix-2.0
+)
+
+include_directories(
+  SYSTEM
+  ${UAL_INCLUDE_DIRS}
+  ${PROP-CPP_INCLUDE_DIRS}
+  ${HELPERS_TEST_DEPS_INCLUDE_DIRS}
+)
+
+set(
+  HELPERS_TEST
+  helpers-test
+)
+
+add_executable(
+  ${HELPERS_TEST}
+  helpers-test.cc
+  mir-mock.cpp
+)
+
+set_target_properties(
+  ${HELPERS_TEST}
+  PROPERTIES
+  COMPILE_FLAGS -fPIC
+  AUTOMOC TRUE
+)
+
+target_link_libraries(
+  ${HELPERS_TEST}
+  ${HELPERS_TEST_DEPS_LDFLAGS}
+  ${INTEGRATION_TEST_LIBRARIES}
+  Qt5::Core
+  Qt5::DBus
+  Qt5::Test
+)
+
+add_test(
+  NAME ${HELPERS_TEST}
+  COMMAND ${HELPERS_TEST}
+)
+
+set(
+  UNIT_TEST_TARGETS
+  ${UNIT_TEST_TARGETS}
+  ${HELPERS_TEST}
+  PARENT_SCOPE
+)

=== renamed file 'tests/unit/helper/helpers-test.cc' => 'tests/integration/helpers/helpers-test.cc'
--- tests/unit/helper/helpers-test.cc	2016-07-22 13:25:07 +0000
+++ tests/integration/helpers/helpers-test.cc	2016-07-27 10:18:45 +0000
@@ -37,7 +37,7 @@
 #include "mir-mock.h"
 #include <helper/backup-helper.h>
 #include <qdbus-stubs/dbus-types.h>
-#include <simple-helper/simple-helper-defs.h>
+#include "tests/fakes/fake-backup-helper.h"
 #include "tests/utils/file-utils.h"
 #include "../../../src/service/app-const.h"
 

=== renamed file 'tests/unit/helper/mir-mock.cpp' => 'tests/integration/helpers/mir-mock.cpp'
=== renamed file 'tests/unit/helper/mir-mock.h' => 'tests/integration/helpers/mir-mock.h'
=== modified file 'tests/unit/CMakeLists.txt'
--- tests/unit/CMakeLists.txt	2016-07-22 13:49:34 +0000
+++ tests/unit/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -1,15 +1,3 @@
-set(KEEPER_TAR_CREATE_BIN ${CMAKE_BINARY_DIR}/src/tar/keeper-tar-create)
-set(KEEPER_TAR_CREATE_INVOKE ${CMAKE_CURRENT_BINARY_DIR}/tar/keeper-tar-create-invoke.sh)
-
-add_definitions(
-  -DCMAKE_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}"
-  -DTEST_SIMPLE_HELPER="${CMAKE_BINARY_DIR}/src/simple-helper/simple-helper"
-  -DKEEPER_SERVICE_BIN="${CMAKE_BINARY_DIR}/src/service/keeper-service"
-  -DKEEPER_CLIENT_BIN="${CMAKE_BINARY_DIR}/src/cli/keeper"
-  -DTEST_SIMPLE_HELPER_SH="${CMAKE_SOURCE_DIR}/src/simple-helper/helper-test.sh"
-  -DKEEPER_TAR_CREATE_BIN="${KEEPER_TAR_CREATE_BIN}"
-  -DKEEPER_TAR_CREATE_INVOKE="${KEEPER_TAR_CREATE_INVOKE}"
-)
 
 include_directories(
   "${CMAKE_SOURCE_DIR}/src"

=== modified file 'tests/unit/helper/CMakeLists.txt'
--- tests/unit/helper/CMakeLists.txt	2016-07-22 12:59:11 +0000
+++ tests/unit/helper/CMakeLists.txt	2016-07-27 10:18:45 +0000
@@ -4,58 +4,6 @@
 )
 
 #
-# helpers-test
-#
-
-pkg_check_modules(HELPERS_TEST_DEPS REQUIRED
-  ubuntu-app-launch-2
-  properties-cpp
-  dbustest-1>=14.04.0
-  glib-2.0>=2.26
-  gio-2.0>=2.26
-  gio-unix-2.0
-)
-
-include_directories(
-  SYSTEM
-  ${UAL_INCLUDE_DIRS}
-  ${PROP-CPP_INCLUDE_DIRS}
-  ${HELPERS_TEST_DEPS_INCLUDE_DIRS}
-)
-
-set(
-  HELPERS_TEST
-  helpers-test
-)
-
-add_executable(
-  ${HELPERS_TEST}
-  helpers-test.cc
-  mir-mock.cpp
-)
-
-set_target_properties(
-  ${HELPERS_TEST}
-  PROPERTIES
-  COMPILE_FLAGS -fPIC
-  AUTOMOC TRUE
-)
-
-target_link_libraries(
-  ${HELPERS_TEST}
-  ${HELPERS_TEST_DEPS_LDFLAGS}
-  ${UNIT_TEST_LIBRARIES}
-  Qt5::Core
-  Qt5::DBus
-  Qt5::Test
-)
-
-add_test(
-  NAME ${HELPERS_TEST}
-  COMMAND ${HELPERS_TEST}
-)
-
-#
 # speed-test
 #
 
@@ -97,7 +45,6 @@
 set(
   UNIT_TEST_TARGETS
   ${UNIT_TEST_TARGETS}
-  ${HELPERS_TEST}
   ${SPEED_TEST}
   PARENT_SCOPE
 )