2 Commits

Author SHA1 Message Date
3ee8c1e573 Stable release (#5)
Reviewed-on: #5
2025-06-02 00:13:57 +00:00
9aa16a3f2e First release (#2)
Reviewed-on: #2
2025-05-29 22:55:19 +00:00
9 changed files with 24 additions and 109 deletions

1
.env
View File

@@ -6,4 +6,3 @@ POSTGRES_MAIN_PASSWORD=password
POSTGRES_MAIN_DB=my_db POSTGRES_MAIN_DB=my_db
POSTGRES_MAIN_HOST=localhost POSTGRES_MAIN_HOST=localhost
DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB} DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB}
ICARUS_BASE_API_URL=https://icarus.com

View File

@@ -6,4 +6,3 @@ POSTGRES_MAIN_PASSWORD=password
POSTGRES_MAIN_DB=my_db POSTGRES_MAIN_DB=my_db
POSTGRES_MAIN_HOST=localhost POSTGRES_MAIN_HOST=localhost
DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB} DATABASE_URL=postgres://${POSTGRES_MAIN_USER}:${POSTGRES_MAIN_PASSWORD}@${POSTGRES_MAIN_HOST}:5432/${POSTGRES_MAIN_DB}
ICARUS_BASE_API_URL=https://icarus.com

View File

@@ -1,65 +0,0 @@
name: Rust Build
on:
push:
branches:
- main
- devel
pull_request:
branches:
- main
- devel
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.86.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.86.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.86.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.86.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.86.0
- run: cargo build

2
Cargo.lock generated
View File

@@ -277,7 +277,7 @@ checksum = "f154ce46856750ed433c8649605bf7ed2de3bc35fd9d2a9f30cddd873c80cb08"
[[package]] [[package]]
name = "icarus_envy" name = "icarus_envy"
version = "0.2.0" version = "0.1.0"
dependencies = [ dependencies = [
"async-std", "async-std",
"dotenvy", "dotenvy",

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "icarus_envy" name = "icarus_envy"
version = "0.2.1" version = "0.2.0"
edition = "2024" edition = "2024"
rust-version = "1.86" rust-version = "1.86"

View File

@@ -1,3 +1,4 @@
pub async fn get_db_url() -> String { pub async fn get_db_url() -> String {
dotenvy::dotenv().ok(); dotenvy::dotenv().ok();
std::env::var(crate::keys::DB_URL).expect(crate::keys::error::DB_URL) std::env::var(crate::keys::DB_URL).expect(crate::keys::error::DB_URL)
@@ -17,8 +18,3 @@ pub async fn get_root_directory() -> String {
dotenvy::dotenv().ok(); dotenvy::dotenv().ok();
std::env::var(crate::keys::ROOT_DIRECTORY).expect(crate::keys::error::ROOT_DIRECTORY) std::env::var(crate::keys::ROOT_DIRECTORY).expect(crate::keys::error::ROOT_DIRECTORY)
} }
pub async fn get_icarus_base_api_url() -> String {
dotenvy::dotenv().ok();
std::env::var(crate::keys::ICARUS_BASE_API_URL).expect(crate::keys::error::ICARUS_BASE_API_URL)
}

View File

@@ -3,7 +3,7 @@ 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"; pub const SECRET_MAIN_KEY: &str = "SECRET_MAIN_KEY";
// 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
@@ -12,13 +12,9 @@ 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"; pub const ROOT_DIRECTORY: &str = "ROOT_DIRECTORY";
// Environment key for icarus api url
pub const ICARUS_BASE_API_URL: &str = "ICARUS_BASE_API_URL";
pub mod error { pub mod error {
pub const DB_URL: &str = "DATABASE_URL must be set in .env"; 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_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 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 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";
} }

View File

@@ -1,2 +1,17 @@
pub mod environment; pub mod environment;
pub mod keys; pub mod keys;
pub fn add(left: u64, right: u64) -> u64 {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
let result = add(2, 2);
assert_eq!(result, 4);
}
}

View File

@@ -1,52 +1,27 @@
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
#[test] #[test]
fn test_dburl() { fn test_dburl() {
let result = async_std::task::block_on(icarus_envy::environment::get_db_url()); let result = async_std::task::block_on(icarus_envy::environment::get_db_url());
assert_eq!( assert_eq!(result, "postgres://myuser:password@localhost:5432/my_db", "DATABASE_URL does not match {:?}", result);
result, "postgres://myuser:password@localhost:5432/my_db",
"DATABASE_URL does not match {:?}",
result
);
} }
#[test] #[test]
fn test_get_secret_main_key() { fn test_get_secret_main_key() {
let result = async_std::task::block_on(icarus_envy::environment::get_secret_main_key()); let result = async_std::task::block_on(icarus_envy::environment::get_secret_main_key());
assert_eq!( assert_eq!(result, "Somesupersecretpassword!!!45345435", "SECRET_MAIN_KEY does not match {:?}", result)
result, "Somesupersecretpassword!!!45345435",
"SECRET_MAIN_KEY does not match {:?}",
result
)
} }
#[test] #[test]
fn test_get_secret_key() { fn test_get_secret_key() {
let result = async_std::task::block_on(icarus_envy::environment::get_secret_key()); let result = async_std::task::block_on(icarus_envy::environment::get_secret_key());
assert_eq!( assert_eq!(result, "AmIGoodEnoughForYou?", "SECRET_KEY does not match {:?}", result)
result, "AmIGoodEnoughForYou?",
"SECRET_KEY does not match {:?}",
result
)
} }
#[test] #[test]
fn test_get_root_directory() { fn test_get_root_directory() {
let result = async_std::task::block_on(icarus_envy::environment::get_root_directory()); let result = async_std::task::block_on(icarus_envy::environment::get_root_directory());
assert_eq!( assert_eq!(result, "/path/to/root", "ROOT_DIRECTORY does not match {:?}", result)
result, "/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, "https://icarus.com",
"ICARUS_BASE_API_URL does not match {:?}",
result
)
} }
} }