org.scalatestplus.junit5

JUnitSuite

class JUnitSuite extends JUnitSuiteLike

A suite of tests that can be run with either JUnit or ScalaTest. This class allows you to write JUnit 5 tests with ScalaTest's more concise assertion syntax as well as JUnit's assertions (assertEquals, etc.). You create tests by defining methods that are annotated with Test, and can create fixtures with methods annotated with Before and After. For example:

import org.scalatest.junit5.JUnitSuite
import scala.collection.mutable.ListBuffer
import _root_.org.junit.Test
import _root_.org.junit.Before

class TwoSuite extends JUnitSuite {

  var sb: StringBuilder = _
  var lb: ListBuffer[String] = _

  @Before def initialize() {
    sb = new StringBuilder("ScalaTest is ")
    lb = new ListBuffer[String]
  }

  @Test def verifyEasy() {
    sb.append("easy!")
    assert(sb.toString === "ScalaTest is easy!")
    assert(lb.isEmpty)
    lb += "sweet"
  }

  @Test def verifyFun() {
    sb.append("fun!")
    assert(sb.toString === "ScalaTest is fun!")
    assert(lb.isEmpty)
  }
}

To execute JUnitSuites with ScalaTest's Runner, you must include JUnit 5's jar file on the class path or runpath. This version of JUnitSuite was tested with JUnit version 5.9.

Instances of this class are not thread safe.

Source
JUnitSuite.scala
Linear Supertypes
JUnitSuiteLike, AssertionsForJUnit, VersionSpecificAssertionsForJUnit, Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JUnitSuite
  2. JUnitSuiteLike
  3. AssertionsForJUnit
  4. VersionSpecificAssertionsForJUnit
  5. Suite
  6. Serializable
  7. Serializable
  8. Assertions
  9. TripleEquals
  10. TripleEqualsSupport
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JUnitSuite()

Type Members

  1. class CheckingEqualizer[L] extends AnyRef

    Definition Classes
    TripleEqualsSupport
  2. class Equalizer[L] extends AnyRef

    Definition Classes
    TripleEqualsSupport

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Definition Classes
    TripleEqualsSupport
  4. def !==(right: Null): TripleEqualsInvocation[Null]

    Definition Classes
    TripleEqualsSupport
  5. def !==[T](right: T): TripleEqualsInvocation[T]

    Definition Classes
    TripleEqualsSupport
  6. final def ##(): Int

    Definition Classes
    AnyRef → Any
  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  8. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  9. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Definition Classes
    TripleEqualsSupport
  10. def ===(right: Null): TripleEqualsInvocation[Null]

    Definition Classes
    TripleEqualsSupport
  11. def ===[T](right: T): TripleEqualsInvocation[T]

    Definition Classes
    TripleEqualsSupport
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    VersionSpecificAssertionsForJUnit → Assertions
    Annotations
    @macroImpl( ... )
  14. def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    VersionSpecificAssertionsForJUnit → Assertions
    Annotations
    @macroImpl( ... )
  15. def assertCompiles(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  16. def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  17. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
  18. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
  19. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion

    Definition Classes
    Assertions
  20. def assertTypeError(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  21. def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    VersionSpecificAssertionsForJUnit → Assertions
    Annotations
    @macroImpl( ... )
  22. def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    VersionSpecificAssertionsForJUnit → Assertions
    Annotations
    @macroImpl( ... )
  23. def cancel(cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  24. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  25. def cancel(message: String)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  26. def cancel()(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  27. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  29. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  30. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. implicit def convertToEqualizer[T](left: T): Equalizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def defaultEquality[A]: Equality[A]

    Definition Classes
    TripleEqualsSupport
  33. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  35. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit

    Definition Classes
    Suite
  36. def expectedTestCount(filter: Filter): Int

    Returns the number of tests expected to be run by JUnit when run is invoked on this JUnitSuite.

    Returns the number of tests expected to be run by JUnit when run is invoked on this JUnitSuite.

    If tagsToInclude in the passed Filter is defined, this class's implementation of this method returns 0. Else this class's implementation of this method returns the size of the set returned by testNames on the current instance, less the number of tests that were annotated with org.junit.Ignore.

    filter

    a Filter for test filtering

    returns

    number of expected test count

    Definition Classes
    JUnitSuiteLike → Suite
  37. def fail(cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  38. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  39. def fail(message: String)(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  40. def fail()(implicit pos: Position): Nothing

    Definition Classes
    Assertions
  41. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  43. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  44. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T

    Definition Classes
    Assertions
  45. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  46. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  47. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  48. def nestedSuites: IndexedSeq[Suite]

    Definition Classes
    Suite
  49. final def notify(): Unit

    Definition Classes
    AnyRef
  50. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  51. def pending: Assertion with PendingStatement

    Definition Classes
    Assertions
  52. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement

    Definition Classes
    Assertions
  53. def rerunner: Option[String]

    Definition Classes
    Suite
  54. def run(testName: Option[String], args: Args): Status

    Overrides to use JUnit 5 to run the test(s).

    Overrides to use JUnit 5 to run the test(s).

    testName

    an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

    args

    the Args for this run

    returns

    a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.

    Definition Classes
    JUnitSuiteLike → Suite
  55. final def runNestedSuites(args: Args): Status

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to JUnit to run its tests.

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to JUnit to run its tests.

    The main purpose of this method implementation is to render a compiler error an attempt to mix in a trait that overrides runNestedSuites. Because this trait does not actually use runNestedSuites, the attempt to mix in behavior would very likely not work.

    args

    the Args for this run

    Attributes
    protected
    Definition Classes
    JUnitSuiteLike → Suite
    Exceptions thrown
    UnsupportedOperationException

    always.

  56. final def runTest(testName: String, args: Args): Status

    Throws UnsupportedOperationException, because this method is unused by this trait, given this traits's run method delegates to JUnit to run its tests.

    Throws UnsupportedOperationException, because this method is unused by this trait, given this traits's run method delegates to JUnit to run its tests.

    The main purpose of this method implementation is to render a compiler error an attempt to mix in a trait that overrides runTest. Because this trait does not actually use runTest, the attempt to mix in behavior would very likely not work.

    testName

    the name of one test to run.

    args

    the Args for this run

    Attributes
    protected
    Definition Classes
    JUnitSuiteLike → Suite
    Exceptions thrown
    UnsupportedOperationException

    always.

  57. final def runTests(testName: Option[String], args: Args): Status

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to JUnit to run its tests.

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to JUnit to run its tests.

    The main purpose of this method implementation is to render a compiler error an attempt to mix in a trait that overrides runTests. Because this trait does not actually use runTests, the attempt to mix in behavior would very likely not work.

    testName

    an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

    args

    the Args for this run

    Attributes
    protected
    Definition Classes
    JUnitSuiteLike → Suite
    Exceptions thrown
    UnsupportedOperationException

    always.

  58. final val styleName: String

    Suite style name.

    Suite style name.

    returns

    JUnitSuite

    Definition Classes
    JUnitSuiteLike → Suite
  59. final val succeed: Assertion

    Definition Classes
    Assertions
  60. def suiteId: String

    Definition Classes
    Suite
  61. def suiteName: String

    Definition Classes
    Suite
  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  63. def tags: Map[String, Set[String]]

    Overrides to return just tests that have org.

    Overrides to return just tests that have org.junit.Ignore on them, but calls it org.scalatest.Ignore. It also auto-tags suite level annotation.

    Definition Classes
    JUnitSuiteLike → Suite
  64. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Overrides to retrieve suite and test tags from annotations.

    Overrides to retrieve suite and test tags from annotations.

    testName

    the name of the test for which to return a TestData instance

    theConfigMap

    the config map to include in the returned TestData

    returns

    a TestData instance for the specified test, which includes the specified config map

    Definition Classes
    JUnitSuiteLike → Suite
  65. def testNames: Set[String]

    Returns the set of test names that will be executed by JUnit when run is invoked on an instance of this class, or the instance is passed directly to JUnit for running.

    Returns the set of test names that will be executed by JUnit when run is invoked on an instance of this class, or the instance is passed directly to JUnit for running.

    The iterator obtained by invoking elements on this returned Set will produce the test names in their natural order, as determined by String's compareTo method. Nevertheless, this method is not consulted by JUnit when it runs the tests, and JUnit may run the tests in any order.

    Definition Classes
    JUnitSuiteLike → Suite
  66. def toExceptionFunction(message: Option[String]): (StackDepthException) ⇒ Option[String]

    If message or message contents are null, throw a null exception, otherwise create a function that returns the option.

    If message or message contents are null, throw a null exception, otherwise create a function that returns the option.

    Definition Classes
    AssertionsForJUnit
  67. def toString(): String

    Definition Classes
    AnyRef → Any
  68. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  69. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  70. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. def withClue[T](clue: Any)(fun: ⇒ T): T

    Definition Classes
    Assertions

Deprecated Value Members

  1. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  2. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  3. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  4. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Inherited from JUnitSuiteLike

Inherited from AssertionsForJUnit

Inherited from Suite

Inherited from Serializable

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped