diff --git a/README.md b/README.md index a12c7d79c..5065090c7 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ Zombienet aims to be a testing framework for Substrate based blockchains, provid tool that allows users to spawn and test ephemeral networks. The assertions used in the tests can include on-chain storage, metrics, logs and custom javascript scripts that interact with the chain. To make it easy to define those, zombienet has a `natural language` built-in allowing developers to -write tests as smooth as posible. +write tests as smooth as possible. Internally zombienet is a `javascript` library, designed to run on `Node.js` and support different backend `providers` to run the *nodes*, at this moment `kubernetes`, `podman` and `native` are -supported. +supported. **Note:** Currently, it is only possible to use `podman` for Zombienet users on Linux machines. Although `podman` comes with support for macOS, it is done using an internal VM and the Zombienet provider code expects `podman` to be running natively. diff --git a/crates/parser/src/zombienet.pest b/crates/parser/src/zombienet.pest index 1e790e635..cf6ba9dad 100644 --- a/crates/parser/src/zombienet.pest +++ b/crates/parser/src/zombienet.pest @@ -1,6 +1,6 @@ /// Helpers WHITESPACE = _{ " " | "\t" | "\r" | "\n" } -/// matches permited node's names +/// matches permitted node's names name = @{ (ASCII_ALPHANUMERIC | "-")+ } /// matched any integer int = @{ "-" ? ~ ("0" | '1'..'9' ~ '0'..'9' * ) } diff --git a/docs/book/cli/spawn.html b/docs/book/cli/spawn.html index 9566d765c..3524a461c 100644 --- a/docs/book/cli/spawn.html +++ b/docs/book/cli/spawn.html @@ -143,7 +143,7 @@

🧟🧟🧟 ZombieNet 🧟🧟🧟

Spawning

-

One of the goal of ZombieNet is easily spawn ephemeral networks, providing a simple but poweful cli that allow you to declare the desired network in toml or json format. You can check the definition spec to view the available options.

+

One of the goal of ZombieNet is easily spawn ephemeral networks, providing a simple but powerful cli that allow you to declare the desired network in toml or json format. You can check the definition spec to view the available options.

A minimal configuration example with two validators and one parachain:

[settings]
 timeout = 1000
@@ -166,7 +166,7 @@ 
Spawning

   image = "paritypr/colander:4131-ccd09bbf"
   command = "adder-collator"
-

Then you can spwan the network by running the following command:

+

Then you can spawn the network by running the following command:

./zombienet-macos spawn examples/0001-small-network.toml

You can follow the output of the steps to spawn the network and once the network is launched a message with the nodes information like this one is show

diff --git a/docs/book/cli/testing.html b/docs/book/cli/testing.html index a4a585aae..a0f3eb6a5 100644 --- a/docs/book/cli/testing.html +++ b/docs/book/cli/testing.html @@ -145,7 +145,7 @@

🧟🧟🧟 ZombieNet 🧟🧟🧟

Testing

The other goal of ZombieNet is provide a way to perform test/assertions agins the spawned network, using a set of natural language expressions that allow to make assertions based on metrics, logs and some built-in function that query the network using polkadot.js. Those assertions should be defined in a feature test, and the dsl and format is documented in here.

-

The following is an small example to spawn a network (using the previos simple network definition) and assert that:

+

The following is an small example to spawn a network (using the previous simple network definition) and assert that:

Testing

The other goal of ZombieNet is provide a way to perform test/assertions agins the spawned network, using a set of natural language expressions that allow to make assertions based on metrics, logs and some built-in function that query the network using polkadot.js. Those assertions should be defined in a feature test, and the dsl and format is documented in here.

-

The following is an small example to spawn a network (using the previos simple network definition) and assert that:

+

The following is an small example to spawn a network (using the previous simple network definition) and assert that: