aleph_types/message/
program.rs

1use crate::item_hash::ItemHash;
2use crate::message::execution::base::{Encoding, ExecutableContent, Interface};
3use crate::message::execution::environment::{FunctionEnvironment, FunctionTriggers};
4use crate::toolkit::serde::{default_some_false, default_true};
5use serde::{Deserialize, Serialize};
6use std::path::PathBuf;
7
8#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
9pub struct FunctionRuntime {
10    #[serde(rename = "ref")]
11    reference: ItemHash,
12    #[serde(default = "default_true")]
13    use_latest: bool,
14    comment: String,
15}
16
17#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
18pub struct CodeContent {
19    encoding: Encoding,
20    entrypoint: String,
21    /// Reference to the STORE message containing the code.
22    #[serde(rename = "ref")]
23    reference: ItemHash,
24    #[serde(default)]
25    interface: Option<Interface>,
26    #[serde(default)]
27    args: Option<Vec<String>>,
28    #[serde(default)]
29    use_latest: bool,
30}
31
32#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
33pub struct DataContent {
34    encoding: Encoding,
35    mount: PathBuf,
36    #[serde(default, rename = "ref")]
37    reference: Option<ItemHash>,
38    #[serde(default = "default_some_false")]
39    use_latest: Option<bool>,
40}
41
42#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
43pub struct Export {
44    encoding: Encoding,
45    mount: PathBuf,
46}
47
48#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
49pub struct ProgramContent {
50    #[serde(flatten)]
51    pub base: ExecutableContent,
52    /// Code to execute.
53    pub code: CodeContent,
54    /// Execution runtime (rootfs with Python interpreter).
55    pub runtime: FunctionRuntime,
56    /// Data to use during computation.
57    #[serde(default)]
58    pub data: Option<DataContent>,
59    /// Properties of the execution environment.
60    pub environment: FunctionEnvironment,
61    /// Data to export after computation.
62    #[serde(default)]
63    pub export: Option<Export>,
64    /// Signals that trigger an execution.
65    pub on: FunctionTriggers,
66}
67
68impl ProgramContent {
69    pub fn executable_content(&self) -> &ExecutableContent {
70        &self.base
71    }
72}
73
74#[cfg(test)]
75mod tests {
76    use super::*;
77    use crate::chain::{Address, Chain, Signature};
78    use crate::message::base_message::MessageContentEnum;
79    use crate::message::execution::environment::MachineResources;
80    use crate::message::execution::volume::{BaseVolume, ImmutableVolume, MachineVolume};
81    use crate::message::{ContentSource, Message, MessageType};
82    use crate::storage_size::{MemorySize, MiB};
83    use crate::timestamp::Timestamp;
84    use crate::{channel, item_hash};
85    use assert_matches::assert_matches;
86    use std::collections::HashMap;
87
88    const PROGRAM_FIXTURE: &str = include_str!(concat!(
89        env!("CARGO_MANIFEST_DIR"),
90        "/../../fixtures/messages/program/program.json"
91    ));
92
93    #[test]
94    fn test_deserialize_program_message() {
95        let message: Message = serde_json::from_str(PROGRAM_FIXTURE).unwrap();
96
97        assert_eq!(
98            message.sender,
99            Address::from("0x9C2FD74F9CA2B7C4941690316B0Ebc35ce55c885".to_string())
100        );
101        assert_eq!(message.chain, Chain::Ethereum);
102        assert_eq!(
103            message.signature,
104            Signature::from(
105                "0x421c656709851fba752f323a117bc7a07f175a4dd7faf1d8fc1cd9a99028081a6419f9e8b0a7cd454bfef1c52d1f0675a7a59a7d07eb4ebdb22e18bbaf415f881c".to_string()
106            )
107        );
108        assert_matches!(message.message_type, MessageType::Program);
109        assert_matches!(
110            message.content_source,
111            ContentSource::Inline { item_content: _ }
112        );
113        assert_eq!(
114            &message.item_hash.to_string(),
115            "acab01087137c68a5e84734e75145482651accf3bea80fb9b723b761639ecc1c"
116        );
117        assert_eq!(message.time, Timestamp::from(1757026128.773));
118        assert_eq!(message.channel, Some(channel!("ALEPH-CLOUDSOLUTIONS")));
119
120        // Check content fields
121        assert_eq!(
122            &message.content.address,
123            &Address::from("0x9C2FD74F9CA2B7C4941690316B0Ebc35ce55c885".to_string())
124        );
125        assert_eq!(&message.content.time, &Timestamp::from(1757026128.773));
126
127        // Check program content fields
128        let program_content = match message.content() {
129            MessageContentEnum::Program(content) => content,
130            other => {
131                panic!("Expected MessageContentEnum::Program, got {:?}", other);
132            }
133        };
134
135        assert!(!program_content.base.allow_amend);
136        assert_eq!(
137            program_content.base.metadata,
138            Some(HashMap::from([(
139                "name".to_string(),
140                serde_json::Value::String("Hoymiles".to_string())
141            )]))
142        );
143        assert_eq!(program_content.base.variables, Some(HashMap::new()));
144        assert_eq!(
145            program_content.base.resources,
146            MachineResources {
147                vcpus: 2,
148                memory: MiB::from_units(4096),
149                seconds: 30,
150                published_ports: None,
151            }
152        );
153        assert_matches!(program_content.base.authorized_keys, None);
154        assert_eq!(
155            program_content.environment,
156            FunctionEnvironment {
157                reproducible: false,
158                internet: true,
159                aleph_api: true,
160                shared_cache: false,
161            }
162        );
163        assert_eq!(
164            program_content.base.volumes,
165            vec![MachineVolume::Immutable(ImmutableVolume {
166                base: BaseVolume {
167                    comment: None,
168                    mount: Some(PathBuf::from("/opt/packages"))
169                },
170                reference: Some(item_hash!(
171                    "8df728d560ed6e9103b040a6b5fc5417e0a52e890c12977464ebadf9becf1bf6"
172                )),
173                use_latest: true,
174            })]
175        );
176        assert_eq!(program_content.base.replaces, None);
177        assert_eq!(
178            program_content.code,
179            CodeContent {
180                encoding: Encoding::Zip,
181                entrypoint: "main:app".to_string(),
182                reference: item_hash!(
183                    "9a4735bca0d3f7032ddd6659c35387b57b470550c931841e6862ece4e9e6523e"
184                ),
185                interface: None,
186                args: None,
187                use_latest: true,
188            }
189        );
190        assert_eq!(
191            program_content.runtime,
192            FunctionRuntime {
193                reference: item_hash!(
194                    "63f07193e6ee9d207b7d1fcf8286f9aee34e6f12f101d2ec77c1229f92964696"
195                ),
196                use_latest: true,
197                comment: "Aleph Alpine Linux with Python 3.12".to_string(),
198            }
199        );
200        assert_eq!(program_content.data, None);
201        assert_eq!(program_content.export, None);
202        assert_eq!(
203            program_content.on,
204            FunctionTriggers {
205                http: true,
206                persistent: Some(false)
207            }
208        );
209
210        // No confirmation on this fixture
211        assert!(!message.confirmed());
212        assert!(message.confirmations.is_empty());
213    }
214}
aleph_types/message/program.rs

aleph_types/message/
program.rs
