tsk-22: Add function to parse env variable to a vector of strings (#25)

Closes #22

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

.env

@@ -1,8 +1,18 @@
+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
 ROOT_DIRECTORY=/path/to/root
 POSTGRES_MAIN_USER=myuser
 POSTGRES_MAIN_PASSWORD=password
 POSTGRES_MAIN_DB=my_db
 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,5 +1,8 @@
+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
 ROOT_DIRECTORY=/path/to/root
 POSTGRES_MAIN_USER=myuser
 POSTGRES_MAIN_PASSWORD=password
@@ -7,3 +10,9 @@ POSTGRES_MAIN_DB=my_db
 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

.gitea/workflows/tag_release.yml

@@ -3,7 +3,10 @@ name: Release Tagging
 on:
   push:
     branches:
-      - devel
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   release:
@@ -17,7 +20,7 @@ jobs:
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.86.0
+          toolchain: 1.88.0
           components: cargo
 
       - name: Extract Version from Cargo.toml
@@ -28,7 +31,7 @@ jobs:
           BRANCH_REF="${GITHUB_REF}"
           BRANCH_NAME=$(echo "$BRANCH_REF" | cut -d '/' -f 3)
           PROJECT_TAG_RELEASE="v$VERSION-$BRANCH_NAME-$PROJECT_COMMIT_HASH"
-          echo "::set-output name=project_tag_release::$PROJECT_TAG_RELEASE-950"
+          echo "::set-output name=project_tag_release::$PROJECT_TAG_RELEASE-006"
           echo "Version: $VERSION"
           echo "Hash: $PROJECT_COMMIT_HASH"
           echo "Branch: $BRANCH_NAME"

.gitea/workflows/workflow.yaml

@@ -0,0 +1,62 @@
+name: Rust Build
+
+on:
+  push:
+    branches:
+      - main 
+  pull_request:
+    branches:
+      - main 
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.88.0
+      - run: cargo check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.88.0
+      - run: cargo test
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.88.0
+      - run: rustup component add rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.88.0
+      - run: rustup component add clippy
+      - run: cargo clippy -- -D warnings
+
+  build:
+    name: build
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.88.0
+      - run: cargo build

Cargo.lock

@@ -168,6 +168,26 @@ dependencies = [
  "crossbeam-utils",
 ]
 
+[[package]]
+name = "const_format"
+version = "0.2.34"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "126f97965c8ad46d6d9163268ff28432e8f6a1196a55578867832e3049df63dd"
+dependencies = [
+ "const_format_proc_macros",
+]
+
+[[package]]
+name = "const_format_proc_macros"
+version = "0.2.34"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d57c2eccfb16dbac1f4e61e206105db5820c9d26c3c472bc17c774259ef7744"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-xid",
+]
+
 [[package]]
 name = "crossbeam-utils"
 version = "0.8.21"
@@ -277,9 +297,10 @@ checksum = "f154ce46856750ed433c8649605bf7ed2de3bc35fd9d2a9f30cddd873c80cb08"
 
 [[package]]
 name = "icarus_envy"
-version = "0.2.0"
+version = "0.4.1"
 dependencies = [
  "async-std",
+ "const_format",
  "dotenvy",
 ]
 
@@ -458,6 +479,12 @@ version = "1.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
+[[package]]
+name = "unicode-xid"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853"
+
 [[package]]
 name = "value-bag"
 version = "1.11.1"

Cargo.toml

@@ -1,11 +1,12 @@
 [package]
 name = "icarus_envy"
-version = "0.2.0"
+version = "0.4.1"
 edition = "2024"
-rust-version = "1.86"
+rust-version = "1.88"
 
 [dependencies]
 dotenvy = { version = "0.15.7" }
+const_format = { version = "0.2.34" }
 
 [dev-dependencies]
 async-std = { version = "1.13.1" }

src/environment.rs

@@ -1,25 +1,106 @@
-
-pub async fn get_db_url() -> String {
+pub async fn get_db_url() -> crate::EnvVar {
     dotenvy::dotenv().ok();
-    std::env::var(crate::keys::DB_URL).expect(crate::keys::error::DB_URL)
+    let key = crate::keys::DB_URL;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
 }
 
-pub async fn get_secret_main_key() -> String {
+pub async fn get_secret_main_key() -> crate::EnvVar {
     dotenvy::dotenv().ok();
-    std::env::var(crate::keys::SECRET_MAIN_KEY).expect(crate::keys::error::SECRET_MAIN_KEY)
+    let key = crate::keys::SECRET_MAIN_KEY;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
 }
 
-pub async fn get_secret_key() -> String {
+pub async fn get_service_passphrase() -> crate::EnvVar {
     dotenvy::dotenv().ok();
-    std::env::var(crate::keys::SECRET_KEY).expect(crate::keys::error::SECRET_KEY)
+    let key = crate::keys::SERVICE_PASSPHRASE;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
 }
 
-pub async fn get_root_directory() -> String {
+pub async fn get_secret_key() -> crate::EnvVar {
     dotenvy::dotenv().ok();
-    std::env::var(crate::keys::ROOT_DIRECTORY).expect(crate::keys::error::ROOT_DIRECTORY)
+    let key = crate::keys::SECRET_KEY;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
 }
 
-pub async fn get_icarus_base_api_url() -> String {
+pub async fn get_root_directory() -> crate::EnvVar {
     dotenvy::dotenv().ok();
-    std::env::var(crate::keys::ICARUS_BASE_API_URL).expect(crate::keys::error::ICARUS_BASE_API_URL)
+    let key = crate::keys::ROOT_DIRECTORY;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_icarus_base_api_url() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::ICARUS_BASE_API_URL;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_icarus_auth_base_api_url() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::ICARUS_AUTH_BASE_API_URL;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_app_env() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::APP_ENV;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_backend_port() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::BACKEND_PORT;
+    let value = std::env::var(key).expect(key);
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_frontend_url() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::FRONTEND_URL;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_rust_log() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::RUST_LOG;
+    let value = std::env::var(key).expect(key);
+
+    crate::init_envvar(key, &value)
+}
+
+pub async fn get_allowed_origins() -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let key = crate::keys::ALLOWED_ORIGINS;
+    let value = std::env::var(key).expect(key);
+
+    let mut envvar = crate::init_envvar(key, &value);
+    crate::init_delimiter(&mut envvar, ',');
+
+    envvar
+}
+
+/// Get environment not specified in the code
+pub async fn get_env(environment: &str) -> crate::EnvVar {
+    dotenvy::dotenv().ok();
+    let my_error = format!("{environment} {}", crate::keys::error::GENERAL_ERROR);
+    let value = std::env::var(environment).expect(&my_error);
+
+    crate::init_envvar(environment, &value)
 }

src/keys.rs

@@ -1,24 +1,52 @@
-// 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
-pub const SECRET_MAIN_KEY: &str = "SECRET_MAIN_KEY"; 
+/// Environment key for secret main key
+/// Used for the icarus app
+pub const SECRET_MAIN_KEY: &str = "SECRET_MAIN_KEY";
 
-// Environment key for secret key
-// Generic use of secret key that could be found in various apps
+/// 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
 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
+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 {
-    pub const DB_URL: &str = "DATABASE_URL must be set in .env";
-    pub const SECRET_KEY: &str = "SECRET_KEY must be set in environment file";
-    pub const SECRET_MAIN_KEY: &str = "SECRET_MAIN_KEY must not be set in environment file";
-    pub const ROOT_DIRECTORY: &str = "ROOT_DIRECTORY must not be set in environment file";
-    pub const ICARUS_BASE_API_URL: &str = "ICARUS_BASE_API_URL must not be set in enviornment file";
+    use const_format::concatcp;
+
+    pub const GENERAL_ERROR: &str = "must not be set in enviornment file";
+    pub const DB_URL: &str = concatcp!(super::DB_URL, " ", GENERAL_ERROR);
+    pub const SECRET_MAIN_KEY: &str = concatcp!(super::SECRET_MAIN_KEY, " ", GENERAL_ERROR);
+    pub const SERVICE_LOGIN: &str = concatcp!(super::SERVICE_PASSPHRASE, " ", GENERAL_ERROR);
+    pub const SECRET_KEY: &str = concatcp!(super::SECRET_KEY, " ", GENERAL_ERROR);
+    pub const ROOT_DIRECTORY: &str = concatcp!(super::ROOT_DIRECTORY, " ", GENERAL_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);
 }

src/lib.rs

@@ -1,17 +1,39 @@
 pub mod environment;
 pub mod keys;
+pub mod utility;
 
-pub fn add(left: u64, right: u64) -> u64 {
-    left + right
+#[derive(Debug, Default, Clone)]
+pub struct EnvVar {
+    pub key: String,
+    pub value: String,
+    pub has_delimiter: bool,
+    pub delimiter: char,
 }
 
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn it_works() {
-        let result = add(2, 2);
-        assert_eq!(result, 4);
+pub fn init_envvar(key: &str, value: &str) -> EnvVar {
+    EnvVar {
+        key: key.to_string(),
+        value: value.to_string(),
+        has_delimiter: false,
+        ..Default::default()
+    }
+}
+
+pub fn init_delimiter(envvar: &mut EnvVar, delimiter: char) {
+    let mut amount_of_delimiters_found: i32 = 0;
+
+    for v in envvar.value.chars() {
+        if v == delimiter {
+            amount_of_delimiters_found += 1;
+        }
+    }
+
+    let has_delimiter = amount_of_delimiters_found >= 1;
+
+    if has_delimiter {
+        envvar.has_delimiter = has_delimiter;
+        envvar.delimiter = delimiter;
+    } else {
+        envvar.has_delimiter = has_delimiter;
     }
 }

src/utility.rs

@@ -0,0 +1,15 @@
+/// Take the Environment variable and delimitize it. If the value has a delimiter,
+/// extract it into some strings
+pub fn delimitize(var: &crate::EnvVar) -> Result<Vec<String>, std::io::Error> {
+    if var.has_delimiter {
+        Ok(var
+            .value
+            .split(var.delimiter)
+            .map(|c| c.parse::<String>().unwrap())
+            .collect())
+    } else {
+        Err(std::io::Error::other(
+            "Environment variable does not have a delimiter",
+        ))
+    }
+}

tests/test.rs

@@ -1,27 +1,163 @@
-
 #[cfg(test)]
 mod tests {
     #[test]
     fn test_dburl() {
         let result = async_std::task::block_on(icarus_envy::environment::get_db_url());
-        assert_eq!(result, "postgres://myuser:password@localhost:5432/my_db", "DATABASE_URL does not match {:?}", result);
+        assert_eq!(
+            result.value, "postgres://myuser:password@localhost:5432/my_db",
+            "DATABASE_URL does not match {:?}",
+            result
+        );
     }
 
     #[test]
     fn test_get_secret_main_key() {
         let result = async_std::task::block_on(icarus_envy::environment::get_secret_main_key());
-        assert_eq!(result, "Somesupersecretpassword!!!45345435", "SECRET_MAIN_KEY does not match {:?}", result)
+        assert_eq!(
+            result.value, "Somesupersecretpassword!!!45345435",
+            "SECRET_MAIN_KEY does not match {:?}",
+            result
+        )
+    }
+
+    #[test]
+    fn test_get_service_passphrase() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_service_passphrase());
+        assert_eq!(
+            result.value, "T5OCHDHadAtuOWIqRAS7u8XHDDkzKT1Uvvw7mGMkNzKjVdlHA8xGdILf2adDHspO",
+            "SERVICE_PASSPHRASE does not match {:?}",
+            result
+        )
     }
 
     #[test]
     fn test_get_secret_key() {
         let result = async_std::task::block_on(icarus_envy::environment::get_secret_key());
-        assert_eq!(result, "AmIGoodEnoughForYou?", "SECRET_KEY does not match {:?}", result)
+        assert_eq!(
+            result.value, "AmIGoodEnoughForYou?",
+            "SECRET_KEY does not match {:?}",
+            result
+        )
     }
 
     #[test]
     fn test_get_root_directory() {
         let result = async_std::task::block_on(icarus_envy::environment::get_root_directory());
-        assert_eq!(result, "/path/to/root", "ROOT_DIRECTORY does not match {:?}", result)
+        assert_eq!(
+            result.value, "/path/to/root",
+            "ROOT_DIRECTORY does not match {:?}",
+            result
+        )
+    }
+
+    #[test]
+    fn test_get_icarus_base_api_url() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_icarus_base_api_url());
+        assert_eq!(
+            result.value, "https://icarus.com",
+            "ICARUS_BASE_API_URL does not match {:?}",
+            result
+        )
+    }
+
+    #[test]
+    fn test_get_app_env() {
+        let result = async_std::task::block_on(icarus_envy::environment::get_app_env());
+        assert_eq!(
+            result.value,
+            "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.value,
+            "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.value,
+            "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.value,
+            "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.value,
+            "https://soaricarus.com,https://www.soaricarus.com",
+            "{} does not match {:?}",
+            icarus_envy::keys::ALLOWED_ORIGINS,
+            result
+        );
+
+        assert_eq!(
+            result.has_delimiter, true,
+            "The {} variable has an issue finding the delimiter",
+            result.key
+        );
+
+        match icarus_envy::utility::delimitize(&result) {
+            Ok(allowed_origins) => {
+                assert_eq!(
+                    allowed_origins.len(),
+                    2,
+                    "The amount of allowed origins does not match. {} {}",
+                    allowed_origins.len(),
+                    2
+                )
+            }
+            Err(err) => {
+                assert!(false, "Error: {:?}", err)
+            }
+        }
+    }
+
+    #[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, *value,
+                "{:?} does not match {:?}",
+                key, result
+            )
+        }
     }
 }