Put integration tests behind feature flag

.github/workflows/nightly.yml

@@ -40,7 +40,7 @@ jobs:
         uses: actions-rs/[email protected]
         with:
           command: test
-          args: --all-targets --workspace
+          args: --features integration-tests --all-targets --workspace
 
       # If the previous step fails, create a new Github issue
       # to nofity us about it.

.github/workflows/rust.yml

@@ -127,7 +127,7 @@ jobs:
         uses: actions-rs/[email protected]
         with:
           command: test
-          args: --all-targets --workspace
+          args: --features integration-tests --all-targets --workspace
 
   clippy:
     name: Cargo clippy
@@ -158,4 +158,4 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets -- -D warnings
+          args: --features integration-tests --all-targets -- -D warnings

subxt/Cargo.toml

@@ -12,6 +12,9 @@ homepage = "https://www.parity.io/"
 description = "Submit extrinsics (transactions) to a substrate node via RPC"
 keywords = ["parity", "substrate", "blockchain"]
 
+[features]
+integration-tests = ["test-runtime/integration-tests"]
+
 [dependencies]
 async-trait = "0.1.49"
 bitvec = { version = "1.0.0", default-features = false, features = ["alloc"] }

subxt/src/client.rs

@@ -88,7 +88,7 @@ impl ClientBuilder {
     /// Set the metadata.
     ///
     /// *Note:* Metadata will no longer be downloaded from the runtime node.
-    #[cfg(integration_tests)]
+    #[cfg(feature = "integration-tests")]
     pub fn set_metadata(mut self, metadata: Metadata) -> Self {
         self.metadata = Some(metadata);
         self

subxt/tests/integration/main.rs

@@ -15,19 +15,26 @@
 // along with subxt.  If not, see <http://www.gnu.org/licenses/>.
 
 mod codegen;
+#[cfg(feature = "integration-tests")]
 mod utils;
 
 #[cfg(test)]
+#[cfg(feature = "integration-tests")]
 mod client;
 #[cfg(test)]
+#[cfg(feature = "integration-tests")]
 mod events;
 #[cfg(test)]
+#[cfg(feature = "integration-tests")]
 mod frame;
 #[cfg(test)]
-#[cfg(integration_tests)]
+#[cfg(feature = "integration-tests")]
 mod metadata;
 #[cfg(test)]
+#[cfg(feature = "integration-tests")]
 mod storage;
 
+#[cfg(feature = "integration-tests")]
 use test_runtime::node_runtime;
+#[cfg(feature = "integration-tests")]
 use utils::*;

subxt/tests/integration/utils/node_proc.rs

@@ -37,7 +37,6 @@ use subxt::{
 pub struct TestNodeProcess<R: Config> {
     proc: process::Child,
     client: Client<R>,
-    #[cfg(integration_tests)]
     ws_url: String,
 }
 
@@ -79,7 +78,6 @@ where
     }
 
     /// Returns the address to which the client is connected.
-    #[cfg(integration_tests)]
     pub fn ws_url(&self) -> &str {
         &self.ws_url
     }
@@ -149,7 +147,6 @@ impl TestNodeProcessBuilder {
                 Ok(TestNodeProcess {
                     proc,
                     client,
-                    #[cfg(integration_tests)]
                     ws_url,
                 })
             }

test-runtime/Cargo.toml

@@ -3,6 +3,9 @@ name = "test-runtime"
 version = "0.20.0"
 edition = "2021"
 
+[features]
+integration-tests = []
+
 [dependencies]
 subxt = { path = "../subxt" }
 sp-runtime = "6.0.0"

test-runtime/build.rs

@@ -33,13 +33,20 @@ use subxt::rpc::{
 };
 
 static SUBSTRATE_BIN_ENV_VAR: &str = "SUBSTRATE_NODE_PATH";
+static INTEGRATION_FEATURE_FLAG: &str = "CARGO_FEATURE_INTEGRATION_TESTS";
 
 #[tokio::main]
 async fn main() {
     run().await;
 }
 
 async fn run() {
+    // The build script must run only in test context, as having `integration-tests` feature
+    // flag enabled.
+    if env::var_os(INTEGRATION_FEATURE_FLAG).is_none() {
+        return
+    }
+
     // Select substrate binary to run based on env var.
     let substrate_bin =
         env::var(SUBSTRATE_BIN_ENV_VAR).unwrap_or_else(|_| "substrate".to_owned());

test-runtime/src/lib.rs

@@ -17,6 +17,8 @@
 #![allow(clippy::too_many_arguments)]
 
 /// The SCALE encoded metadata obtained from a local run of a substrate node.
+#[cfg(feature = "integration-tests")]
 pub static METADATA: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/metadata.scale"));
 
+#[cfg(feature = "integration-tests")]
 include!(concat!(env!("OUT_DIR"), "/runtime.rs"));