Metadata: Retain a subset of metadata pallets (#879)

* Update cargo.lock to use scale-info v2.4.0 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Retain only a subset of the metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * codegen: Generate top level Event Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Only retain DispatchError Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Export just the retain method Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * cli: Retain pallets Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Do not include extrinsic metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * retain: Fix clippy Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * test-runtime: Generate per pallet metadata and rs file Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * ui-tests: Check per metadata generated files Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Revert "test-runtime: Generate per pallet metadata and rs file" This reverts commit 725a2e5f8339a795892dbbd2df19e49330ae3a9b. Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * ui-tests: Adjust path to metadata file Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * ui-tests: Change drop order to keep `PalletMetadata` around Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Update metadata/src/retain.rs Co-authored-by: James Wilson <james@jsdw.me> * Address feedback Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * retain: Keep extrinsic type Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * cli: Introduce `MetadataSource` Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * cli: Use `MetadataSource` helper Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * cli: Use `FileOrUrl` flatten command argument Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * retain: Do not include generic type params in retained metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Adjust subxt to scale-info v2.5.0 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Update scaleinfo to v2.5.0 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Remove deprecated fn Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * testing: Fix clippy Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * benches: Use inner fields of scale info Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * address nits, and strip RuntimeCall type instead of trying to filter out use of it for better overall wins/clarity * fix UI test * move utils out of commands folder and fix clippy etc * address nits --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: James Wilson <james@jsdw.me>
2026-04-28 06:17:56 +00:00 · 2023-04-04 18:16:51 +03:00
parent c08eb6c8f1
commit 8a7c17289a
14 changed files with 464 additions and 72 deletions
@@ -4,6 +4,7 @@

 pub mod dispatch_error;
 mod metadata_test_runner;
+mod pallet_metadata_test_runner;

 use frame_metadata::{
    v14::RuntimeMetadataV14, ExtrinsicMetadata, PalletMetadata, PalletStorageMetadata,
@@ -12,6 +13,7 @@ use frame_metadata::{
 use scale_info::{meta_type, IntoPortable, TypeInfo};

 pub use metadata_test_runner::MetadataTestRunner;
+pub use pallet_metadata_test_runner::PalletMetadataTestRunner;

 /// Given some pallet metadata, generate a [`RuntimeMetadataPrefixed`] struct.
 /// We default to a useless extrinsic type, and register a fake `DispatchError`
@@ -0,0 +1,99 @@
+// Copyright 2019-2023 Parity Technologies (UK) Ltd.
+// This file is dual-licensed as Apache-2.0 or GPL-3.0.
+// see LICENSE for license details.
+
+use codec::{Decode, Encode};
+use frame_metadata::{RuntimeMetadataPrefixed, RuntimeMetadataV14};
+use std::io::Read;
+use subxt_metadata::retain_metadata_pallets;
+
+static TEST_DIR_PREFIX: &str = "subxt_generated_pallets_ui_tests_";
+static METADATA_FILE: &str = "../../artifacts/polkadot_metadata.scale";
+
+pub struct PalletMetadataTestRunner {
+    metadata: RuntimeMetadataV14,
+    index: usize,
+}
+
+impl PalletMetadataTestRunner {
+    pub fn new() -> PalletMetadataTestRunner {
+        let mut file =
+            std::fs::File::open(METADATA_FILE).expect("Cannot open metadata.scale artifact");
+
+        let mut bytes = Vec::new();
+        file.read_to_end(&mut bytes)
+            .expect("Failed to read metadata.scale file");
+
+        let meta: RuntimeMetadataPrefixed =
+            Decode::decode(&mut &*bytes).expect("Cannot decode metadata bytes");
+
+        let metadata = match meta.1 {
+            frame_metadata::RuntimeMetadata::V14(v14) => v14,
+            _ => panic!("Unsupported metadata version. Tests support only v14"),
+        };
+
+        PalletMetadataTestRunner { metadata, index: 0 }
+    }
+
+    pub fn path_to_next_ui_test(&mut self) -> Option<String> {
+        let Some(pallet) = self.metadata.pallets.get(self.index) else {
+            return None
+        };
+        let test_name = &pallet.name;
+
+        // Increment test index to avoid overlaps.
+        let index = self.index;
+        self.index += 1;
+
+        // Build custom metadata containing only this pallet.
+        let mut metadata = self.metadata.clone();
+        retain_metadata_pallets(&mut metadata, |pallet_filter| pallet_filter == pallet.name);
+
+        let mut tmp_dir = std::env::temp_dir();
+        tmp_dir.push(format!("{TEST_DIR_PREFIX}{index}"));
+
+        let tmp_metadata_path = {
+            let mut t = tmp_dir.clone();
+            t.push("metadata.scale");
+            t.to_string_lossy().into_owned()
+        };
+        let tmp_rust_path = {
+            let mut t = tmp_dir.clone();
+            t.push(format!("{test_name}.rs"));
+            t.to_string_lossy().into_owned()
+        };
+
+        let metadata_prefixed: RuntimeMetadataPrefixed = metadata.into();
+        let encoded_metadata = metadata_prefixed.encode();
+        let rust_file = format!(
+            r#"
+            use subxt;
+
+            #[subxt::subxt(runtime_metadata_path = "{tmp_metadata_path}")]
+            pub mod polkadot {{}}
+
+            fn main() {{}}
+        "#
+        );
+
+        std::fs::create_dir_all(&tmp_dir).expect("could not create tmp ui test dir");
+        // Write metadata to tmp folder:
+        std::fs::write(&tmp_metadata_path, encoded_metadata).unwrap();
+        // Write test file to tmp folder (it'll be moved by trybuild):
+        std::fs::write(&tmp_rust_path, rust_file).unwrap();
+
+        Some(tmp_rust_path)
+    }
+}
+
+// `trybuild` runs all tests once it's dropped. So, we defer all cleanup until we
+// are dropped too, to make sure that cleanup happens after tests are ran.
+impl Drop for PalletMetadataTestRunner {
+    fn drop(&mut self) {
+        for i in 0..self.index {
+            let mut tmp_dir = std::env::temp_dir();
+            tmp_dir.push(format!("{TEST_DIR_PREFIX}{i}"));
+            std::fs::remove_dir_all(tmp_dir).expect("cannot cleanup temp files");
+        }
+    }
+}