Added configurable sua server address

OleksandrChaika · OleksandrChaika · commit 260768f087b2 · 2023-01-23T10:39:16.000+01:00
diff --git a/src/Utils/ServerAddressParser.cpp b/src/Utils/ServerAddressParser.cpp
@@ -0,0 +1,57 @@
+//    Copyright 2022 Contributors to the Eclipse Foundation
+//
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+//
+//    SPDX-License-Identifier: Apache-2.0
+
+#include "ServerAddressParser.h"
+
+#include "spdlog/fmt/fmt.h"
+
+#include <regex>
+#include <algorithm>
+
+namespace sua {
+
+    void ServerAddressParser::parse(const std::string & address, std::string & transport, std::string & host, int & port)
+    {
+        std::regex  regex("^([a-zA-Z]+)\\:\\/\\/([^:\\/?#]+)(?:\\:([0-9]+))?$");
+        std::smatch result;
+
+        std::regex_match(address, result, regex);
+
+        // 4 total because:
+        // [0]         is entire match (address)
+        // [1],[2],[3] are transport,host,port
+        if(result.size() != 4) {
+            throw std::runtime_error(fmt::format("Invalid server address: {}", address));
+        }
+
+        if(result[1].str().empty()) {
+            throw std::runtime_error("Missing transport");
+        }
+        transport = result[1];
+        std::transform(transport.begin(), transport.end(), transport.begin(), ::tolower);
+
+        if(result[2].str().empty()) {
+            throw std::runtime_error("Missing host");
+        }
+        host = result[2];
+
+        if(result[3].str().empty()) {
+            throw std::runtime_error("Missing port");
+        }
+        port = std::stoi(result[3]);
+    }
+
+} // namespace sua
diff --git a/src/Utils/ServerAddressParser.h b/src/Utils/ServerAddressParser.h
@@ -0,0 +1,31 @@
+//    Copyright 2022 Contributors to the Eclipse Foundation
+//
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+//
+//    SPDX-License-Identifier: Apache-2.0
+
+#ifndef SDV_SUA_SERVERADDRESSPARSER_H
+#define SDV_SUA_SERVERADDRESSPARSER_H
+
+#include <string>
+
+namespace sua {
+
+    class ServerAddressParser {
+    public:
+        void parse(const std::string & address, std::string & transport, std::string & host, int & port);
+    };
+
+} // namespace sua
+
+#endif
diff --git a/src/main.cpp b/src/main.cpp
@@ -20,10 +20,12 @@
 #include "Mqtt/MqttMessagingProtocolYAML.h"
 #include "Mqtt/MqttConfiguration.h"
 #include "Utils/BundleChecker.h"
+#include "Utils/ServerAddressParser.h"
 #include "SelfUpdateAgent.h"
 #include "Logger.h"
 #include "version.h"
 
+#include <cstdlib>
 #include <iostream>
 #include <memory>
 
@@ -34,21 +36,29 @@ The system needs to be restarted manually for the update to take effect.
 
 Usage: sdv-self-update-agent [OPTIONS]
 
+Environment variables:
+SUA_SERVER    sets and overrides MQTT server address to connect
+              (default is 'tcp://mosquitto:1883')
+
 Options:
 -h, --help    display this help and exit
 -v, --version display version (git hash and build number) used to build sua
 -p, --path    path where downloaded update bundles will be stored (default is '/data/selfupdates')
 -a, --api     use 'k8s' or 'bfb' format for mqtt communication (default is 'bfb')
-    --host    MQTT broker host to connect (default is 'mosquitto')
-    --port    MQTT broker port to conenct (default is '1883')
+-s, --server  MQTT broker server to connect (default is 'tcp://mosquitto:1883')
+              (has precedence over SUA_SERVER environment variable)
 )";
 
 int main(int argc, char* argv[])
 {
     std::string hostPathToSelfupdateDir{"/data/selfupdates"};
-    std::string api  = "bfb";
-    std::string host = "mosquitto";
-    int         port = 1883;
+    std::string api    = "bfb";
+    std::string server = "tcp://mosquitto:1883";
+
+    const char * env_server = std::getenv("SUA_SERVER");
+    if(env_server) {
+        server = env_server;
+    }
 
     if(argc > 1) {
         for(int i = 1; i < argc; i++) {
@@ -79,27 +89,49 @@ int main(int argc, char* argv[])
                 continue;
             }
 
-            if("--host" == opt) {
-                if((i + 1) < argc) {
-                    host = argv[i + 1];
-                }
-                continue;
-            }
-
-            if("--port" == opt) {
+            if(("-s" == opt) || ("--server" == opt)) {
                 if((i + 1) < argc) {
-                    port = std::stoi(argv[i + 1]);
+                    server = argv[i + 1];
                 }
                 continue;
             }
         }
     }
 
+    bool failure_detected = false;
+
+    std::cout << "Self Update Agent:" << std::endl;
+
+    std::string transport = "tcp";
+    std::string host      = "mosquitto";
+    int         port      = 1883;
+
+    try {
+        sua::ServerAddressParser().parse(server, transport, host, port);
+    } catch (const std::invalid_argument & e) {
+        std::cout << fmt::format("Invalid port in address '{}'\n", server);
+        failure_detected = true;
+    } catch (const std::out_of_range & e) {
+        std::cout << fmt::format("Invalid port in address '{}'\n", server);
+        failure_detected = true;
+    } catch (const std::runtime_error & e) {
+        std::cout << e.what() << std::endl;
+        failure_detected = true;
+    }
+
+    if(transport != "tcp") {
+        std::cout << "Unsupported transport '" << transport << "', 'tcp' in one valid option." << std::endl;
+        failure_detected = true;
+    }
+
     if((api != "k8s") && (api != "bfb")) {
-        std::cout << "Self Update Agent:" << std::endl;
         std::cout << "Unsupported api '" << api << "', valid are 'k8s' and 'bfb' only."
                   << std::endl;
-        return 0;
+        failure_detected = true;
+    }
+
+    if(failure_detected) {
+      return 0;
     }
 
     sua::Logger::instance().init();
@@ -132,7 +164,7 @@ int main(int argc, char* argv[])
     sua::Logger::info("SUA commit hash        : '{}'", SUA_COMMIT_HASH  );
     sua::Logger::info("Communication protocol : '{}'", api);
     sua::Logger::info("Updates directory      : '{}'", ctx.updatesDirectory);
-    sua::Logger::info("MQTT broker address    : '{}:{}'", conf.brokerHost, conf.brokerPort);
+    sua::Logger::info("MQTT broker address    : '{}://{}:{}'", transport, conf.brokerHost, conf.brokerPort);
 
     sua.init();
     sua.start(conf);
diff --git a/utest/CMakeLists.txt b/utest/CMakeLists.txt
@@ -3,6 +3,7 @@ add_executable(TestSelfUpdateAgent
     TestFSM.cpp
     TestMqttMessagingProtocolYAML.cpp
     TestMqttMessagingProtocolJSON.cpp
+    TestServerAddressParser.cpp
     Utils.cpp
 )
 
diff --git a/utest/TestServerAddressParser.cpp b/utest/TestServerAddressParser.cpp
@@ -0,0 +1,50 @@
+#include "gtest/gtest.h"
+#include "Utils/ServerAddressParser.h"
+
+namespace
+{
+
+    class TestServerAddressParser : public ::testing::Test {
+    public:
+        void parse(const std::string & address) {
+            sua::ServerAddressParser().parse(address, transport, host, port);
+        }
+
+        std::string transport;
+        std::string host;
+        int         port;
+    };
+
+    TEST_F(TestServerAddressParser, parse_missingTransport_throws)
+    {
+        EXPECT_THROW(parse("://host:42"), std::runtime_error);
+        EXPECT_THROW(parse("//host:42"), std::runtime_error);
+        EXPECT_THROW(parse("host:42"), std::runtime_error);
+    }
+
+    TEST_F(TestServerAddressParser, parse_missingHost_throws)
+    {
+        EXPECT_THROW(parse("tcp://:42"), std::runtime_error);
+        EXPECT_THROW(parse("tcp://42"), std::runtime_error);
+    }
+
+    TEST_F(TestServerAddressParser, parse_missingPort_throws)
+    {
+        EXPECT_THROW(parse("tcp://host"), std::runtime_error);
+        EXPECT_THROW(parse("tcp://host:"), std::runtime_error);
+    }
+
+    TEST_F(TestServerAddressParser, parse_success)
+    {
+        parse("tcp://host:42");
+        EXPECT_EQ(transport, "tcp");
+        EXPECT_EQ(host, "host");
+        EXPECT_EQ(port, 42);
+
+        parse("TCP://host:42");
+        EXPECT_EQ(transport, "tcp");
+        EXPECT_EQ(host, "host");
+        EXPECT_EQ(port, 42);
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ add_executable(TestSelfUpdateAgent`
`3`	`3`	`TestFSM.cpp`
`4`	`4`	`TestMqttMessagingProtocolYAML.cpp`
`5`	`5`	`TestMqttMessagingProtocolJSON.cpp`
	`6`	`+ TestServerAddressParser.cpp`
`6`	`7`	`Utils.cpp`
`7`	`8`	`)`
`8`	`9`