Add zepter toml linter to CI (#368)

moondance-labs · Dec 18, 2023 · 19a111b · 19a111b
1 parent b2cf2d1
commit 19a111b
Show file tree

Hide file tree

Showing 28 changed files with 504 additions and 26 deletions.
diff --git a/.cargo/zepter.yaml b/.cargo/zepter.yaml
@@ -0,0 +1,43 @@
+# This file should be kept updated with the upstream config file:
+# https://github.com/paritytech/polkadot-sdk/blob/master/.config/zepter.yaml
+
+version:
+  format: 1
+  # Minimum version of the binary that is expected to work. This is just for printing a nice error
+  # message when someone tries to use an older version.
+  binary: 0.13.2
+
+# The examples in this file assume crate `A` to have a dependency on crate `B`.
+workflows:
+  check:
+    - [
+        'lint',
+        # Check that `A` activates the features of `B`.
+        'propagate-feature',
+        # These are the features to check:
+        '--features=try-runtime,runtime-benchmarks,std',
+        # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
+        '--left-side-feature-missing=ignore',
+        # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
+        '--left-side-outside-workspace=ignore',
+        # Some features imply that they activate a specific dependency as non-optional. Otherwise the default behaviour with a `?` is used.
+        '--feature-enables-dep=try-runtime:frame-try-runtime,runtime-benchmarks:frame-benchmarking',
+        # Auxillary flags:
+        '--offline',
+        '--locked',
+        '--show-path',
+        '--quiet',
+      ]
+  # Same as `check`, but with the `--fix` flag.
+  default:
+    - [ $check.0, '--fix' ]
+
+# Will be displayed when any workflow fails:
+help:
+  text: |
+    Polkadot-SDK uses the Zepter CLI to detect abnormalities in the feature configuration.
+    It looks like one more more checks failed; please check the console output. You can try to automatically address them by running `zepter`.
+    Otherwise please ask directly in the Merge Request, GitHub Discussions or on Matrix Chat, thank you.
+  links:
+    - "https://github.com/paritytech/polkadot-sdk/issues/1831"
+    - "https://github.com/ggwpez/zepter"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -117,6 +117,24 @@ jobs:
             - name: Clippy
               run: SKIP_WASM_BUILD=1 env -u RUSTFLAGS cargo clippy --all-targets --locked --workspace --features runtime-benchmarks
 
+    cargo-toml-feature-propagation:
+        runs-on: ubuntu-latest
+        needs: ["set-tags"]
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ needs.set-tags.outputs.git_ref }}
+
+            - name: Setup Rust toolchain
+              run: rustup show
+
+            - name: Install zepter
+              run: cargo install --locked -f zepter
+
+            - name: Run zepter
+              run: zepter run check
+
     typescript-formatting:
         runs-on: ubuntu-latest
         needs: ["set-tags"]

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/container-chains/templates/frontier/node/Cargo.toml b/container-chains/templates/frontier/node/Cargo.toml
@@ -109,8 +109,24 @@ substrate-build-script-utils = { workspace = true }
 
 [features]
 default = []
-runtime-benchmarks = [ "container-chain-template-frontier-runtime/runtime-benchmarks", "pallet-ethereum/runtime-benchmarks", "polkadot-cli/runtime-benchmarks" ]
+runtime-benchmarks = [
+	"container-chain-template-frontier-runtime/runtime-benchmarks",
+	"pallet-ethereum/runtime-benchmarks",
+	"polkadot-cli/runtime-benchmarks",
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-benchmarking-cli/runtime-benchmarks",
+	"nimbus-primitives/runtime-benchmarks",
+	"polkadot-primitives/runtime-benchmarks",
+	"polkadot-service/runtime-benchmarks",
+	"sc-service/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks"
+]
 try-runtime = [
 	"container-chain-template-frontier-runtime/try-runtime",
 	"try-runtime-cli/try-runtime",
+	"nimbus-primitives/try-runtime",
+	"pallet-ethereum/try-runtime",
+	"polkadot-cli/try-runtime",
+	"polkadot-service/try-runtime",
+	"sp-runtime/try-runtime"
  ]
diff --git a/container-chains/templates/frontier/runtime/Cargo.toml b/container-chains/templates/frontier/runtime/Cargo.toml
@@ -170,6 +170,16 @@ std = [
 	"staging-xcm/std",
 	"tp-consensus/std",
 	"xcm-primitives/std",
+	"cumulus-pallet-session-benchmarking/std",
+	"nimbus-primitives/std",
+	"num_enum/std",
+	"pallet-author-inherent/std",
+	"pallet-root-testing/std",
+	"pallet-transaction-payment/std",
+	"serde?/std",
+	"sp-debug-derive/std",
+	"sp-session/std",
+	"sp-trie/std"
 ]
 
 # Allow to print logs details (no wasm:stripped)
@@ -186,6 +196,24 @@ runtime-benchmarks = [
 	"pallet-xcm/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
 	"staging-xcm-builder/runtime-benchmarks",
+	"cumulus-pallet-parachain-system/runtime-benchmarks",
+	"cumulus-pallet-xcmp-queue/runtime-benchmarks",
+	"cumulus-primitives-utility/runtime-benchmarks",
+	"nimbus-primitives/runtime-benchmarks",
+	"pallet-author-inherent/runtime-benchmarks",
+	"pallet-cc-authorities-noting/runtime-benchmarks",
+	"pallet-evm/runtime-benchmarks",
+	"pallet-evm-precompile-xcm-utils/runtime-benchmarks",
+	"pallet-hotfix-sufficients/runtime-benchmarks",
+	"pallet-migrations/runtime-benchmarks",
+	"pallet-proxy/runtime-benchmarks",
+	"pallet-sudo/runtime-benchmarks",
+	"pallet-tx-pause/runtime-benchmarks",
+	"pallet-utility/runtime-benchmarks",
+	"polkadot-parachain-primitives/runtime-benchmarks",
+	"polkadot-runtime-common/runtime-benchmarks",
+	"staging-xcm-executor/runtime-benchmarks",
+	"xcm-primitives/runtime-benchmarks"
 ]
 
 try-runtime = [
@@ -215,4 +243,10 @@ try-runtime = [
 	"parachain-info/try-runtime",
 	"polkadot-runtime-common/try-runtime",
 	"sp-runtime/try-runtime",
+	"cumulus-pallet-dmp-queue/try-runtime",
+	"cumulus-pallet-xcm/try-runtime",
+	"cumulus-pallet-xcmp-queue/try-runtime",
+	"pallet-author-inherent/try-runtime",
+	"pallet-root-testing/try-runtime",
+	"pallet-xcm/try-runtime"
 ]
diff --git a/container-chains/templates/simple/node/Cargo.toml b/container-chains/templates/simple/node/Cargo.toml
@@ -88,8 +88,22 @@ substrate-build-script-utils = { workspace = true }
 
 [features]
 default = []
-runtime-benchmarks = [ "container-chain-template-simple-runtime/runtime-benchmarks", "polkadot-cli/runtime-benchmarks" ]
+runtime-benchmarks = [
+	"container-chain-template-simple-runtime/runtime-benchmarks",
+	"polkadot-cli/runtime-benchmarks",
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-benchmarking-cli/runtime-benchmarks",
+	"nimbus-primitives/runtime-benchmarks",
+	"polkadot-primitives/runtime-benchmarks",
+	"polkadot-service/runtime-benchmarks",
+	"sc-service/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks"
+]
 try-runtime = [
 	"container-chain-template-simple-runtime/try-runtime",
 	"try-runtime-cli/try-runtime",
+	"nimbus-primitives/try-runtime",
+	"polkadot-cli/try-runtime",
+	"polkadot-service/try-runtime",
+	"sp-runtime/try-runtime"
  ]
diff --git a/container-chains/templates/simple/runtime/Cargo.toml b/container-chains/templates/simple/runtime/Cargo.toml
@@ -135,6 +135,15 @@ std = [
 	"staging-xcm/std",
 	"tp-consensus/std",
 	"xcm-primitives/std",
+	"cumulus-pallet-session-benchmarking/std",
+	"frame-benchmarking?/std",
+	"frame-system-benchmarking?/std",
+	"pallet-root-testing/std",
+	"pallet-transaction-payment/std",
+	"serde?/std",
+	"sp-debug-derive/std",
+	"sp-session/std",
+	"sp-trie/std"
 ]
 
 # Allow to print logs details (no wasm:stripped)
@@ -153,6 +162,21 @@ runtime-benchmarks = [
 	"pallet-xcm/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
 	"staging-xcm-builder/runtime-benchmarks",
+	"cumulus-pallet-parachain-system/runtime-benchmarks",
+	"cumulus-pallet-xcmp-queue/runtime-benchmarks",
+	"cumulus-primitives-utility/runtime-benchmarks",
+	"frame-benchmarking/runtime-benchmarks",
+	"nimbus-primitives/runtime-benchmarks",
+	"pallet-author-inherent/runtime-benchmarks",
+	"pallet-migrations/runtime-benchmarks",
+	"pallet-proxy/runtime-benchmarks",
+	"pallet-sudo/runtime-benchmarks",
+	"pallet-tx-pause/runtime-benchmarks",
+	"pallet-utility/runtime-benchmarks",
+	"polkadot-parachain-primitives/runtime-benchmarks",
+	"polkadot-runtime-common/runtime-benchmarks",
+	"staging-xcm-executor/runtime-benchmarks",
+	"xcm-primitives/runtime-benchmarks"
 ]
 
 try-runtime = [
@@ -174,4 +198,13 @@ try-runtime = [
 	"parachain-info/try-runtime",
 	"polkadot-runtime-common/try-runtime",
 	"sp-runtime/try-runtime",
+	"cumulus-pallet-dmp-queue/try-runtime",
+	"cumulus-pallet-xcm/try-runtime",
+	"cumulus-pallet-xcmp-queue/try-runtime",
+	"frame-try-runtime/try-runtime",
+	"pallet-author-inherent/try-runtime",
+	"pallet-migrations/try-runtime",
+	"pallet-root-testing/try-runtime",
+	"pallet-transaction-payment/try-runtime",
+	"pallet-xcm/try-runtime"
 ]
diff --git a/node/Cargo.toml b/node/Cargo.toml
@@ -103,7 +103,18 @@ substrate-build-script-utils = { workspace = true }
 
 [features]
 default = []
-runtime-benchmarks = [ "dancebox-runtime/runtime-benchmarks", "polkadot-cli/runtime-benchmarks", "polkadot-service/runtime-benchmarks" ]
+runtime-benchmarks = [
+	"dancebox-runtime/runtime-benchmarks",
+	"polkadot-cli/runtime-benchmarks",
+	"polkadot-service/runtime-benchmarks",
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-benchmarking-cli/runtime-benchmarks",
+	"nimbus-primitives/runtime-benchmarks",
+	"pallet-configuration/runtime-benchmarks",
+	"polkadot-primitives/runtime-benchmarks",
+	"sc-service/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks"
+]
 try-runtime = [ "dancebox-runtime/try-runtime", "nimbus-primitives/try-runtime", "pallet-configuration/try-runtime", "polkadot-cli/try-runtime", "polkadot-service/try-runtime", "sp-runtime/try-runtime", "try-runtime-cli/try-runtime" ]
 
 fast-runtime = [ "dancebox-runtime/fast-runtime" ]
diff --git a/pallets/author-noting/Cargo.toml b/pallets/author-noting/Cargo.toml
@@ -63,11 +63,36 @@ std = [
 	"sp-trie/std",
 	"tp-author-noting-inherent/std",
 	"tp-traits/std",
+	"bounded-collections/std",
+	"hex?/std",
+	"log/std",
+	"polkadot-parachain-primitives/std",
+	"polkadot-primitives/std",
+	"serde?/std",
+	"sp-core/std",
+	"sp-externalities/std",
+	"sp-inherents/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std",
+	"sp-version/std",
+	"test-relay-sproof-builder/std"
 ]
 runtime-benchmarks = [
 	"cumulus-pallet-parachain-system/runtime-benchmarks",
 	"frame-benchmarking",
 	"hex",
 	"tp-traits/runtime-benchmarks",
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"polkadot-parachain-primitives/runtime-benchmarks",
+	"polkadot-primitives/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"cumulus-pallet-parachain-system/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-try-runtime = [ "frame-support/try-runtime" ]
diff --git a/pallets/authority-assignment/Cargo.toml b/pallets/authority-assignment/Cargo.toml
@@ -34,5 +34,15 @@ std = [
 	"scale-info/std",
 	"serde",
 	"tp-traits/std",
+	"log/std",
+	"serde?/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-try-runtime = [ "frame-support/try-runtime" ]
diff --git a/pallets/authority-mapping/Cargo.toml b/pallets/authority-mapping/Cargo.toml
@@ -27,5 +27,13 @@ std = [
 	"frame-system/std",
 	"parity-scale-codec/std",
 	"scale-info/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-try-runtime = [ "frame-support/try-runtime" ]
diff --git a/pallets/collator-assignment/Cargo.toml b/pallets/collator-assignment/Cargo.toml
@@ -40,11 +40,22 @@ std = [
 	"sp-runtime/std",
 	"sp-std/std",
 	"tp-traits/std",
+	"log/std",
+	"rand/std",
+	"rand_chacha/std",
+	"serde?/std",
+	"sp-core/std",
+	"sp-io/std"
 ]
 runtime-benchmarks = [
 	"frame-benchmarking/runtime-benchmarks",
 	"frame-support/runtime-benchmarks",
 	"frame-system/runtime-benchmarks",
 	"tp-traits/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-try-runtime = [ "frame-support/try-runtime" ]
diff --git a/pallets/collator-assignment/rpc/runtime-api/Cargo.toml b/pallets/collator-assignment/rpc/runtime-api/Cargo.toml
@@ -18,4 +18,5 @@ default = [ "std" ]
 std = [
 	"parity-scale-codec/std",
 	"sp-api/std",
+	"scale-info/std"
 ]
diff --git a/pallets/configuration/Cargo.toml b/pallets/configuration/Cargo.toml
@@ -34,6 +34,22 @@ std = [
 	"scale-info/std",
 	"serde/std",
 	"tp-traits/std",
+	"log/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std"
+]
+runtime-benchmarks = [
+	"frame-benchmarking",
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+	"tp-traits/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-runtime-benchmarks = [ "frame-benchmarking" ]
-try-runtime = [ "frame-support/try-runtime" ]