Use Singleton<T> class for the runner

Author: dhilst

include/cloysterhpc/functions.h

@@ -17,6 +17,17 @@
 
 namespace cloyster {
 
+template <typename B, typename T>
+std::unique_ptr<B> makeUniqueDerived()
+{
+    return static_cast<std::unique_ptr<B>>(std::make_unique<T>());
+}
+
+//
+// Globals
+extern bool dryRun;
+
+
 template <typename T>
 class Singleton {
     // Private constructor to prevent direct instantiation
@@ -32,12 +43,20 @@ class Singleton {
     Singleton& operator=(const Singleton&) = delete;
     ~Singleton() = delete;
 
-    static void init(std::unique_ptr<T> value) {
+    static void init(std::unique_ptr<T> value)
+    {
         std::call_once(initFlag, [&](){
             instance = std::move(value);
         });
     }
 
+    static void init(const auto& factory)
+    {
+        std::call_once(initFlag, [&](){
+            instance = std::move(factory());
+        });
+    }
+
     static gsl::not_null<T*> get() {
         if (!instance) {
             throw std::runtime_error("Singleton read before initialization");
@@ -52,12 +71,24 @@ std::unique_ptr<T> Singleton<T>::instance = nullptr;
 template <typename T>
 std::once_flag Singleton<T>::initFlag;
 
-// Globals
-extern bool dryRun;
+using cloyster::services::BaseRunner;
+using cloyster::models::OS;
 
-using OS = cloyster::models::OS;
+template <typename T>
+[[deprecated("WIP")]]
+gsl::not_null<T*> 
+getSingleton(auto func)
+{
+    static std::once_flag once;
+    static std::unique_ptr<T> instance;
+
+    std::call_once(once, [&](){
+        instance = std::move(func());
+    });
+
+    return gsl::not_null<T*>(instance.get());
+}
 
-std::shared_ptr<cloyster::services::BaseRunner> getRunner();
 std::shared_ptr<cloyster::services::repos::RepoManager> getRepoManager(
     const OS& osinfo);
 

include/cloysterhpc/mailsystem/postfix.h

@@ -6,7 +6,6 @@
 #ifndef CLOYSTERHPC_POSTFIX_H_
 #define CLOYSTERHPC_POSTFIX_H_
 
-#include <cloysterhpc/services/runner.h>
 #include <cstdint>
 #include <filesystem>
 #include <optional>
@@ -21,7 +20,6 @@ class Postfix : public IService {
     enum class Profile { Local, Relay, SASL };
 
 private:
-    cloyster::services::BaseRunner& m_runner;
     Profile m_profile;
     std::optional<std::string> m_hostname {};
     std::optional<std::string> m_domain {};
@@ -75,8 +73,7 @@ class Postfix : public IService {
 
     void setup(const std::filesystem::path& basedir = "/etc/postfix");
 
-    explicit Postfix(std::shared_ptr<MessageBus> bus,
-        cloyster::services::BaseRunner& runner, Profile profile);
+    explicit Postfix(std::shared_ptr<MessageBus> bus, Profile profile);
 };
 
 #endif // CLOYSTERHPC_POSTFIX_H_

include/cloysterhpc/models/cluster.h

@@ -188,7 +188,7 @@ class Cluster {
 
     std::optional<Postfix>& getMailSystem();
     void setMailSystem(
-        Postfix::Profile profile, std::shared_ptr<services::BaseRunner> runner);
+        Postfix::Profile profile);
 
     const DiskImage& getDiskImage() const;
     void setDiskImage(const std::filesystem::path& diskImagePath);

src/functions.cpp

@@ -26,11 +26,6 @@
 
 namespace cloyster {
 
-using cloyster::services::BaseRunner;
-using cloyster::services::DryRunner;
-using cloyster::services::Runner;
-
-
 namespace {
     std::tuple<bool, std::optional<std::string>> retrieveLine(
         boost::process::ipstream& pipe_stream,
@@ -42,29 +37,8 @@ namespace {
 
         return make_tuple(pipe_stream.good(), std::nullopt);
     }
-
-    std::shared_ptr<BaseRunner> makeRunner(const bool dryRun)
-    {
-        if (dryRun) {
-            return std::make_shared<DryRunner>();
-        }
-
-        return std::make_shared<Runner>();
-    }
-
 } // anonymous namespace
 
-std::shared_ptr<BaseRunner> getRunner()
-{
-    static std::optional<std::shared_ptr<BaseRunner>> runner = std::nullopt;
-    if (!runner) {
-        runner = makeRunner(cloyster::dryRun);
-    }
-
-    return runner.value();
-}
-
-using cloyster::models::Cluster;
 using cloyster::services::repos::RepoManager;
 
 std::shared_ptr<RepoManager> getRepoManager(const OS& osinfo)

src/mailsystem/postfix.cpp

@@ -17,9 +17,8 @@ using cloyster::runCommand;
 using cloyster::services::BaseRunner;
 
 Postfix::Postfix(
-    std::shared_ptr<MessageBus> bus, BaseRunner& runner, Profile profile)
+    std::shared_ptr<MessageBus> bus, Profile profile)
     : IService(bus, "postfix.service")
-    , m_runner(runner)
     , m_profile(profile)
 {
 }
@@ -118,7 +117,8 @@ void Postfix::setKeyFile(const std::optional<std::filesystem::path>& key_file)
 void Postfix::install()
 {
     LOG_INFO("Installing Postfix");
-    m_runner.executeCommand("dnf -y install postfix");
+    cloyster::Singleton<BaseRunner>::get()
+        ->executeCommand("dnf -y install postfix");
 }
 
 static void maybeDisableLocalOnMasterFile(std::string& line)
@@ -209,7 +209,7 @@ void Postfix::createFiles(const std::filesystem::path& basedir)
 
     if (!std::filesystem::exists(basedir / "transport.db")) {
         auto transport = basedir / "transport";
-        m_runner.executeCommand(
+        cloyster::Singleton<BaseRunner>::get()->executeCommand(
             fmt::format("postmap hash:{}", transport.string()));
     }
 
@@ -259,7 +259,8 @@ void Postfix::configureSASL(const std::filesystem::path& basedir)
         std::filesystem::perm_options::add);
 
     auto passwordFile = basedir / "sasl_password";
-    m_runner.executeCommand(fmt::format("postmap {}", passwordFile.string()));
+    cloyster::Singleton<BaseRunner>::get()
+        ->executeCommand(fmt::format("postmap {}", passwordFile.string()));
 
     std::filesystem::permissions(dbFilename,
         std::filesystem::perms::owner_write

src/main.cpp

@@ -194,6 +194,18 @@ int main(int argc, const char** argv)
         using cloyster::models::Cluster;
         cloyster::Singleton<Cluster>::init(std::move(model));
 
+        cloyster::Singleton<cloyster::services::BaseRunner>::init([](){
+            using cloyster::services::BaseRunner;
+            using cloyster::services::DryRunner;
+            using cloyster::services::Runner;
+
+            if (cloyster::dryRun) {
+                return cloyster::makeUniqueDerived<BaseRunner, DryRunner>();
+            }
+
+            return cloyster::makeUniqueDerived<BaseRunner, Runner>();
+        });
+
         std::unique_ptr<Execution> executionEngine
             = std::make_unique<cloyster::services::Shell>();
 

src/models/cluster.cpp

@@ -59,11 +59,6 @@ std::shared_ptr<DBusClient> Cluster::getDaemonBus() { return m_systemdBus; }
 Headnode& Cluster::getHeadnode() { return m_headnode; }
 
 const Headnode& Cluster::getHeadnode() const { return m_headnode; }
-// template <typename Runner>
-// std::unique_ptr<Runner> Cluster<Runner>::getRunner() const
-//{
-//     return m_runner;
-// }
 
 std::string_view Cluster::getName() const { return m_name; }
 
@@ -241,9 +236,9 @@ void Cluster::setQueueSystem(QueueSystem::Kind kind)
 std::optional<Postfix>& Cluster::getMailSystem() { return m_mailSystem; }
 
 void Cluster::setMailSystem(
-    Postfix::Profile profile, std::shared_ptr<BaseRunner> runner)
+    Postfix::Profile profile)
 {
-    m_mailSystem.emplace(m_systemdBus, *runner, profile);
+    m_mailSystem.emplace(m_systemdBus, profile);
 }
 
 const DiskImage& Cluster::getDiskImage() const { return m_diskImage; }
@@ -893,7 +888,7 @@ void Cluster::fillData(const std::filesystem::path& answerfilePath)
     }
 
     if (answerfil.postfix.enabled) {
-        setMailSystem(answerfil.postfix.profile, cloyster::getRunner());
+        setMailSystem(answerfil.postfix.profile);
         m_mailSystem->setHostname(this->m_headnode.getHostname());
         m_mailSystem->setDomain(getDomainName());
         m_mailSystem->setDestination(answerfil.postfix.destination);

src/ofed.cpp

@@ -50,7 +50,7 @@ std::string headnodeDistroName()
 
 void installMellanoxDoca(cloyster::services::repos::RepoManager& repoManager, const OFED& ofed)
 {
-    auto runner = cloyster::getRunner();
+    auto runner = cloyster::Singleton<cloyster::services::BaseRunner>::get();
 
     if (runner->executeCommand("modprobe mlx5_core") == 0) {
         LOG_WARN("mlx5_core module loaded, skiping DOCA setup");

src/presenter/PresenterMailSystem.cpp

@@ -21,7 +21,7 @@ PresenterMailSystem::PresenterMailSystem(
                     magic_enum::enum_names<Postfix::Profile>(),
                     Messages::Profile::help))
                   .value();
-        m_model->setMailSystem(mailSystemProfile, cloyster::getRunner());
+        m_model->setMailSystem(mailSystemProfile);
         auto mailSystem = m_model->getMailSystem().value();
 
         LOG_DEBUG("Enabled Postfix with profile: {}",

src/services/xcat.cpp

@@ -22,10 +22,7 @@
 namespace {
 using cloyster::models::Cluster;
 
-inline auto cluster()
-{
-    return cloyster::Singleton<Cluster>::get();
-}
+inline auto cluster() { return cloyster::Singleton<Cluster>::get(); }
 
 }
 
@@ -79,7 +76,8 @@ void XCAT::patchInstall()
 
 void XCAT::setup()
 {
-    setDHCPInterfaces(cluster()->getHeadnode()
+    setDHCPInterfaces(cluster()
+            ->getHeadnode()
             .getConnection(Network::Profile::Management)
             .getInterface()
             .value());
@@ -171,7 +169,8 @@ void XCAT::configureTimeService()
 
     m_stateless.postinstall.emplace_back(fmt::format(
         "echo \"server {} iburst\" >> $IMG_ROOTIMGDIR/etc/chrony.conf\n\n",
-        cluster()->getHeadnode()
+        cluster()
+            ->getHeadnode()
             .getConnection(Network::Profile::Management)
             .getAddress()
             .to_string()));
@@ -207,7 +206,8 @@ void XCAT::configureSLURM()
     m_stateless.postinstall.emplace_back(
         fmt::format("echo SLURMD_OPTIONS=\\\"--conf-server {}\\\" > "
                     "$IMG_ROOTIMGDIR/etc/sysconfig/slurmd\n\n",
-            cluster()->getHeadnode()
+            cluster()
+                ->getHeadnode()
                 .getConnection(Network::Profile::Management)
                 .getAddress()
                 .to_string()));
@@ -259,7 +259,8 @@ void XCAT::generatePostinstallFile()
                     "{0}:/home /home nfs nfsvers=3,nodev,nosuid 0 0\n"
                     "{0}:/opt/ohpc/pub /opt/ohpc/pub nfs nfsvers=3,nodev 0 0\n"
                     "END\n\n",
-            cluster()->getHeadnode()
+            cluster()
+                ->getHeadnode()
                 .getConnection(Network::Profile::Management)
                 .getAddress()
                 .to_string()));
@@ -303,7 +304,7 @@ void XCAT::generateSynclistsFile()
 
 void XCAT::configureOSImageDefinition()
 {
-    auto runner = getRunner();
+    auto runner = cloyster::Singleton<BaseRunner>::get();
     runner->executeCommand(
         fmt::format("chdef -t osimage {} --plus otherpkglist="
                     "/install/custom/netboot/compute.otherpkglist",
@@ -618,7 +619,7 @@ void XCAT::installRepositories()
     const std::filesystem::path& repofileDest
         = std::filesystem::temp_directory_path();
     LOG_INFO("Setting up XCAT repositories");
-    auto runner = cloyster::getRunner();
+    auto runner = cloyster::Singleton<BaseRunner>::get();
 
     runner->downloadFile("https://xcat.org/files/xcat/repos/yum/devel/"
                          "core-snap/xcat-core.repo",