From eb74d4db31655b31fe944bf2dcedae60fc7d6884 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Imobach=20Gonz=C3=A1lez=20Sosa?= <igonzalezsosa@suse.com>
Date: Thu, 10 Oct 2024 09:59:11 +0100
Subject: [PATCH] feat(rust): add a simple API to register and run scripts

---
 rust/agama-lib/src/install_settings.rs |   4 +-
 rust/agama-lib/src/lib.rs              |   1 +
 rust/agama-lib/src/scripts.rs          |  32 +++++
 rust/agama-lib/src/scripts/client.rs   |  43 +++++++
 rust/agama-lib/src/scripts/error.rs    |  32 +++++
 rust/agama-lib/src/scripts/model.rs    | 162 +++++++++++++++++++++++++
 rust/agama-lib/src/scripts/settings.rs |  40 ++++++
 rust/agama-lib/src/scripts/store.rs    |  51 ++++++++
 rust/agama-lib/src/store.rs            |   9 +-
 rust/agama-server/src/lib.rs           |   1 +
 rust/agama-server/src/scripts.rs       |  21 ++++
 rust/agama-server/src/scripts/web.rs   | 111 +++++++++++++++++
 rust/agama-server/src/web.rs           |   2 +
 13 files changed, 507 insertions(+), 2 deletions(-)
 create mode 100644 rust/agama-lib/src/scripts.rs
 create mode 100644 rust/agama-lib/src/scripts/client.rs
 create mode 100644 rust/agama-lib/src/scripts/error.rs
 create mode 100644 rust/agama-lib/src/scripts/model.rs
 create mode 100644 rust/agama-lib/src/scripts/settings.rs
 create mode 100644 rust/agama-lib/src/scripts/store.rs
 create mode 100644 rust/agama-server/src/scripts.rs
 create mode 100644 rust/agama-server/src/scripts/web.rs

diff --git a/rust/agama-lib/src/install_settings.rs b/rust/agama-lib/src/install_settings.rs
index c5fbd2b8f..fad3c78d1 100644
--- a/rust/agama-lib/src/install_settings.rs
+++ b/rust/agama-lib/src/install_settings.rs
@@ -23,7 +23,7 @@
 //! This module implements the mechanisms to load and store the installation settings.
 use crate::{
     localization::LocalizationSettings, network::NetworkSettings, product::ProductSettings,
-    software::SoftwareSettings, users::UserSettings,
+    scripts::ScriptsSettings, software::SoftwareSettings, users::UserSettings,
 };
 use serde::{Deserialize, Serialize};
 use serde_json::value::RawValue;
@@ -55,6 +55,8 @@ pub struct InstallSettings {
     pub network: Option<NetworkSettings>,
     #[serde(default)]
     pub localization: Option<LocalizationSettings>,
+    #[serde(default)]
+    pub scripts: Option<ScriptsSettings>,
 }
 
 impl InstallSettings {
diff --git a/rust/agama-lib/src/lib.rs b/rust/agama-lib/src/lib.rs
index 6c86b035a..659b6505f 100644
--- a/rust/agama-lib/src/lib.rs
+++ b/rust/agama-lib/src/lib.rs
@@ -63,6 +63,7 @@ pub mod proxies;
 mod store;
 pub use store::Store;
 pub mod questions;
+pub mod scripts;
 pub mod transfer;
 use crate::error::ServiceError;
 use reqwest::{header, Client};
diff --git a/rust/agama-lib/src/scripts.rs b/rust/agama-lib/src/scripts.rs
new file mode 100644
index 000000000..2636b6f61
--- /dev/null
+++ b/rust/agama-lib/src/scripts.rs
@@ -0,0 +1,32 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+//! Implements support for handling the user-defined scripts.
+
+mod client;
+mod error;
+mod model;
+mod settings;
+mod store;
+
+pub use error::ScriptError;
+pub use model::*;
+pub use settings::*;
+pub use store::ScriptsStore;
diff --git a/rust/agama-lib/src/scripts/client.rs b/rust/agama-lib/src/scripts/client.rs
new file mode 100644
index 000000000..bd750b0b6
--- /dev/null
+++ b/rust/agama-lib/src/scripts/client.rs
@@ -0,0 +1,43 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use crate::{base_http_client::BaseHTTPClient, error::ServiceError};
+
+use super::settings::ScriptSettings;
+
+pub struct ScriptsClient {
+    client: BaseHTTPClient,
+}
+
+impl ScriptsClient {
+    pub fn new() -> Result<Self, ServiceError> {
+        Ok(Self {
+            client: BaseHTTPClient::new()?,
+        })
+    }
+
+    pub async fn add_script(&self, script: &ScriptSettings) -> Result<(), ServiceError> {
+        self.client.post_void("/scripts", script).await
+    }
+
+    pub async fn run_scripts(&self) -> Result<(), ServiceError> {
+        self.client.post_void("/scripts/run", &()).await
+    }
+}
diff --git a/rust/agama-lib/src/scripts/error.rs b/rust/agama-lib/src/scripts/error.rs
new file mode 100644
index 000000000..d6dbc3b3b
--- /dev/null
+++ b/rust/agama-lib/src/scripts/error.rs
@@ -0,0 +1,32 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use std::io;
+use thiserror::Error;
+
+use crate::transfer::TransferError;
+
+#[derive(Error, Debug)]
+pub enum ScriptError {
+    #[error("Could not fetch the profile: '{0}'")]
+    Unreachable(#[from] TransferError),
+    #[error("I/O error: '{0}'")]
+    InputOutputError(#[from] io::Error),
+}
diff --git a/rust/agama-lib/src/scripts/model.rs b/rust/agama-lib/src/scripts/model.rs
new file mode 100644
index 000000000..401542b33
--- /dev/null
+++ b/rust/agama-lib/src/scripts/model.rs
@@ -0,0 +1,162 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use std::{
+    fs,
+    io::Write,
+    os::unix::fs::OpenOptionsExt,
+    path::{Path, PathBuf},
+    process,
+};
+
+use crate::transfer::Transfer;
+
+use super::ScriptError;
+
+/// Represents a script to run as part of the installation process.
+pub struct Script {
+    /// Location of the script in the local disk.
+    pub path: PathBuf,
+}
+
+impl Script {
+    /// Runs the script and returns the output.
+    ///
+    /// TODO: write stdout and stderr to the file system.
+    pub async fn run(&self) -> Result<process::Output, ScriptError> {
+        Ok(process::Command::new(&self.path).output()?)
+    }
+}
+
+/// Manages a set of installation scripts.
+///
+/// It offers an API to add and execute installation scripts.
+pub struct ScriptsRepository {
+    workdir: PathBuf,
+    scripts: Vec<Script>,
+}
+
+impl ScriptsRepository {
+    /// Builds a new repository.
+    ///
+    /// * `workdir`: directory to store the scripts.
+    pub fn new<P: AsRef<Path>>(workdir: P) -> ScriptsRepository {
+        ScriptsRepository {
+            workdir: PathBuf::from(workdir.as_ref()),
+            ..Default::default()
+        }
+    }
+
+    /// Adds a script.
+    ///
+    /// * `name`: script's name for reference purposes.
+    /// * `body`: script's body.
+    pub fn add_with_body(&mut self, name: &str, body: &str) -> Result<(), ScriptError> {
+        self.write_script(name, |mut file| {
+            write!(file, "{}", &body)?;
+            Ok(())
+        })
+    }
+
+    /// Adds a script fetching it from a given URL.
+    ///
+    /// * `name`: script's name for reference purposes.
+    /// * `url`: script's URL.
+    pub fn add_from_url(&mut self, name: &str, url: &str) -> Result<(), ScriptError> {
+        self.write_script(name, |file| {
+            Transfer::get(url, file)?;
+            Ok(())
+        })
+    }
+
+    /// Run all the scripts.
+    ///
+    /// They run in the order they were added to the repository.
+    pub async fn run(&self) -> Result<(), ScriptError> {
+        for script in &self.scripts {
+            script.run().await?;
+        }
+        Ok(())
+    }
+
+    /// Writes and registers the script.
+    ///
+    /// It reduces the code repetition.
+    ///
+    /// * `name`: script's name.
+    /// * `update`: function which writes the content of the script to the given `std::fs::File`.
+    fn write_script<F>(&mut self, name: &str, update: F) -> Result<(), ScriptError>
+    where
+        F: FnOnce(fs::File) -> Result<(), ScriptError>,
+    {
+        std::fs::create_dir_all(&self.workdir)?;
+        let path = self.workdir.join(name);
+        let file = std::fs::OpenOptions::new()
+            .create(true)
+            .write(true)
+            .truncate(true)
+            .mode(0o500)
+            .open(&path)?;
+
+        update(file)?;
+        self.scripts.push(Script { path });
+        Ok(())
+    }
+}
+
+impl Default for ScriptsRepository {
+    fn default() -> Self {
+        Self {
+            workdir: PathBuf::from("/run/agama/scripts"),
+            scripts: vec![],
+        }
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use tempfile::TempDir;
+    use tokio::test;
+
+    use super::ScriptsRepository;
+
+    #[test]
+    async fn test_add_with_body() {
+        let tmp_dir = TempDir::with_prefix("scripts-").expect("a temporary directory");
+        let mut repo = ScriptsRepository::new(&tmp_dir);
+        let expected_body = "echo hello".to_string();
+        repo.add_with_body("test", &expected_body).unwrap();
+
+        let script = repo.scripts.first().unwrap();
+        let body: Vec<u8> = std::fs::read(&script.path).unwrap();
+        let body = String::from_utf8(body).unwrap();
+        assert_eq!(expected_body, body);
+    }
+
+    #[test]
+    async fn test_add_with_url() {
+        let tmp_dir = TempDir::with_prefix("scripts-").expect("a temporary directory");
+        let mut repo = ScriptsRepository::new(&tmp_dir);
+        repo.add_from_url("test", "http://localhost/scripts.sh")
+            .unwrap();
+        let script = repo.scripts.first().unwrap();
+        println!("script={}", script.path.to_str().unwrap());
+    }
+}
diff --git a/rust/agama-lib/src/scripts/settings.rs b/rust/agama-lib/src/scripts/settings.rs
new file mode 100644
index 000000000..0991addec
--- /dev/null
+++ b/rust/agama-lib/src/scripts/settings.rs
@@ -0,0 +1,40 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ScriptsSettings {
+    pub pre: Vec<ScriptSettings>,
+    pub post: Vec<ScriptSettings>,
+}
+
+// FIXME: it is just the same than ScriptConfig.
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ScriptSettings {
+    /// Script name.
+    name: String,
+    /// Script body. Either the body or the URL must be specified.
+    body: Option<String>,
+    /// URL to get the script from. Either the body or the URL must be specified.
+    url: Option<String>,
+}
diff --git a/rust/agama-lib/src/scripts/store.rs b/rust/agama-lib/src/scripts/store.rs
new file mode 100644
index 000000000..b029d6388
--- /dev/null
+++ b/rust/agama-lib/src/scripts/store.rs
@@ -0,0 +1,51 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use crate::error::ServiceError;
+
+use super::{client::ScriptsClient, settings::ScriptsSettings};
+
+pub struct ScriptsStore {
+    client: ScriptsClient,
+}
+
+impl ScriptsStore {
+    pub fn new() -> Result<Self, ServiceError> {
+        Ok(Self {
+            client: ScriptsClient::new()?,
+        })
+    }
+
+    pub fn new_with_client(client: ScriptsClient) -> Result<Self, ServiceError> {
+        Ok(Self { client })
+    }
+
+    pub async fn load(&self) -> Result<ScriptsSettings, ServiceError> {
+        // TODO: export nothing
+        Ok(ScriptsSettings::default())
+    }
+
+    pub async fn store(&self, settings: &ScriptsSettings) -> Result<(), ServiceError> {
+        for pre in &settings.pre {
+            self.client.add_script(pre).await?;
+        }
+        Ok(())
+    }
+}
diff --git a/rust/agama-lib/src/store.rs b/rust/agama-lib/src/store.rs
index 83ac06275..7d988281d 100644
--- a/rust/agama-lib/src/store.rs
+++ b/rust/agama-lib/src/store.rs
@@ -25,7 +25,7 @@ use crate::error::ServiceError;
 use crate::install_settings::InstallSettings;
 use crate::{
     localization::LocalizationStore, network::NetworkStore, product::ProductStore,
-    software::SoftwareStore, storage::StorageStore, users::UsersStore,
+    scripts::ScriptsStore, software::SoftwareStore, storage::StorageStore, users::UsersStore,
 };
 
 /// Struct that loads/stores the settings from/to the D-Bus services.
@@ -41,6 +41,7 @@ pub struct Store {
     software: SoftwareStore,
     storage: StorageStore,
     localization: LocalizationStore,
+    scripts: ScriptsStore,
 }
 
 impl Store {
@@ -52,6 +53,7 @@ impl Store {
             product: ProductStore::new()?,
             software: SoftwareStore::new()?,
             storage: StorageStore::new()?,
+            scripts: ScriptsStore::new()?,
         })
     }
 
@@ -63,6 +65,7 @@ impl Store {
             user: Some(self.users.load().await?),
             product: Some(self.product.load().await?),
             localization: Some(self.localization.load().await?),
+            scripts: Some(self.scripts.load().await?),
             ..Default::default()
         };
 
@@ -84,6 +87,9 @@ impl Store {
         if let Some(product) = &settings.product {
             self.product.store(product).await?;
         }
+        if let Some(scripts) = &settings.scripts {
+            self.scripts.store(scripts).await?;
+        }
         // ordering: localization after product as some product may miss some locales
         if let Some(localization) = &settings.localization {
             self.localization.store(localization).await?;
@@ -97,6 +103,7 @@ impl Store {
         if settings.storage.is_some() || settings.storage_autoyast.is_some() {
             self.storage.store(&settings.into()).await?
         }
+
         Ok(())
     }
 }
diff --git a/rust/agama-server/src/lib.rs b/rust/agama-server/src/lib.rs
index b6dd710ed..c26eaa774 100644
--- a/rust/agama-server/src/lib.rs
+++ b/rust/agama-server/src/lib.rs
@@ -26,6 +26,7 @@ pub mod logs;
 pub mod manager;
 pub mod network;
 pub mod questions;
+pub mod scripts;
 pub mod software;
 pub mod storage;
 pub mod users;
diff --git a/rust/agama-server/src/scripts.rs b/rust/agama-server/src/scripts.rs
new file mode 100644
index 000000000..f0e99a215
--- /dev/null
+++ b/rust/agama-server/src/scripts.rs
@@ -0,0 +1,21 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+pub mod web;
diff --git a/rust/agama-server/src/scripts/web.rs b/rust/agama-server/src/scripts/web.rs
new file mode 100644
index 000000000..f524384e3
--- /dev/null
+++ b/rust/agama-server/src/scripts/web.rs
@@ -0,0 +1,111 @@
+// Copyright (c) [2024] SUSE LLC
+//
+// All Rights Reserved.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 2 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, contact SUSE LLC.
+//
+// To contact SUSE LLC about this file by physical or electronic mail, you may
+// find current contact information at www.suse.com.
+
+use std::sync::Arc;
+
+use agama_lib::{
+    error::ServiceError,
+    scripts::{ScriptError, ScriptsRepository},
+};
+use axum::{
+    extract::State,
+    http::StatusCode,
+    response::{IntoResponse, Response},
+    routing::post,
+    Json, Router,
+};
+use serde::Deserialize;
+use serde_json::json;
+use thiserror::Error;
+use tokio::sync::RwLock;
+
+#[derive(Clone, Default)]
+struct ScriptsState {
+    scripts: Arc<RwLock<ScriptsRepository>>,
+}
+
+#[derive(Error, Debug)]
+#[error("Script error: {0}")]
+struct ScriptServiceError(#[from] ScriptError);
+
+impl IntoResponse for ScriptServiceError {
+    fn into_response(self) -> Response {
+        let body = json!({
+            "error": self.to_string()
+        });
+        (StatusCode::BAD_REQUEST, Json(body)).into_response()
+    }
+}
+
+/// Sets up and returns the axum service for the auto-installation scripts.
+pub async fn scripts_service() -> Result<Router, ServiceError> {
+    let state = ScriptsState::default();
+    let router = Router::new()
+        .route("/", post(add_script))
+        .route("/run", post(run_scripts))
+        .with_state(state);
+    Ok(router)
+}
+
+#[derive(Deserialize)]
+struct ScriptConfig {
+    /// Script name.
+    name: String,
+    /// Script body. Either the body or the URL must be specified.
+    body: Option<String>,
+    /// URL to get the script from. Either the body or the URL must be specified.
+    url: Option<String>,
+}
+
+#[utoipa::path(
+    post,
+    path = "/",
+    context_path = "/api/scripts",
+    request_body(content = ScriptConfig, description = "Script definition"),
+    responses(
+        (status = 200, description = "The script was added")
+    )
+)]
+async fn add_script(
+    state: State<ScriptsState>,
+    script: Json<ScriptConfig>,
+) -> Result<impl IntoResponse, ScriptServiceError> {
+    let mut scripts = state.scripts.write().await;
+    if let Some(body) = &script.body {
+        scripts.add_with_body(&script.name, body)?;
+    } else if let Some(url) = &script.url {
+        scripts.add_from_url(&script.name, url)?;
+    }
+    Ok(())
+}
+
+#[utoipa::path(
+    post,
+    path = "/run",
+    context_path = "/api/scripts",
+    responses(
+        (status = 200, description = "The scripts were successfully executed.")
+    )
+)]
+async fn run_scripts(state: State<ScriptsState>) -> Result<(), ScriptServiceError> {
+    let scripts = state.scripts.write().await;
+    scripts.run().await?;
+    Ok(())
+}
diff --git a/rust/agama-server/src/web.rs b/rust/agama-server/src/web.rs
index 6cb7adb77..7f77b8dfd 100644
--- a/rust/agama-server/src/web.rs
+++ b/rust/agama-server/src/web.rs
@@ -30,6 +30,7 @@ use crate::{
     manager::web::{manager_service, manager_stream},
     network::{web::network_service, NetworkManagerAdapter},
     questions::web::{questions_service, questions_stream},
+    scripts::web::scripts_service,
     software::web::{software_service, software_streams},
     storage::web::{storage_service, storage_streams},
     users::web::{users_service, users_streams},
@@ -82,6 +83,7 @@ where
         .add_service("/network", network_service(network_adapter, events).await?)
         .add_service("/questions", questions_service(dbus.clone()).await?)
         .add_service("/users", users_service(dbus.clone()).await?)
+        .add_service("/scripts", scripts_service().await?)
         .with_config(config)
         .build();
     Ok(router)