Add miri test (#655)

* Add miri test

Signed-off-by: Moritz Hoffmann <[email protected]>

* Add miri component

Signed-off-by: Moritz Hoffmann <[email protected]>

* too slow

Signed-off-by: Moritz Hoffmann <[email protected]>

* ignore doc tests, unignore scaling test

Signed-off-by: Moritz Hoffmann <[email protected]>

* missing guard

Signed-off-by: Moritz Hoffmann <[email protected]>

* Disable miri on pull request

Signed-off-by: Moritz Hoffmann <[email protected]>

---------

Signed-off-by: Moritz Hoffmann <[email protected]>

Author: antiguru

.github/workflows/miri.yml

@@ -0,0 +1,19 @@
+name: "Test Suite (miri)"
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: cargo miri test on ubuntu, rust nightly
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: nightly
+      - name: Install miri
+        run: rustup component add miri
+      - name: Cargo test
+        run: cargo miri test

timely/src/dataflow/operators/core/capture/capture.rs

@@ -72,6 +72,9 @@ pub trait Capture<T: Timestamp, C: Container + Data> {
     /// use timely::dataflow::operators::{Capture, ToStream, Inspect};
     /// use timely::dataflow::operators::capture::{EventReader, EventWriter, Replay, Extract};
     ///
+    /// # #[cfg(miri)] fn main() {}
+    /// # #[cfg(not(miri))]
+    /// # fn main() {
     /// // get send and recv endpoints, wrap send to share
     /// let (send0, recv0) = ::std::sync::mpsc::channel();
     /// let send0 = Arc::new(Mutex::new(send0));
@@ -102,6 +105,7 @@ pub trait Capture<T: Timestamp, C: Container + Data> {
     /// }).unwrap();
     ///
     /// assert_eq!(recv0.extract()[0].1, (0..10).collect::<Vec<_>>());
+    /// # }
     /// ```
     fn capture_into<P: EventPusher<T, C>+'static>(&self, pusher: P);
 

timely/src/dataflow/operators/core/capture/event.rs

@@ -116,9 +116,13 @@ pub mod link {
 
     #[test]
     fn avoid_stack_overflow_in_drop() {
+        #[cfg(miri)]
+        let limit = 1_000;
+        #[cfg(not(miri))]
+        let limit = 1_000_000;
         let mut event1 = Rc::new(EventLink::<(),()>::new());
         let _event2 = event1.clone();
-        for _ in 0 .. 1_000_000 {
+        for _ in 0 .. limit {
             event1.push(Event::Progress(vec![]));
         }
     }

timely/src/dataflow/operators/core/capture/mod.rs

@@ -24,6 +24,9 @@
 //! use timely::dataflow::operators::{Capture, ToStream, Inspect};
 //! use timely::dataflow::operators::capture::{EventLink, Replay};
 //!
+//! # #[cfg(miri)] fn main() {}
+//! # #[cfg(not(miri))]
+//! # fn main() {
 //! timely::execute(timely::Config::thread(), |worker| {
 //!     let handle1 = Rc::new(EventLink::new());
 //!     let handle2 = Some(handle1.clone());
@@ -38,6 +41,7 @@
 //!                .inspect(|x| println!("replayed: {:?}", x));
 //!     })
 //! }).unwrap();
+//! # }
 //! ```
 //!
 //! The types `EventWriter<T, D, W>` and `EventReader<T, D, R>` can be
@@ -52,6 +56,9 @@
 //! use timely::dataflow::operators::{Capture, ToStream, Inspect};
 //! use timely::dataflow::operators::capture::{EventReader, EventWriter, Replay};
 //!
+//! # #[cfg(miri)] fn main() {}
+//! # #[cfg(not(miri))]
+//! # fn main() {
 //! timely::execute(timely::Config::thread(), |worker| {
 //!     let list = TcpListener::bind("127.0.0.1:8000").unwrap();
 //!     let send = TcpStream::connect("127.0.0.1:8000").unwrap();
@@ -71,6 +78,7 @@
 //!             .inspect(|x| println!("replayed: {:?}", x));
 //!     })
 //! }).unwrap();
+//! # }
 //! ```
 
 pub use self::capture::Capture;