From 4814566bb9e855f309cca5cab065700a8c902737 Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Tue, 5 Dec 2023 15:28:40 +0800 Subject: [PATCH] Fix typos (#1583) * fix typo * fix typo * fix typo * fix typo * fix typo --- docs/book/searchindex.js | 4 ++-- docs/book/searchindex.json | 4 ++-- docs/src/cli/test-dsl-definition-spec.md | 2 +- scripts/ci/run-test-env-manager.sh | 2 +- scripts/ci/run-test-local-env-manager.sh | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/book/searchindex.js b/docs/book/searchindex.js index 13e2bd0af..5e85383e8 100644 --- a/docs/book/searchindex.js +++ b/docs/book/searchindex.js @@ -118,7 +118,7 @@ Object.assign(window.search, { title: "Download and install needed artifacts", }, 13: { - body: '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. A minimal configuration example with two validators and one parachain: [settings]\ntimeout = 1000 [relaychain]\ndefault_image = "paritypr/polkadot-debug:master"\nchain = "rococo-local" [[relaychain.nodes]] name = "alice" [[relaychain.nodes]] name = "bob" [[parachains]]\nid = 100 [parachains.collator] name = "collator01" image = "paritypr/colander:4131-ccd09bbf" command = "adder-collator" Then you can spwan 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 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│ Network launched 🚀🚀 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Namespace │ zombie-0c26e3512b222b8cd7053d4f632f0b62 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Provider │ native │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ alice │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:43185#/explorer │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44521/metrics │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ bob │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:45645#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:38901/metrics │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Parachain ID │ 100 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ ChainSpec Path │ /tmp/zombie-0c26e3512b222b8cd7053d4f632f0b62_-20554-cMuCmVc8OQ7f/rococo-local-100.json │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────-─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ collator01 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:37543#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44807/metrics │\n└─────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────┘ Both the prometheus and the node links are accesibles in your local machine to get the metrics or connect to the node.', + body: '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]\ntimeout = 1000 [relaychain]\ndefault_image = "paritypr/polkadot-debug:master"\nchain = "rococo-local" [[relaychain.nodes]] name = "alice" [[relaychain.nodes]] name = "bob" [[parachains]]\nid = 100 [parachains.collator] name = "collator01" image = "paritypr/colander:4131-ccd09bbf" command = "adder-collator" Then you can spwan 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 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│ Network launched 🚀🚀 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Namespace │ zombie-0c26e3512b222b8cd7053d4f632f0b62 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Provider │ native │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ alice │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:43185#/explorer │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44521/metrics │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ bob │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:45645#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:38901/metrics │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Parachain ID │ 100 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ ChainSpec Path │ /tmp/zombie-0c26e3512b222b8cd7053d4f632f0b62_-20554-cMuCmVc8OQ7f/rococo-local-100.json │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────-─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ collator01 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:37543#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44807/metrics │\n└─────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────┘ Both the prometheus and the node links are accesibles in your local machine to get the metrics or connect to the node.', breadcrumbs: "Cli usage » Spawning » Spawning", id: "13", title: "Spawning", @@ -136,7 +136,7 @@ Object.assign(window.search, { title: "Teardown", }, 16: { - body: "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: Both nodes are running The definded parachain is registered The defined parachain is producing blocks and produced at least 10 within 200 seconds. Description: Simple Network Smoke Test\nNetwork: ./0001-small-network.toml\nCreds: config alice: is up\nbob: is up\nalice: parachain 100 is registered within 225 seconds\nalice: parachain 100 block height is at least 10 within 200 seconds Another examples are provided in the examples directory.", + body: "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 previous simple network definition) and assert that: Both nodes are running The definded parachain is registered The defined parachain is producing blocks and produced at least 10 within 200 seconds. Description: Simple Network Smoke Test\nNetwork: ./0001-small-network.toml\nCreds: config alice: is up\nbob: is up\nalice: parachain 100 is registered within 225 seconds\nalice: parachain 100 block height is at least 10 within 200 seconds Another examples are provided in the examples directory.", breadcrumbs: "Cli usage » Testing » Testing", id: "16", title: "Testing", diff --git a/docs/book/searchindex.json b/docs/book/searchindex.json index 4f7b017ac..6f1df9f79 100644 --- a/docs/book/searchindex.json +++ b/docs/book/searchindex.json @@ -117,7 +117,7 @@ "title": "Download and install needed artifacts" }, "13": { - "body": "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. A minimal configuration example with two validators and one parachain: [settings]\ntimeout = 1000 [relaychain]\ndefault_image = \"paritypr/polkadot-debug:master\"\nchain = \"rococo-local\" [[relaychain.nodes]] name = \"alice\" [[relaychain.nodes]] name = \"bob\" [[parachains]]\nid = 100 [parachains.collator] name = \"collator01\" image = \"paritypr/colander:4131-ccd09bbf\" command = \"adder-collator\" Then you can spwan 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 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│ Network launched 🚀🚀 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Namespace │ zombie-0c26e3512b222b8cd7053d4f632f0b62 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Provider │ native │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ alice │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:43185#/explorer │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44521/metrics │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ bob │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:45645#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:38901/metrics │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Parachain ID │ 100 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ ChainSpec Path │ /tmp/zombie-0c26e3512b222b8cd7053d4f632f0b62_-20554-cMuCmVc8OQ7f/rococo-local-100.json │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────-─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ collator01 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:37543#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44807/metrics │\n└─────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────┘ Both the prometheus and the node links are accesibles in your local machine to get the metrics or connect to the node.", + "body": "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]\ntimeout = 1000 [relaychain]\ndefault_image = \"paritypr/polkadot-debug:master\"\nchain = \"rococo-local\" [[relaychain.nodes]] name = \"alice\" [[relaychain.nodes]] name = \"bob\" [[parachains]]\nid = 100 [parachains.collator] name = \"collator01\" image = \"paritypr/colander:4131-ccd09bbf\" command = \"adder-collator\" Then you can spwan 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 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│ Network launched 🚀🚀 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Namespace │ zombie-0c26e3512b222b8cd7053d4f632f0b62 │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Provider │ native │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ alice │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:43185#/explorer │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44521/metrics │\n├─────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ bob │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:45645#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:38901/metrics │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Parachain ID │ 100 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ ChainSpec Path │ /tmp/zombie-0c26e3512b222b8cd7053d4f632f0b62_-20554-cMuCmVc8OQ7f/rococo-local-100.json │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Node Information │\n├─────────────────────────-─────────────────────────────────────────────────────────────────────────────────────┤\n│ Name │ collator01 │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Direct Link │ https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:37543#/explorer │\n├─────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────┤\n│ Prometheus Link │ http://127.0.0.1:44807/metrics │\n└─────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────┘ Both the prometheus and the node links are accesibles in your local machine to get the metrics or connect to the node.", "breadcrumbs": "Cli usage » Spawning » Spawning", "id": "13", "title": "Spawning" @@ -135,7 +135,7 @@ "title": "Teardown" }, "16": { - "body": "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: Both nodes are running The definded parachain is registered The defined parachain is producing blocks and produced at least 10 within 200 seconds. Description: Simple Network Smoke Test\nNetwork: ./0001-small-network.toml\nCreds: config alice: is up\nbob: is up\nalice: parachain 100 is registered within 225 seconds\nalice: parachain 100 block height is at least 10 within 200 seconds Another examples are provided in the examples directory.", + "body": "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 previous simple network definition) and assert that: Both nodes are running The definded parachain is registered The defined parachain is producing blocks and produced at least 10 within 200 seconds. Description: Simple Network Smoke Test\nNetwork: ./0001-small-network.toml\nCreds: config alice: is up\nbob: is up\nalice: parachain 100 is registered within 225 seconds\nalice: parachain 100 block height is at least 10 within 200 seconds Another examples are provided in the examples directory.", "breadcrumbs": "Cli usage » Testing » Testing", "id": "16", "title": "Testing" diff --git a/docs/src/cli/test-dsl-definition-spec.md b/docs/src/cli/test-dsl-definition-spec.md index f6d19aa60..07a8cb92a 100644 --- a/docs/src/cli/test-dsl-definition-spec.md +++ b/docs/src/cli/test-dsl-definition-spec.md @@ -29,7 +29,7 @@ The first lines are used to define the **header fields**: - Network: .......... Path to the network definition file, supported both `json` and `toml` formats. - Creds: ............ Credentials file name or `path` to use (**Only** with `kubernetes` provider), we look in the current directory or in `$HOME/.kube/` if a filename is passed. -**Then** each line define a test `assertion` or a `commnad`. +**Then** each line define a test `assertion` or a `command`. ### Available Assertions diff --git a/scripts/ci/run-test-env-manager.sh b/scripts/ci/run-test-env-manager.sh index 72bf8c693..67c875ac5 100755 --- a/scripts/ci/run-test-env-manager.sh +++ b/scripts/ci/run-test-env-manager.sh @@ -25,7 +25,7 @@ OPTION https://github.com/paritytech/polkadot/tree/master/simnet_tests -h, --help OPTIONAL Print this help message -o, --output-dir OPTIONAL - Path to dir where to save contens of --github-remote-dir + Path to dir where to save contents of --github-remote-dir Defaults to ${SCRIPT_PATH} specified, it will be ifered from there. diff --git a/scripts/ci/run-test-local-env-manager.sh b/scripts/ci/run-test-local-env-manager.sh index 28400cdac..1d32cca09 100755 --- a/scripts/ci/run-test-local-env-manager.sh +++ b/scripts/ci/run-test-local-env-manager.sh @@ -24,7 +24,7 @@ OPTION -c, --concurrency OPTIONAL concurrency for spawn nodes -h, --help OPTIONAL Print this help message -o, --output-dir OPTIONAL - Path to dir where to save contens of --local-dir + Path to dir where to save contents of --local-dir Defaults to ${SCRIPT_PATH} specified, it will be ifered from there.