Version bump

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
@@ -9,3 +11,8 @@ POSTGRES_MAIN_HOST=localhost
 DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB}
 ICARUS_BASE_API_URL=https://icarus.com
 ICARUS_AUTH_BASE_API_URL=https://auth.icarus.com
+APP_ENV=development
+BACKEND_PORT=8001
+FRONTEND_URL=http://localhost:4200
+RUST_LOG=debug
+ALLOWED_ORIGINS=https://soaricarus.com,https://www.soaricarus.com

.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
@@ -9,3 +11,8 @@ POSTGRES_MAIN_HOST=localhost
 DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB}
 ICARUS_BASE_API_URL=https://icarus.com
 ICARUS_AUTH_BASE_API_URL=https://auth.icarus.com
+APP_ENV=development
+BACKEND_PORT=8001
+FRONTEND_URL=http://localhost:4200
+RUST_LOG=debug
+ALLOWED_ORIGINS=https://soaricarus.com,https://www.soaricarus.com

Cargo.lock

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

Cargo.toml

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

src/environment.rs

@@ -33,3 +33,35 @@ pub async fn get_icarus_auth_base_api_url() -> String {
     std::env::var(crate::keys::ICARUS_AUTH_BASE_API_URL)
         .expect(crate::keys::error::ICARUS_AUTH_BASE_API_URL)
 }
+
+pub async fn get_app_env() -> String {
+    dotenvy::dotenv().ok();
+    std::env::var(crate::keys::APP_ENV).expect(crate::keys::error::APP_ENV)
+}
+
+pub async fn get_backend_port() -> String {
+    dotenvy::dotenv().ok();
+    std::env::var(crate::keys::BACKEND_PORT).expect(crate::keys::error::BACKEND_PORT)
+}
+
+pub async fn get_frontend_url() -> String {
+    dotenvy::dotenv().ok();
+    std::env::var(crate::keys::FRONTEND_URL).expect(crate::keys::error::FRONTEND_URL)
+}
+
+pub async fn get_rust_log() -> String {
+    dotenvy::dotenv().ok();
+    std::env::var(crate::keys::RUST_LOG).expect(crate::keys::error::RUST_LOG)
+}
+
+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,26 +1,37 @@
-// Environment key for Database management
+/// Environment key for Database management
 pub const DB_URL: &str = "DATABASE_URL";
 
-// Environment key for secret main key
+/// Environment key for secret main key
-// Used for the icarus app
+/// 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
+/// Environment key for secret key
-// Generic use of secret key that could be found in various apps
+/// 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
+pub const APP_ENV: &str = "APP_ENV";
+/// Environment key for backend port. Used for both auth and core functionality
+pub const BACKEND_PORT: &str = "BACKEND_PORT";
+/// Environment key for frontend url
+pub const FRONTEND_URL: &str = "FRONTEND_URL";
+/// Environment key for application logging
+pub const RUST_LOG: &str = "RUST_LOG";
+/// Environment key for allowed origins for CORS support
+pub const ALLOWED_ORIGINS: &str = "ALLOWED_ORIGINS";
+
 pub mod error {
     use const_format::concatcp;
 
@@ -33,4 +44,9 @@ pub mod error {
     pub const ICARUS_BASE_API_URL: &str = concatcp!(super::ICARUS_BASE_API_URL, " ", GENERAL_ERROR);
     pub const ICARUS_AUTH_BASE_API_URL: &str =
         concatcp!(super::ICARUS_AUTH_BASE_API_URL, " ", GENERAL_ERROR);
+    pub const APP_ENV: &str = concatcp!(super::APP_ENV, " ", GENERAL_ERROR);
+    pub const BACKEND_PORT: &str = concatcp!(super::BACKEND_PORT, " ", GENERAL_ERROR);
+    pub const FRONTEND_URL: &str = concatcp!(super::FRONTEND_URL, " ", GENERAL_ERROR);
+    pub const RUST_LOG: &str = concatcp!(super::RUST_LOG, " ", GENERAL_ERROR);
+    pub const ALLOWED_ORIGINS: &str = concatcp!(super::ALLOWED_ORIGINS, " ", GENERAL_ERROR);
 }

tests/test.rs

@@ -59,4 +59,80 @@ mod tests {
             result
         )
     }
+
+    #[test]
+    fn test_get_app_env() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_app_env());
+        assert_eq!(
+            result,
+            "development",
+            "{} does not match {:?}",
+            icarus_envy::keys::APP_ENV,
+            result
+        )
+    }
+
+    #[test]
+    fn test_get_backend_port() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_backend_port());
+        assert_eq!(
+            result,
+            "8001",
+            "{} does not match {:?}",
+            icarus_envy::keys::BACKEND_PORT,
+            result
+        )
+    }
+    #[test]
+    fn test_get_frontend_url() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_frontend_url());
+        assert_eq!(
+            result,
+            "http://localhost:4200",
+            "{} does not match {:?}",
+            icarus_envy::keys::FRONTEND_URL,
+            result
+        )
+    }
+    #[test]
+    fn test_get_rust_log() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_rust_log());
+        assert_eq!(
+            result,
+            "debug",
+            "{} does not match {:?}",
+            icarus_envy::keys::RUST_LOG,
+            result
+        )
+    }
+    #[test]
+    fn test_get_allowed_origins() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_allowed_origins());
+        assert_eq!(
+            result,
+            "https://soaricarus.com,https://www.soaricarus.com",
+            "{} does not match {:?}",
+            icarus_envy::keys::ALLOWED_ORIGINS,
+            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)
+        }
+    }
 }