initial commit (configuration, registration, launch, executor)

Author: upsj

.gitignore

@@ -0,0 +1,2 @@
+/target
+/Cargo.lock

Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "gitlab-meta-runner"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+anyhow = "1.0.87"
+async-process = "2.2.4"
+async-std = "1.13.0"
+clap = { version = "4.5.17", features = ["derive", "string"] }
+clap-verbosity-flag = "2.2.1"
+colored = "2.1.0"
+dirs = "5.0.1"
+futures = "0.3.30"
+gitlab = "0.1705.0"
+http = "1.1.0"
+itertools = "0.13.0"
+log = "0.4.22"
+serde = "1.0.210"
+serde_derive = "1.0.210"
+serde_json = "1.0.128"
+shellexpand = "3.1.0"
+simple_logger = { version = "5.0.0", features = ["stderr"] }
+tokio = { version = "1.40.0", features = ["full"] }
+toml = "0.8.19"

src/check_config.rs

@@ -0,0 +1,92 @@
+use anyhow::Context;
+use colored::Colorize;
+use log::info;
+
+use crate::{
+    cli,
+    config::read_config,
+    template::{
+        expand_executor_config_template, expand_launch_config_template,
+        expand_runner_config_template,
+    },
+};
+
+pub fn check(paths: &cli::Paths) -> anyhow::Result<()> {
+    let config = read_config(&paths.config_file).context(format!(
+        "Failed reading config file {:?}",
+        paths.config_file
+    ))?;
+    let num_jobs = config.launch.as_ref().map_or(1, |v| v.group_size);
+    for (instance_name, instance) in &config.runners {
+        expand_runner_config_template(&config.runner, instance_name, instance).context(format!(
+            "Failed expanding [runner] for instance {}",
+            instance_name
+        ))?;
+        expand_executor_config_template(&config, instance_name, instance).context(format!(
+            "Failed expanding [executor] for instance {}",
+            instance_name
+        ))?;
+        expand_launch_config_template(paths, &config, instance_name, instance, num_jobs).context(
+            format!("Failed expanding [launch] for instance {}", instance_name),
+        )?;
+    }
+    info!("Config check successful, no errors found");
+    Ok(())
+}
+
+pub fn show(paths: &cli::Paths) -> anyhow::Result<()> {
+    let config = read_config(&paths.config_file).context(format!(
+        "Failed reading config file {:?}",
+        paths.config_file
+    ))?;
+    info!("{}", "Full configuration".green());
+    println!(
+        "{}",
+        toml::to_string_pretty(&config).context("Failed printing config")?
+    );
+    let num_jobs = config.launch.as_ref().map_or(1, |v| v.group_size);
+    for (instance_name, instance) in &config.runners {
+        println!(
+            "{}",
+            format!("gitlab-runner configuration for runner {}", instance_name).green()
+        );
+        println!(
+            "{}",
+            toml::to_string_pretty(
+                &expand_runner_config_template(&config.runner, instance_name, instance).context(
+                    format!("Failed expanding [runner] for instance {}", instance_name)
+                )?
+            )
+            .context("Failed printing config")?
+        );
+        println!(
+            "{}",
+            format!("executor configuration for runner {}", instance_name).green()
+        );
+        println!(
+            "{}",
+            toml::to_string_pretty(
+                &expand_executor_config_template(&config, instance_name, instance).context(
+                    format!("Failed expanding [executor] for instance {}", instance_name)
+                )?
+            )
+            .context("Failed printing config")?
+        );
+        println!(
+            "{}",
+            format!("launch configuration for runner {}", instance_name).green()
+        );
+        println!(
+            "{}",
+            toml::to_string_pretty(
+                &expand_launch_config_template(paths, &config, instance_name, instance, num_jobs)
+                    .context(format!(
+                    "Failed expanding [launch] for instance {}",
+                    instance_name
+                ),)?
+            )
+            .context("Failed printing config")?
+        );
+    }
+    Ok(())
+}

src/cli.rs

@@ -0,0 +1,77 @@
+use std::path::PathBuf;
+
+use clap::{Args, Parser, Subcommand};
+use clap_verbosity_flag::{InfoLevel, Verbosity};
+
+use crate::config;
+
+#[derive(Debug, Args)]
+pub struct Paths {
+    /// Configuration file for the meta-runner
+    #[arg(long, default_value = config::get_default_config_file_path().into_os_string())]
+    pub config_file: PathBuf,
+    /// Directory used to store meta-runner data (registered runners, their tokens and generated gitlab-runner config files)
+    /// The files in this directory will be prefixed by the meta-runner's name
+    #[arg(long, default_value = config::get_default_data_dir().into_os_string(), verbatim_doc_comment)]
+    pub data_dir: PathBuf,
+    /// Path for the generated gitlab-runner configuration file.
+    /// Only use this if you don't want to use the default location in `data_dir`
+    #[arg(long, verbatim_doc_comment)]
+    pub generated_config_file: Option<PathBuf>,
+}
+
+#[derive(Debug, Subcommand)]
+pub enum ExecutorCommand {
+    // Run the config step of the custom executor
+    Config,
+    // Run the prepare step of the custom executor
+    Prepare,
+    // Run the run step of the custom executor
+    Run {
+        /// The script to be executed
+        script_name: PathBuf,
+        /// The step to be executed in the script
+        step_name: String,
+    },
+    // Run the cleanup step of the custom executor
+    Cleanup,
+}
+
+#[derive(Debug, Args)]
+pub struct ExecutorOptions {
+    /// The name of the runner configuration to use
+    pub runner_name: String,
+    #[command(subcommand)]
+    pub command: ExecutorCommand,
+}
+
+#[derive(Debug, Subcommand)]
+pub enum Command {
+    /// Creates an example configuration file
+    CreateExampleConfig,
+    /// Prints the example configuration
+    ShowExampleConfig,
+    /// Checks the configuration for validity
+    CheckConfig,
+    /// Show the configuration instantiated for each runner
+    ShowConfig,
+    /// Updates runner registrations and gitlab-runner config files
+    Configure,
+    /// Run the custom executor
+    Executor(ExecutorOptions),
+    /// Run the meta-runner a single time to dispatch runners for all currently pending jobs
+    RunSingle,
+    /// Run the meta-runner continuously to dispatch runners at regular intervals
+    Run,
+}
+
+#[derive(Parser, Debug)]
+pub struct CliOptions {
+    #[command(subcommand)]
+    pub command: Command,
+    /// Config file paths
+    #[command(flatten)]
+    pub paths: Paths,
+    #[command(flatten)]
+    pub verbose: Verbosity<InfoLevel>,
+}