Fix Windows environment (#242)

* feat: ✨ Add env mod and rework Windows environment setup

* style: 🎨 Format includes

* build: ⬆️ Bump version

* fix: 🐛 Fix unix includes

* docs: 📝 Add file docstring

Author: SergioGasquez

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "espup"
-version = "0.3.3-dev"
+version = "0.4.0-dev"
 authors = ["Sergio Gasquez Arcos <sergio.gasquez@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -42,6 +42,9 @@ zip = "0.6.4"
 [target.'cfg(unix)'.dependencies]
 openssl = { version = "0.10.50", features = ["vendored"] }
 
+[target.'cfg(windows)'.dependencies]
+winreg = "0.50.0"
+
 [dev-dependencies]
 assert_cmd = "2.0.11"
 assert_fs = "1.0.13"

Cargo.toml

@@ -0,0 +1,167 @@
+//! Environment variables set up and export file support.
+
+use crate::{emoji, error::Error};
+use directories::BaseDirs;
+use log::{info, warn};
+#[cfg(windows)]
+use std::env;
+use std::{
+    fs::File,
+    io::Write,
+    path::{Path, PathBuf},
+};
+#[cfg(windows)]
+use winreg::{
+    enums::{HKEY_CURRENT_USER, KEY_READ, KEY_WRITE},
+    RegKey,
+};
+
+#[cfg(windows)]
+const DEFAULT_EXPORT_FILE: &str = "export-esp.ps1";
+#[cfg(not(windows))]
+const DEFAULT_EXPORT_FILE: &str = "export-esp.sh";
+
+#[cfg(windows)]
+/// Sets an environment variable for the current user.
+pub fn set_environment_variable(key: &str, value: &str) -> Result<(), Error> {
+    env::set_var(key, value);
+
+    let hkcu = RegKey::predef(HKEY_CURRENT_USER);
+    let environment_key = hkcu.open_subkey_with_flags("Environment", KEY_WRITE)?;
+    environment_key.set_value(key, &value)?;
+    Ok(())
+}
+
+#[cfg(windows)]
+/// Deletes an environment variable for the current user.
+pub fn delete_environment_variable(key: &str) -> Result<(), Error> {
+    if env::var_os(key).is_none() {
+        return Ok(());
+    }
+
+    env::remove_var(key);
+
+    let hkcu = RegKey::predef(HKEY_CURRENT_USER);
+    let environment_key = hkcu.open_subkey_with_flags("Environment", KEY_READ | KEY_WRITE)?;
+    environment_key.delete_value(key)?;
+    Ok(())
+}
+
+/// Returns the absolute path to the export file, uses the DEFAULT_EXPORT_FILE if no arg is provided.
+pub fn get_export_file(export_file: Option<PathBuf>) -> Result<PathBuf, Error> {
+    if let Some(export_file) = export_file {
+        if export_file.is_dir() {
+            return Err(Error::InvalidDestination(export_file.display().to_string()));
+        }
+        if export_file.is_absolute() {
+            Ok(export_file)
+        } else {
+            let current_dir = std::env::current_dir()?;
+            Ok(current_dir.join(export_file))
+        }
+    } else {
+        Ok(BaseDirs::new()
+            .unwrap()
+            .home_dir()
+            .join(DEFAULT_EXPORT_FILE))
+    }
+}
+
+/// Creates the export file with the necessary environment variables.
+pub fn create_export_file(export_file: &PathBuf, exports: &[String]) -> Result<(), Error> {
+    info!("{} Creating export file", emoji::WRENCH);
+    let mut file = File::create(export_file)?;
+    for e in exports.iter() {
+        #[cfg(windows)]
+        let e = e.replace('/', r#"\"#);
+        file.write_all(e.as_bytes())?;
+        file.write_all(b"\n")?;
+    }
+
+    Ok(())
+}
+
+/// Instructions to export the environment variables.
+pub fn export_environment(export_file: &Path) -> Result<(), Error> {
+    #[cfg(windows)]
+    if cfg!(windows) {
+        set_environment_variable("PATH", &env::var("PATH").unwrap())?;
+        warn!(
+            "{} Your environments variables have been updated! Shell may need to be restarted for changes to be effective.",
+            emoji::INFO
+        );
+        warn!(
+            "{} A file was created at '{}' showing the injected environment variables.",
+            emoji::INFO,
+            export_file.display()
+        );
+    }
+    #[cfg(unix)]
+    if cfg!(unix) {
+        warn!(
+            "{} Please, set up the environment variables by running: '. {}'",
+            emoji::INFO,
+            export_file.display()
+        );
+        warn!(
+            "{} This step must be done every time you open a new terminal.",
+            emoji::WARN
+        );
+    }
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::env::{create_export_file, get_export_file, DEFAULT_EXPORT_FILE};
+    use directories::BaseDirs;
+    use std::{env::current_dir, path::PathBuf};
+
+    #[test]
+    #[allow(unused_variables)]
+    fn test_get_export_file() {
+        // No arg provided
+        let home_dir = BaseDirs::new().unwrap().home_dir().to_path_buf();
+        let export_file = home_dir.join(DEFAULT_EXPORT_FILE);
+        assert!(matches!(get_export_file(None), Ok(export_file)));
+        // Relative path
+        let current_dir = current_dir().unwrap();
+        let export_file = current_dir.join("export.sh");
+        assert!(matches!(
+            get_export_file(Some(PathBuf::from("export.sh"))),
+            Ok(export_file)
+        ));
+        // Absolute path
+        let export_file = PathBuf::from("/home/user/export.sh");
+        assert!(matches!(
+            get_export_file(Some(PathBuf::from("/home/user/export.sh"))),
+            Ok(export_file)
+        ));
+        // Path is a directory instead of a file
+        assert!(get_export_file(Some(home_dir)).is_err());
+    }
+
+    #[test]
+    fn test_create_export_file() {
+        // Creates the export file and writes the correct content to it
+        let temp_dir = tempfile::TempDir::new().unwrap();
+        let export_file = temp_dir.path().join("export.sh");
+        let exports = vec![
+            "export VAR1=value1".to_string(),
+            "export VAR2=value2".to_string(),
+        ];
+        create_export_file(&export_file, &exports).unwrap();
+        let contents = std::fs::read_to_string(export_file).unwrap();
+        assert_eq!(contents, "export VAR1=value1\nexport VAR2=value2\n");
+
+        // Returns the correct error when it fails to create the export file (it already exists)
+        let temp_dir = tempfile::TempDir::new().unwrap();
+        let export_file = temp_dir.path().join("export.sh");
+        std::fs::create_dir_all(&export_file).unwrap();
+        let exports = vec![
+            "export VAR1=value1".to_string(),
+            "export VAR2=value2".to_string(),
+        ];
+        assert!(create_export_file(&export_file, &exports).is_err());
+    }
+}

src/env.rs

@@ -1,4 +1,5 @@
 pub mod emoji;
+pub mod env;
 pub mod error;
 pub mod host_triple;
 pub mod targets;