Wire between Orchestrator - Provider

crates/configuration/src/lib.rs

@@ -10,7 +10,7 @@ mod utils;
 pub use global_settings::{GlobalSettings, GlobalSettingsBuilder};
 pub use hrmp_channel::{HrmpChannelConfig, HrmpChannelConfigBuilder};
 pub use network::{NetworkConfig, NetworkConfigBuilder};
-pub use parachain::{ParachainConfig, ParachainConfigBuilder};
+pub use parachain::{ParachainConfig, ParachainConfigBuilder, RegistrationStrategy};
 pub use relaychain::{RelaychainConfig, RelaychainConfigBuilder};
 // re-export shared
 pub use shared::{node::NodeConfig, types};

crates/configuration/src/network.rs

@@ -753,15 +753,11 @@ mod tests {
                     .with_default_command("polkadot")
                     .with_default_image("docker.io/parity/polkadot:latest")
                     .with_default_args(vec![("-lparachain", "debug").into()])
-                    .with_node(|node| {
-                        node.with_name("alice")
-                            .validator(true)
-                            .invulnerable(true)
-                            .validator(true)
-                    })
+                    .with_node(|node| node.with_name("alice").validator(true))
                     .with_node(|node| {
                         node.with_name("bob")
                             .validator(true)
+                            .invulnerable(false)
                             .bootnode(true)
                             .with_args(vec![("--database", "paritydb-experimental").into()])
                     })
@@ -822,6 +818,7 @@ mod tests {
                     .with_collator(|collator| {
                         collator
                             .with_name("charles")
+                            .validator(false)
                             .bootnode(true)
                             .invulnerable(true)
                             .with_initial_balance(0)
@@ -830,6 +827,7 @@ mod tests {
                         collator
                             .with_name("frank")
                             .validator(true)
+                            .invulnerable(false)
                             .bootnode(true)
                             .with_initial_balance(1_000_000_000)
                     })
@@ -850,6 +848,7 @@ mod tests {
                     .with_collator(|collator| {
                         collator
                             .with_name("georges")
+                            .validator(false)
                             .bootnode(true)
                             .invulnerable(true)
                             .with_initial_balance(0)
@@ -858,6 +857,7 @@ mod tests {
                         collator
                             .with_name("victor")
                             .validator(true)
+                            .invulnerable(false)
                             .bootnode(true)
                             .with_initial_balance(1_000_000_000)
                     })
@@ -947,6 +947,7 @@ mod tests {
                     .with_collator(|collator| {
                         collator
                             .with_name("charles")
+                            .validator(false)
                             .bootnode(true)
                             .invulnerable(true)
                             .with_initial_balance(0)
@@ -1088,13 +1089,15 @@ mod tests {
                         collator
                             .with_name("charles")
                             .bootnode(true)
+                            .validator(false)
                             .invulnerable(true)
                             .with_initial_balance(0)
                     })
                     .with_collator(|collator| {
                         collator
                             .with_name("frank")
                             .validator(true)
+                            .invulnerable(false)
                             .bootnode(true)
                             .with_initial_balance(1_000_000_000)
                     })
@@ -1116,13 +1119,15 @@ mod tests {
                         collator
                             .with_name("georges")
                             .bootnode(true)
+                            .validator(false)
                             .invulnerable(true)
                             .with_initial_balance(0)
                     })
                     .with_collator(|collator| {
                         collator
                             .with_name("victor")
                             .validator(true)
+                            .invulnerable(false)
                             .bootnode(true)
                             .with_initial_balance(1_000_000_000)
                     })
@@ -1323,6 +1328,7 @@ mod tests {
                         collator
                             .with_name("charles")
                             .bootnode(true)
+                            .validator(false)
                             .invulnerable(true)
                             .with_initial_balance(0)
                     })

crates/configuration/src/shared/node.rs

@@ -10,9 +10,12 @@ use super::{
     resources::ResourcesBuilder,
     types::{AssetLocation, ChainDefaultContext, Command, Image, ValidationContext, U128},
 };
-use crate::shared::{
-    resources::Resources,
-    types::{Arg, Port},
+use crate::{
+    shared::{
+        resources::Resources,
+        types::{Arg, Port},
+    },
+    utils::default_as_true,
 };
 
 /// An environment variable with a name and a value.
@@ -59,9 +62,9 @@ pub struct NodeConfig {
     pub(crate) command: Option<Command>,
     #[serde(default)]
     args: Vec<Arg>,
-    #[serde(alias = "validator")]
+    #[serde(alias = "validator", default = "default_as_true")]
     pub(crate) is_validator: bool,
-    #[serde(alias = "invulnerable")]
+    #[serde(alias = "invulnerable", default = "default_as_true")]
     pub(crate) is_invulnerable: bool,
     #[serde(alias = "bootnode")]
     pub(crate) is_bootnode: bool,
@@ -263,8 +266,8 @@ impl Default for NodeConfigBuilder<Initial> {
                 image: None,
                 command: None,
                 args: vec![],
-                is_validator: false,
-                is_invulnerable: false,
+                is_validator: true,
+                is_invulnerable: true,
                 is_bootnode: false,
                 initial_balance: 2_000_000_000_000.into(),
                 env: vec![],

crates/configuration/src/shared/types.rs

@@ -217,7 +217,7 @@ impl Command {
 /// let url_location2: AssetLocation = "https://mycloudstorage.com/path/to/my/file.tgz".into();
 /// let path_location: AssetLocation = PathBuf::from_str("/tmp/path/to/my/file").unwrap().into();
 /// let path_location2: AssetLocation = "/tmp/path/to/my/file".into();
-///        
+///
 /// assert!(matches!(url_location, AssetLocation::Url(value) if value.as_str() == "https://mycloudstorage.com/path/to/my/file.tgz"));
 /// assert!(matches!(url_location2, AssetLocation::Url(value) if value.as_str() == "https://mycloudstorage.com/path/to/my/file.tgz"));
 /// assert!(matches!(path_location, AssetLocation::FilePath(value) if value.to_str().unwrap() == "/tmp/path/to/my/file"));

crates/examples/Cargo.toml

@@ -7,3 +7,9 @@ edition = "2021"
 
 [dependencies]
 configuration = { path = "../configuration" }
+orchestrator = { path = "../orchestrator" }
+provider = { path = "../provider" }
+# TODO: we shouldn't need to pull from support, we need
+# to review the exports for neeeded types
+support = { path = "../support" }
+tokio = { workspace = true }

crates/examples/examples/small_network_with_default.rs

@@ -1,14 +1,66 @@
+use std::time::Duration;
+
 use configuration::NetworkConfigBuilder;
+use orchestrator::{AddNodeOpts, Orchestrator};
+use provider::NativeProvider;
+use support::fs::local::LocalFileSystem;
 
-fn main() {
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config = NetworkConfigBuilder::new()
         .with_relaychain(|r| {
             r.with_chain("rococo-local")
                 .with_default_command("polkadot")
                 .with_node(|node| node.with_name("alice"))
-                .with_node(|node| node.with_name("name"))
+                .with_node(|node| node.with_name("bob"))
+        })
+        .with_parachain(|p| {
+            p.with_id(100).cumulus_based(true).with_collator(|n| {
+                n.with_name("collator").with_command("polkadot-parachain")
+                //.with_command("adder-collator")
+            })
         })
-        .build();
+        .build()
+        .unwrap();
+
+    println!("{:?}", &config);
+
+    let fs = LocalFileSystem;
+    let provider = NativeProvider::new(fs.clone());
+    let orchestrator = Orchestrator::new(fs, provider);
+    let mut network = orchestrator.spawn(config).await?;
+    println!("🚀🚀🚀🚀 network deployed");
+    // add  a new node
+    let opts = AddNodeOpts {
+        rpc_port: Some(9444),
+        is_validator: true,
+        ..Default::default()
+    };
+
+    // TODO: add check to ensure if unique
+    network.add_node("new1", opts, None).await?;
+
+    tokio::time::sleep(Duration::from_secs(5)).await;
+
+    // pause the node
+    network.pause_node("new1").await?;
+    println!("node new1 paused!");
+
+    tokio::time::sleep(Duration::from_secs(5)).await;
+
+    network.resume_node("new1").await?;
+    println!("node new1 resumed!");
+
+    let col_opts = AddNodeOpts {
+        command: Some("polkadot-parachain".try_into()?),
+        ..Default::default()
+    };
+    network.add_node("new-col-1", col_opts, Some(100)).await?;
+    println!("new collator deployed!");
+
+    // For now let just loop....
+    #[allow(clippy::empty_loop)]
+    loop {}
 
-    println!("{:?}", config.unwrap());
+    // Ok(())
 }

crates/orchestrator/Cargo.toml

@@ -6,3 +6,19 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+configuration = { path = "../configuration" }
+support = { path = "../support" }
+provider = { path = "../provider" }
+tokio = { workspace = true, features = ["time"] }
+thiserror = { workspace = true }
+# TODO: add logger in a new pr.
+#log = { workspace = true }
+multiaddr = { workspace = true }
+rand = "0.8"
+sha2 = { version = "0.10.2", default-features = false }
+hex = "0.4"
+sp-core = "22.0.0"
+serde_json = { workspace = true }
+futures = { workspace = true }
+libp2p = { version = "0.52" }
+anyhow = { workspace = true }

crates/orchestrator/src/errors.rs

@@ -0,0 +1,27 @@
+//! Zombienet Orchestrator error definitions.
+
+use provider::ProviderError;
+use support::fs::FileSystemError;
+
+use crate::generators;
+
+#[derive(Debug, thiserror::Error)]
+pub enum OrchestratorError {
+    // TODO: improve invalid config reporting
+    #[error("Invalid network configuration: {0}")]
+    InvalidConfig(String),
+    #[error("Invalid configuration for node: {0}, field: {1}")]
+    InvalidNodeConfig(String, String),
+    #[error("Invariant not fulfilled {0}")]
+    InvariantError(&'static str),
+    #[error("Global network spawn timeout: {0} secs")]
+    GlobalTimeOut(u32),
+    #[error("Generator error")]
+    GeneratorError(#[from] generators::errors::GeneratorError),
+    #[error("Provider error")]
+    ProviderError(#[from] ProviderError),
+    #[error("FileSystem error")]
+    FileSystemError(#[from] FileSystemError),
+    #[error(transparent)]
+    SpawnerError(#[from] anyhow::Error),
+}

crates/orchestrator/src/generators.rs

@@ -0,0 +1,9 @@
+pub mod bootnode_addr;
+pub mod chain_spec;
+pub mod command;
+pub mod errors;
+pub mod identity;
+pub mod key;
+pub mod keystore;
+pub mod para_artifact;
+pub mod port;

crates/orchestrator/src/generators/bootnode_addr.rs

@@ -0,0 +1,34 @@
+use std::net::IpAddr;
+
+use super::errors::GeneratorError;
+
+pub fn generate(
+    peer_id: &str,
+    ip: &IpAddr,
+    port: u16,
+    args: &[&String],
+    p2p_cert: &Option<String>,
+) -> Result<String, GeneratorError> {
+    let addr = if let Some(index) = args.iter().position(|arg| (*arg).eq("--lister-addr")) {
+        let listen_value = args
+            .get(index + 1)
+            .ok_or(GeneratorError::BootnodeAddrGeneration(
+                "can not generate bootnode address from args".into(),
+            ))?;
+        let ip_str = ip.to_string();
+        let port_str = port.to_string();
+        let mut parts = listen_value.split('/').collect::<Vec<&str>>();
+        parts[2] = ip_str.as_str();
+        parts[4] = port_str.as_str();
+        let mut addr = parts.join("/");
+        if let Some(p2p_cert) = p2p_cert {
+            addr.push_str("/certhash/");
+            addr.push_str(p2p_cert)
+        }
+        addr
+    } else {
+        format!("/ip4/{ip}/tcp/{port}/ws")
+    };
+
+    Ok(format!("{addr}/p2p/{peer_id}"))
+}