Remove CATTUS_... environment variables in favor of --force + --skip flags

Author: dhilst

include/cloysterhpc/cloyster.h

@@ -9,6 +9,7 @@
 #include <cloysterhpc/services/log.h>
 #include <fmt/format.h>
 #include <magic_enum/magic_enum.hpp>
+#include <set>
 #include <string>
 
 namespace cloyster {
@@ -22,6 +23,12 @@ extern bool runAsDaemon;
 extern std::string logLevelInput;
 extern std::string answerfile;
 extern std::string customRepofilePath;
+
+extern std::set<std::string> skipSteps;
+extern std::set<std::string> forceSteps;
+
+bool shouldSkip(const std::string& step);
+bool shouldForce(const std::string& step);
 }
 
 #endif // CLOYSTERHPC_CLOYSTER_H_

include/cloysterhpc/functions.h

@@ -190,7 +190,13 @@ void installFile(const std::filesystem::path& path, std::string&& data);
 
 bool exists(const std::filesystem::path& path);
 
-void createHTTPRepo(const std::string_view repoName);
+struct HTTPRepo {
+    std::filesystem::path directory;
+    std::string name;
+    std::string url;
+};
+
+HTTPRepo createHTTPRepo(const std::string_view repoName);
 
 } // namespace cloyster
 

include/cloysterhpc/models/os.h

@@ -131,5 +131,18 @@ class OS {
     void printData() const;
 };
 
+
 }; // namespace cloyster::models
+
+template <>
+struct fmt::formatter<cloyster::models::OS> : formatter<string_view> {
+    template <typename FormatContext>
+    auto format(const cloyster::models::OS& osinfo, FormatContext& ctx) const
+    -> decltype(ctx.out())
+    {
+        return fmt::format_to(ctx.out(), "OS(distro={}, kernel={})", osinfo.getDistroString(), osinfo.getKernel());
+    }
+};
+
+
 #endif // CLOYSTERHPC_OS_H_

include/cloysterhpc/patterns/singleton.h

@@ -1,5 +1,5 @@
-#ifndef CLOYSTER_SINGLETON_H
-#define CLOYSTER_SINGLETON_H
+#ifndef CLOYSTER_SINGLETON_H_
+#define CLOYSTER_SINGLETON_H_
 
 #include <memory>
 #include <mutex>

include/cloysterhpc/services/osservice.h

@@ -0,0 +1,34 @@
+#ifndef CLOYSTER_OSSERVICE_H_
+#define CLOYSTER_OSSERVICE_H_
+
+#include <string>
+
+#include <cloysterhpc/models/os.h>
+
+namespace cloyster::services {
+
+using cloyster::models::OS;
+
+class IOSService {
+public:
+    [[nodiscard]] IOSService(const IOSService&) = default;
+    IOSService(IOSService&&) = delete;
+    IOSService& operator=(const IOSService&) = default;
+    IOSService& operator=(IOSService&&) = delete;
+    IOSService() = default;
+    virtual ~IOSService() = default;
+
+    [[nodiscard]] virtual std::string getKernelVersion() const = 0;
+
+    static std::unique_ptr<IOSService> factory(const OS& osinfo);
+};
+
+class ELOSService final : public IOSService {
+public:
+    [[nodiscard]] std::string getKernelVersion() const override;
+};
+
+
+};
+
+#endif

include/cloysterhpc/services/xcat.h

@@ -6,17 +6,19 @@
 #ifndef CLOYSTERHPC_XCAT_H_
 #define CLOYSTERHPC_XCAT_H_
 
+#include <filesystem>
+#include <string>
+
+#include <fmt/format.h>
+#include <fmt/ranges.h> // for std::vector formatters
+#include <magic_enum/magic_enum.hpp>
+
 #include <cloysterhpc/const.h>
 #include <cloysterhpc/services/execution.h>
 #include <cloysterhpc/services/log.h>
 #include <cloysterhpc/services/provisioner.h>
 #include <cloysterhpc/services/shell.h>
 
-#include <magic_enum/magic_enum.hpp>
-
-#include <filesystem>
-#include <memory>
-#include <string>
 
 namespace cloyster::services {
 
@@ -28,7 +30,20 @@ namespace cloyster::services {
  * provisioning process of compute and service nodes in a cluster using xCAT.
  */
 class XCAT : public Provisioner {
+public:
+    struct Image {
+        std::vector<std::string_view> otherpkgs = {};
+        // @TODO: We need to support more than one osimage (:
+        //   this can be a default osimage though
+        std::string osimage;
+        std::filesystem::path chroot;
+        std::vector<std::string> postinstall = { "#!/bin/sh\n\n" };
+        std::vector<std::string> synclists;
+    };
+
 private:
+    Image m_stateless;
+
     /**
      * @enum ImageType
      * @brief Defines the types of OS images.
@@ -45,15 +60,6 @@ class XCAT : public Provisioner {
      */
     enum class NodeType { Compute, Service };
 
-    struct {
-        std::vector<std::string_view> otherpkgs = {};
-        // @TODO: We need to support more than one osimage (:
-        //   this can be a default osimage though
-        std::string osimage;
-        std::filesystem::path chroot;
-        std::vector<std::string> postinstall = { "#!/bin/sh\n\n" };
-        std::vector<std::string> synclists;
-    } m_stateless;
 
     static void setDHCPInterfaces(std::string_view interface);
     static void setDomain(std::string_view domain);
@@ -107,13 +113,6 @@ class XCAT : public Provisioner {
      */
     void configureTimeService();
 
-    /**
-     * @brief Configures InfiniBand settings.
-     *
-     * This function sets up InfiniBand interconnect settings.
-     */
-    void configureInfiniband();
-
     /**
      * @brief Configures SLURM settings.
      *
@@ -263,8 +262,31 @@ class XCAT : public Provisioner {
      * This function resets the nodes.
      */
     static void resetNodes();
+
+    /**
+     * @brief Configures InfiniBand settings.
+     *
+     * This function sets up InfiniBand interconnect settings.
+     */
+    void configureInfiniband();
+
+    /**
+    * @brief Return the Image
+    */
+    [[nodiscard]] Image getImage() const;
+};
+
 };
 
+template <>
+struct fmt::formatter<cloyster::services::XCAT::Image> : formatter<string_view> {
+    template <typename FormatContext>
+    auto format(const cloyster::services::XCAT::Image& image, FormatContext& ctx) const
+    -> decltype(ctx.out())
+    {
+        return fmt::format_to(ctx.out(), "XCAT::Image({}, {})", 
+                              image.osimage, image.otherpkgs);
+    }
 };
 
 #endif // CLOYSTERHPC_XCAT_H_

src/cloyster.cpp

@@ -12,4 +12,18 @@ std::string logLevelInput
     = fmt::format("{}", magic_enum::enum_name(Log::Level::Info));
 std::string answerfile = "";
 std::string customRepofilePath = "";
+
+std::set<std::string> skipSteps{};
+std::set<std::string> forceSteps{};
+
+bool shouldSkip(const std::string& step)
+{
+    return skipSteps.contains(step);
+}
+
+bool shouldForce(const std::string& step)
+{
+    return forceSteps.contains(step);
+}
+
 }

src/diskImage.cpp

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <cloysterhpc/cloyster.h>
 #include <cloysterhpc/diskImage.h>
 #include <cloysterhpc/functions.h>
 #include <cloysterhpc/models/os.h>
@@ -78,10 +79,9 @@ bool DiskImage::hasVerifiedChecksum(const std::filesystem::path& path)
         return true;
     }
 
-    LOG_INFO("Verifying disk image checksum... This may take a while")
-    if (cloyster::getEnvironmentVariable("CATTUS_SKIP_DISK_CHECKSUM") == "1") {
-        LOG_WARN("Skiping disk the image checksum because "
-                 "CATTUS_SKIP_DISK_CHECKSUM=1");
+    LOG_INFO("Verifying disk image checksum... This may take a while, use `--skip disk-checksum` to skip")
+    if (cloyster::shouldSkip("disk-checksum")) {
+        LOG_WARN("Skiping disk the image checksum because `--skip disk-checksum`");
         return true;
     }
 

src/functions.cpp

@@ -385,14 +385,18 @@ bool exists(const std::filesystem::path& path)
     return std::filesystem::exists(path);
 }
 
-void createHTTPRepo(const std::string_view repoName)
+HTTPRepo createHTTPRepo(const std::string_view repoName)
 {
     const auto confPath = fmt::format("/etc/httpd/conf.d/{}.conf", repoName);
+    const auto repoFolder = fmt::format("/var/www/html/repos/{}", repoName);
+    // @FIXME:  Use the HN hostname instead of localhost to make it work in the nodes
+    HTTPRepo repo(repoFolder, std::string(repoName), fmt::format("http://localhost/repos/{}", repoName));
     if (exists(confPath)) {
         LOG_WARN("Skipping the creation of HTTP repository, {} already exists", confPath);
-        return;
+        return repo;
     }
-    auto repoFolder = fmt::format("/var/www/html/{}", repoName);
+
+    cloyster::createDirectory("/var/www/html/repos/");
     LOG_INFO("Creating HTTP repository {} at {}", confPath, repoFolder);
     auto runner = cloyster::Singleton<BaseRunner>::get();
     cloyster::createDirectory(repoFolder);
@@ -409,6 +413,7 @@ IndexOptions FancyIndexing VersionSort NameWidth=* HTMLTable Charset=UTF-8
 
     runner->checkCommand("apachectl configtest");
     runner->checkCommand("systemctl restart httpd");
+    return repo;
 }
 
 }; // namespace cloyster