malus: add the nemesis use cases

.gitlab-ci.yml

@@ -28,6 +28,7 @@ variables:
   CI_SERVER_NAME:                  "GitLab CI"
   DOCKER_OS:                       "debian:stretch"
   ARCH:                            "x86_64"
+  SIMNET_IMAGE:                    "europe-west3-docker.pkg.dev/parity-simnet/simnet-images/simnet:v14"
   VAULT_SERVER_URL:                "https://vault.parity-mgmt-vault.parity.io"
   VAULT_AUTH_PATH:                 "gitlab-parity-io-jwt"
   VAULT_AUTH_ROLE:                 "cicd_gitlab_parity_${CI_PROJECT_NAME}"
@@ -198,7 +199,8 @@ test-build-linux-stable:
   script:
     - ./scripts/gitlab/test_linux_stable.sh
     # we're using the bin built here, instead of having a parallel `build-linux-release`
-    - time cargo build --release --verbose --bin polkadot
+    # disputes feature is needed for simnet parachains malus test
+    - time cargo build --release --verbose --bin polkadot --features disputes
     - sccache -s
     # pack artifacts
     - mkdir -p ./artifacts
@@ -269,6 +271,26 @@ build-adder-collator:
     - echo "adder-collator version = $(cat ./artifacts/VERSION) (EXTRATAG = $(cat ./artifacts/EXTRATAG))"
     - cp -r scripts/* ./artifacts
 
+build-malus:
+  stage:                           test
+  <<:                              *collect-artifacts
+  <<:                              *docker-env
+  <<:                              *compiler-info
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_COMMIT_REF_NAME == "master"
+    - if: $CI_COMMIT_REF_NAME =~ /^[0-9]+$/                         # PRs
+  script:
+    - time cargo build --release --verbose -p polkadot-test-malus --features disputes
+    - sccache -s
+    # pack artifacts
+    - mkdir -p ./artifacts
+    - mv ./target/release/malus ./artifacts/.
+    - echo -n "${CI_COMMIT_REF_NAME}" > ./artifacts/VERSION
+    - echo -n "${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}" > ./artifacts/EXTRATAG
+    - echo "polkadot-test-malus = $(cat ./artifacts/VERSION) (EXTRATAG = $(cat ./artifacts/EXTRATAG))"
+    - cp -r scripts/* ./artifacts
+
 #### stage:                        build
 
 .check-dependent-project:          &check-dependent-project
@@ -439,6 +461,32 @@ publish-adder-collator-image:
       # this artifact is used in simnet-tests job
       dotenv: ./artifacts/collator.env
 
+publish-malus-image:
+  # service image for Simnet
+  stage:                           build
+  <<:                              *build-push-image
+  variables:
+    <<:                            *image-variables
+    # scripts/dockerfiles/malus.Dockerfile
+    DOCKERFILE:                    dockerfiles/malus.Dockerfile
+    IMAGE_NAME:                    docker.io/paritypr/malus
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_COMMIT_REF_NAME == "master"
+    - if: $CI_COMMIT_REF_NAME =~ /^[0-9]+$/                         # PRs
+  needs:
+    - job:                         build-malus
+      artifacts:                   true
+  after_script:
+    - buildah logout "$IMAGE_NAME"
+    # pass artifacts to the simnet-tests job
+    - echo "MALUS_IMAGE_NAME=${IMAGE_NAME}" > ./artifacts/malus.env
+    - echo "MALUS_IMAGE_TAG=$(cat ./artifacts/EXTRATAG)" >> ./artifacts/malus.env
+  artifacts:
+    reports:
+      # this artifact is used in simnet-tests job
+      dotenv: ./artifacts/malus.env
+
 .update_weights:                   &update-weights
   stage:                           build
   when:                            manual
@@ -566,9 +614,8 @@ deploy-polkasync-kusama:
   allow_failure:                   true
   trigger:                         "parity/infrastructure/parity-testnet"
 
-simnet-tests:
+simnet-tests-parachains-smoketest:
   stage:                           deploy
-  image:                           "docker.io/paritytech/simnet:${SIMNET_REF}"
   <<:                              *kubernetes-env
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule"
@@ -578,25 +625,78 @@ simnet-tests:
   needs:
     - job:                         publish-polkadot-image
     - job:                         publish-adder-collator-image
+
+  image:                           "${SIMNET_IMAGE}"
+  variables:
+    GH_DIR:                        'https://github.com/paritytech/polkadot/tree/bernhard-malus-fx/simnet_tests'
+    # FIXME: use the master after the merge of the malus pr
+    # GH_DIR:                        'https://github.com/paritytech/polkadot/tree/master/simnet_tests'
+    NETWORK_CONFIG:                'simnet_tests/configs/simple_rococo_testnet.toml'
   # `parachains.env` brings here `$PARACHAINS_IMAGE_NAME` and `$PARACHAINS_IMAGE_TAG`
   # (`$EXTRATAG` here, # i.e. `2643-0.8.29-5f689e0a-6b24dc54`).
   # `collator.env` brings here `$COLLATOR_IMAGE_NAME` and  `$COLLATOR_IMAGE_TAG`
   # For local tests with docker `$PARACHAINS_IMAGE_TAG` and `$COLLATOR_IMAGE_TAG`
   # can be replaced with `master` tag.
-
-  # SIMNET_REF is a gitlab variable
   before_script:
-    - echo "Simnet Tests Config
-        ${SIMNET_IMAGE_NAME} ${SIMNET_REF}
-        ${PARACHAINS_IMAGE_NAME} ${PARACHAINS_IMAGE_TAG}
-        ${COLLATOR_IMAGE_NAME} ${COLLATOR_IMAGE_TAG}"
+    - echo "Simnet Tests Config"
+    - echo "${SIMNET_IMAGE_NAME}"
+    - echo "${SIMNET_IMAGE_TAG}"
+    - echo "${PARACHAINS_IMAGE_NAME}"
+    - echo "${PARACHAINS_IMAGE_TAG}"
+    - echo "${GH_DIR}"
+    - echo "${NETWORK_CONFIG}"
   script:
-    - /home/nonroot/simnet/gurke/scripts/run-test-environment-manager.sh
-        --github-remote-dir="https://github.com/paritytech/polkadot/tree/master/simnet_tests"
-        --config="simnet_tests/configs/simple_rococo_testnet.toml"
+    - /home/nonroot/simnet/scripts/run-test-environment-manager.sh
+        --github-remote-dir="${GH_DIR}"
+        --config="${NETWORK_CONFIG}"
         --image="${PARACHAINS_IMAGE_NAME}:${PARACHAINS_IMAGE_TAG}"
-        --image-2="${COLLATOR_IMAGE_NAME}:${COLLATOR_IMAGE_TAG}"
-        --image-simnet="docker.io/paritytech/simnet:${SIMNET_REF}"
+        -e "SYNTHIMAGE=${PARACHAINS_IMAGE_NAME}:${PARACHAINS_IMAGE_TAG}"
+        -e "COLIMAGE=${COLLATOR_IMAGE_NAME}:${COLLATOR_IMAGE_TAG}"
+        -e "SCRIPTSIMAGE=${SIMNET_IMAGE_NAME}:${SIMNET_IMAGE_TAG}"
+  allow_failure:                   true
+  retry: 2
+  tags:
+    - parity-simnet
+
+simnet-tests-malus-dispute-valid:
+  stage:                           deploy
+  image:                           "${SIMNET_IMAGE}"
+  <<:                              *kubernetes-env
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_COMMIT_REF_NAME == "master"
+    - if: $CI_COMMIT_REF_NAME =~ /^[0-9]+$/                         # PRs
+    - if: $CI_COMMIT_REF_NAME == "rococo-v1"
+  needs:
+    - job:                         publish-polkadot-image
+    - job:                         publish-malus-image
+    - job:                         publish-adder-collator-image
+
+  variables:
+    GH_DIR:                        'https://github.com/paritytech/polkadot/tree/bernhard-malus-fx/simnet_tests'
+    # FIXME: use the master after the merge of the malus pr
+    # GH_DIR:                        'https://github.com/paritytech/polkadot/tree/master/simnet_tests'
+    # FIXME: copy config of tests in simnet_test and use proper values
+  # `malus.env` brings here `$MALUS_IMAGE_NAME` and `$MALUS_IMAGE_TAG`
+  # (`$EXTRATAG` here, # i.e. `2643-0.8.29-5f689e0a-6b24dc54`).
+  # For local tests with docker `$MALUS_IMAGE_TAG` can be replaced with `master` tag.
+
+  before_script:
+    - echo "Simnet Tests Config"
+    - echo "${SIMNET_IMAGE_NAME}"
+    - echo "${PARACHAINS_IMAGE_NAME} ${PARACHAINS_IMAGE_TAG}"
+    - echo "${MALUS_IMAGE_NAME} ${MALUS_IMAGE_TAG}"
+    - echo "${GH_DIR}"
+
+  script:
+    - /home/nonroot/simnet/scripts/run-test-environment-manager-v2.sh
+        --github-remote-dir="${GH_DIR}"
+        --tag=malus
+        --image="PARACHAINSIMAGE=${PARACHAINS_IMAGE_NAME}:${PARACHAINS_IMAGE_TAG}"
+        --image="SYNTHIMAGE=${PARACHAINS_IMAGE_NAME}:${PARACHAINS_IMAGE_TAG}"
+        --image="COLIMAGE=${COLLATOR_IMAGE_NAME}:${COLLATOR_IMAGE_TAG}"
+        --image="SCRIPTSIMAGE=${SIMNET_IMAGE}"
+        --image="MALUSIMAGE=${MALUS_IMAGE_NAME}:${MALUS_IMAGE_TAG}"
   allow_failure:                   true
   retry: 2
   tags:

cli/src/command.rs

@@ -219,8 +219,8 @@ fn ensure_dev(spec: &Box<dyn service::ChainSpec>) -> std::result::Result<(), Str
 /// accepts an alternative overseer generator, to adjust behavior
 /// for integration tests as needed.
 #[cfg(feature = "malus")]
-pub fn run_node(cli: Cli, overseer_gen: impl service::OverseerGen) -> Result<()> {
-	run_node_inner(cli, overseer_gen)
+pub fn run_node(run: Cli, overseer_gen: impl service::OverseerGen) -> Result<()> {
+	run_node_inner(run, overseer_gen)
 }
 
 fn run_node_inner(cli: Cli, overseer_gen: impl service::OverseerGen) -> Result<()> {

node/malus/Cargo.toml

@@ -1,11 +1,3 @@
-[lib]
-name = "malus"
-path = "src/lib.rs"
-
-[[bin]]
-name = "malus-variant-a"
-path = "src/variant-a.rs"
-
 [package]
 name = "polkadot-test-malus"
 description = "Misbehaving nodes for local testnets, system and Simnet tests."
@@ -16,17 +8,34 @@ edition = "2018"
 readme = "README.md"
 publish = false
 
+[[bin]]
+name = "malus"
+path = "src/malus.rs"
+
 [dependencies]
 polkadot-cli = { path = "../../cli", default-features = false, features = [ "cli", "malus" ]  }
 polkadot-node-subsystem = { path = "../subsystem" }
 polkadot-node-subsystem-util = { path = "../subsystem-util" }
+polkadot-node-subsystem-types = { path = "../subsystem-types" }
+polkadot-node-core-dispute-coordinator = { path = "../core/dispute-coordinator" }
 polkadot-node-core-candidate-validation = { path = "../core/candidate-validation" }
+polkadot-node-core-backing = { path = "../core/backing" }
+polkadot-node-primitives = { path = "../primitives" }
+polkadot-primitives = { path = "../../primitives" }
 polkadot-node-core-pvf = { path = "../core/pvf" }
 parity-util-mem = { version = "0.10.0", default-features = false, features = ["jemalloc-global"] }
 color-eyre = { version = "0.5.11", default-features = false }
 assert_matches = "1.5"
 structopt = "0.3.23"
 async-trait = "0.1.51"
+sp-keystore = { git = "https://github.com/paritytech/substrate", branch = "master" }
+futures = "0.3.16"
+futures-timer = "3.0.2"
+tracing = "0.1.26"
+
+[features]
+default = [] # we do not enable disputes by default to avoid feature leak
+disputes = ["polkadot-cli/disputes"]
 
 [dev-dependencies]
 polkadot-node-subsystem-test-helpers = { path = "../subsystem-test-helpers" }

node/malus/README.md

@@ -1,3 +1,59 @@
 # malus
 
-Create nemesis nodes with alternate, at best fault, at worst intentionally destructive behavior traits.
+Create nemesis nodes with alternate, at best faulty, at worst intentionally destructive behavior traits.
+
+The first argument determines the behavior strain. The currently supported are:
+
+* `suggest-garbage-candidate`
+* `back-garbage-candidate`
+* `dispute-ancestor`
+
+## Integration test cases
+
+To define integration tests create file
+in the toml format as used with [gurke][gurke]
+under `./integrationtests` with either extension
+`.toml` or `.toml.tera` depending on if you use
+tera based templating.
+
+> For the time being non-templated variants should be preferred!
+## Usage
+
+> Assumes you already gained permissiones, followed the [GKE access guide][gke],
+> and you installed [gurke][gurke].
+
+To launch a test case in the development cluster use (e.g. for the  ./node/malus/integrationtests/0001-dispute-valid-block.toml):
+
+```sh
+# declare the containers pulled in by gurke test definitions
+export SYNTHIMAGE=paritypr/synth-wave:3639-0.9.9-7edc6602-ed5fb773
+export COLIMAGE=paritypr/colander:3639-7edc6602
+export MALUSIMAGE=paritypr/malus:3639-7edc6602
+export SCRIPTSIMAGE=paritytech/simnet:v9
+
+# login chore, once, with the values as provided in the above guide
+gcloud auth login
+gcloud config set project "parity-simnet"
+gcloud container clusters get-credentials "parity-simnet-devtest" --zone "europe-west3-b"
+
+# launching the actual test
+gurke run -c ./node/malus/integrationtests/0001-dispute-valid-block.toml -n parity-simnet-devtest ./node/malus/integrationtests/0001-dispute-valid-block.feature
+
+# Access individual logs
+kubectl -n parity-simnet-devtest logs mal
+```
+
+This will also teardown the cluster after completion.
+
+## Container Image Building Note
+
+In order to build the container image you need to have the latest changes from
+polkadot and substrate master branches.
+
+```sh
+pwd # run this from the current dir
+podman build -t paritypr/malus:v1 -f Containerfile ../../..
+```
+
+[gurke]: https://github.com/paritytech/gurke
+[gke]: (https://github.com/paritytech/gurke/blob/main/docs/How-to-setup-access-to-gke-k8s-cluster.md)