Fix Confluent deployment

Author: dhilst

include/cloysterhpc/models/cluster.h

@@ -52,7 +52,7 @@ class Cluster {
      * @enum Provisioner
      * @brief Enumeration for cluster provisioners.
      */
-    enum class Provisioner { xCAT };
+    enum class Provisioner { xCAT, Confluent };
 
 private:
     std::string m_name;

include/cloysterhpc/services/options.h

@@ -8,8 +8,8 @@
 
 namespace cloyster::services {
 
-// @TODO Make this an aggregate type to avoid the warnings
-// about partial initialization
+// @TODO: Make this an aggregate type to avoid the warnings
+//   about partial initialization
 struct Options final {
     bool parsingError;
     bool helpAndExit;
@@ -23,6 +23,7 @@ struct Options final {
     bool unattended;
     bool enableMirrors;
     bool listRoles;
+    bool debug;
     std::size_t logLevelInput;
     std::string error;
     std::string config;

include/cloysterhpc/services/runner.h

@@ -18,9 +18,46 @@
 #include <cloysterhpc/services/options.h>
 #include <cloysterhpc/services/scriptbuilder.h>
 
+/**
+ * @brief Hold functions to execute commands inside shell. This is
+ * usefull to have pipes, file descriptor, execute commands that
+ * depends on /etc/profile.d/ files, etc.
+ *
+ * WARNING: THESE FUNCTIONS ARE VULNERABLE TO SHEL INJECTION
+ *
+ * While this is a concern in genenral, in this case (this project) the user
+ * need root access to run the project so ... but do not COPY/PASTE this to
+ * projects that run behind a network or you'll introduce an attack vector.
+ */
 namespace cloyster::services::runner::shell {
 
+/**
+ * @brief Hold "unsafe" shell functions. Unsafe here means that
+ * the caller is responsible for checking the exit code, the
+ * execution is not aborted if the command fails.
+ */
 namespace unsafe {
+    /**
+     * @brief Executes a formatted shell command and captures its output.
+     *
+     * This function runs a shell command constructed from a format string
+     * and arguments. The command is executed in a new `/bin/bash` process
+     * with `-xelc` flags enabled:
+     * - `-x`: print commands as they are executed (debugging).
+     * - `-l`: load `/etc/profile.d/*` environment files.
+     * - `-e`: exit on the first error.
+     *
+     * Behavior depends on runtime options:
+     * - If `--dry-run` is enabled, the command is not executed, only logged.
+     * - If `--debug` is enabled, both the executed command and its output
+     *   are logged line-by-line for troubleshooting.
+     *
+     * @tparam Args Variadic template parameter pack for formatting arguments.
+     * @param output A vector to store each line of command output.
+     * @param format The fmtlib format string for constructing the command.
+     * @param args Arguments to format into the command string.
+     * @return The exit code of the executed command, or 0 in dry-run mode.
+     */
     template <typename... Args>
     [[nodiscard]]
     int fmt(std::vector<std::string>& output,
@@ -32,7 +69,11 @@ namespace unsafe {
         if (!opts->dryRun) {
             LOG_DEBUG("Running shell command: {}", command);
             boost::process::ipstream pipe_stream;
-            boost::process::child child("/bin/bash", "-xc", command,
+            // -x for debug
+            // -l for loading /etc/profile.d/* files
+            // -e for stopping in the first error, use (|| :) to ignore
+            const std::string_view flags = opts->debug ? "-xelc" : "-elc";
+            boost::process::child child("/bin/bash", flags, command,
                 boost::process::std_out > pipe_stream);
 
             std::string line;
@@ -50,6 +91,22 @@ namespace unsafe {
         }
     }
 
+    /**
+     * @brief Executes a formatted shell command without capturing output.
+     *
+     * Same as the overload above, but does not store the output lines. Output
+     * is only streamed to logs.  
+     *
+     * Behavior depends on runtime options:
+     * - If `--dry-run` is enabled, the command is not executed, only logged.
+     * - If `--debug` is enabled, both the executed command and its output
+     *   are logged line-by-line for troubleshooting.
+     *
+     * @tparam Args Variadic template parameter pack for formatting arguments.
+     * @param format The fmtlib format string for constructing the command.
+     * @param args Arguments to format into the command string.
+     * @return The exit code of the executed command, or 0 in dry-run mode.
+     */
     template <typename... Args>
     [[nodiscard]]
     int fmt(fmt::format_string<Args...> format, Args&&... args)
@@ -59,7 +116,11 @@ namespace unsafe {
         if (!opts->dryRun) {
             LOG_DEBUG("Running shell command: {}", command);
             boost::process::ipstream pipe_stream;
-            boost::process::child child("/bin/bash", "-xc", command,
+            // -x for debug
+            // -l for loading /etc/profile.d/* files
+            // -e for stopping in the first error, use (|| :) to ignore
+            const std::string_view flags = opts->debug ? "-xelc" : "-elc";
+            boost::process::child child("/bin/bash", flags, command,
                 boost::process::std_out > pipe_stream);
 
             std::string line;
@@ -77,6 +138,21 @@ namespace unsafe {
     }
 }
 
+/**
+ * @brief Executes a shell command and throws if it fails.
+ *
+ * A safer wrapper around `unsafe::fmt()`. Throws std::runtime_error if the
+ * command returns a non-zero exit code.
+ *
+ * Behavior depends on runtime options:
+ * - If `--dry-run` is enabled, the command is not executed, only logged.
+ * - If `--debug` is enabled, the command and its output are logged.
+ *
+ * @tparam Args Variadic template parameter pack for formatting arguments.
+ * @param format The fmtlib format string for constructing the command.
+ * @param args Arguments to format into the command string.
+ * @throws std::runtime_error if the command exits with a non-zero code.
+ */
 template <typename... Args>
 void fmt(fmt::format_string<Args...> format, Args&&... args)
 {
@@ -89,8 +165,36 @@ void fmt(fmt::format_string<Args...> format, Args&&... args)
     }
 }
 
+/**
+ * @brief Executes a raw shell command string.
+ *
+ * Runs the provided command string directly without formatting. Throws if
+ * execution fails.
+ *
+ * Behavior depends on runtime options:
+ * - If `--dry-run` is enabled, the command is not executed, only logged.
+ * - If `--debug` is enabled, the command and its output are logged.
+ *
+ * @param cmd The raw shell command string.
+ */
 void cmd(std::string_view cmd);
 
+/**
+ * @brief Executes a shell command and returns its combined output.
+ *
+ * Runs a command and returns its stdout as a single string, with lines
+ * joined by newlines. Throws if the command fails.
+ *
+ * Behavior depends on runtime options:
+ * - If `--dry-run` is enabled, the command is not executed, only logged.
+ * - If `--debug` is enabled, the command and its output are logged.
+ *
+ * @tparam Args Variadic template parameter pack for formatting arguments.
+ * @param format The fmtlib format string for constructing the command.
+ * @param args Arguments to format into the command string.
+ * @return A string containing the full command output.
+ * @throws std::runtime_error if the command exits with a non-zero code.
+ */
 template <typename... Args>
 [[nodiscard]]
 std::string output(fmt::format_string<Args...> format, Args&&... args)

src/models/answerfile.cpp

@@ -3,8 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-// TODO: CFL Retrieve the provisioner (xcat | confluent (default: confluent) from the answerfile
-
 #include <cstddef>
 #include <fmt/core.h>
 #include <iterator>

src/models/cluster.cpp

@@ -766,7 +766,14 @@ void Cluster::fillData(const AnswerFile& answerfil)
 
 
     // TODO: CFL Retrieve the provisioner from the answerfile
-    setProvisioner(Provisioner::xCAT);
+    const auto provisioner = utils::string::lower(answerfil.system.provisioner);
+    if (provisioner == "xcat") {
+        setProvisioner(Provisioner::xCAT);
+    } else if (provisioner == "confluent") {
+        setProvisioner(Provisioner::Confluent);
+    } else {
+        cloyster::functions::abort("Invalid provisioner {}", provisioner);
+    }
 
     // FIXME: This should come from /etc/os-release
     m_headnode.setOS(nodeOS);

src/models/slurm.cpp

@@ -19,7 +19,7 @@ SLURM::SLURM(const Cluster& cluster)
 
 void SLURM::installServer()
 {
-    cloyster::Singleton<cloyster::services::IOSService>::get()->install(
+    cloyster::Singleton<const cloyster::services::IOSService>::get()->install(
         "ohpc-slurm-server");
 }
 
@@ -55,14 +55,14 @@ void SLURM::configureServer()
 
 void SLURM::enableServer()
 {
-    auto osservice = cloyster::Singleton<services::IOSService>::get();
+    auto osservice = cloyster::Singleton<const services::IOSService>::get();
     osservice->enableService("munge");
     osservice->enableService("slurmctld");
 }
 
 void SLURM::startServer()
 {
-    auto osservice = cloyster::Singleton<services::IOSService>::get();
+    auto osservice = cloyster::Singleton<const services::IOSService>::get();
     osservice->startService("munge");
     osservice->startService("slurmctld");
 }

src/network.cpp

@@ -368,9 +368,6 @@ std::string Network::fetchDomainName()
     return ret;
 }
 
-/* TODO: Check return type
- *  - We can't return const (don't know exactly why)
- */
 std::vector<address> Network::getNameservers() const
 {
     std::vector<address> returnVector;