Merge pull request #8 from StarryInternet/feature/macOS

Building on macOS

Author: mtp401

README.md

@@ -3,42 +3,6 @@ sysadmin
 
 Like system administrators in big companies, `sysadmin` configures things
 
-Development
-===========
-
-Generally speaking, build as follows:
-
-```
-mkdir build
-cd build
-cmake ..
-make check
-make
-```
-
-`make check` runs only sysadmin's tests. If you wish to run the decibel-cpp tests, run
-`make decibel-check`.
-
-If this is your first time, you might have some dependencies which need to be installed
-first. The included `third-party-build.sh` will download, build, then install those
-dependencies. You will definitely need gcc, g++, and make at the very least in order
-to build those dependencies.
-
-Dependencies
-============
-
-sysadmin's dependencies are codified in its CMakeLists.txt files, but the key ones are
-as follows:
-    - decibel-cpp, which is included with sysadmin and built when sysadmin is built. It
-      is a C++ wrapper around libuv, and additional abstractions built with folly
-    - [libuv](https://github.com/libuv/libuv) is a C event loop library
-    - [boost](http://www.boost.org/) is boost
-    - [folly](https://github.com/facebook/folly) is a C++ library, primarily used for
-      its excellent futures code
-    - [protobufs](https://developers.google.com/protocol-buffers/), specifically proto 2,
-      provides the API to sysadmin
-    - [yaml-cpp](https://github.com/jbeder/yaml-cpp) provides YAML config file support
-
 About
 =====
 
@@ -70,3 +34,51 @@ sysadmin allows you to change the value of one or more of these keys, then `comm
 all at once, at which point the 2 hooks above are run. From a user's perspective, they need
 only know what values they want, and sysadmin takes care of the messy, system level details
 via its hooks.
+
+Dependencies
+============
+
+sysadmin's dependencies are codified in its CMakeLists.txt files, but the key ones are
+as follows:
+    - decibel-cpp, which is included with sysadmin and built when sysadmin is built. It
+      is a C++ wrapper around libuv, and additional abstractions built with folly
+    - [libuv](https://github.com/libuv/libuv) is a C event loop library
+    - [boost](http://www.boost.org/) is boost
+    - [folly](https://github.com/facebook/folly) is a C++ library, primarily used for
+      its excellent futures code
+    - [protobufs](https://developers.google.com/protocol-buffers/), specifically proto 2,
+      provides the API to sysadmin
+    - [yaml-cpp](https://github.com/jbeder/yaml-cpp) provides YAML config file support
+
+Development
+===========
+
+Generally speaking, build as follows:
+
+```
+mkdir build
+cd build
+cmake ..
+make check
+make
+```
+
+`make check` runs only sysadmin's tests. If you wish to run the decibel-cpp tests, run
+`make decibel-check`.
+
+If this is your first time, you might have some dependencies which need to be installed
+first.
+
+If you're on linux, the included `third-party-build.sh` will pull and install all
+the necessary dependencies.
+
+On macOS, `brew` is generally able to install all the necessary
+libraries, at least at the time of writing this. You'll at least need to do the following
+the first time:
+```bash
+brew install folly # Folly is the key dependency, and brings boost with it
+brew install amqp-cpp
+brew install libuv
+brew install yaml-cpp
+brew install protobuf
+```

decibel-cpp/include/decibel/Protobuf.h

@@ -100,8 +100,10 @@ struct ProtobufSetter
 
 DEFINE_PROTOBUF_FIELD_MAPPING(int32_t, Int32);
 DEFINE_PROTOBUF_FIELD_MAPPING(int64_t, Int64);
+DEFINE_PROTOBUF_FIELD_MAPPING(long, Int64);
 DEFINE_PROTOBUF_FIELD_MAPPING(uint32_t, UInt32);
 DEFINE_PROTOBUF_FIELD_MAPPING(uint64_t, UInt64);
+DEFINE_PROTOBUF_FIELD_MAPPING(unsigned long, UInt64);
 DEFINE_PROTOBUF_FIELD_MAPPING(float, Float);
 DEFINE_PROTOBUF_FIELD_MAPPING(double, Double);
 DEFINE_PROTOBUF_FIELD_MAPPING(bool, Bool);

decibel-cpp/include/decibel/messaging/ProtobufProtocolFactory.h

@@ -51,7 +51,7 @@ class ProtobufProtocolFactory : public IProtocolFactory
         {
             auto protocol = std::make_unique<ProtocolT>(mDispatcher);
             protocol->RegisterSendErrorCallback(*mSendErrorCallback);
-            return protocol;
+            return std::move(protocol);
         }
         else
         {

decibel-cpp/include/decibel/messaging/RabbitMQMessageHandler.h

@@ -18,7 +18,7 @@ class RabbitMQMessageHandler : public IRabbitMQMessageHandler
     virtual void HandleData(AMQP::Message&& message, uint64_t, bool)
     {
         MessageType protobufMessage;
-        protobufMessage.ParseFromString(message.message());
+        protobufMessage.ParseFromString(std::string(message.body()));
         HandleMessage(std::move(protobufMessage));
     }
 

decibel-cpp/include/decibel/messaging/Reactor.h

@@ -22,7 +22,7 @@ namespace messaging
 class Protocol;
 class IProtocolFactory;
 
-class Reactor : public folly::Executor, public folly::Timekeeper
+class Reactor : public folly::Timekeeper
 {
 public:
     Reactor();
@@ -70,8 +70,9 @@ class Reactor : public folly::Executor, public folly::Timekeeper
         return pPromise->getFuture();
     }
 
-    // folly::Executor
-    virtual void add(folly::Func fn);
+    // This is kept around for posterity should anyone want to add back
+    // folly::Executor functionality
+    // virtual void add(folly::Func fn);
 
     // folly::TimeKeeper
     virtual folly::Future<folly::Unit> after(folly::Duration duration);

decibel-cpp/include/decibel/stdlib.h

@@ -2,7 +2,7 @@
 
 #include <memory>
 
-#ifndef __cpp_lib_make_unique
+#if !defined __cpp_lib_make_unique && !defined __APPLE__
 
 namespace std
 {

decibel-cpp/src/decibel/messaging/Reactor.cpp

@@ -28,8 +28,7 @@ namespace decibel
 namespace messaging
 {
 Reactor::Reactor()
-    : folly::Executor()
-    , folly::Timekeeper()
+    : folly::Timekeeper()
     , mEventLoop()
     , mpTimer(
           std::make_unique<EventLoopTimer>(niceuv::EventLoopTimer(&mEventLoop)))
@@ -153,10 +152,12 @@ void Reactor::CancelCall(std::shared_ptr<OneShotTimerEvent> pTimer)
     pTimer->Stop();
 }
 
-void Reactor::add(folly::Func fn)
-{
-    CallSoon(fn);
-}
+// This is kept around for posterity should anyone want to add back
+// folly::Executor functionality
+// void Reactor::add(folly::Func fn)
+// {
+//     CallSoon(fn);
+// }
 
 folly::Future<folly::Unit> Reactor::after(folly::Duration duration)
 {

decibel-cpp/src/decibel/messaging/TcpServer.cpp

@@ -23,7 +23,7 @@ TcpServer::TcpServer(niceuv::EventLoop* loop,
     : mServer(new niceuv::TcpServer(loop)), mProtocols()
 {
     auto connectCb = [factory, this, host, port](niceuv::TcpConnPtr conn) {
-        auto pProtocol = std::move(factory->Construct());
+        auto pProtocol = factory->Construct();
         auto rawpConn = conn.get();
         auto pTransport =
             std::make_unique<TcpTransport>(std::move(conn), host, port);

decibel-cpp/src/decibel/niceuv/WorkCancellable.cpp

@@ -1,5 +1,8 @@
 #include "decibel/niceuv/WorkCancellable.h"
 
+#include <exception>
+#include <stdexcept>
+
 namespace decibel
 {
 namespace niceuv

decibel-cpp/test/test_reactor.cpp

@@ -153,12 +153,14 @@ TEST(TestSelfConnectMultiClients, ConnectTcp)
     ASSERT_EQ(1, rawpProto2->mConnectionLostCalls);
 }
 
-TEST(TestReactor, FollyExecutorAdd)
-{
-    dm::Reactor r;
-    bool then_called = false;
-    auto fut = folly::makeFuture().via(&r).then([&]() { then_called = true; });
-    ASSERT_FALSE(then_called);
-    r.Start();
-    ASSERT_TRUE(then_called);
-}
+// This is kept around for posterity should anyone want to add back
+// folly::Executor functionality
+// TEST(TestReactor, FollyExecutorAdd)
+// {
+//     dm::Reactor r;
+//     bool then_called = false;
+//     auto fut = folly::makeFuture().via(&r).then([&]() { then_called = true; });
+//     ASSERT_FALSE(then_called);
+//     r.Start();
+//     ASSERT_TRUE(then_called);
+// }

src/ConfigTypes.h

@@ -73,6 +73,21 @@ class ConfigValue
         }
     }
 
+    template <typename T>
+    ConfigType<T> ToConfigType() const
+    {
+        BOOST_ASSERT_MSG(!mEmpty, "Can't dereference Empty Value");
+        try
+        {
+            return boost::get<ConfigType<T>>(mValue);
+        }
+        catch (const boost::bad_get& ex)
+        {
+            BOOST_ASSERT_MSG(false, "Requested incorrect type from variant");
+            return ConfigType<T>({});
+        }
+    }
+
     template <typename T>
     bool Is() const
     {

src/LocalYAMLStorage.cpp

@@ -25,6 +25,21 @@ namespace
 namespace dm = decibel::messaging;
 namespace bfs = boost::filesystem;
 
+namespace YAML
+{
+
+Node convert<ConfigType<std::vector<bool>>>::encode(const ConfigType<std::vector<bool>>& val)
+{
+    Node output;
+    for (const auto& iter : val.mValue)
+    {
+        output.push_back(bool(iter));
+    }
+    return output;
+}
+
+}
+
 YAML::Node LoadOrCreate(boost::filesystem::path path)
 {
     YAML::Node config;

src/LocalYAMLStorage.h

@@ -12,6 +12,22 @@
 
 #include <yaml-cpp/yaml.h>
 
+// Strictly speaking, this specialization is only necessary on macOS. The C++ headers included
+// in osx are opinionated enough about the bool vector specialization that they don't use
+// the same proxy reference methodology the gnu stdlib uses, or something like that.
+// Subsequently, we need to do this bool casting badness to get yaml-cpp's assignment to work
+// Chere here for more details: https://stackoverflow.com/questions/31974237/why-is-libcs-vectorboolconst-reference-not-bool
+namespace YAML
+{
+
+template<>
+struct convert<ConfigType<std::vector<bool>>>
+{
+    static Node encode(const ConfigType<std::vector<bool>>& val);
+};
+
+}
+
 #define DYNAMIC_UNPACK(value, storage)                      \
     if (value.Is<int32_t>())                                \
     {                                                       \
@@ -35,7 +51,7 @@
     }                                                       \
     else if (value.Is<std::vector<bool>>())                 \
     {                                                       \
-        storage = value.Unpack<std::vector<bool>>();        \
+        storage = value.ToConfigType<std::vector<bool>>();  \
     }
 
 std::pair<boost::filesystem::path, std::string> TranslateKeyToPathPair(const ConfigPair::Key& key);