Skip to main content

stackless_integrations/providers/railway/
redis.rs

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