activity: add volume spec to ExeScriptCommand::Deploy (#188)

* activity: add volume spec to ExeScriptCommand::Deploy

* activity: use bytesize for Volume size & preallocate

* Revert "Feature/market scan (#185)"

This reverts commit 1dc4062.

* activity: Volume size no longer optional

* activity: Simplify Volume API

* activity: update OpenAPI spec with rough  definition

* activity: add volume spec to ExeScriptCommand::Deploy

* activity: use bytesize for Volume size & preallocate

* Revert "Feature/market scan (#185)"

This reverts commit 1dc4062.

* activity: Volume size no longer optional

* activity: Simplify Volume API

* activity: update OpenAPI spec with rough  definition

* activity: Add Volumes::as_volumes to construct a cannonical form

* Merge fixup

---------

Co-authored-by: Przemysław Krzysztof Rekucki <[email protected]>

Author: kamirr

Cargo.toml

@@ -29,7 +29,7 @@ members = ["model"]
 secp256k1 = ">=0.23,<0.28"
 
 [dependencies]
-ya-client-model = { version = "0.7", path = "model" }
+ya-client-model = { version = "0.6", path = "model" }
 awc = { version = "3", default-features = false }
 actix-codec = "0.5"
 bytes = "1"
@@ -59,7 +59,7 @@ anyhow = "1.0"
 bigdecimal = { version = "0.2" }
 env_logger = "0.10"
 structopt = "0.3"
-clap = "4.5.7"
 
 [package.metadata.release]
+dev-version = false
 enable-all-features = true

examples/list_offers.rs

@@ -1,6 +1,6 @@
 [package]
 name = "ya-client-model"
-version = "0.7.0"
+version = "0.6.0"
 description = "Yagna REST API data model"
 authors = ["Golem Factory <[email protected]>"]
 homepage = "https://github.com/golemfactory/ya-client"
@@ -14,8 +14,9 @@ with-diesel = ['diesel']
 sgx = ['secp256k1', 'openssl', 'hex', 'secp256k1/serde']
 
 [dependencies]
-bigdecimal = { version = "0.2", features = ["serde"]}
-chrono = { version = "0.4", features = ["serde"]}
+bigdecimal = { version = "0.2", features = ["serde"] }
+bytesize = { version = "1.3.0", features = ["serde"] }
+chrono = { version = "0.4", features = ["serde"] }
 derive_more = "0.99"
 humantime-serde = "1.1"
 rand = "0.8"
@@ -28,9 +29,10 @@ strum_macros = "0.24.3"
 thiserror = "1.0"
 
 diesel = { version = "1.4", optional = true }
-hex = { version = "0.4", optional = true}
+hex = { version = "0.4", optional = true }
 secp256k1 = { workspace = true, optional = true }
 openssl = { version = "0.10", optional = true }
 
 [package.metadata.release]
+dev-version = false
 enable-all-features = true

model/Cargo.toml

@@ -9,6 +9,7 @@
  */
 
 use crate::activity::ExeScriptCommandState;
+use bytesize::ByteSize;
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 use std::time::Duration;
@@ -26,8 +27,9 @@ pub enum ExeScriptCommand {
         #[serde(default)]
         hostname: Option<String>,
 
+        #[serde(skip_serializing_if = "Option::is_none")]
         #[serde(default)]
-        volumes: Vec<String>,
+        volumes: Option<Volumes>,
 
         #[serde(default)]
         env: HashMap<String, String>,
@@ -58,6 +60,46 @@ pub enum ExeScriptCommand {
     Terminate {},
 }
 
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum VolumeMount {
+    Host {},
+    Ram {
+        size: ByteSize,
+    },
+    Storage {
+        size: ByteSize,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        #[serde(default)]
+        preallocate: Option<ByteSize>,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        #[serde(default)]
+        errors: Option<String>,
+    },
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum Volumes {
+    Simple(Vec<String>),
+    Detailed {
+        #[serde(flatten)]
+        volumes: HashMap<String, VolumeMount>,
+    },
+}
+
+impl Volumes {
+    pub fn as_volumes(self) -> HashMap<String, VolumeMount> {
+        match self {
+            Volumes::Simple(paths) => paths
+                .into_iter()
+                .map(|path| (path, VolumeMount::Host {}))
+                .collect(),
+            Volumes::Detailed { volumes } => volumes,
+        }
+    }
+}
+
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Network {
@@ -199,6 +241,11 @@ impl From<ExeScriptCommand> for ExeScriptCommandState {
 
 #[cfg(test)]
 mod test {
+    use bytesize::ByteSize;
+
+    use super::Volumes;
+    use crate::activity::exe_script_command::VolumeMount;
+    use std::collections::HashMap;
 
     #[test]
     fn test_transfers_parsing() {
@@ -236,4 +283,67 @@ mod test {
         ]"#;
         let _: Vec<super::ExeScriptCommand> = serde_json::from_str(command).unwrap();
     }
+
+    #[test]
+    fn test_volumes_simple() {
+        let volumes_json = r#"[
+            "/golem/input",
+            "/golem/output"
+        ]"#;
+        let volumes: Volumes = serde_json::from_str(&volumes_json).unwrap();
+
+        assert_eq!(
+            volumes,
+            Volumes::Simple(vec![
+                "/golem/input".to_string(),
+                "/golem/output".to_string()
+            ])
+        );
+    }
+
+    #[test]
+    fn test_volumes_detailed() {
+        let volumes_json = r#"{
+            "/golem/input": { "host": {} },
+            "/golem/output": { "host": {} },
+            "/storage": {
+                "storage": {
+                    "size": "10GiB",
+                    "preallocate": "2GiB"
+                }
+            },
+            "/": {
+                "ram": {
+                    "size": "1024MiB"
+                }
+            }
+        }"#;
+        let volumes: Volumes = serde_json::from_str(&volumes_json).unwrap();
+
+        assert_eq!(
+            volumes,
+            Volumes::Detailed {
+                volumes: {
+                    let mut map = HashMap::new();
+                    map.insert("/golem/input".to_string(), VolumeMount::Host {});
+                    map.insert("/golem/output".to_string(), VolumeMount::Host {});
+                    map.insert(
+                        "/storage".to_string(),
+                        VolumeMount::Storage {
+                            size: ByteSize::gib(10),
+                            preallocate: Some(ByteSize::gib(2)),
+                            errors: None,
+                        },
+                    );
+                    map.insert(
+                        "/".to_string(),
+                        VolumeMount::Ram {
+                            size: ByteSize::b(1073741824),
+                        },
+                    );
+                    map
+                }
+            }
+        );
+    }
 }

model/src/activity/exe_script_command.rs

@@ -0,0 +1,5 @@
+sign-commit=true
+sign-tag=true
+dev-version=false
+pre-release-commit-message="release {{crate_name}} {{version}}"
+enable-all-features=true

release.toml

@@ -487,6 +487,7 @@ components:
               "net": [{ "id": "id", "ip": "10.0.0.2", "mask": "255.255.0.0" }],
               "hosts": {"master": "10.0.0.1"},
               "nodes": {"10.0.0.1": "0xdeadbeef"},
+              "volumes": {"/": { "storage": { "size": "10g" } }},
               "progress" : {"updateInterval": "300ms", "updateStep": null}
             }
         },
@@ -559,6 +560,10 @@ components:
           type: object
           additionalProperties:
             type: string
+        volumes:
+          type: object
+          additionalProperties:
+            type: string
         progress:
           $ref: '#/components/schemas/ProgressArgs'
 

specs/activity-api.yaml

@@ -79,8 +79,6 @@ paths:
           $ref: 'common.yaml#/responses/NotFound'
         default:
           $ref: 'common.yaml#/responses/UnexpectedError'
-
-  /scan/{subscriptionId}:
     delete:
       tags:
         - requestor

specs/market-api.yaml

@@ -350,7 +350,7 @@ impl MarketRequestorApi {
     }
 
     pub async fn end_scan(&self, subscription_id: &str) -> Result<()> {
-        let url = url_format!("scan/{subscription_id}");
+        let url = url_format!("scan/{subscription_id}/events");
         self.client.delete(&url).send().json().await
     }
 }