stackless_integrations/providers/railway/
bucket.rs

1//! `railway/bucket` 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-railway-bucket";
14
15#[derive(Debug, Serialize)]
16pub struct RailwayBucketConfig {
17    #[serde(skip_serializing_if = "Option::is_none")]
18    pub name: Option<String>,
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub region: Option<String>,
21}
22
23impl CatalogService for RailwayBucketConfig {
24    const REFERENCE: &'static str = "railway/bucket";
25}
26
27#[derive(Debug)]
28pub struct RailwayBucket;
29
30impl Hostable for RailwayBucket {
31    const PROVIDER: &'static str = "railway-bucket";
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        "access_key_id",
37        "secret_access_key",
38        "bucket_name",
39        "endpoint",
40        "region",
41        "type",
42    ];
43}
44
45impl FamilyResource for RailwayBucket {
46    type Config = RailwayBucketConfig;
47    const PROVIDER_PREFIX: &'static str = "RAILWAY";
48    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
49        ("ACCESS_KEY_ID", "access_key_id", true),
50        ("SECRET_ACCESS_KEY", "secret_access_key", true),
51        ("BUCKET_NAME", "bucket_name", true),
52        ("ENDPOINT", "endpoint", true),
53        ("REGION", "region", false),
54        ("TYPE", "type", false),
55    ];
56
57    fn build_config(ctx: &ProvisionContext<'_>) -> Result<RailwayBucketConfig, IntegrationError> {
58        let config = super::integration_config(ctx)?;
59        Ok(RailwayBucketConfig {
60            name: super::interp_optional(ctx, &config, "name")?,
61            region: super::interp_optional(ctx, &config, "region")?,
62        })
63    }
64}
65
66pub fn validate_config(
67    name: &str,
68    config: &BTreeMap<String, toml::Value>,
69) -> Result<(), IntegrationError> {
70    let _ = (name, config);
71    Ok(())
72}
73
74#[cfg(test)]
75mod tests {
76    use super::*;
77    use crate::ProviderOps;
78    use crate::resource::ResourcePayload;
79    use stackless_core::def::StackDef;
80    use stackless_stripe_projects::stripe::StripeProjects;
81    use stackless_stripe_projects::test_support;
82
83    #[test]
84    fn config_matches_catalog() {
85        const FIXTURE: &str = include_str!(concat!(
86            env!("CARGO_MANIFEST_DIR"),
87            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
88        ));
89        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
90        let failures = stackless_stripe_projects::verify_service(
91            &catalog,
92            &RailwayBucketConfig {
93                name: None,
94                region: None,
95            },
96        );
97        assert!(
98            failures.is_empty(),
99            "railway/bucket catalog gaps:\n{}",
100            failures.join("\n")
101        );
102    }
103
104    const CATALOG_ENVELOPE: &str = r##"{"ok":true,"command":"projects catalog","data":{"last_updated":"2026-07-11T00:00:00Z","services":[{"id":"prvsvc_bucket","object":"v2.provisioning.provider_service_detail","provider_id":"prvdr_railway","provider_name":"Railway","service_id":"bucket","categories":["database"],"kind":"deployable","scope":"project","availability":"available","development":false,"livemode":true,"pricing":{"type":"component"},"configuration_schema":{"properties":{"name":{"description":"Bucket name (auto-generated if omitted).","type":"string"},"region":{"description":"Storage region (e.g. sjc, iad, ams, sin).","type":"string"}},"type":"object"}}]}}"##;
105
106    fn test_def() -> StackDef {
107        StackDef::parse(
108            r#"
109[stack]
110name = "atto"
111[stack.projects.stripe]
112project = "project_1"
113[integrations.res]
114provider = "railway-bucket"
115[services.api]
116source = { repo = "r", ref = "main" }
117env = { OUT = "${integrations.res.access_key_id}" }
118health = { path = "/health" }
119[services.api.local]
120run = "true"
121"#,
122        )
123        .unwrap()
124    }
125
126    #[tokio::test]
127    async fn provision_records_outputs() {
128        let runner = test_support::provision_script(
129            CATALOG_ENVELOPE,
130            serde_json::json!({"RAILWAY_ACCESS_KEY_ID": "val_access_key_id", "RAILWAY_SECRET_ACCESS_KEY": "val_secret_access_key", "RAILWAY_BUCKET_NAME": "val_access_key_id_name", "RAILWAY_ENDPOINT": "val_endpoint", "RAILWAY_REGION": "val_region", "RAILWAY_TYPE": "val_type"}),
131            0,
132        );
133        let dir = tempfile::tempdir().unwrap();
134        std::fs::write(
135            dir.path().join("stackless.toml"),
136            "[stack]\nname=\"atto\"\n",
137        )
138        .unwrap();
139        let stripe = StripeProjects::new(&runner, dir.path());
140
141        let resource = RailwayBucket
142            .provision(
143                &stripe.as_dyn(),
144                &test_def(),
145                dir.path(),
146                "demo",
147                "res",
148                "local",
149                false,
150            )
151            .await
152            .unwrap();
153        assert_eq!(resource.resource_kind, "integration-railway-bucket");
154        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
155        assert_eq!(payload.outputs["access_key_id"], "val_access_key_id");
156    }
157}
stackless_integrations/providers/railway/bucket.rs

stackless_integrations/providers/railway/
bucket.rs
