Class

org.scalatestplus.testng

TestNGSuite

Related Doc: package testng

Permalink

class TestNGSuite extends TestNGSuiteLike

A suite of tests that can be run with either TestNG or ScalaTest. This class allows you to mark any method as a test using TestNG's @Test annotation, and supports all other TestNG annotations. Here's an example:

import org.scalatest.testng.TestNGSuite
import org.testng.annotations.Test
import org.testng.annotations.Configuration
import scala.collection.mutable.ListBuffer

class MySuite extends TestNGSuite {

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

  @Configuration(beforeTestMethod = true)
  def setUpFixture() {
    sb = new StringBuilder("ScalaTest is ")
    lb = new ListBuffer[String]
  }

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

  @Test(groups = Array("com.mycompany.groups.SlowTest"))
  def funTest() {
    sb.append("fun!")
    assert(sb.toString === "ScalaTest is fun!")
    assert(lb.isEmpty)
  }
}

To execute TestNGSuites with ScalaTest's Runner, you must include TestNG's jar file on the class path or runpath. This version of TestNGSuite was tested with TestNG version 6.3.1.

Linear Supertypes
TestNGSuiteLike, Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
TestNGWrapperSuite
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestNGSuite
  2. TestNGSuiteLike
  3. Suite
  4. Serializable
  5. Serializable
  6. Assertions
  7. TripleEquals
  8. TripleEqualsSupport
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestNGSuite()

    Permalink

Type Members

  1. class CheckingEqualizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport

  2. class Equalizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport

  3. def !==(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport

  4. def !==[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport

  5. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport

  8. def ===(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport

  9. def ===[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  11. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  12. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  13. macro def assertCompiles(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  14. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  15. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  16. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

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

    Permalink
    Definition Classes
    Assertions

  18. macro def assertTypeError(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  19. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  20. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions

  21. def cancel(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  22. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  23. def cancel(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  24. def cancel()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  25. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  27. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  28. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  29. implicit def convertToEqualizer[T](left: T): Equalizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  30. def defaultEquality[A]: Equality[A]

    Permalink
    Definition Classes
    TripleEqualsSupport

  31. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  33. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit

    Permalink
    Definition Classes
    Suite

  34. def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    Suite

  35. def fail(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  36. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  37. def fail(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  38. def fail()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions

  39. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  40. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Assertions

  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  44. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  45. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  46. def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    Suite

  47. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  49. def pending: Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions

  50. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions

  51. def rerunner: Option[String]

    Permalink
    Definition Classes
    Suite

  52. def run(testName: Option[String], args: Args): Status

    Permalink

    Execute this TestNGSuite.

    Execute this TestNGSuite.

    testName

    an optional name of one test to execute. If None, this class will execute all relevant tests. I.e., None acts like a wildcard that means execute all relevant tests in this TestNGSuite.

    args

    the Args for this run

    Definition Classes
    TestNGSuiteLike → Suite

  53. final def runNestedSuites(args: Args): Status

    Permalink

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

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to TestNG 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
    TestNGSuiteLike → Suite
    Exceptions thrown

    UnsupportedOperationException always.

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

    Permalink

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

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to TestNG 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
    TestNGSuiteLike → Suite
    Exceptions thrown

    UnsupportedOperationException always.

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

    Permalink

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

    Throws UnsupportedOperationException, because this method is unused by this trait, given this trait's run method delegates to TestNG 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
    TestNGSuiteLike → Suite
    Exceptions thrown

    UnsupportedOperationException always.

  56. final val styleName: String

    Permalink

    Suite style name.

    Suite style name.

    Definition Classes
    TestNGSuiteLike → Suite

  57. final val succeed: Assertion

    Permalink
    Definition Classes
    Assertions

  58. def suiteId: String

    Permalink
    Definition Classes
    Suite

  59. def suiteName: String

    Permalink
    Definition Classes
    Suite

  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  61. def tags: Map[String, Set[String]]

    Permalink
    Definition Classes
    TestNGSuiteLike → Suite

  62. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Permalink
    Definition Classes
    TestNGSuiteLike → Suite

  63. def testNames: Set[String]

    Permalink
    Definition Classes
    TestNGSuiteLike → Suite

  64. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  65. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  66. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport

  67. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  68. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  69. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  70. def withClue[T](clue: Any)(fun: ⇒ T): T

    Permalink
    Definition Classes
    Assertions

Deprecated Value Members

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

    Permalink
    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]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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 TestNGSuiteLike

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