Merge pull request #400 from moka-rs/fix-ci/2024-02-10/v011

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

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

@@ -3,4 +3,4 @@
 set -eux
 
 # Pin some dependencies to specific versions for the MSRV.
-cargo update -p cargo-platform --precise 0.1.5
+# cargo update -p <crate> --precise <version>

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

@@ -4,3 +4,5 @@ set -eux
 
 # Pin some dependencies to specific versions for the nightly toolchain.
 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,10 +47,7 @@ jobs:
           components: rustfmt, clippy
 
       - name: Run Clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --lib --tests --all-features --all-targets -- -D warnings
+        run: cargo clippy --lib --tests --all-features --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

@@ -24,6 +24,8 @@
         "Descheduled",
         "devcontainer",
         "docsrs",
+        "doctest",
+        "doctests",
         "Einziger",
         "else's",
         "ENHANCEME",

Cargo.toml

@@ -99,15 +99,11 @@ env_logger = "0.10.0"
 getrandom = "0.2"
 paste = "1.0.9"
 reqwest = { version = "0.11.11", default-features = false, features = ["rustls-tls"] }
-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

@@ -498,14 +498,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/common/timer_wheel.rs

@@ -401,10 +401,13 @@ pub(crate) enum TimerEvent<K> {
     // This cache entry has been rescheduled. Rescheduling includes moving a timer
     // from one wheel to another in a lower level of the hierarchy. (This variant
     // is mainly used for testing)
+    #[cfg(test)]
     Rescheduled(TrioArc<EntryInfo<K>>),
+    #[cfg(not(test))]
+    Rescheduled(()),
     /// This timer node (containing a cache entry) has been removed from the timer.
     /// (This variant is mainly used for testing)
-    Descheduled(Box<DeqNode<TimerNode<K>>>),
+    Descheduled,
 }
 
 /// An iterator over expired cache entries.
@@ -515,18 +518,23 @@ impl<'iter, K> Iterator for TimerEventsIter<'iter, K> {
                             // The cache entry has not expired. Reschedule it.
                             let node_p = NonNull::new(Box::into_raw(node)).expect("Got a null ptr");
                             match self.timer_wheel.schedule_existing_node(node_p) {
+                                #[cfg(test)]
                                 ReschedulingResult::Rescheduled => {
                                     let entry_info =
                                         unsafe { node_p.as_ref() }.element.entry_info();
                                     return Some(TimerEvent::Rescheduled(TrioArc::clone(
                                         entry_info,
                                     )));
                                 }
+                                #[cfg(not(test))]
+                                ReschedulingResult::Rescheduled => {
+                                    return Some(TimerEvent::Rescheduled(()));
+                                }
                                 ReschedulingResult::Removed(node) => {
                                     // The timer event has been removed from the timer
                                     // wheel. Unset the timer node from the ValueEntry.
                                     node.as_ref().element.unset_timer_node_in_deq_nodes();
-                                    return Some(TimerEvent::Descheduled(node));
+                                    return Some(TimerEvent::Descheduled);
                                 }
                             }
                         }

src/future/cache.rs

@@ -3578,7 +3578,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>>;
 
@@ -3713,7 +3713,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

@@ -220,3 +220,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/policy.rs

@@ -206,7 +206,7 @@ impl<K, V> Clone for ExpirationPolicy<K, V> {
         Self {
             time_to_live: self.time_to_live,
             time_to_idle: self.time_to_idle,
-            expiry: self.expiry.as_ref().map(Arc::clone),
+            expiry: self.expiry.clone(),
         }
     }
 }
@@ -244,7 +244,7 @@ impl<K, V> ExpirationPolicy<K, V> {
     }
 
     pub(crate) fn expiry(&self) -> Option<Arc<dyn Expiry<K, V> + Send + Sync + 'static>> {
-        self.expiry.as_ref().map(Arc::clone)
+        self.expiry.clone()
     }
 
     pub(crate) fn set_expiry(&mut self, expiry: Arc<dyn Expiry<K, V> + Send + Sync + 'static>) {

src/sync/cache.rs

@@ -3588,7 +3588,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>>;
 
@@ -3727,7 +3727,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

@@ -759,8 +759,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(),
                     expiration_policy.clone(),
                     invalidator_enabled,

src/sync_base/base_cache.rs

@@ -74,7 +74,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(),
         }
     }
 }