caelix-cli 0.0.12

Command line generator for Caelix applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use std::fs;

use tempfile::tempdir;

#[test]
fn new_creates_application_structure_with_crates_io_dependency() {
    let tmp = tempdir().unwrap();

    let output = caelix_cli::run_from(["caelix", "new", "demo-api"], tmp.path()).unwrap();

    let app_dir = tmp.path().join("demo-api");
    let cargo_toml = fs::read_to_string(app_dir.join("Cargo.toml")).unwrap();
    let agents_md = fs::read_to_string(app_dir.join("AGENTS.md")).unwrap();
    let main_rs = fs::read_to_string(app_dir.join("src/main.rs")).unwrap();
    let lib_rs = fs::read_to_string(app_dir.join("src/lib.rs")).unwrap();
    let app_rs = fs::read_to_string(app_dir.join("src/app.rs")).unwrap();

    assert!(output.contains("Created Caelix application `demo-api`"));
    assert!(cargo_toml.contains("edition = \"2024\""));
    assert!(!cargo_toml.contains("[workspace]"));
    assert!(cargo_toml.contains("caelix = \"0.0.9\""));
    assert!(!cargo_toml.contains("path = "));
    assert!(!cargo_toml.contains("caelix-core"));
    assert!(!cargo_toml.contains("caelix-actix"));
    assert!(agents_md.contains("Use this file as the quick working reference"));
    assert!(agents_md.contains("https://ohanronnie.github.io/caelix/"));
    assert!(agents_md.contains("Prefer the Caelix CLI for new framework files"));
    assert!(agents_md.contains("caelix g module name"));
    assert!(agents_md.contains("## Registration Model"));
    assert!(agents_md.contains("A module implements `Module` and returns `ModuleMetadata`."));
    assert!(agents_md.contains("## Controllers"));
    assert!(agents_md.contains("Supported extractor attributes"));
    assert!(agents_md.contains("## Responses And Errors"));
    assert!(agents_md.contains("Do not add automatic HTTP response caching"));
    assert!(main_rs.contains("use caelix::Application;"));
    assert!(main_rs.contains("use demo_api::AppModule;"));
    assert!(main_rs.contains("#[caelix::main]"));
    assert!(main_rs.contains("Application::new::<AppModule>()"));
    assert_eq!(lib_rs, "pub mod app;\n\npub use app::AppModule;\n");
    assert!(app_rs.contains("use caelix::{Module, ModuleMetadata};"));
    assert!(app_rs.contains("ModuleMetadata::new()"));
}

#[test]
fn generate_service_creates_service_and_refuses_overwrite() {
    let tmp = tempdir().unwrap();

    let output = caelix_cli::run_from(["caelix", "g", "service", "users"], tmp.path()).unwrap();
    let service_path = tmp.path().join("src/users/service.rs");
    let mod_path = tmp.path().join("src/users/mod.rs");
    let service = fs::read_to_string(&service_path).unwrap();
    let module = fs::read_to_string(&mod_path).unwrap();

    assert!(output.contains("Manual registration:"));
    assert!(service.contains("use caelix::injectable;"));
    assert!(service.contains("#[injectable]\npub struct UsersService;"));
    assert!(module.contains("pub mod service;"));
    assert!(module.contains("pub use service::UsersService;"));

    let err = caelix_cli::run_from(["caelix", "generate", "service", "users"], tmp.path())
        .unwrap_err()
        .to_string();
    assert!(err.contains("already exists; refusing to overwrite"));
}

#[test]
fn generate_controller_uses_service_when_present_and_prints_instructions() {
    let tmp = tempdir().unwrap();
    caelix_cli::run_from(["caelix", "g", "service", "users"], tmp.path()).unwrap();

    let output =
        caelix_cli::run_from(["caelix", "generate", "controller", "users"], tmp.path()).unwrap();
    let controller = fs::read_to_string(tmp.path().join("src/users/controller.rs")).unwrap();

    assert!(controller.contains("service: Arc<UsersService>"));
    assert!(controller.contains("use caelix::{controller, get, injectable, Result};"));
    assert!(controller.contains("#[controller(\"/users\")]"));
    assert!(controller.contains("Ok(self.service.hello())"));
    assert!(output.contains("Add `.controller::<UsersController>()`"));
    assert!(output.contains("Ensure `UsersService` is registered"));
}

#[test]
fn generate_controller_without_service_prints_note() {
    let tmp = tempdir().unwrap();

    let output = caelix_cli::run_from(["caelix", "g", "controller", "users"], tmp.path()).unwrap();
    let controller = fs::read_to_string(tmp.path().join("src/users/controller.rs")).unwrap();

    assert!(controller.contains("pub struct UsersController;"));
    assert!(controller.contains("use caelix::{controller, get, injectable, Result};"));
    assert!(!controller.contains("Arc<UsersService>"));
    assert!(output.contains("generated without a UsersService dependency"));
}

#[test]
fn generate_module_creates_complete_feature_folder() {
    let tmp = tempdir().unwrap();

    let output =
        caelix_cli::run_from(["caelix", "g", "module", "auth-session"], tmp.path()).unwrap();
    let module = fs::read_to_string(tmp.path().join("src/auth_session/mod.rs")).unwrap();
    let service = fs::read_to_string(tmp.path().join("src/auth_session/service.rs")).unwrap();
    let controller = fs::read_to_string(tmp.path().join("src/auth_session/controller.rs")).unwrap();

    assert!(module.contains("pub struct AuthSessionModule;"));
    assert!(module.contains("use caelix::{Module, ModuleMetadata};"));
    assert!(module.contains(".provider::<AuthSessionService>()"));
    assert!(module.contains(".controller::<AuthSessionController>()"));
    assert!(service.contains("use caelix::injectable;"));
    assert!(service.contains("pub struct AuthSessionService;"));
    assert!(controller.contains("use caelix::{controller, get, injectable, Result};"));
    assert!(controller.contains("#[controller(\"/auth-session\")]"));
    assert!(output.contains("Add `.import::<AuthSessionModule>()`"));
}