resolves test fail issue + improved reability

Signed-off-by: Aminu 'Seun Joshua <[email protected]>

Author: seun-ja

Cargo.lock

@@ -0,0 +1,12 @@
+//! Environment variable utilities
+
+/// Defines the default environment variable prefix used by Spin.
+pub const DEFAULT_ENV_PREFIX: &str = "SPIN_VARIABLE";
+
+/// Creates an environment variable key based on the given prefix and key.
+pub fn env_key(prefix: Option<String>, key: &str) -> String {
+    let prefix = prefix.unwrap_or_else(|| DEFAULT_ENV_PREFIX.to_string());
+    let upper_key = key.to_ascii_uppercase();
+    let key = format!("{prefix}_{upper_key}");
+    key
+}

crates/common/src/env.rs

@@ -10,6 +10,7 @@
 
 pub mod arg_parser;
 pub mod data_dir;
+pub mod env;
 pub mod paths;
 pub mod sha256;
 pub mod sloth;

crates/common/src/lib.rs

@@ -6,6 +6,7 @@ edition = { workspace = true }
 
 [dependencies]
 spin-app = { path = "../app" }
+spin-common = { path = "../common" }
 spin-factors = { path = "../factors" }
 spin-loader = { path = "../loader" }
 spin-telemetry = { path = "../telemetry", features = ["testing"] }

crates/factors-test/Cargo.toml

@@ -1,4 +1,5 @@
 use spin_app::locked::LockedApp;
+use spin_common::env::env_key;
 use spin_factors::{
     anyhow::{self, Context},
     wasmtime::{component::Linker, Config, Engine},
@@ -100,6 +101,8 @@ impl<T: RuntimeFactors> TestEnvironment<T> {
 pub async fn build_locked_app(manifest: &toml::Table) -> anyhow::Result<LockedApp> {
     let toml_str = toml::to_string(manifest).context("failed serializing manifest")?;
     let dir = tempfile::tempdir().context("failed creating tempdir")?;
+    // `foo` variable is set to require. As we're not providing a default value, env is checked.
+    _ = std::env::set_var(env_key(None, "foo"), "baz");
     let path = dir.path().join("spin.toml");
     std::fs::write(&path, toml_str).context("failed writing manifest")?;
     spin_loader::from_file(&path, FilesMountStrategy::Direct, None).await

crates/factors-test/src/lib.rs

@@ -3,7 +3,7 @@ use std::path::{Path, PathBuf};
 use anyhow::{anyhow, bail, ensure, Context, Result};
 use futures::{future::try_join_all, StreamExt};
 use reqwest::Url;
-use spin_common::{paths::parent_dir, sloth, ui::quoted_path};
+use spin_common::{env::env_key, paths::parent_dir, sloth, ui::quoted_path};
 use spin_locked_app::{
     locked::{
         self, ContentPath, ContentRef, LockedApp, LockedComponent, LockedComponentDependency,
@@ -17,7 +17,6 @@ use spin_outbound_networking_config::allowed_hosts::{
     AllowedHostsConfig, SERVICE_CHAINING_DOMAIN_SUFFIX,
 };
 use spin_serde::DependencyName;
-use spin_variables::DEFAULT_ENV_PREFIX;
 use std::collections::BTreeMap;
 use tokio::{io::AsyncWriteExt, sync::Semaphore};
 
@@ -137,15 +136,9 @@ impl LocalLoader {
         })
     }
 
-    fn env_key_creator(key: &str) -> String {
-        let upper_key = key.to_ascii_uppercase();
-        let key = format!("{DEFAULT_ENV_PREFIX}_{upper_key}");
-        key
-    }
-
     fn env_checker((key, val): (String, Variable)) -> anyhow::Result<(String, Variable)> {
         if val.default.is_none() {
-            if std::env::var(Self::env_key_creator(key.as_ref())).is_err() {
+            if std::env::var(env_key(None, key.as_ref())).is_err() {
                 Err(anyhow::anyhow!(
                     "Variable data not provided for {}",
                     quoted_path(key)

crates/loader/src/local.rs

@@ -14,6 +14,7 @@ azure_identity = { git = "https://github.com/azure/azure-sdk-for-rust", rev = "8
 azure_security_keyvault = { git = "https://github.com/azure/azure-sdk-for-rust", rev = "8c4caa251c3903d5eae848b41bb1d02a4d65231c" }
 dotenvy = "0.15"
 serde = { workspace = true }
+spin-common = { path = "../common" }
 spin-expressions = { path = "../expressions" }
 spin-factor-variables = { path = "../factor-variables" }
 spin-factors = { path = "../factors" }

crates/variables/Cargo.toml

@@ -6,6 +6,7 @@ use std::{
 };
 
 use serde::Deserialize;
+use spin_common::env::env_key;
 use spin_expressions::{Key, Provider};
 use spin_factors::anyhow::{self, Context as _};
 use spin_world::async_trait;
@@ -25,8 +26,6 @@ pub struct EnvVariablesConfig {
     pub dotenv_path: Option<PathBuf>,
 }
 
-pub const DEFAULT_ENV_PREFIX: &str = "SPIN_VARIABLE";
-
 type EnvFetcherFn = Box<dyn Fn(&str) -> Result<String, VarError> + Send + Sync>;
 
 /// A [`Provider`] that uses environment variables.
@@ -71,14 +70,7 @@ impl EnvVariablesProvider {
 
     /// Gets the value of a variable from the environment.
     fn get_sync(&self, key: &Key) -> anyhow::Result<Option<String>> {
-        let prefix = self
-            .prefix
-            .clone()
-            .unwrap_or_else(|| DEFAULT_ENV_PREFIX.to_string());
-
-        let upper_key = key.as_ref().to_ascii_uppercase();
-        let env_key = format!("{prefix}_{upper_key}");
-
+        let env_key = env_key(self.prefix.clone(), key.as_ref());
         self.query_env(&env_key)
     }