Merge pull request #402 from moka-rs/fix-ci/2024-02-10/v010

CI: Fix the CI (remove Skeptic etc.) for v0.10.x

.ci_extras/pin-crate-vers-msrv.sh

@@ -13,7 +13,6 @@ cargo update -p regex --precise 1.9.6
 cargo update -p memchr --precise 2.6.2
 cargo update -p h2 --precise 0.3.20
 cargo update -p actix-rt --precise 2.8.0
-cargo update -p cargo-platform --precise 0.1.5
 cargo update -p crossbeam-epoch --precise 0.9.15
 
 # To use memchr 2.5.0, we need to use regex 1.9.4 and regex-automata 0.3.7.
@@ -23,6 +22,5 @@ cargo update -p regex-automata --precise 0.3.7
 # The following crates require rustc to support target feature "neon",
 # which is unstable in Rust 1.60.0.
 cargo update -p aho-corasick --precise 1.0.5
-cargo update -p bytecount --precise 0.6.3
 cargo update -p memchr --precise 2.5.0
 cargo update -p value-bag --precise 1.4.1

.ci_extras/pin-crate-vers-nightly.sh

@@ -6,3 +6,5 @@ set -eux
 cargo update -p openssl --precise 0.10.39
 cargo update -p cc --precise 1.0.61
 cargo update -p proc-macro2 --precise 1.0.63
+# https://github.com/tkaitchuck/aHash/issues/200
+cargo update -p ahash --precise 0.8.7

.github/workflows/Lints.yml

@@ -28,6 +28,8 @@ jobs:
     if: needs.pre_job.outputs.should_skip != 'true'
     runs-on: ubuntu-latest
     strategy:
+      # Continue running other jobs in the matrix even if one fails.
+      fail-fast: false
       matrix:
         rust:
           - toolchain: stable
@@ -45,12 +47,11 @@ jobs:
           components: rustfmt, clippy
 
       - name: Run Clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          # Specify individual features until we remove `dash` feature.
-          # args: --lib --tests --all-features --all-targets -- -D warnings
-          args: --lib --tests --features 'future, logging, unstable-debug-counters' --all-targets -- -D warnings
+        # Specify individual features until we remove `dash` feature.
+        run: |
+          cargo clippy --lib --tests \
+            --features 'future, logging, unstable-debug-counters' \
+            --all-targets -- -D warnings
         env:
           RUSTFLAGS: ${{ matrix.rust.rustflags }}
 

.github/workflows/LinuxCrossCompileTest.yml

@@ -76,7 +76,7 @@ jobs:
       - name: Remove integration tests and force enable rustc_version crate
         run: |
           rm -rf tests
-          sed -i '/actix-rt\|async-std\|reqwest\|skeptic/d' Cargo.toml
+          sed -i '/actix-rt\|async-std\|reqwest/d' Cargo.toml
           sed -i 's/target.*rustver.*\.//' Cargo.toml
           sed -i 's/build = "build.rs"/build = ".ci_extras\/build_linux_cross.rs"/' Cargo.toml
           cat Cargo.toml

.github/workflows/Skeptic.yml → .github/workflows/Trybuild.yml

@@ -1,4 +1,4 @@
-name: Skeptic and Trybuild
+name: Trybuild
 
 on:
   push:
@@ -42,21 +42,6 @@ jobs:
         with:
           toolchain: ${{ matrix.rust }}
 
-      - name: Run tests (no features)
-        run: cargo test --release
-        env:
-          RUSTFLAGS: '--cfg skeptic'
-
-      - name: Run tests (release, sync and future)
-        run: cargo test --release --features 'sync, future'
-        env:
-          RUSTFLAGS: '--cfg skeptic'
-
-      - name: Run tests (sync and future, without atomic64 and quanta)
-        run: cargo test --release --no-default-features --features 'sync, future'
-        env:
-          RUSTFLAGS: '--cfg skeptic'
-
       - name: Run compile error tests (sync and future features, trybuild)
         if: ${{ matrix.rust == 'stable' }}
         run: cargo test ui_trybuild --release --features 'sync, future'

.vscode/settings.json

@@ -21,6 +21,8 @@
         "Deques",
         "devcontainer",
         "docsrs",
+        "doctest",
+        "doctests",
         "Einziger",
         "else's",
         "Eytan",

Cargo.toml

@@ -90,15 +90,11 @@ env_logger = "0.9"
 getrandom = "0.2"
 paste = "1.0.9"
 reqwest = "0.11.11"
-skeptic = "0.13"
 tokio = { version = "1.19", features = ["fs", "macros", "rt-multi-thread", "sync", "time" ] }
 
 [target.'cfg(trybuild)'.dev-dependencies]
 trybuild = "1.0"
 
-[target.'cfg(skeptic)'.build-dependencies]
-skeptic = "0.13.5"
-
 [target.'cfg(rustver)'.build-dependencies]
 rustc_version = "0.4.0"
 

README.md

@@ -521,14 +521,13 @@ To run all tests including `future` feature and doc tests on the README, use the
 following command:
 
 ```console
-$ RUSTFLAGS='--cfg skeptic --cfg trybuild' cargo test --all-features
+$ RUSTFLAGS='--cfg trybuild' cargo test --all-features
 ```
 
 **Running All Tests without Default Features**
 
 ```console
-$ RUSTFLAGS='--cfg skeptic --cfg trybuild' cargo test \
-    --no-default-features --features future
+$ RUSTFLAGS='--cfg trybuild' cargo test --no-default-features --features future
 ```
 
 **Generating the Doc**

build.rs

@@ -1,9 +1,3 @@
-#[cfg(skeptic)]
-fn main() {
-    // generates doc tests for `README.md`.
-    skeptic::generate_doc_tests(&["README.md"]);
-}
-
 #[cfg(rustver)]
 fn main() {
     use rustc_version::version;
@@ -14,5 +8,5 @@ fn main() {
     );
 }
 
-#[cfg(not(any(skeptic, rustver)))]
+#[cfg(not(rustver))]
 fn main() {}

src/future/cache.rs

@@ -3059,7 +3059,7 @@ mod tests {
         // Note that MyError does not implement std::error::Error trait
         // like anyhow::Error.
         #[derive(Debug)]
-        pub struct MyError(String);
+        pub struct MyError(#[allow(dead_code)] String);
 
         type MyResult<T> = Result<T, Arc<MyError>>;
 
@@ -3194,7 +3194,7 @@ mod tests {
         // Note that MyError does not implement std::error::Error trait
         // like anyhow::Error.
         #[derive(Debug)]
-        pub struct MyError(String);
+        pub struct MyError(#[allow(dead_code)] String);
 
         type MyResult<T> = Result<T, Arc<MyError>>;
 

src/lib.rs

@@ -218,3 +218,10 @@ mod tests {
         t.compile_fail("tests/compile_tests/future/clone/*.rs");
     }
 }
+
+#[cfg(all(doctest, feature = "sync"))]
+mod doctests {
+    // https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#include-items-only-when-collecting-doctests
+    #[doc = include_str!("../README.md")]
+    struct ReadMeDoctests;
+}

src/sync/cache.rs

@@ -3086,7 +3086,7 @@ mod tests {
         // Note that MyError does not implement std::error::Error trait like
         // anyhow::Error.
         #[derive(Debug)]
-        pub struct MyError(String);
+        pub struct MyError(#[allow(dead_code)] String);
 
         type MyResult<T> = Result<T, Arc<MyError>>;
 
@@ -3225,7 +3225,7 @@ mod tests {
         // Note that MyError does not implement std::error::Error trait like
         // anyhow::Error.
         #[derive(Debug)]
-        pub struct MyError(String);
+        pub struct MyError(#[allow(dead_code)] String);
 
         type MyResult<T> = Result<T, Arc<MyError>>;
 

src/sync/segment.rs

@@ -740,8 +740,8 @@ where
                     seg_max_capacity,
                     seg_init_capacity,
                     build_hasher.clone(),
-                    weigher.as_ref().map(Arc::clone),
-                    eviction_listener.as_ref().map(Arc::clone),
+                    weigher.clone(),
+                    eviction_listener.clone(),
                     eviction_listener_conf.clone(),
                     time_to_live,
                     time_to_idle,

src/sync_base/base_cache.rs

@@ -73,7 +73,7 @@ impl<K, V, S> Clone for BaseCache<K, V, S> {
             inner: Arc::clone(&self.inner),
             read_op_ch: self.read_op_ch.clone(),
             write_op_ch: self.write_op_ch.clone(),
-            housekeeper: self.housekeeper.as_ref().map(Arc::clone),
+            housekeeper: self.housekeeper.clone(),
         }
     }
 }

src/unsync/cache.rs

@@ -968,6 +968,9 @@ where
                     break;
                 }
 
+                // clippy::map_clone will give us a false positive warning here.
+                // Version: clippy 0.1.77 (f2048098a1c 2024-02-09) in Rust 1.77.0-beta.2
+                #[allow(clippy::map_clone)]
                 let key = probation
                     .peek_front()
                     .map(|node| Rc::clone(&node.element.key));