Merge branch 'feature-checkpoints-trait' of https://github.com/ndy2/s…

…calatest
scalatest · Jun 10, 2024 · fced376 · fced376
2 parents d6e68e7 + d70879f
commit fced376
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 15 deletions.
diff --git a/jvm/core/src/main/scala/org/scalatest/Checkpoints.scala b/jvm/core/src/main/scala/org/scalatest/Checkpoints.scala
@@ -147,10 +147,6 @@ trait Checkpoints {
      * failed checkpoints.
      */
     def reportAll()(implicit pos: source.Position): Unit = {
-      // SKIP-SCALATESTJS,NATIVE-START
-      val stackDepth = 1
-      // SKIP-SCALATESTJS,NATIVE-END
-      //SCALATESTJS,NATIVE-ONLY val stackDepth = 10
       if (!failures.isEmpty) {
         val failMessages =
           for (failure <- failures.asScala)
@@ -159,6 +155,27 @@ trait Checkpoints {
       }
     }
   }
+
+
+  /**
+   * Run provided function with a new <code>Checkpoint</code> and report the <code>Checkpoint</code>.
+   * You can group your assertions, like this:
+   *
+   *
+   * <pre>
+   * withCheckpoint { cp =>
+   *    cp { x should be < 0 }
+   *    cp { y should be > 9 }
+   * }
+   * </pre>
+   *
+   * @param f the block of code, likely containing one or more checkpointed assertions, to execute
+   */
+  def withCheckpoint(f: Checkpoint => Unit)(implicit pos: source.Position): Unit = {
+    val cp = new Checkpoint
+    f(cp)
+    cp.reportAll()
+  }
 }
 
 /**

diff --git a/jvm/scalatest-test/src/test/scala/org/scalatest/CheckpointsSpec.scala b/jvm/scalatest-test/src/test/scala/org/scalatest/CheckpointsSpec.scala
@@ -20,16 +20,10 @@ import org.scalatest.OptionValues._
 
 // SKIP-SCALATESTJS,NATIVE-START
 import org.scalatestplus.junit.AssertionsForJUnit
-import org.scalatestplus.junit.JUnitTestFailedError
 // SKIP-SCALATESTJS,NATIVE-END
-import org.scalatest.SharedHelpers.thisLineNumber
-import org.scalatest.exceptions.TestFailedException
-import org.scalatest.exceptions.TestCanceledException
-import org.scalatest.exceptions.TestRegistrationClosedException
-import org.scalatest.exceptions.NotAllowedException
-import org.scalatest.exceptions.DuplicateTestNameException
-
 import org.scalactic.source
+import org.scalatest.SharedHelpers.thisLineNumber
+import org.scalatest.exceptions._
 import org.scalatest.funspec.AnyFunSpec
 import org.scalatest.matchers.should.Matchers._
 
@@ -96,8 +90,10 @@ class CheckpointsSpec extends AnyFunSpec with AssertionsForJUnit {
     describe("with a success condition") {
       it("should not throw an exception") {
         val cp = new Checkpoint
-        cp { 1 should equal (1) }
-        cp.reportAll()
+        noException should be thrownBy {
+          cp { 1 should equal (1) }
+          cp.reportAll()
+        }
       }
     } 
     describe("when a TestCanceledException is thrown") {
@@ -134,7 +130,71 @@ class CheckpointsSpec extends AnyFunSpec with AssertionsForJUnit {
     } 
   }
 
-  // SKIP-SCALATESTJS,NATIVE-START
+  describe("The withCheckpoint method") {
+    describe("with a failure condition") {
+
+      it("should throw a TestFailedException when reportAll is called") {
+        val caught = the [TestFailedException] thrownBy {
+            withCheckpoint { cp =>
+              cp { 1 should equal (2) }
+            }
+          }
+
+        val failConditionLineNumber = thisLineNumber - 4
+        // For Scala 3 the position is at the end of the application of the checkpoint function.
+        val reportAllLineNumber      = if (ScalaTestVersions.BuiltForScalaVersion.startsWith("3.")) failConditionLineNumber + 1 else failConditionLineNumber - 1
+
+        caught.failedCodeLineNumber.value should equal (reportAllLineNumber)
+        caught.failedCodeFileName.value should be ("CheckpointsSpec.scala")
+        caught.getMessage should include (Resources.atCheckpointAt +
+          " CheckpointsSpec.scala:" +
+          failConditionLineNumber)
+      }
+    }
+
+    describe("with multiple failure conditions") {
+
+      it("should report all failures when reportAll is called") {
+        val caught =
+          the [TestFailedException] thrownBy {
+            withCheckpoint { cp =>
+              cp { 1 should equal (2) }
+              cp { 3 should equal (2) }
+            }
+          }
+
+        val failCondition1LineNumber = thisLineNumber - 5
+        val failCondition2LineNumber = failCondition1LineNumber + 1
+        // For Scala 3 the position is at the end of the application of the checkpoint function.
+        val reportAllLineNumber      = if (ScalaTestVersions.BuiltForScalaVersion.startsWith("3.")) failCondition1LineNumber + 2 else failCondition1LineNumber - 1
+
+        caught.failedCodeLineNumber.value should equal (reportAllLineNumber)
+        caught.failedCodeFileName.value should be ("CheckpointsSpec.scala")
+
+        caught.getMessage should include (Resources.atCheckpointAt +
+          " CheckpointsSpec.scala:" +
+          failCondition1LineNumber)
+
+        caught.getMessage should include (Resources.atCheckpointAt +
+          " CheckpointsSpec.scala:" +
+          failCondition2LineNumber)
+      }
+    }
+
+
+    describe("with a success condition") {
+
+      it("should not throw an exception") {
+        noException should be thrownBy {
+          withCheckpoint { cp =>
+            cp { 1 should equal (1) }
+          }
+        }
+      }
+    }
+  }
+
+    // SKIP-SCALATESTJS,NATIVE-START
   describe("a Checkpoint using AssertionsForJUnit") {
     describe("with a failure condition") {