stackless_integrations/providers/schematic/
schematic_environment.rs

1//! `schematic/schematic-environment` integration.
2
3use std::collections::BTreeMap;
4
5use serde::Serialize;
6use stackless_stripe_projects::catalog::verify::CatalogService;
7use stackless_stripe_projects::provision::ProvisionContext;
8
9use super::FamilyResource;
10use crate::error::IntegrationError;
11use crate::hostable::{ConfigScope, Hostable, IntegrationHosting};
12
13pub const RESOURCE_KIND: &str = "integration-schematic";
14
15#[derive(Debug, Serialize)]
16pub struct SchematicEnvironmentConfig {
17    #[serde(skip_serializing_if = "Option::is_none")]
18    pub environment_type: Option<String>,
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub name: Option<String>,
21}
22
23impl CatalogService for SchematicEnvironmentConfig {
24    const REFERENCE: &'static str = "schematic/schematic-environment";
25}
26
27#[derive(Debug)]
28pub struct SchematicEnvironment;
29
30impl Hostable for SchematicEnvironment {
31    const PROVIDER: &'static str = "schematic";
32    const HOSTING: IntegrationHosting = IntegrationHosting::Managed;
33    const CONFIG_SCOPE: ConfigScope = ConfigScope::GlobalOnly;
34    const RESOURCE_KIND: &'static str = RESOURCE_KIND;
35    const OUTPUTS: &'static [&'static str] = &[
36        "api_base_url",
37        "api_key",
38        "environment_id",
39        "publishable_key",
40    ];
41}
42
43impl FamilyResource for SchematicEnvironment {
44    type Config = SchematicEnvironmentConfig;
45    const PROVIDER_PREFIX: &'static str = "SCHEMATIC";
46    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
47        ("API_BASE_URL", "api_base_url", true),
48        ("API_KEY", "api_key", true),
49        ("ENVIRONMENT_ID", "environment_id", true),
50        ("PUBLISHABLE_KEY", "publishable_key", true),
51    ];
52
53    fn build_config(
54        ctx: &ProvisionContext<'_>,
55    ) -> Result<SchematicEnvironmentConfig, IntegrationError> {
56        let config = super::integration_config(ctx)?;
57        Ok(SchematicEnvironmentConfig {
58            environment_type: super::interp_optional(ctx, &config, "environment_type")?,
59            name: super::interp_optional(ctx, &config, "name")?,
60        })
61    }
62}
63
64pub fn validate_config(
65    name: &str,
66    config: &BTreeMap<String, toml::Value>,
67) -> Result<(), IntegrationError> {
68    let _ = (name, config);
69    Ok(())
70}
71
72#[cfg(test)]
73mod tests {
74    use super::*;
75    use crate::ProviderOps;
76    use crate::resource::ResourcePayload;
77    use stackless_core::def::StackDef;
78    use stackless_stripe_projects::stripe::StripeProjects;
79    use stackless_stripe_projects::test_support;
80
81    #[test]
82    fn config_matches_catalog() {
83        const FIXTURE: &str = include_str!(concat!(
84            env!("CARGO_MANIFEST_DIR"),
85            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
86        ));
87        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
88        let failures = stackless_stripe_projects::verify_service(
89            &catalog,
90            &SchematicEnvironmentConfig {
91                environment_type: None,
92                name: None,
93            },
94        );
95        assert!(
96            failures.is_empty(),
97            "schematic/schematic-environment catalog gaps:\n{}",
98            failures.join("\n")
99        );
100    }
101
102    const CATALOG_ENVELOPE: &str = r##"{"ok":true,"command":"projects catalog","data":{"last_updated":"2026-07-11T00:00:00Z","services":[{"id":"prvsvc_schematic_environment","object":"v2.provisioning.provider_service_detail","provider_id":"prvdr_schematic","provider_name":"Schematic","service_id":"schematic-environment","categories":["database"],"kind":"deployable","scope":"project","availability":"available","development":false,"livemode":true,"pricing":{"type":"component"},"configuration_schema":{"properties":{"environment_type":{"type":"string","enum":["development","production"]},"name":{"type":"string"}},"type":"object"}}]}}"##;
103
104    fn test_def() -> StackDef {
105        StackDef::parse(
106            r#"
107[stack]
108name = "atto"
109[stack.projects.stripe]
110project = "project_1"
111[integrations.res]
112provider = "schematic"
113[services.api]
114source = { repo = "r", ref = "main" }
115env = { OUT = "${integrations.res.api_key}" }
116health = { path = "/health" }
117[services.api.local]
118run = "true"
119"#,
120        )
121        .unwrap()
122    }
123
124    #[tokio::test]
125    async fn provision_records_outputs() {
126        let runner = test_support::provision_script(
127            CATALOG_ENVELOPE,
128            serde_json::json!({"SCHEMATIC_API_BASE_URL": "val_api_base_url", "SCHEMATIC_API_KEY": "val_api_key", "SCHEMATIC_ENVIRONMENT_ID": "val_environment_id", "SCHEMATIC_PUBLISHABLE_KEY": "val_publishable_key"}),
129            0,
130        );
131        let dir = tempfile::tempdir().unwrap();
132        std::fs::write(
133            dir.path().join("stackless.toml"),
134            "[stack]\nname=\"atto\"\n",
135        )
136        .unwrap();
137        let stripe = StripeProjects::new(&runner, dir.path());
138
139        let resource = SchematicEnvironment
140            .provision(
141                &stripe.as_dyn(),
142                &test_def(),
143                dir.path(),
144                "demo",
145                "res",
146                "local",
147                false,
148            )
149            .await
150            .unwrap();
151        assert_eq!(resource.resource_kind, "integration-schematic");
152        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
153        assert_eq!(payload.outputs["api_key"], "val_api_key");
154    }
155}
stackless_integrations/providers/schematic/schematic_environment.rs

stackless_integrations/providers/schematic/
schematic_environment.rs
