feat(rs): implement reset

Author: SomeMWDev

rs/src/config.rs

@@ -82,6 +82,11 @@ pub struct MWUtilConfig {
     pub mw_database: Option<String>,
     pub mw_install_path: String,
     pub mw_branch: String,
+    pub mw_server: Option<String>,
+    pub mw_script_path: Option<String>,
+    pub mw_language: Option<String>,
+    pub mw_user: Option<String>,
+    pub mw_password: Option<String>,
 
     pub gerrit_username: Option<String>,
     pub git_email: Option<String>,
@@ -145,6 +150,11 @@ pub fn load_mwutil_config(debug: bool) -> anyhow::Result<MWUtilConfig> {
         mw_database: env::var("MWC_DB_DATABASE").ok(),
         mw_install_path,
         mw_branch,
+        mw_server: env::var("MW_SERVER").ok(),
+        mw_script_path: env::var("MW_SCRIPT_PATH").ok(),
+        mw_language: env::var("MW_LANG").ok(),
+        mw_user: env::var("MEDIAWIKI_USER").ok(),
+        mw_password: env::var("MEDIAWIKI_PASSWORD").ok(),
 
         gerrit_username: env::var("GERRIT_USERNAME").ok(),
         git_email: env::var("GIT_EMAIL").ok(),

rs/src/main.rs

@@ -14,6 +14,7 @@ use crate::modules::security::SecurityArgs;
 use crate::modules::sql::SqlArgs;
 use anyhow::bail;
 use clap::{CommandFactory, Parser, Subcommand};
+use crate::modules::reset::ResetArgs;
 
 mod config;
 mod modules;
@@ -58,6 +59,8 @@ pub enum Modules {
     Pull(PullArgs),
     /// Recreates containers
     Recreate(RecreateArgs),
+    /// Resets various parts of the local dev environment
+    Reset(ResetArgs),
     /// Runs a maintenance script
     Run(RunArgs),
     /// Allows creating and pushing security patches
@@ -102,6 +105,7 @@ pub fn run_module(module: Modules, config: Option<&MWUtilConfig>) -> anyhow::Res
         Modules::OpenSearch(args) => modules::opensearch::execute(config.unwrap(), args),
         Modules::Pull(args) => modules::pull::execute(config.unwrap(), args),
         Modules::Recreate(args) => modules::recreate::execute(config.unwrap(), args),
+        Modules::Reset(args) => modules::reset::execute(config.unwrap(), args),
         Modules::Run(args) => modules::run::execute(config.unwrap(), args),
         Modules::Security(args) => modules::security::execute(config, args),
         Modules::SetupGerrit => modules::setup_gerrit::execute(config.unwrap(), None),

rs/src/modules/db.rs

@@ -5,7 +5,7 @@ use crate::modules::down::DownArgs;
 use crate::modules::recreate::RecreateArgs;
 use crate::modules::{down, recreate};
 use crate::utils::SpinnerSequence;
-use anyhow::{anyhow, Context};
+use anyhow::{anyhow, bail, Context};
 use clap::{Args, Subcommand};
 use clap_complete::ArgValueCompleter;
 use clap_complete::CompletionCandidate;
@@ -150,12 +150,8 @@ pub fn delete_all_dumps(config: &MWUtilConfig) -> anyhow::Result<()> {
     Ok(())
 }
 
-pub fn import_dump(config: &MWUtilConfig, args: DumpSubArgs) -> anyhow::Result<()> {
-    let dump_file = get_dump(config, &args.name, Existence::MustExist)?;
-    let bytes = fs::read(dump_file).context("Failed to read dump file")?;
-
-    let mut spinner = SpinnerSequence::new(4, "Dropping database");
-    run_sql_query(
+pub fn drop_mw_database(config: &MWUtilConfig) -> anyhow::Result<()> {
+    let status = run_sql_query(
         config,
         DbCommandUser::Mw,
         Some(DbCommandDatabase::None),
@@ -164,6 +160,18 @@ pub fn import_dump(config: &MWUtilConfig, args: DumpSubArgs) -> anyhow::Result<(
             config.mw_database.clone().ok_or_else(|| anyhow!("MW database not set!"))?
         ).as_str(),
     ).context("Failed to drop database")?;
+    if !status.success() {
+        bail!("Failed to drop database: Command returned an error!")
+    }
+    Ok(())
+}
+
+pub fn import_dump(config: &MWUtilConfig, args: DumpSubArgs) -> anyhow::Result<()> {
+    let dump_file = get_dump(config, &args.name, Existence::MustExist)?;
+    let bytes = fs::read(dump_file).context("Failed to read dump file")?;
+
+    let mut spinner = SpinnerSequence::new(4, "Dropping database");
+    drop_mw_database(config)?;
 
     spinner.next("Creating database");
     run_sql_query(

rs/src/modules/mod.rs

@@ -16,3 +16,4 @@ pub(crate) mod lint;
 pub(crate) mod npm;
 pub(crate) mod list_repo_remotes;
 pub(crate) mod security;
+pub(crate) mod reset;

rs/src/modules/opensearch.rs

@@ -14,7 +14,7 @@ use std::process::Command;
 #[derive(Args)]
 pub struct OpenSearchArgs {
     #[command(subcommand)]
-    command: OpenSearchCommand,
+    pub command: OpenSearchCommand,
 }
 
 #[derive(Subcommand)]

rs/src/modules/recreate.rs

@@ -4,7 +4,7 @@ use crate::utils::container_completer;
 use clap::Args;
 use clap_complete::ArgValueCompleter;
 
-#[derive(Args)]
+#[derive(Args, Default)]
 pub struct RecreateArgs {
     /// The container to recreate
     #[arg(add = ArgValueCompleter::new(container_completer))]

rs/src/modules/reset.rs

@@ -0,0 +1,110 @@
+use std::fs;
+use anyhow::{anyhow, bail};
+use clap::{Args, ValueEnum};
+use crate::config::MWUtilConfig;
+use crate::constants::MEDIAWIKI_CONTAINER;
+use crate::modules::{db, opensearch};
+use crate::modules::opensearch::{OpenSearchArgs, OpenSearchCommand};
+use crate::modules::run::RunArgs;
+use crate::{run_module, Modules};
+use crate::utils::SpinnerSequence;
+
+// only supports top-level files in images/ !
+const EXCLUDED_UPLOADS: [&str; 2] = ["README", ".htaccess"];
+
+#[derive(Clone, PartialEq, ValueEnum)]
+pub enum ResetActions {
+    Database,
+    OpenSearch,
+    Uploads,
+}
+
+#[derive(Args)]
+pub struct ResetArgs {
+    /// The actions to perform
+    actions: Vec<ResetActions>
+}
+
+pub fn execute(config: &MWUtilConfig, args: ResetArgs) -> anyhow::Result<()> {
+    let actions = args.actions;
+    // not using SpinnerSequence::new here so we can init the text dynamically
+    let mut spinner = SpinnerSequence {
+        cur: 0,
+        max: actions.len() as u8,
+        last: None,
+    };
+    if actions.contains(&ResetActions::Uploads) {
+        spinner.next("Resetting uploads");
+        reset_uploads(config)?;
+    }
+    if actions.contains(&ResetActions::Database) {
+        spinner.next("Resetting database");
+        reset_database(config)?;
+    }
+    if actions.contains(&ResetActions::OpenSearch) {
+        spinner.next("Resetting OpenSearch");
+        opensearch::execute(config, OpenSearchArgs {
+            command: OpenSearchCommand::Reset,
+        })?;
+    }
+    Ok(())
+}
+
+pub fn reset_uploads(config: &MWUtilConfig) -> anyhow::Result<()> {
+    let upload_dir = config.core_dir.join("images");
+    if !upload_dir.exists() {
+        bail!("Upload directory does not exist!");
+    }
+    if !upload_dir.is_dir() {
+        bail!("Upload directory is not a directory!");
+    }
+    if let Ok(files) = fs::read_dir(upload_dir) {
+        for entry in files.flatten() {
+            if !EXCLUDED_UPLOADS.contains(&entry.file_name().to_string_lossy().as_ref()) {
+                let path = entry.path();
+                println!("Removing {}", entry.file_name().to_string_lossy());
+                if path.is_dir() {
+                    fs::remove_dir_all(path)?;
+                } else {
+                    fs::remove_file(path)?;
+                }
+            }
+        }
+    }
+    Ok(())
+}
+
+pub fn reset_database(config: &MWUtilConfig) -> anyhow::Result<()> {
+    db::drop_mw_database(config)?;
+
+    let local_settings = config.core_dir.join("LocalSettings.php");
+    let local_settings_tmp = config.core_dir.join("LocalSettings.temp.php");
+    fs::rename(&local_settings, &local_settings_tmp)?;
+
+    let install_args = vec![
+        format!("--dbname={}", config.mw_database.clone().ok_or_else(|| anyhow!("MW Database not set!"))?),
+        format!("--dbuser={}", config.db_user.clone().ok_or_else(|| anyhow!("DB User not set!"))?),
+        format!("--dbpass={}", config.db_password.clone().ok_or_else(|| anyhow!("DB Password not set!"))?),
+        format!("--dbserver={}", config.db_type.clone().get_container_name()),
+        format!("--server={}", config.mw_server.clone().ok_or_else(|| anyhow!("MW Server not set!"))?),
+        format!("--scriptpath={}", config.mw_script_path.clone().ok_or_else(|| anyhow!("MW Script Path not set!"))?),
+        format!("--lang={}", config.mw_language.clone().ok_or_else(|| anyhow!("MW Language not set!"))?),
+        format!("--pass={}", config.mw_password.clone().ok_or_else(|| anyhow!("MW Password not set!"))?),
+        MEDIAWIKI_CONTAINER.to_string(),
+        config.mw_user.clone().ok_or_else(|| anyhow!("MW User not set!"))?,
+    ];
+
+    let result = run_module(Modules::Run(RunArgs {
+        script: "install".to_string(),
+        extra_args: install_args,
+    }), Some(config));
+
+    fs::rename(local_settings_tmp, local_settings)?;
+
+    result?;
+
+    run_module(Modules::Update, Some(config))?;
+    run_module(Modules::Recreate(Default::default()), Some(config))?;
+
+    Ok(())
+}

rs/src/utils.rs

@@ -51,9 +51,9 @@ pub fn set_git_config(option: &str, value: &str, repo_folder: &PathBuf) -> anyho
 }
 
 pub struct SpinnerSequence {
-    cur: u8,
-    max: u8,
-    last: Option<ProgressBar>,
+    pub cur: u8,
+    pub max: u8,
+    pub last: Option<ProgressBar>,
 }
 
 impl SpinnerSequence {