Replace TestDoc with Doc

tests/ef_tests/src/case_result.rs

@@ -0,0 +1,56 @@
+use super::*;
+use types::EthSpec;
+
+#[derive(Debug, PartialEq, Clone)]
+pub struct TestCaseResult {
+    pub case_index: usize,
+    pub desc: String,
+    pub result: Result<(), Error>,
+}
+
+impl TestCaseResult {
+    pub fn new<T: Debug>(case_index: usize, case: &T, result: Result<(), Error>) -> Self {
+        TestCaseResult {
+            case_index,
+            desc: format!("{:?}", case),
+            result,
+        }
+    }
+}
+
+pub trait Test {
+    fn test<E: EthSpec>(&self) -> Vec<TestCaseResult>;
+}
+
+/// Compares `result` with `expected`.
+///
+/// If `expected.is_none()` then `result` is expected to be `Err`. Otherwise, `T` in `result` and
+/// `expected` must be equal.
+pub fn compare_result<T, E>(result: &Result<T, E>, expected: &Option<T>) -> Result<(), Error>
+where
+    T: PartialEq<T> + Debug,
+    E: Debug,
+{
+    match (result, expected) {
+        // Pass: The should have failed and did fail.
+        (Err(_), None) => Ok(()),
+        // Fail: The test failed when it should have produced a result (fail).
+        (Err(e), Some(expected)) => Err(Error::NotEqual(format!(
+            "Got {:?} Expected {:?}",
+            e, expected
+        ))),
+        // Fail: The test produced a result when it should have failed (fail).
+        (Ok(result), None) => Err(Error::DidntFail(format!("Got {:?}", result))),
+        // Potential Pass: The test should have produced a result, and it did.
+        (Ok(result), Some(expected)) => {
+            if result == expected {
+                Ok(())
+            } else {
+                Err(Error::NotEqual(format!(
+                    "Got {:?} expected {:?}",
+                    result, expected
+                )))
+            }
+        }
+    }
+}