Modified comments

Reviewed-on: #20
Co-authored-by: phoenix <kundeng00@pm.me>
Co-committed-by: phoenix <kundeng00@pm.me>

.env

@@ -1,3 +1,5 @@
+RANDOM_ENV_KEY="YouDon'tWantToButYouGottaChange|It'sGoingToHurtYouTryingToStayTheSame|AreYouInItOrYouInItForTheFame?|I'mTryingToFigureOutWhoLoveMeForMe"
+MODNAR_ENV_KEY="FeelingTheMonsterClimbDeepserInsideOfMe|FeelingHimGnawingMyHeartAwayHungrily|I'llNeverLoseThisPain|NeverDreamOfYouAgain"
 SECRET_MAIN_KEY=Somesupersecretpassword!!!45345435
 SECRET_KEY=AmIGoodEnoughForYou?
 SERVICE_PASSPHRASE=T5OCHDHadAtuOWIqRAS7u8XHDDkzKT1Uvvw7mGMkNzKjVdlHA8xGdILf2adDHspO

.env.sample

@@ -1,3 +1,5 @@
+RANDOM_ENV_KEY="YouDon'tWantToButYouGottaChange|It'sGoingToHurtYouTryingToStayTheSame|AreYouInItOrYouInItForTheFame?|I'mTryingToFigureOutWhoLoveMeForMe"
+MODNAR_ENV_KEY="FeelingTheMonsterClimbDeepserInsideOfMe|FeelingHimGnawingMyHeartAwayHungrily|I'llNeverLoseThisPain|NeverDreamOfYouAgain"
 SECRET_MAIN_KEY=Somesupersecretpassword!!!45345435
 SECRET_KEY=AmIGoodEnoughForYou?
 SERVICE_PASSPHRASE=T5OCHDHadAtuOWIqRAS7u8XHDDkzKT1Uvvw7mGMkNzKjVdlHA8xGdILf2adDHspO

Cargo.lock

@@ -297,7 +297,7 @@ checksum = "f154ce46856750ed433c8649605bf7ed2de3bc35fd9d2a9f30cddd873c80cb08"
 
 [[package]]
 name = "icarus_envy"
-version = "0.3.3"
+version = "0.3.4"
 dependencies = [
  "async-std",
  "const_format",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_envy"
-version = "0.3.3"
+version = "0.3.4"
 edition = "2024"
 rust-version = "1.88"
 

src/environment.rs

@@ -58,3 +58,10 @@ pub async fn get_allowed_origins() -> String {
     dotenvy::dotenv().ok();
     std::env::var(crate::keys::ALLOWED_ORIGINS).expect(crate::keys::error::ALLOWED_ORIGINS)
 }
+
+/// Get environment not specified in the code
+pub async fn get_env(environment: &str) -> String {
+    dotenvy::dotenv().ok();
+    let my_error = format!("{environment} {}", crate::keys::error::GENERAL_ERROR);
+    std::env::var(environment).expect(&my_error)
+}

src/keys.rs

@@ -1,24 +1,24 @@
-// Environment key for Database management
+/// Environment key for Database management
 pub const DB_URL: &str = "DATABASE_URL";
 
-// Environment key for secret main key
-// Used for the icarus app
+/// Environment key for secret main key
+/// Used for the icarus app
 pub const SECRET_MAIN_KEY: &str = "SECRET_MAIN_KEY";
 
-// Environment key for service logins
+/// Environment key for service logins
 pub const SERVICE_PASSPHRASE: &str = "SERVICE_PASSPHRASE";
 
-// Environment key for secret key
-// Generic use of secret key that could be found in various apps
+/// Environment key for secret key
+/// Generic use of secret key that could be found in various apps
 pub const SECRET_KEY: &str = "SECRET_KEY";
 
-// Environment key for root directory for the icarus app
+/// Environment key for root directory for the icarus app
 pub const ROOT_DIRECTORY: &str = "ROOT_DIRECTORY";
 
-// Environment key for icarus api url
+/// Environment key for icarus api url
 pub const ICARUS_BASE_API_URL: &str = "ICARUS_BASE_API_URL";
 
-// Environment key for icarus auth api url
+/// Environment key for icarus auth api url
 pub const ICARUS_AUTH_BASE_API_URL: &str = "ICARUS_AUTH_BASE_API_URL";
 
 /// Environment key for App status

tests/test.rs

@@ -59,4 +59,23 @@ mod tests {
             result
         )
     }
+
+    #[test]
+    fn test_get_env() {
+        let keys = vec![
+            (
+                "RANDOM_ENV_KEY",
+                "YouDon'tWantToButYouGottaChange|It'sGoingToHurtYouTryingToStayTheSame|AreYouInItOrYouInItForTheFame?|I'mTryingToFigureOutWhoLoveMeForMe",
+            ),
+            (
+                "MODNAR_ENV_KEY",
+                "FeelingTheMonsterClimbDeepserInsideOfMe|FeelingHimGnawingMyHeartAwayHungrily|I'llNeverLoseThisPain|NeverDreamOfYouAgain",
+            ),
+        ];
+
+        for (key, value) in keys.iter() {
+            let result = async_std::task::block_on(icarus_envy::environment::get_env(key));
+            assert_eq!(result, *value, "{:?} does not match {:?}", key, result)
+        }
+    }
 }