rust: replace static fixture with test helpers

Summary:
In #4385, @nfelt suggested using test helpers to easily populate a
commit rather than using a single fixture across all test cases. This
patch implements such test helpers and uses them in the server tests.
The net diff to the test code (not the helpers) is −32 lines.

Test Plan:
Existing tests pass. The new test helpers mostly don’t have explicit
tests, but that’s okay since they’re exercised by the main test code.

wchargin-branch: rust-test-data-builders
wchargin-source: 31164b4d2b4a1fb9bbabc584249e1d3715c17a3e

Author: wchargin

tensorboard/data/server/commit.rs

@@ -105,7 +105,7 @@ pub struct DataLoss;
 #[derive(Debug, Copy, Clone, PartialEq)]
 pub struct ScalarValue(pub f32);
 
-#[cfg(test)]
+#[cfg(any(test, doctest))]
 mod tests {
     use super::*;
 
@@ -136,3 +136,162 @@ mod tests {
         );
     }
 }
+
+/// Utilities for constructing commits with test data.
+pub mod test_data {
+    use super::*;
+    use crate::data_compat;
+    use crate::reservoir::StageReservoir;
+
+    #[derive(Default)]
+    pub struct CommitBuilder(Commit);
+
+    impl CommitBuilder {
+        /// Creates a new builder for an empty commit.
+        pub fn new() -> Self {
+            Self::default()
+        }
+
+        /// Ensures that data for a run exists, and update it.
+        ///
+        /// This takes a callback because we can't just return a mutable reference, since there are
+        /// nested `RwLockWriteGuard`s.
+        fn with_run_data(&self, run: Run, update: impl FnOnce(&mut RunData)) {
+            let mut runs = self.0.runs.write().expect("runs.write");
+            let mut run_data = runs
+                .entry(run)
+                .or_default()
+                .write()
+                .expect("runs[run].write");
+            update(&mut run_data);
+        }
+
+        /// Adds a scalar time series, creating the run if it doesn't exist, and setting its start
+        /// time if unset.
+        ///
+        /// # Examples
+        ///
+        /// ```
+        /// use rustboard_core::commit::{test_data::CommitBuilder, Commit};
+        /// use rustboard_core::types::Step;
+        ///
+        /// let my_commit: Commit = CommitBuilder::new()
+        ///     .scalars("train", "xent", |mut b| {
+        ///         b.eval(|Step(i)| 1.0 / (i + 1) as f32).build()
+        ///     })
+        ///     .build();
+        /// ```
+        pub fn scalars(
+            self,
+            run: &str,
+            tag: &str,
+            build: impl FnOnce(ScalarTimeSeriesBuilder) -> TimeSeries<ScalarValue>,
+        ) -> Self {
+            self.with_run_data(Run(run.to_string()), |run_data| {
+                let time_series = build(ScalarTimeSeriesBuilder::default());
+                match (run_data.start_time, time_series.valid_values().nth(0)) {
+                    (None, Some((_step, wt, _value))) => run_data.start_time = Some(wt),
+                    _ => (),
+                };
+                run_data.scalars.insert(Tag(tag.to_string()), time_series);
+            });
+            self
+        }
+
+        /// Ensures that a run is present and sets its start time.
+        ///
+        /// If you don't care about the start time and the run is going to have data, anyway, you
+        /// can just add the data directly, which will create the run as a side effect.
+        ///
+        /// # Panics
+        ///
+        /// If `start_time` represents an invalid wall time (i.e., `start_time` is `Some(wt)` but
+        /// `WallTime::new(wt)` is `None`).
+        pub fn run(self, run: &str, start_time: Option<f64>) -> Self {
+            self.with_run_data(Run(run.to_string()), |run_data| {
+                run_data.start_time = start_time.map(|f| WallTime::new(f).unwrap());
+            });
+            self
+        }
+
+        /// Consumes this `CommitBuilder` and returns the underlying commit.
+        pub fn build(self) -> Commit {
+            self.0
+        }
+    }
+
+    pub struct ScalarTimeSeriesBuilder {
+        /// Initial step. Increments by `1` for each point.
+        step_start: Step,
+        /// Initial wall time. Increments by `1.0` for each point.
+        wall_time_start: WallTime,
+        /// Number of points in this time series.
+        len: u64,
+        /// Custom summary metadata. Leave `None` to use default.
+        metadata: Option<Box<pb::SummaryMetadata>>,
+        /// Scalar evaluation function, called for each point in the series.
+        ///
+        /// By default, this maps step `i` to `0.5 ** (i + 1)`.
+        eval: Box<dyn Fn(Step) -> f32>,
+    }
+
+    impl Default for ScalarTimeSeriesBuilder {
+        fn default() -> Self {
+            ScalarTimeSeriesBuilder {
+                step_start: Step(0),
+                wall_time_start: WallTime::new(1235.0).unwrap(),
+                len: 3,
+                metadata: None,
+                eval: Box::new(|Step(i)| 0.5f32.powi((i + 1) as i32)),
+            }
+        }
+    }
+
+    impl ScalarTimeSeriesBuilder {
+        pub fn step_start(&mut self, raw_step: i64) -> &mut Self {
+            self.step_start = Step(raw_step);
+            self
+        }
+        pub fn wall_time_start(&mut self, raw_wall_time: f64) -> &mut Self {
+            self.wall_time_start = WallTime::new(raw_wall_time).unwrap();
+            self
+        }
+        pub fn len(&mut self, len: u64) -> &mut Self {
+            self.len = len;
+            self
+        }
+        pub fn metadata(&mut self, metadata: Option<Box<pb::SummaryMetadata>>) -> &mut Self {
+            self.metadata = metadata;
+            self
+        }
+        pub fn eval(&mut self, eval: impl Fn(Step) -> f32 + 'static) -> &mut Self {
+            self.eval = Box::new(eval);
+            self
+        }
+
+        /// Constructs a scalar time series from the state of this builder.
+        ///
+        /// # Panics
+        ///
+        /// If the wall time of a point would overflow to be infinite.
+        pub fn build(&self) -> TimeSeries<ScalarValue> {
+            let metadata = self.metadata.clone().unwrap_or_else(|| {
+                let sample_point = Box::new(pb::summary::value::Value::SimpleValue(0.0));
+                data_compat::SummaryValue(sample_point).initial_metadata(None)
+            });
+            let mut time_series = TimeSeries::new(metadata);
+
+            let mut rsv = StageReservoir::new(self.len as usize);
+            for i in 0..self.len {
+                let step = Step(self.step_start.0 + i as i64);
+                let wall_time =
+                    WallTime::new(f64::from(self.wall_time_start) + (i as f64)).unwrap();
+                let value = (self.eval)(step);
+                rsv.offer(step, (wall_time, Ok(ScalarValue(value))));
+            }
+            rsv.commit(&mut time_series.basin);
+
+            time_series
+        }
+    }
+}

tensorboard/data/server/server.rs

@@ -324,80 +324,22 @@ mod tests {
     use super::*;
     use tonic::Code;
 
-    use crate::commit::{ScalarValue, TimeSeries};
-    use crate::data_compat;
-    use crate::proto::tensorboard as pb;
-    use crate::reservoir::StageReservoir;
-    use crate::types::{Run, Step, Tag, WallTime};
-
-    /// Creates a commit with some test data.
-    fn sample_commit() -> Commit {
-        let commit = Commit::new();
-
-        let mut runs = commit.runs.write().unwrap();
-
-        fn scalar_series(points: Vec<(Step, WallTime, f32)>) -> TimeSeries<ScalarValue> {
-            use pb::summary::value::Value::SimpleValue;
-            let mut ts = commit::TimeSeries::new(
-                data_compat::SummaryValue(Box::new(SimpleValue(0.0))).initial_metadata(None),
-            );
-            let mut rsv = StageReservoir::new(points.len());
-            for (step, wall_time, value) in points {
-                rsv.offer(step, (wall_time, Ok(commit::ScalarValue(value))));
-            }
-            rsv.commit(&mut ts.basin);
-            ts
-        }
-
-        let mut train = runs
-            .entry(Run("train".to_string()))
-            .or_default()
-            .write()
-            .unwrap();
-        train.start_time = Some(WallTime::new(1234.0).unwrap());
-        train.scalars.insert(
-            Tag("xent".to_string()),
-            scalar_series(vec![
-                (Step(0), WallTime::new(1235.0).unwrap(), 0.5),
-                (Step(1), WallTime::new(1236.0).unwrap(), 0.25),
-                (Step(2), WallTime::new(1237.0).unwrap(), 0.125),
-            ]),
-        );
-        drop(train);
-
-        let mut test = runs
-            .entry(Run("test".to_string()))
-            .or_default()
-            .write()
-            .unwrap();
-        test.start_time = Some(WallTime::new(6234.0).unwrap());
-        test.scalars.insert(
-            Tag("accuracy".to_string()),
-            scalar_series(vec![
-                (Step(0), WallTime::new(6235.0).unwrap(), 0.125),
-                (Step(1), WallTime::new(6236.0).unwrap(), 0.25),
-                (Step(2), WallTime::new(6237.0).unwrap(), 0.5),
-            ]),
-        );
-        drop(test);
-
-        // An run with no start time or data: should not show up in results.
-        runs.entry(Run("empty".to_string())).or_default();
-
-        drop(runs);
-        commit
-    }
+    use crate::commit::test_data::CommitBuilder;
+    use crate::types::{Run, Tag};
 
-    fn sample_handler() -> DataProviderHandler {
+    fn sample_handler(commit: Commit) -> DataProviderHandler {
         DataProviderHandler {
             // Leak the commit object, since the Tonic server must have only 'static references.
-            commit: Box::leak(Box::new(sample_commit())),
+            commit: Box::leak(Box::new(commit)),
         }
     }
 
     #[tokio::test]
     async fn test_list_plugins() {
-        let handler = sample_handler();
+        let commit = CommitBuilder::new()
+            .scalars("train", "xent", |b| b.build())
+            .build();
+        let handler = sample_handler(commit);
         let req = Request::new(data::ListPluginsRequest {
             experiment_id: "123".to_string(),
         });
@@ -410,7 +352,14 @@ mod tests {
 
     #[tokio::test]
     async fn test_list_runs() {
-        let handler = sample_handler();
+        let commit = CommitBuilder::new()
+            .run("train", Some(1234.0))
+            .run("test", Some(6234.0))
+            .run("run_with_no_data", None)
+            .scalars("train", "xent", |mut b| b.wall_time_start(1235.0).build())
+            .scalars("test", "acc", |mut b| b.wall_time_start(6235.0).build())
+            .build();
+        let handler = sample_handler(commit);
         let req = Request::new(data::ListRunsRequest {
             experiment_id: "123".to_string(),
         });
@@ -457,7 +406,18 @@ mod tests {
 
     #[tokio::test]
     async fn test_list_scalars() {
-        let handler = sample_handler();
+        let commit = CommitBuilder::new()
+            .run("train", Some(1234.0))
+            .run("test", Some(6234.0))
+            .run("run_with_no_data", None)
+            .scalars("train", "xent", |mut b| {
+                b.wall_time_start(1235.0).len(3).build()
+            })
+            .scalars("test", "accuracy", |mut b| {
+                b.wall_time_start(6235.0).len(3).build()
+            })
+            .build();
+        let handler = sample_handler(commit);
         let req = Request::new(data::ListScalarsRequest {
             experiment_id: "123".to_string(),
             plugin_filter: Some(data::PluginFilter {
@@ -501,7 +461,11 @@ mod tests {
 
     #[tokio::test]
     async fn test_read_scalars() {
-        let handler = sample_handler();
+        let commit = CommitBuilder::new()
+            .scalars("train", "xent", |b| b.build())
+            .scalars("test", "xent", |b| b.build())
+            .build();
+        let handler = sample_handler(commit);
         let req = Request::new(data::ReadScalarsRequest {
             experiment_id: "123".to_string(),
             plugin_filter: Some(data::PluginFilter {
@@ -532,7 +496,7 @@ mod tests {
 
     #[tokio::test]
     async fn test_read_scalars_needs_downsample() {
-        let handler = sample_handler();
+        let handler = sample_handler(Commit::default());
         let req = Request::new(data::ReadScalarsRequest {
             experiment_id: "123".to_string(),
             plugin_filter: Some(data::PluginFilter {
@@ -550,7 +514,11 @@ mod tests {
 
     #[tokio::test]
     async fn test_read_scalars_downsample_zero_okay() {
-        let handler = sample_handler();
+        let commit = CommitBuilder::new()
+            .scalars("train", "xent", |b| b.build())
+            .scalars("test", "xent", |b| b.build())
+            .build();
+        let handler = sample_handler(commit);
         let req = Request::new(data::ReadScalarsRequest {
             experiment_id: "123".to_string(),
             plugin_filter: Some(data::PluginFilter {