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
44#[typetag::serde(name = "queue")]
45impl ResourceOutputsDefinition for QueueOutputs {
46    fn resource_type() -> ResourceType {
47        Queue::RESOURCE_TYPE.clone()
48    }
49
50    fn as_any(&self) -> &dyn Any {
51        self
52    }
53
54    fn box_clone(&self) -> Box<dyn ResourceOutputsDefinition> {
55        Box::new(self.clone())
56    }
57
58    fn outputs_eq(&self, other: &dyn ResourceOutputsDefinition) -> bool {
59        other.as_any().downcast_ref::<QueueOutputs>() == Some(self)
60    }
61}
62
63// Implementation of ResourceDefinition trait for Queue
64#[typetag::serde(name = "queue")]
65impl ResourceDefinition for Queue {
66    fn resource_type() -> ResourceType {
67        Self::RESOURCE_TYPE.clone()
68    }
69
70    fn get_resource_type(&self) -> ResourceType {
71        Self::resource_type()
72    }
73
74    fn id(&self) -> &str {
75        &self.id
76    }
77
78    fn get_dependencies(&self) -> Vec<ResourceRef> {
79        Vec::new()
80    }
81
82    fn validate_update(&self, new_config: &dyn ResourceDefinition) -> Result<()> {
83        // Downcast to Queue type to use the existing validate_update method
84        let new_queue = new_config.as_any().downcast_ref::<Queue>().ok_or_else(|| {
85            AlienError::new(ErrorData::UnexpectedResourceType {
86                resource_id: self.id.clone(),
87                expected: Self::RESOURCE_TYPE,
88                actual: new_config.get_resource_type(),
89            })
90        })?;
91
92        if self.id != new_queue.id {
93            return Err(AlienError::new(ErrorData::InvalidResourceUpdate {
94                resource_id: self.id.clone(),
95                reason: "the 'id' field is immutable".to_string(),
96            }));
97        }
98        Ok(())
99    }
100
101    fn as_any(&self) -> &dyn Any {
102        self
103    }
104
105    fn as_any_mut(&mut self) -> &mut dyn Any {
106        self
107    }
108
109    fn box_clone(&self) -> Box<dyn ResourceDefinition> {
110        Box::new(self.clone())
111    }
112
113    fn resource_eq(&self, other: &dyn ResourceDefinition) -> bool {
114        other.as_any().downcast_ref::<Queue>() == Some(self)
115    }
116}
117
118#[cfg(test)]
119mod tests {
120    use super::*;
121
122    #[test]
123    fn test_queue_builder() {
124        let q = Queue::new("my-queue".to_string()).build();
125        assert_eq!(q.id, "my-queue");
126    }
127
128    #[test]
129    fn test_queue_resource_type() {
130        assert_eq!(Queue::RESOURCE_TYPE.as_ref(), "queue");
131    }
132
133    #[test]
134    fn test_queue_resource_definition() {
135        let q = Queue::new("test-q".to_string()).build();
136        assert_eq!(q.get_resource_type(), Queue::RESOURCE_TYPE);
137        assert_eq!(q.id(), "test-q");
138        assert!(q.get_dependencies().is_empty());
139    }
140
141    #[test]
142    fn test_queue_validate_update() {
143        let original = Queue::new("test-q".to_string()).build();
144        let valid_update = Queue::new("test-q".to_string()).build();
145        let invalid_update = Queue::new("different-q".to_string()).build();
146
147        assert!(original.validate_update(&valid_update).is_ok());
148        assert!(original.validate_update(&invalid_update).is_err());
149    }
150}