puerto 0.15.0

Puerto — Rust full-stack DDD framework CLI. Scaffolds Clean Architecture projects with auto-wired DI, SQLx support, and zero manual wiring. Formerly puerto-framework.
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

// AUTO-GENERATED by puerto. Edit puerto.toml, then run `puerto generate bootstrap`.
{% if entities -%}
use std::sync::Arc;

{% for entity in entities -%}
{% for uc in entity.use_cases -%}
use business::application::{{ entity.snake }}::{{ uc.action }}::{{ uc.uc_pascal }}UseCaseImpl;
{% endfor -%}
{% endfor %}
{% for entity in entities -%}
use business::domain::{{ entity.snake }}::repository::{{ entity.pascal }}RepositoryTrait;
{% if entity.uow -%}
use business::domain::{{ entity.snake }}::unit_of_work::{{ entity.pascal }}UnitOfWorkFactory;
use infrastructure::{{ entity.snake }}::unit_of_work::Pg{{ entity.pascal }}UnitOfWorkFactory;
{% endif -%}
use infrastructure::{{ entity.snake }}::repository::{% if entity.db %}Pg{% else %}InMemory{% endif %}{{ entity.pascal }}Repository;
{% endfor %}
{% endif -%}
use poem::Endpoint;
use poem_openapi::OpenApiService;

{% for entity in entities -%}
use crate::api::{{ entity.snake }}::routes::{{ entity.pascal }}Api;
{% endfor %}
pub async fn build_app(config: puerto_web::Config) -> impl Endpoint {
{%- if has_db %}
    let database_url = std::env::var("DATABASE_URL").expect("DATABASE_URL must be set");
    let pool = infrastructure::db::create_postgres_pool(&database_url)
        .await
        .expect("Failed to connect to database");
    infrastructure::db::run_migrations(&pool, &infrastructure::db::MIGRATOR)
        .await
        .expect("Failed to run migrations");
{% endif %}
{%- for entity in entities %}
{%- if entity.db %}{% set repo = "Pg" ~ entity.pascal ~ "Repository::new(pool.clone())" %}{% else %}{% set repo = "InMemory" ~ entity.pascal ~ "Repository::new()" %}{% endif %}
{%- if entity.uow %}
    let {{ entity.snake }}_repo: Arc<dyn {{ entity.pascal }}RepositoryTrait> = Arc::new({{ repo }});
    let {{ entity.snake }}_uow: Arc<dyn {{ entity.pascal }}UnitOfWorkFactory> = Arc::new(Pg{{ entity.pascal }}UnitOfWorkFactory::new(pool.clone()));
{%- for uc in entity.use_cases %}
    let {{ uc.action }} = Arc::new({{ uc.uc_pascal }}UseCaseImpl { {% if uc.repository %}repository: Arc::clone(&{{ entity.snake }}_repo){% endif %}{% if uc.repository and uc.uow %}, {% endif %}{% if uc.uow %}uow_factory: Arc::clone(&{{ entity.snake }}_uow){% endif %} });
{%- endfor %}
{%- else %}
{%- if entity.use_cases | length > 1 %}
    let {{ entity.snake }}_repo: Arc<dyn {{ entity.pascal }}RepositoryTrait> = Arc::new({{ repo }});
{%- endif %}
{%- for uc in entity.use_cases %}
    let {{ uc.action }} = Arc::new({{ uc.uc_pascal }}UseCaseImpl { repository: {% if entity.use_cases | length == 1 %}Arc::new({{ repo }}) as Arc<dyn {{ entity.pascal }}RepositoryTrait>{% elif loop.last %}{{ entity.snake }}_repo{% else %}Arc::clone(&{{ entity.snake }}_repo){% endif %} });
{%- endfor %}
{%- endif %}
    let {{ entity.snake }}_api = {{ entity.pascal }}Api {% if entity.use_cases %}{ {% for uc in entity.use_cases %}{{ uc.action }}{% if not loop.last %}, {% endif %}{% endfor %} }{% else %}{}{% endif %};
{% endfor %}
{%- if has_db %}
    let ready = puerto_web::health::probe(move || {
        let pool = pool.clone();
        async move { infrastructure::db::ping(&pool).await }
    });
{%- else %}
    let ready = puerto_web::health::always_ready();
{%- endif %}

    // `app.rs` is the project's own: middleware and routes added there wrap everything here.
    crate::app::configure(puerto_web::routes(openapi_service({{ apis }}), &config, ready))
}

/// The API service, built in one place: whatever else reads its spec (the export test of a project
/// with `web/`) sees the API the server answers.
fn openapi_service<T: poem_openapi::OpenApi>(api: T) -> OpenApiService<T, ()> {
    OpenApiService::new(api, env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"))
}
{%- if web %}

#[cfg(test)]
mod tests {
    use super::*;
{% for entity in entities -%}
{% for uc in entity.use_cases %}
    use business::domain::{{ entity.snake }}::use_cases::{{ uc.action }}::mocks::Mock{{ uc.uc_pascal }}UseCase;
{%- endfor %}
{%- endfor %}

    /// The API contract the frontend's types are generated from (`make web/sync`).
    const OPENAPI_JSON: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/api/openapi.json");

    /// Built from mocked use cases: no server, no database. A missing file is written; a different
    /// one fails — run `make web/sync` (it sets `UPDATE_OPENAPI=1`) and commit the diff.
    #[test]
    fn openapi_spec_matches_docs_api_openapi_json() {
{%- for entity in entities %}
        let {{ entity.snake }}_api = {{ entity.pascal }}Api {% if entity.use_cases %}{ {% for uc in entity.use_cases %}{{ uc.action }}: Arc::new(Mock{{ uc.uc_pascal }}UseCase::new()){% if not loop.last %}, {% endif %}{% endfor %} }{% else %}{}{% endif %};
{%- endfor %}
        let spec = openapi_service({{ apis }}).spec();

        let path = std::path::Path::new(OPENAPI_JSON);
        if std::env::var_os("UPDATE_OPENAPI").is_some() || !path.exists() {
            let dir = path.parent().expect("docs/api/openapi.json has a parent");
            std::fs::create_dir_all(dir).expect("create docs/api");
            std::fs::write(path, &spec).expect("write docs/api/openapi.json");
            return;
        }
        let committed = std::fs::read_to_string(path).expect("read docs/api/openapi.json");
        assert!(
            committed == spec,
            "docs/api/openapi.json is not the API this code serves: run `make web/sync`"
        );
    }
}
{%- endif %}