Merge #126 'Optionally listen on a UNIX socket instead of TCP'

Author: paoloambrosio

.travis.yml

@@ -25,6 +25,7 @@ addons:
       - libboost-system-dev
       - libboost-regex-dev
       - libboost-date-time-dev 
+      - libboost-filesystem-dev
       - libboost-program-options-dev
       - libboost-test-dev
       - google-mock

CMakeLists.txt

@@ -40,7 +40,7 @@ else()
     set(BOOST_MIN_VERSION "1.40")
 endif()
 
-set(CUKE_CORE_BOOST_LIBS thread system regex date_time program_options)
+set(CUKE_CORE_BOOST_LIBS thread system regex date_time program_options filesystem)
 if(NOT CUKE_DISABLE_BOOST_TEST)
     set(CUKE_TEST_BOOST_LIBS unit_test_framework)
 endif()
@@ -72,7 +72,7 @@ endif()
 
 if(Boost_FOUND)
     include_directories(${Boost_INCLUDE_DIRS})
-    set(CUKE_EXTRA_LIBRARIES ${CUKE_EXTRA_LIBRARIES} ${Boost_THREAD_LIBRARY} ${Boost_SYSTEM_LIBRARY} ${Boost_REGEX_LIBRARY} ${Boost_DATE_TIME_LIBRARY} ${Boost_PROGRAM_OPTIONS_LIBRARY})
+    set(CUKE_EXTRA_LIBRARIES ${CUKE_EXTRA_LIBRARIES} ${Boost_THREAD_LIBRARY} ${Boost_SYSTEM_LIBRARY} ${Boost_REGEX_LIBRARY} ${Boost_DATE_TIME_LIBRARY} ${Boost_PROGRAM_OPTIONS_LIBRARY} ${Boost_FILESYSTEM_LIBRARY})
 endif()
 
 #

HISTORY.md

@@ -2,6 +2,7 @@
 
 ### New Features
 
+* Add support for Unix sockets ([#126](https://github.com./cucumber/cucumber-cpp/pull/126) Giel van Schijndel)
 * Add support for using ephemeral ports ([#131](https://github.com./cucumber/cucumber-cpp/pull/131) Giel van Schijndel)
 * Removed CppSpec support ([#118](https://github.com./cucumber/cucumber-cpp/pull/118) Paolo Ambrosio)
 * Support for GoogleTest 1.8 ([#120](https://github.com./cucumber/cucumber-cpp/pull/120) Kamil Strzempowicz)

include/cucumber-cpp/internal/connectors/wire/WireServer.hpp

@@ -12,11 +12,41 @@ namespace internal {
 
 using namespace boost::asio;
 using namespace boost::asio::ip;
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+using namespace boost::asio::local;
+#endif
 
 /**
  * Socket server that calls a protocol handler line by line
  */
 class SocketServer {
+public:
+    /**
+      * Constructor for DI
+      */
+    SocketServer(const ProtocolHandler *protocolHandler);
+
+    /**
+     * Accept one connection
+     */
+    virtual void acceptOnce() = 0;
+
+protected:
+    const ProtocolHandler *protocolHandler;
+    io_service ios;
+
+    template <typename Protocol, typename Service>
+    void doListen(basic_socket_acceptor<Protocol, Service>& acceptor,
+            const typename Protocol::endpoint& endpoint);
+    template <typename Protocol, typename Service>
+    void doAcceptOnce(basic_socket_acceptor<Protocol, Service>& acceptor);
+    void processStream(std::iostream &stream);
+};
+
+/**
+ * Socket server that calls a protocol handler line by line
+ */
+class TCPSocketServer : public SocketServer {
 public:
     /**
      * Type definition for TCP port
@@ -26,35 +56,60 @@ class SocketServer {
     /**
       * Constructor for DI
       */
-    SocketServer(const ProtocolHandler *protocolHandler);
+    TCPSocketServer(const ProtocolHandler *protocolHandler);
 
     /**
      * Bind and listen to a TCP port
      */
     void listen(const port_type port);
 
     /**
-     * Port number that this server is currently listening on.
+     * Endpoint (IP address and port number) that this server is currently
+     * listening on.
      *
-     * @throw boost::system::system_error when not listening on any TCP port or
-     *        the port cannot be determined.
+     * @throw boost::system::system_error when not listening on any socket or
+     *        the endpoint cannot be determined.
+     */
+    tcp::endpoint listenEndpoint() const;
+
+    virtual void acceptOnce();
+
+private:
+    tcp::acceptor acceptor;
+};
+
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+/**
+ * Socket server that calls a protocol handler line by line
+ */
+class UnixSocketServer : public SocketServer {
+public:
+    /**
+      * Constructor for DI
+      */
+    UnixSocketServer(const ProtocolHandler *protocolHandler);
+
+    /**
+     * Bind and listen on a local stream socket
      */
-    port_type listenPort() const;
+    void listen(const std::string& unixPath);
 
     /**
-     * Accept one connection
+     * Port number that this server is currently listening on.
+     *
+     * @throw boost::system::system_error when not listening on any socket or
+     *        the endpoint cannot be determined.
      */
-    void acceptOnce();
+    stream_protocol::endpoint listenEndpoint() const;
 
-    ~SocketServer() {}; // Forbid inheritance
+    virtual void acceptOnce();
 
-private:
-    const ProtocolHandler *protocolHandler;
-    io_service ios;
-    tcp::acceptor acceptor;
+    ~UnixSocketServer();
 
-    void processStream(tcp::iostream &stream);
+private:
+    stream_protocol::acceptor acceptor;
 };
+#endif
 
 }
 }

src/connectors/wire/WireServer.cpp

@@ -1,40 +1,91 @@
 #include <cucumber-cpp/internal/connectors/wire/WireServer.hpp>
+#include <boost/filesystem/operations.hpp>
 
 namespace cucumber {
 namespace internal {
 
+using namespace boost::asio::ip;
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+using namespace boost::asio::local;
+#endif
+
 SocketServer::SocketServer(const ProtocolHandler *protocolHandler) :
     protocolHandler(protocolHandler),
-    ios(),
-    acceptor(ios) {
+    ios() {
 }
 
-void SocketServer::listen(const port_type port) {
-    tcp::endpoint endpoint(tcp::v4(), port);
+template <typename Protocol, typename Service>
+void SocketServer::doListen(basic_socket_acceptor<Protocol, Service>& acceptor,
+        const typename Protocol::endpoint& endpoint) {
+    if (acceptor.is_open())
+        throw boost::system::system_error(boost::asio::error::already_open);
     acceptor.open(endpoint.protocol());
-    acceptor.set_option(tcp::acceptor::reuse_address(true));
-    acceptor.set_option(tcp::no_delay(true));
+    acceptor.set_option(typename Protocol::acceptor::reuse_address(true));
     acceptor.bind(endpoint);
     acceptor.listen(1);
 }
 
-SocketServer::port_type SocketServer::listenPort() const {
-  const tcp::endpoint ep(acceptor.local_endpoint());
-  return ep.port();
-}
-
-void SocketServer::acceptOnce() {
-    tcp::iostream stream;
+template <typename Protocol, typename Service>
+void SocketServer::doAcceptOnce(basic_socket_acceptor<Protocol, Service>& acceptor) {
+    typename Protocol::iostream stream;
     acceptor.accept(*stream.rdbuf());
     processStream(stream);
 }
 
-void SocketServer::processStream(tcp::iostream &stream) {
+void SocketServer::processStream(std::iostream& stream) {
     std::string request;
     while (getline(stream, request)) {
         stream << protocolHandler->handle(request) << std::endl << std::flush;
     }
 }
 
+TCPSocketServer::TCPSocketServer(const ProtocolHandler *protocolHandler) :
+    SocketServer(protocolHandler),
+    acceptor(ios) {
+}
+
+void TCPSocketServer::listen(const port_type port) {
+    doListen(acceptor, tcp::endpoint(tcp::v4(), port));
+    acceptor.set_option(tcp::no_delay(true));
+}
+
+tcp::endpoint TCPSocketServer::listenEndpoint() const {
+    return acceptor.local_endpoint();
+}
+
+void TCPSocketServer::acceptOnce() {
+    doAcceptOnce(acceptor);
+}
+
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+UnixSocketServer::UnixSocketServer(const ProtocolHandler *protocolHandler) :
+    SocketServer(protocolHandler),
+    acceptor(ios) {
+}
+
+void UnixSocketServer::listen(const std::string& unixPath) {
+    if (boost::filesystem::status(unixPath).type() == boost::filesystem::socket_file)
+        boost::filesystem::remove(unixPath);
+
+    doListen(acceptor, stream_protocol::endpoint(unixPath));
+}
+
+stream_protocol::endpoint UnixSocketServer::listenEndpoint() const {
+    return acceptor.local_endpoint();
+}
+
+void UnixSocketServer::acceptOnce() {
+    doAcceptOnce(acceptor);
+}
+
+UnixSocketServer::~UnixSocketServer() {
+    if (!acceptor.is_open())
+        return;
+    std::string path = acceptor.local_endpoint().path();
+    // NOTE: this will fail if this path got deleted manually or represents an abstract-namespace socket
+    boost::filesystem::remove(path);
+}
+#endif
+
 }
 }

src/main.cpp

@@ -3,19 +3,35 @@
 #include <cucumber-cpp/internal/connectors/wire/WireProtocol.hpp>
 #include <iostream>
 #include <boost/program_options.hpp>
+#include <boost/scoped_ptr.hpp>
 
 namespace {
 
-void acceptWireProtocol(int port, bool verbose) {
+void acceptWireProtocol(int port, const std::string& unixPath, bool verbose) {
     using namespace ::cucumber::internal;
     CukeEngineImpl cukeEngine;
     JsonSpiritWireMessageCodec wireCodec;
     WireProtocolHandler protocolHandler(&wireCodec, &cukeEngine);
-    SocketServer server(&protocolHandler);
-    server.listen(port);
-    if (verbose)
-        std::clog << "Listening on port " << server.listenPort() << std::endl;
-    server.acceptOnce();
+    boost::scoped_ptr<SocketServer> server;
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+    if (!unixPath.empty())
+    {
+        UnixSocketServer* const unixServer = new UnixSocketServer(&protocolHandler);
+        server.reset(unixServer);
+        unixServer->listen(unixPath);
+        if (verbose)
+            std::clog << "Listening on socket " << unixServer->listenEndpoint() << std::endl;
+    }
+    else
+#endif
+    {
+        TCPSocketServer* const tcpServer = new TCPSocketServer(&protocolHandler);
+        server.reset(tcpServer);
+        tcpServer->listen(port);
+        if (verbose)
+            std::clog << "Listening on port " << tcpServer->listenEndpoint() << std::endl;
+    }
+    server->acceptOnce();
 }
 
 }
@@ -27,6 +43,9 @@ int main(int argc, char **argv) {
         ("help,h", "help for cucumber-cpp")
         ("verbose,v", "verbose output")
         ("port,p", value<int>(), "listening port of wireserver, use '0' (zero) to select an ephemeral port")
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+        ("unix,u", value<std::string>(), "listening unix socket of wireserver (disables listening on port)")
+#endif
         ;
     boost::program_options::variables_map optionVariableMap;
     boost::program_options::store(boost::program_options::parse_command_line(argc, argv, optionDescription), optionVariableMap);
@@ -42,13 +61,20 @@ int main(int argc, char **argv) {
         port = optionVariableMap["port"].as<int>();
     }
 
+    std::string unixPath;
+#if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
+    if (optionVariableMap.count("unix")) {
+        unixPath = optionVariableMap["unix"].as<std::string>();
+    }
+#endif
+
     bool verbose = false;
     if (optionVariableMap.count("verbose")) {
         verbose = true;
     }
 
     try {
-        acceptWireProtocol(port, verbose);
+        acceptWireProtocol(port, unixPath, verbose);
     } catch (std::exception &e) {
         std::cerr << e.what() << std::endl;
         exit(1);