Skip to main content

alien_core/resources/
queue.rs

1use crate::error::{ErrorData, Result};
2use crate::resource::{ResourceDefinition, ResourceOutputsDefinition, ResourceRef};
3use crate::ResourceType;
4use alien_error::AlienError;
5use bon::Builder;
6use serde::{Deserialize, Serialize};
7use std::any::Any;
8
9/// Represents a message queue resource with minimal, portable semantics.
10/// Queue integrates with platform-native services (AWS SQS, GCP Pub/Sub, Azure Service Bus).
11#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Builder)]
12#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
13#[serde(rename_all = "camelCase", deny_unknown_fields)]
14#[builder(start_fn = new)]
15pub struct Queue {
16    /// Identifier for the queue. Must contain only alphanumeric characters, hyphens, and underscores ([A-Za-z0-9-_]).
17    /// Maximum 64 characters.
18    #[builder(start_fn)]
19    pub id: String,
20}
21
22impl Queue {
23    /// The resource type identifier for Queue
24    pub const RESOURCE_TYPE: ResourceType = ResourceType::from_static("queue");
25
26    /// Returns the queue's unique identifier.
27    pub fn id(&self) -> &str {
28        &self.id
29    }
30}
31
32/// Outputs generated by a successfully provisioned Queue.
33#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
34#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
35#[serde(rename_all = "camelCase")]
36pub struct QueueOutputs {
37    /// The name of the queue (platform-specific physical name).
38    pub queue_name: String,
39    /// Platform-specific identifier or URL (e.g., SQS URL, Pub/Sub topic/subscription).
40    #[serde(skip_serializing_if = "Option::is_none")]
41    pub identifier: Option<String>,
42}
43
44impl ResourceOutputsDefinition for QueueOutputs {
45    fn get_resource_type(&self) -> ResourceType {
46        Queue::RESOURCE_TYPE.clone()
47    }
48
49    fn as_any(&self) -> &dyn Any {
50        self
51    }
52
53    fn box_clone(&self) -> Box<dyn ResourceOutputsDefinition> {
54        Box::new(self.clone())
55    }
56
57    fn outputs_eq(&self, other: &dyn ResourceOutputsDefinition) -> bool {
58        other.as_any().downcast_ref::<QueueOutputs>() == Some(self)
59    }
60
61    fn to_json_value(&self) -> serde_json::Result<serde_json::Value> {
62        serde_json::to_value(self)
63    }
64}
65
66// Implementation of ResourceDefinition trait for Queue
67impl ResourceDefinition for Queue {
68    fn get_resource_type(&self) -> ResourceType {
69        Self::RESOURCE_TYPE
70    }
71
72    fn id(&self) -> &str {
73        &self.id
74    }
75
76    fn get_dependencies(&self) -> Vec<ResourceRef> {
77        Vec::new()
78    }
79
80    fn validate_update(&self, new_config: &dyn ResourceDefinition) -> Result<()> {
81        // Downcast to Queue type to use the existing validate_update method
82        let new_queue = new_config.as_any().downcast_ref::<Queue>().ok_or_else(|| {
83            AlienError::new(ErrorData::UnexpectedResourceType {
84                resource_id: self.id.clone(),
85                expected: Self::RESOURCE_TYPE,
86                actual: new_config.get_resource_type(),
87            })
88        })?;
89
90        if self.id != new_queue.id {
91            return Err(AlienError::new(ErrorData::InvalidResourceUpdate {
92                resource_id: self.id.clone(),
93                reason: "the 'id' field is immutable".to_string(),
94            }));
95        }
96        Ok(())
97    }
98
99    fn as_any(&self) -> &dyn Any {
100        self
101    }
102
103    fn as_any_mut(&mut self) -> &mut dyn Any {
104        self
105    }
106
107    fn box_clone(&self) -> Box<dyn ResourceDefinition> {
108        Box::new(self.clone())
109    }
110
111    fn resource_eq(&self, other: &dyn ResourceDefinition) -> bool {
112        other.as_any().downcast_ref::<Queue>() == Some(self)
113    }
114
115    fn to_json_value(&self) -> serde_json::Result<serde_json::Value> {
116        serde_json::to_value(self)
117    }
118}
119
120#[cfg(test)]
121mod tests {
122    use super::*;
123
124    #[test]
125    fn test_queue_builder() {
126        let q = Queue::new("my-queue".to_string()).build();
127        assert_eq!(q.id, "my-queue");
128    }
129
130    #[test]
131    fn test_queue_resource_type() {
132        assert_eq!(Queue::RESOURCE_TYPE.as_ref(), "queue");
133    }
134
135    #[test]
136    fn test_queue_resource_definition() {
137        let q = Queue::new("test-q".to_string()).build();
138        assert_eq!(q.get_resource_type(), Queue::RESOURCE_TYPE);
139        assert_eq!(q.id(), "test-q");
140        assert!(q.get_dependencies().is_empty());
141    }
142
143    #[test]
144    fn test_queue_validate_update() {
145        let original = Queue::new("test-q".to_string()).build();
146        let valid_update = Queue::new("test-q".to_string()).build();
147        let invalid_update = Queue::new("different-q".to_string()).build();
148
149        assert!(original.validate_update(&valid_update).is_ok());
150        assert!(original.validate_update(&invalid_update).is_err());
151    }
152}