Feature/add module spec

crates/plugins/hetzner/spec/base.star

@@ -1,4 +1,65 @@
+"""
+Hetzner infrastructure as Code
+
+This plugin provides a way to interact with Hetzner Cloud API and manage
+resources in a declarative way using starlark.
+
+The plugin provides the following capabilities:
+- Inherit process args from the host
+- Inherit process stdio from the host
+- Inherit process stdout from the host
+- Inherit process environment from the host
+- Mount files inside wasi
+- Mount directory inside wasi
+"""
+
 module(
-  name = "hetzner",
-  version = "v0.1.0",
+    name = "hetzner",
+    version = "v0.1.0",
+    # capabilities represents a set of capabilities that the plugin gains all
+    # capabilities in starlark map to the capabilities of WASI and are describer here
+    # https://docs.rs/wasmtime-wasi/latest/wasmtime_wasi/struct.WasiCtxBuilder.html#
+    capabilities = capabilities(
+        inherits = [
+            # inherit process args from the host
+            INHERIT_ARGS,
+            # inherit process stdio from the host
+            INHERIT_STDIO,
+            # inherit process stdout from the host
+            INHERIT_STDOUT,
+            # inherit process environment from the host
+            INHERIT_ENV,
+        ],
+        # mounts is a list of mounts that the plugin can use
+        # this gives the WASI module access to the host filesystem
+        mounts = [
+            # mount a dir inside WASI with full capabilities, read, write files,
+            # mutate directory.
+            mount(
+                host_path = "/var/run/",
+                guest_path = "/var/run/",
+                dir_perms = {
+                    "read": true,
+                    "mutate": true,
+                },
+                file_perms = {
+                    "read": true,
+                    "write": true,
+                },
+            ),
+            # mount a dir inside WASI with read only capabilities
+            mount(
+                host_path = "/var/lib/hetzner",
+                guest_path = "/mnt/hetzner",
+                dir_perms = {
+                    "read": true,
+                    "mutate": false,
+                },
+                file_perms = {
+                    "read": true,
+                    "write": false,
+                },
+            ),
+        ],
+    ),
 )

crates/plugins/hetzner/spec/network.star

@@ -1,4 +1,8 @@
-network(
-  name = "network",
-  cidr = "10.0.0.1/16",
-)
+#network(
+#    name = "network",
+#    cidr = "10.0.0.1/16",
+#    docs = """
+#    The network module is responsible for managing 
+#    the network cloud resource
+#    """,
+#)

crates/plugins/hetzner/src/lib.rs

@@ -1,11 +1,16 @@
 use skyforge_sdk::skyforge_plugin;
 
 struct Hetzner;
+use exports::cloudflavor::skyforge::plugin_api::Error as ApiError;
 
 #[skyforge_plugin]
 impl SkyforgePlugin for Hetzner {
-    fn deserialize_config_impl(config: String) -> Result<Config, Error> {
-        println!("Hetzner config: {}", config);
-        Ok(Config { name: config })
+    fn get_version_impl() -> String {
+        "0.1.0".to_string()
+    }
+
+    fn verify_config_impl(config: Config) -> Result<(), ApiError> {
+        println!("Config: {:?}", config);
+        Ok(())
     }
 }

crates/plugins/hetzner/src/resources/instance.rs

@@ -40,6 +40,7 @@ use std::collections::HashMap;
 ///     },
 /// )
 /// ```
+///
 pub fn network(
     _name: &str,
     _expose_routes_to_vswitch: bool,

crates/sdk/skyforge-sdk-macros/src/lib.rs

@@ -16,15 +16,17 @@ pub fn skyforge_plugin(_: TokenStream, input: TokenStream) -> TokenStream {
     let trait_items = &impl_trait.items;
 
     let expanded = quote! {
+        use exports::cloudflavor::skyforge::plugin_api::{Guest, Config,Error};
 
         wit_bindgen::generate!({path: "wit", world: "skyforge-api"});
 
-        use exports::cloudflavor::skyforge::plugin_api::{Guest, Config,Error};
-
         impl Guest for #name {
-            fn deserialize_config(config: String) -> Result<Config, Error> {
-                let config = Self::deserialize_config_impl(config).unwrap();
-                Ok(config)
+            fn get_version() -> String {
+                Self::get_version_impl()
+            }
+
+            fn verify_config(config: Config) -> Result<(), Error> {
+                Self::verify_config_impl(config)
             }
         }
 
@@ -37,3 +39,4 @@ pub fn skyforge_plugin(_: TokenStream, input: TokenStream) -> TokenStream {
 
     TokenStream::from(expanded)
 }
+

spec/wit/skyforge.v1.wit

@@ -11,9 +11,10 @@ interface plugin-api {
         other,
     }
 
-    deserialize-config: func(config-str: string) -> result<config, error>;
+    verify-config: func(config: config) -> result<_, error>;
+    get-version: func() -> string;
 }
 
 world skyforge-api {
     export plugin-api;
-}
+}