Merge lp:~thomas-voss/location-service/add-snapcraft-setup-next into lp:location-service

[Thomas Voß]

Replay http://bazaar.launchpad.net/~phablet-team/location-service/trunk/revision/265.

Replay http://bazaar.launchpad.net/~phablet-team/location-service/trunk/revision/265.

[lp:~thomas-voss/location-service/add-snapcraft-setup-next]

268. By Thomas Voß on 2016-08-26

Wire up system configuration into cmds::Run.

[Simon Fels (morphis)]

LGTM

review: Approve

=== modified file '3rd-party/ichnaea/CMakeLists.txt'
--- 3rd-party/ichnaea/CMakeLists.txt	2016-08-14 19:36:05 +0000
+++ 3rd-party/ichnaea/CMakeLists.txt	2016-08-26 14:52:08 +0000
@@ -11,14 +11,12 @@
 find_package(Threads)
 
 pkg_check_modules(NET_CPP net-cpp REQUIRED)
-pkg_check_modules(UBUNTU_LOCATION_SERVICE_CONNECTIVITY ubuntu-location-service-connectivity REQUIRED)
 
 include_directories(
   include
   src
 
-  ${NET_CPP_INCLUDE_DIRS}
-  ${UBUNTU_LOCATION_SERVICE_CONNECTIVITY_INCLUDE_DIRS})
+  ${NET_CPP_INCLUDE_DIRS})
 
 add_library(
   ichnaea
@@ -50,19 +48,8 @@
 
 target_link_libraries(
   ichnaea
-
+  
   ${CMAKE_THREAD_LIBS_INIT}
-  ${NET_CPP_LDFLAGS}
-  ${UBUNTU_LOCATION_SERVICE_CONNECTIVITY_LDFLAGS})
-
-add_executable(
-  ichnaea-client
-
-  examples/client.cpp)
-
-target_link_libraries(
-  ichnaea-client
-
-  ichnaea)
+  ${NET_CPP_LDFLAGS})
 
 add_subdirectory(tests)

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-08-24 14:12:05 +0000
+++ CMakeLists.txt	2016-08-26 14:52:08 +0000
@@ -2,6 +2,10 @@
 
 project(ubuntu-location-service)
 
+if (DEFINED SNAPPY_UBUNTU_CORE)
+  add_definitions(-DSNAPPY_UBUNTU_CORE)
+endif()
+
 # We haven't received version information via the packaging setup.
 # For that, we try to determine sensible values on our own, ensuring
 # plain old invocations to cmake still work as expected.

=== added file 'snapcraft.yaml'
--- snapcraft.yaml	1970-01-01 00:00:00 +0000
+++ snapcraft.yaml	2016-08-26 14:52:08 +0000
@@ -0,0 +1,96 @@
+name: locationd
+version: 3.0.0+16.10.20160616-0ubuntu1
+summary: Location service mediates access to positioning providers.
+description: |
+  Location service mediates access to positioning providers.
+  
+  **Note** Currently only the dummy provider is supported in this snap. Additional
+  providers will be made available in the near future.
+
+  Please find the source for this snap at https://code.launchpad.net/location-service
+
+apps:
+  run:
+    daemon: simple
+    command: bin/locationd run --bus system
+    slots: [service, cli]
+    plugs: [network-manager]
+  cli:
+    command: bin/locationd status --bus system
+    plugs: [cli]
+  monitor:
+    command: bin/locationd monitor --bus system
+    plugs: [client]
+
+slots:
+    service:
+        interface: location-observe
+    cli:
+        interface: location-control
+plugs:
+    client:
+        interface: location-observe
+    cli:
+        interface: location-control
+
+parts:
+  location-service:
+    plugin: cmake
+    configflags:
+      - -DCMAKE_VERBOSE_MAKEFILE=ON
+      - -DSNAPPY_UBUNTU_CORE=yes
+      - -DUBUNTU_LOCATION_SERVICE_VERSION_MAJOR=3
+    source: .
+    build-packages:
+      - curl
+      - doxygen
+      - gcc
+      - geoclue-ubuntu-geoip
+      - gettext
+      - google-mock
+      - graphviz
+      - g++
+      - libapparmor-dev
+      - libboost-filesystem-dev
+      - libboost-program-options-dev
+      - libboost-system-dev
+      - libc6-dev
+      - libdbus-1-dev
+      - libdbus-cpp-dev
+      - libgoogle-glog-dev
+      - libgtest-dev
+      - libiw-dev
+      - libjson-c-dev
+      - libnet-cpp-dev
+      - libprocess-cpp-dev
+      - libtrust-store-dev
+      - libproperties-cpp-dev
+      - libubuntu-platform-hardware-api-headers
+      - libubuntu-platform-hardware-api-dev
+      - trust-store-bin
+    stage-packages:
+      - geoclue-ubuntu-geoip
+      - libapparmor1
+      - libboost-filesystem1.58.0
+      - libboost-program-options1.58.0
+      - libboost-system1.58.0
+      - libdbus-cpp5
+      - libgflags2v5
+      - libgoogle-glog0v5
+      - libjson-c2
+      - libnet-cpp2
+      - libprocess-cpp3
+      - libtrust-store2
+      - libubuntu-platform-hardware-api3
+    filesets:
+      licenses:
+        - usr/share/doc/*/*copyright*
+    snap:
+      - bin/locationd
+      - etc/dbus-1/system.d
+      - etc/gps.conf
+      - lib/
+      - lib/libubuntu-location-service*
+      - share/ubuntu-location-service
+      - usr/lib/
+      - $licenses

=== modified file 'src/location/CMakeLists.txt'
--- src/location/CMakeLists.txt	2016-08-24 14:12:05 +0000
+++ src/location/CMakeLists.txt	2016-08-26 14:52:08 +0000
@@ -30,6 +30,7 @@
   space_vehicle.cpp
   time_based_update_policy.cpp
   set_name_for_thread.cpp
+  system_configuration.cpp
   time_since_boot.cpp
   wifi_and_cell_reporting_state.cpp
 

=== added file 'src/location/always_granting_permission_manager.h'
--- src/location/always_granting_permission_manager.h	1970-01-01 00:00:00 +0000
+++ src/location/always_granting_permission_manager.h	2016-08-26 14:52:08 +0000
@@ -0,0 +1,44 @@
+/*
+ * Copyright © 2016 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: Scott Sweeny <[e-mail]>
+ */
+#ifndef LOCATION_ALWAYS_GRANTING_PERMISSION_MANAGER_H_
+#define LOCATION_ALWAYS_GRANTING_PERMISSION_MANAGER_H_
+
+#include <location/permission_manager.h>
+
+namespace core { namespace dbus {
+class Bus;
+}}
+
+namespace location
+{
+// A PermissionManager implementation which always returns granted since 
+// permissions are handed by interfaces in Snappy
+class AlwaysGrantingPermissionManager : public PermissionManager
+{
+public:
+    AlwaysGrantingPermissionManager() = default;
+
+    // From PermissionManager
+    Result check_permission_for_credentials(const Criteria&, const Credentials&) override
+    {
+        return Result::granted;
+    }
+};
+}
+
+#endif // LOCATION_ALWAYS_GRANTING_PERMISSION_MANAGER_H_

=== modified file 'src/location/cmds/run.cpp'
--- src/location/cmds/run.cpp	2016-08-12 11:52:37 +0000
+++ src/location/cmds/run.cpp	2016-08-26 14:52:08 +0000
@@ -25,6 +25,7 @@
 #include <location/serializing_bus.h>
 #include <location/service_with_engine.h>
 #include <location/settings.h>
+#include <location/system_configuration.h>
 #include <location/trust_store_permission_manager.h>
 
 #include <location/dbus/skeleton/service.h>
@@ -40,7 +41,7 @@
     : CommandWithFlagsAndAction{cli::Name{"run"}, cli::Usage{"run"}, cli::Description{"runs the daemon"}},
       testing{false},
       bus{core::dbus::WellKnownBus::system},
-      settings{"/var/lib/ubuntu-location-service/config.ini"}
+      settings{SystemConfiguration::instance().runtime_persistent_data_dir()}
 {
     flag(cli::make_flag(cli::Name{"testing"}, cli::Description{"whether we are running under testing, defaults to false"}, testing));
     flag(cli::make_flag(cli::Name{"bus"}, cli::Description{"bus instance to connect to, defaults to system"}, bus));
@@ -98,7 +99,7 @@
             std::make_shared<location::dbus::skeleton::Service::DBusDaemonCredentialsResolver>(outgoing),
             std::make_shared<location::dbus::skeleton::Service::ObjectPathGenerator>(),
             // Incoming requests are verified by talking to a trust-store instance.
-            location::TrustStorePermissionManager::create_default_instance_with_bus(outgoing)
+            SystemConfiguration::instance().create_permission_manager(outgoing)
         };
 
         rt->start();

=== modified file 'src/location/providers/mls/CMakeLists.txt'
--- src/location/providers/mls/CMakeLists.txt	2016-08-14 19:36:05 +0000
+++ src/location/providers/mls/CMakeLists.txt	2016-08-26 14:52:08 +0000
@@ -6,6 +6,8 @@
 target_link_libraries(
   mls
 
+  ubuntu-location-service-connectivity
+  
   ichnaea)
 
 set(

=== added file 'src/location/system_configuration.cpp'
--- src/location/system_configuration.cpp	1970-01-01 00:00:00 +0000
+++ src/location/system_configuration.cpp	2016-08-26 14:52:08 +0000
@@ -0,0 +1,83 @@
+/*
+ * Copyright © 2016 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ß <[e-mail]>
+ *              Scott Sweeny <[e-mail]>
+ */
+#include <location/system_configuration.h>
+
+#include <location/always_granting_permission_manager.h>
+#include <location/trust_store_permission_manager.h>
+
+#include <location/logging.h>
+
+#include <core/posix/this_process.h>
+
+namespace env = core::posix::this_process::env;
+
+#if defined(SNAPPY_UBUNTU_CORE)
+namespace
+{
+struct SnappySystemConfiguration : public location::SystemConfiguration
+{
+    fs::path runtime_persistent_data_dir() const
+    {
+        std::string data_dir = env::get("SNAP_DATA");
+        if (!data_dir.empty()) {
+            return data_dir;
+        } else {
+            LOG(WARNING) << "SNAP_DATA environment variable is not defined.";
+
+            // If SNAP_DATA isn't set it's almost certain we're not running
+            // from a snap, so return the conventional path
+            return "/var/lib/ubuntu-location-service";
+        }
+    }
+    
+    location::PermissionManager::Ptr create_permission_manager(const std::shared_ptr<core::dbus::Bus>&) const
+    {
+        return std::make_shared<location::AlwaysGrantingPermissionManager>();
+    }
+};
+}
+
+location::SystemConfiguration& location::SystemConfiguration::instance()
+{
+    static SnappySystemConfiguration config;
+    return config;
+}
+#else
+namespace
+{
+struct UbuntuSystemConfiguration : public location::SystemConfiguration
+{
+    fs::path runtime_persistent_data_dir() const
+    {
+        return "/var/lib/ubuntu-location-service";
+    }
+    
+    location::PermissionManager::Ptr create_permission_manager(const std::shared_ptr<core::dbus::Bus>& bus) const
+    {
+        return location::TrustStorePermissionManager::create_default_instance_with_bus(bus);
+    }    
+};
+}
+
+location::SystemConfiguration& location::SystemConfiguration::instance()
+{
+    static UbuntuSystemConfiguration config;
+    return config;
+}
+#endif // SNAPPY_UBUNTU_CORE

=== added file 'src/location/system_configuration.h'
--- src/location/system_configuration.h	1970-01-01 00:00:00 +0000
+++ src/location/system_configuration.h	2016-08-26 14:52:08 +0000
@@ -0,0 +1,54 @@
+/*
+ * Copyright © 2016 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ß <[e-mail]>
+ *              Scott Sweeny <[e-mail]>
+ */
+#ifndef LOCATION_SYSTEM_CONFIGURATION_H_
+#define LOCATION_SYSTEM_CONFIGURATION_H_
+
+#include <location/permission_manager.h>
+
+#include <boost/filesystem.hpp>
+
+#include <core/dbus/bus.h>
+
+namespace fs = boost::filesystem;
+
+namespace location
+{
+class SystemConfiguration
+{
+public:
+    // A singleton is ugly, but it's the easier way forward
+    // if we want to contain snappy-specific setup for now.
+    static SystemConfiguration& instance();
+
+    virtual ~SystemConfiguration() = default;
+    
+    // runtime_data_dir returns the path to the directory the service should
+    // use to store runtime persistent data.
+    virtual fs::path runtime_persistent_data_dir() const = 0;
+    
+    // create_permission_manager returns an instance of PermissionManager that 
+    // is meant to be used by the service to verify incoming connection requests.
+    virtual PermissionManager::Ptr create_permission_manager(const std::shared_ptr<core::dbus::Bus>& bus) const = 0;
+    
+protected:
+    SystemConfiguration() = default;
+};
+}
+
+#endif // LOCATION_SYSTEM_CONFIGURATION_H_