Documentation

.config/lingua.dic

@@ -0,0 +1,50 @@
+90
+
+=
+CLI
+Deserialization
+Deserialized
+IFF
+IPv4
+JSON
+NetworkNode
+Ok
+P2P
+PjsResult
+PoS
+RPC
+RUN_IN_CI
+SDK
+WASM
+arg
+args
+chain_spec_command
+cmd
+declaratively
+deserialize
+deserialized
+dir
+env
+fs
+invulnerables
+ip
+js
+k8s
+msg
+multiaddress
+natively
+ns
+p2p
+parachaing
+pjs_rs
+polkadot
+polkadot_
+rococo_local_testnet
+rpc
+serde_json
+tgz
+tmp
+u128
+u64
+validator
+ws

.config/spellcheck.toml

@@ -0,0 +1,13 @@
+[hunspell]
+lang = "en_US"
+search_dirs = ["."]
+extra_dictionaries = ["lingua.dic"]
+skip_os_lookups = true
+use_builtin = true
+
+[hunspell.quirks]
+# `Type`'s
+# 5x
+transform_regex = ["^'([^\\s])'$", "^[0-9]+(?:\\.[0-9]*)?x$", "^'s$", "^\\+$", "[><+-]"]
+allow_concatenation = true
+allow_dashes = true

.dockerignore

@@ -0,0 +1,5 @@
+target
+Dockerfile
+.dockerignore
+.git
+.gitignore

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+@pepoviola
+@l0r1s

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,124 @@
+name: Bug Report
+description: File a bug report
+labels: ["triage-needed"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        **NOTE** A number of issues reported against Zombienet are often found to already be fixed in more current versions of the project.
+        Before reporting an issue, please verify the version you are running with `zombienet version` and compare it to the latest release. 
+        If they differ, please update your version of Zombienet to the latest possible and retry your command before creating an issue.
+
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Issue Description
+      description: Please explain your issue
+      value: "Describe your issue"
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproducer
+    attributes:
+      label: Steps to reproduce the issue
+      description: Please explain the steps to reproduce the issue, including configuration files needed.
+      value: "Steps to reproduce the issue\n1.\n2.\n3.\n"
+    validations:
+      required: true
+
+  - type: textarea
+    id: received_results
+    attributes:
+      label: Describe the results you received
+      description: Please explain the results you are noticing, including stacktrace and error logs.
+      value: "Describe the results you received"
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected_results
+    attributes:
+      label: Describe the results you expected
+      description: Please explain the results you are expecting
+      value: "Describe the results you expected"
+    validations:
+      required: true
+
+  - type: input
+    id: zombienet_version 
+    attributes:
+      label: Zombienet version
+      description: Which zombienet version are you using ?
+    validations:
+      required: true
+
+  - type: dropdown
+    id: provider
+    attributes:
+      label: Provider
+      description: Which provider are you using ?
+      options:
+        - Native
+        - Kubernetes
+        - Podman
+    validations:
+      required: true
+
+  - type: textarea
+    id: provider_version
+    attributes:
+      label: Provider version
+      description: Which provider version / binaries versions are you using ?
+      value: |
+        ## For binaries
+        polkadot 0.9.40-a2b62fb872b
+        polkadot-parachain 0.9.380-fe24f39507f 
+
+        ## For Kubernetes/Podman
+        podman version 4.4.1
+        
+        OR
+        
+        kubectl version v0.26.3
+        cluster version 1.25.2
+      render: yaml
+    validations:
+      required: true
+
+  - type: dropdown
+    id: upstream_latest
+    attributes:
+      label: Upstream Latest Release
+      description: Have you tried running the [latest upstream release](https://github.com/paritytech/zombienet/releases/latest)
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional_environment
+    attributes:
+      label: Additional environment details
+      description: Please describe any additional environment details like (Cloud, Local, OS, Provider versions...)
+      value: "Additional environment details"
+
+  - type: textarea
+    id: additional_info
+    attributes:
+      label: Additional information
+      description: Please explain the additional information you deem important
+      value: "Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting"
+    validations:
+      required: false
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Provide us with screenshots if needed to have a better understanding of the issue
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_report.yaml

@@ -0,0 +1,43 @@
+name: Feature request
+description: File a feature request
+labels: ["triage-needed"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature report!
+        Please make sure to describe your feature and the problem it would solve.
+
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+      value: "Describe the feature"
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen..
+    validations:
+      required: true
+
+  - type: textarea
+    id: alt_solution
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: Cargo Build & Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  build:
+    name: Zombienet SDK - latest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toolchain:
+          - stable
+          # TODO 24-02-08: Disable nightly due to tkaitchuck/aHash#200.
+          #- nightly
+    steps:
+      # https://github.com/jlumbroso/free-disk-space
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@main
+        with:
+          tool-cache: false
+
+      - uses: actions/checkout@v3
+
+      - name: Init nigthly install for fmt
+        run: rustup update nightly && rustup default nightly && rustup component add rustfmt
+
+      - name: Check format
+        run: cargo +nightly fmt --check --all
+
+      - name: Init install
+        run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} && rustup component add clippy
+
+      - name: Fetch cache
+        uses: Swatinem/rust-cache@a95ba195448af2da9b00fb742d14ffaaf3c21f43 # v2.7.0
+        with:
+          shared-key: "zombie-cache"
+
+      - name: Clippy
+        run: cargo clippy --all-targets --all-features
+
+      - name: Build
+        run: cargo build
+
+      - name: Tests
+        run: cargo test --workspace -- --skip ci_k8s
+
+  coverage:
+    name: Zombienet SDK - coverage
+    needs: build
+    runs-on: ubuntu-20.04
+    if: github.event_name == 'pull_request'
+
+    permissions:
+       issues: write
+       pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # https://github.com/jlumbroso/free-disk-space
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@main
+        with:
+          tool-cache: false
+
+      - name: Fetch cache
+        uses: Swatinem/rust-cache@a95ba195448af2da9b00fb742d14ffaaf3c21f43 # v2.7.0
+        with:
+          shared-key: "zombie-cache"
+
+      - name: Install latest nextest release
+        uses: taiki-e/install-action@nextest
+
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: Collect coverage data
+        run: cargo llvm-cov nextest --workspace --exclude zombienet-sdk --test-threads 1 --lcov --output-path lcov.info
+
+      - name: Report code coverage
+        uses: Nef10/[email protected]
+        with:
+          lcov-file: lcov.info
+          pr-number: ${{ github.event.pull_request.number }}

.github/workflows/documentation.yml

@@ -0,0 +1,59 @@
+name: Cargo Create Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  build-rust-doc:
+    name: Zombienet SDK - Rust Docs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toolchain:
+          # TODO 24-02-08: Disable nightly due to tkaitchuck/aHash#200.
+          #- nightly
+          - stable
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Init nigthly install for fmt
+        run: rustup update nightly && rustup default nightly && rustup component add rustfmt
+
+      - name: Check format
+        run: cargo +nightly fmt --check --all
+
+      - name: Init install
+        run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} && rustup component add clippy
+
+      - name: Create docs
+        run: |
+          cargo doc --no-deps
+          echo "<meta http-equiv=\"refresh\" content=\"0; url=zombienet_sdk\">" > target/doc/index.html
+
+
+
+      - name: Move docs
+        run: |
+          mkdir -p ./doc
+          mv ./target/doc/* ./doc
+          git config user.email "[email protected]"
+          git config user.name "GitHub Action"
+          git config user.password "${{ secrets.GH_PAGES_TOKEN }}"
+          git checkout --orphan gh-pages
+          mkdir to_delete
+          shopt -s extglob
+          mv !(to_delete) ./to_delete
+          mv ./to_delete/doc/* .
+          rm -rf ./to_delete
+          git add --all
+          git commit -m "Documentation"
+        shell: bash       # Necessary for `shopt` to work
+      - run: git push -f origin gh-pages:gh-pages
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}