Merge pull request #523 from AmbireTech/improve-ci-checks

Improve CI checks

Author: elpiel

.github/workflows/ci.yml

@@ -1,13 +1,66 @@
 on: [push, pull_request]
 
+# Stops the running workflow of previous pushes
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
 name: Continuous Integration
 
 jobs:
-  ci-flow:
-    name: cargo make ci-flow - Tests, clippy & rustfmt
+  lint-rustfmt:
+    name: Running lint - rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions-rs/toolchain@v1
+        with:
+          # No need to add `toolchain`, it will use `rust-toolchain` file instead
+          profile: minimal
+          components: rustfmt
+      - uses: davidB/rust-cargo-make@v1
+      - name: Rustfmt
+        # we don't use the check-format-ci-flow because it requires nightly (cargo-make)
+        run: cargo make check-format-flow
+  lint-clippy:
+    name: Running lint - clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions-rs/toolchain@v1
+        with:
+          # No need to add `toolchain`, it will use `rust-toolchain` file instead
+          profile: minimal
+          components: clippy
+      - uses: davidB/rust-cargo-make@v1
+      - name: Run Clippy
+        # we don't use the clippy-ci-flow because it requires nightly (cargo-make)
+        run: cargo make clippy-flow
+  check-docs:
+    name: Rustdoc build check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions-rs/toolchain@v1
+        with:
+          # No need to add `toolchain`, it will use `rust-toolchain` file instead
+          profile: minimal
+          components: rust-docs
+      - name: Build docs with no features
+        run: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps --no-default-features
+      - name: Build docs with --all-features
+        run: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps --all-features
+  test-flow:
+    name: cargo make ci-flow - Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
       # Runs all services needed for testing
@@ -19,9 +72,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           # No need to add `toolchain`, it will use `rust-toolchain` file instead
-          profile: default
-          override: true
-          components: clippy, rustfmt
+          profile: minimal
       - uses: davidB/rust-cargo-make@v1
       - name: Run `cargo make ci-flow`
         # Running cargo make doesn't successfully start `ganache`

.github/workflows/docs.yml

@@ -10,11 +10,17 @@ jobs:
     name: Deploy docs on gh-pages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
+      - uses: actions-rs/toolchain@v1
+        with:
+          # Use nightly to build the docs with `--cfg docsrs`
+          toolchain: nightly
+          profile: minimal
+          components: rust-docs
       - name: Build docs
-        run: cargo doc --no-deps
+        run: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --workspace
       - name: Prepare /docs & index file
         run: |
           rm -rf ./docs

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     if: startsWith(github.event.ref, 'refs/tags/validator-v')
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: true
     # See https://github.community/t/how-to-get-just-the-tag-name/16241/10

Makefile.toml

@@ -1,15 +1,15 @@
 [env]
 CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = "true"
-CARGO_MAKE_CLIPPY_ARGS = "--all-features -- -D warnings"
+CARGO_MAKE_CLIPPY_ARGS = "--all-features --no-deps -- -D warnings"
 CARGO_MAKE_RUN_TOML_FORMAT = "true"
 CARGO_MAKE_RUN_CHECK_FORMAT = "true"
 CARGO_MAKE_RUN_CLIPPY = "true"
 
 [tasks.dev-test-flow]
 dependencies = [
-  "format-flow",
   "format-toml-conditioned-flow",
-  "clippy",
+  "format-flow",
+  "clippy-flow",
   "pre-build",
   "build",
   "post-build",

adapter/Makefile.toml

@@ -4,8 +4,9 @@ extend = "../Makefile.toml"
 description = "Development testing flow will first format the code, and than run cargo build and test"
 category = "Development"
 dependencies = [
-  "format-flow",
   "format-toml-conditioned-flow",
+  "format-flow",
+  "clippy-flow",
   "pre-build",
   "build",
   "post-build",
@@ -15,14 +16,13 @@ dependencies = [
 ]
 
 [tasks.test]
-# run tests in release because of slow unlock time of Ethereum adapter (i.e. keystore decryption)
-args = ["test", "--release", "--all-features"]
+args = ["test", "--all-features"]
 
 [tasks.ganache-up]
 # `--renew-anon-volumes` is required to make sure that the snapshot used for the `ganache` instances is reloaded.
 script = '''
 docker-compose -f ../docker-compose.harness.yml up --renew-anon-volumes -d ganache-1 ganache-1337 \
-&& sleep 10
+&& sleep 6
 '''
 
 [tasks.ganache-down]

adapter/src/dummy.rs

@@ -14,7 +14,7 @@ use primitives::{
 use std::collections::HashMap;
 
 #[doc(inline)]
-pub use self::deposit::Deposits;
+pub use self::deposit::{Deposits, Key};
 
 pub type Adapter<S> = crate::Adapter<Dummy, S>;
 
@@ -66,8 +66,6 @@ impl Dummy {
         depositor: Address,
         deposit: D,
     ) {
-        use deposit::Key;
-
         let key = Key::from_chain_of(channel_context, depositor);
         match deposit.into() {
             Some(deposit) => {
@@ -261,6 +259,7 @@ mod deposit {
     use primitives::{Address, ChainId, ChainOf, Channel, ChannelId};
     use std::sync::Arc;
 
+    /// The Key for deposits that are unique for retrieving a Dummy deposit.
     #[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)]
     pub struct Key {
         channel_id: ChannelId,

adapter/src/ethereum/client.rs

@@ -619,7 +619,7 @@ mod test {
     async fn multi_chain_deposit_from_config() -> Result<(), Box<dyn std::error::Error>> {
         let config = GANACHE_CONFIG.clone();
 
-        let mut channel_1 = DUMMY_CAMPAIGN.channel.clone();
+        let mut channel_1 = DUMMY_CAMPAIGN.channel;
         let channel_1_token = GANACHE_INFO_1.tokens["Mocked TOKEN 1"].clone();
         channel_1.token = channel_1_token.address;
 
@@ -699,11 +699,10 @@ mod test {
                 .expect("Should have Ganache #1 already in config");
 
             assert!(
-                ganache_1
+                !ganache_1
                     .tokens
                     .values()
-                    .find(|existing_token| { existing_token.address == token.info.address })
-                    .is_none(),
+                    .any(|existing_token| { existing_token.address == token.info.address }),
                 "The deployed token address should not have existed previously in the config!"
             );
 

adapter/src/ethereum/ewt.rs

@@ -139,7 +139,7 @@ impl Token {
 
         let token_parts = token.splitn(3, '.').collect::<Vec<_>>();
         let ((header_encoded, payload_encoded), signature_encoded) = token_parts
-            .get(0)
+            .first()
             .zip(token_parts.get(1))
             .zip(token_parts.get(2))
             .ok_or(EwtVerifyError::InvalidToken)?;
@@ -236,7 +236,7 @@ mod test {
             // Eth
             chain_id: ChainId::new(1),
         };
-        let wallet = eth_adapter.state.wallet.clone();
+        let wallet = eth_adapter.state.wallet;
         let token = Token::sign(&wallet, payload).expect("failed to generate ewt signature");
         let expected = "eyJ0eXAiOiJKV1QiLCJhbGciOiJFVEgifQ.eyJpZCI6IjB4ODA2OTA3NTE5NjlCMjM0Njk3ZTkwNTllMDRlZDcyMTk1YzM1MDdmYSIsImVyYSI6MTAwMDAwLCJhZGRyZXNzIjoiMHhhQ0JhREEyZDU4MzBkMTg3NWFlM0QyZGUyMDdBMTM2M0IzMTZEZjJGIiwiY2hhaW5faWQiOjF9.GxF4XDXMx-rRty5zQ7-0nx2VlX51R_uEs_7OfA5ezDcyryUS06IWqVgGIfu4chhRJFP7woZ1YJpARNbCE01nWxwB";
         assert_eq!(token.as_str(), expected, "generated wrong ewt signature");

adapter/tests/resources/0x0E45891a570Af9e5A962F181C219468A6C9EB4e1_keystore.json

@@ -1 +1 @@
-{"address":"0e45891a570af9e5a962f181c219468a6c9eb4e1","crypto":{"cipher":"aes-128-ctr","ciphertext":"639873e843cdf99a0c09cf24ee56569f35b4ebffeb054bf2b181f5c21545acee","cipherparams":{"iv":"281838b5a67842e79f8abe5cfb252567"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":262144,"p":1,"r":8,"salt":"f2843ca233d543de6b545660b76f5a310ed30b50a0fbde7d6806d7fb53266711"},"mac":"9e73a152fcd224bfedf4625311ab625504a8a44f920d12bdc37884bead529941"},"id":"b757f415-d9f5-4c5e-b0ef-27a3b664d699","version":3}
+{"address":"0e45891a570af9e5a962f181c219468a6c9eb4e1","crypto":{"cipher":"aes-128-ctr","ciphertext":"7855c754157c4d6f3e46d9a6b4ad36e345f93ae7a82a961ef2b480055b5d7de1","cipherparams":{"iv":"e7bde7b532173c194994be8bd4035a21"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":4096,"p":6,"r":8,"salt":"8e6e57cc562375d521ecbb9691dc920c4afd1cf6b8a8569a81ba95b7dc46be4a"},"mac":"5aec65224313526d20fd15f3746c8677abc07ffe0eb2f0137d8acead8db8568d"},"id":"252fedc0-53ea-453a-9ce7-1940b4dcdc8f","version":3}

adapter/tests/resources/0x0e880972A4b216906F05D67EeaaF55d16B5EE4F1_keystore.json

@@ -1 +1 @@
-{"address":"0e880972a4b216906f05d67eeaaf55d16b5ee4f1","crypto":{"cipher":"aes-128-ctr","ciphertext":"a6517c853f41d70892195c2d49b6bf9cb70b28714df9148a2115422582ed71a7","cipherparams":{"iv":"29a072ed18b810e36461a4dafa3b8816"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":262144,"p":1,"r":8,"salt":"4647c8d015db3c67db397f291c13440b5a657f391470d02568c797d22252ee19"},"mac":"b9a6db84659a13b0d895418a9cff0a2b7b5f671ece4ea5c58b3c6cb403ad5a13"},"id":"be2aa04b-63d8-48ac-8d3b-3ed09a9d88b1","version":3}
+{"address":"0e880972a4b216906f05d67eeaaf55d16b5ee4f1","crypto":{"cipher":"aes-128-ctr","ciphertext":"8fc0abf80cd0c5c80322a323ae01fd6d9dfe310a7b2efa001bf7902cd63c6897","cipherparams":{"iv":"bd65e4a245eca4829f82de94676e427e"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":4096,"p":6,"r":8,"salt":"4203bb6a0822bfbb3597bfb755658bc14c9cb2044e8122f88e19b9f811a87393"},"mac":"80b81fcd0a677b59e53c709e155983ea9671f26f3a96394ee6d108797aab6cad"},"id":"22eb2ffb-2ffa-465d-b20c-234263ed0f56","version":3}