Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Report error messages to sbt events which end up in JUnit XML #6387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2022
Merged

Report error messages to sbt events which end up in JUnit XML #6387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions test-sbt/jvm/src/test/scala/zio/test/sbt/ZTestFrameworkSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ object ZTestFrameworkSpec {
test("should return correct fingerprints")(testFingerprints()),
test("should report events")(testReportEvents()),
test("should report durations")(testReportDurations()),
test("should report errors")(testReportErrors()),
test("should log messages")(testLogMessages()),
test("should correctly display colorized output for multi-line strings")(testColored()),
test("should test only selected test")(testTestSelection()),
Expand All @@ -44,16 +45,21 @@ object ZTestFrameworkSpec {
}

def testReportEvents(): Unit = {
val reported = ArrayBuffer[Event]()
val reported = ArrayBuffer.empty[Event]
loadAndExecute(failingSpecFQN, reported.append(_))

val expected = Set(
val actual = reported.map {
case event: ZTestEvent => event.copy(maybeThrowable = None)
case event => event
}

val expected = Seq(
sbtEvent(failingSpecFQN, "failing test", Status.Failure),
sbtEvent(failingSpecFQN, "passing test", Status.Success),
sbtEvent(failingSpecFQN, "ignored test", Status.Ignored)
)

assertEquals("reported events", reported.toSet, expected)
assertEquals("reported events", actual, expected)
}

private def sbtEvent(fqn: String, label: String, status: Status) =
Expand All @@ -66,6 +72,21 @@ object ZTestFrameworkSpec {
assert(reported.forall(_.duration() > 0), s"reported events should have positive durations: $reported")
}

def testReportErrors(): Unit = {
val reported = ArrayBuffer.empty[Event]
loadAndExecute(errorReportingSpecFQN, reported.append(_))
assert(reported.forall(_.throwable.isDefined), s"reported events should have errors: $reported")

val actual = reported.map(_.throwable.get.getMessage.split('\n').take(4).mkString("|").withNoLineNumbers)
val expected = Seq(
s"- failing assertion| true did not satisfy isFalse()| $assertLocation",
s"- failing test| Fiber failed.| A checked error was not handled.| Boom",
s"- dying test| Fiber failed.| An unchecked error was produced.| java.lang.Exception: KO"
)

assertEquals("reported errors", actual, expected)
}

def testLogMessages(): Unit = {
val loggers = Seq.fill(3)(new MockLogger)

Expand Down Expand Up @@ -211,6 +232,15 @@ object ZTestFrameworkSpec {
} @@ TestAspect.before(Live.live(ZIO.sleep(5.millis))) @@ TestAspect.timed
}

lazy val errorReportingSpecFQN = ErrorReportingSpec.getClass.getName
object ErrorReportingSpec extends DefaultRunnableSpec {
override def spec: ZSpec[Environment, Failure] = suite("error reporting")(
test("failing assertion")(zio.test.assert(true)(Assertion.isFalse)),
testM("failing test")(ZIO.fail("Boom")),
testM("dying test")(ZIO.die(new Exception("KO")))
)
}

lazy val multiLineSpecFQN = MultiLineSpec.getClass.getName
object MultiLineSpec extends DefaultRunnableSpec {
def spec: ZSpec[Environment, Failure] = test("multi-line test") {
Expand Down
29 changes: 22 additions & 7 deletions test-sbt/shared/src/main/scala/zio/test/sbt/ZTestEvent.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package zio.test.sbt

import sbt.testing._
import zio.test.{ExecutedSpec, TestAnnotation, TestFailure, TestSuccess}
import zio.test.{DefaultTestReporter, ExecutedSpec, TestAnnotation, TestAnnotationRenderer, TestFailure, TestSuccess}

final case class ZTestEvent(
fullyQualifiedName: String,
Expand All @@ -22,29 +22,44 @@ object ZTestEvent {
fingerprint: Fingerprint
): Seq[ZTestEvent] = {

def loop(executedSpec: ExecutedSpec[E], labels: List[String]): Seq[ZTestEvent] =
def loop(executedSpec: ExecutedSpec[E], label: Option[String]): Seq[ZTestEvent] =
executedSpec.caseValue match {
case ExecutedSpec.LabeledCase(label, spec) => loop(spec, label :: labels)
case ExecutedSpec.MultipleCase(specs) => specs.flatMap(spec => loop(spec, labels))
case ExecutedSpec.LabeledCase(label, spec) => loop(spec, Some(label))
case ExecutedSpec.MultipleCase(specs) => specs.flatMap(loop(_, label))
case ExecutedSpec.TestCase(result, annotations) =>
Seq(
ZTestEvent(
fullyQualifiedName,
new TestSelector(labels.headOption.getOrElse("")),
new TestSelector(label.getOrElse("")),
toStatus(result),
None,
toThrowable(executedSpec, label, result),
annotations.get(TestAnnotation.timing).toMillis,
fingerprint
)
)
}

loop(executedSpec, List.empty)
loop(executedSpec, None)
}

private def toStatus[E](result: Either[TestFailure[E], TestSuccess]) = result match {
case Left(_) => Status.Failure
case Right(TestSuccess.Succeeded(_)) => Status.Success
case Right(TestSuccess.Ignored) => Status.Ignored
}

private def toThrowable[E](
spec: ExecutedSpec[E],
label: Option[String],
result: Either[TestFailure[E], TestSuccess]
) = result.left.toOption.map {
case TestFailure.Assertion(_) => new AssertionError(render(spec, label))
case TestFailure.Runtime(_) => new RuntimeException(render(spec, label))
}

private def render[E](spec: ExecutedSpec[E], label: Option[String]) = DefaultTestReporter
.render(label.fold(spec)(ExecutedSpec.labeled(_, spec)), TestAnnotationRenderer.default, includeCause = true)
.flatMap(_.rendered)
.mkString("\n")
.replaceAll("\u001B\\[[;\\d]*m", "")
}