Class

org.scalajs.junit.plugin

ScalaJSJUnitPlugin

Related Doc: package plugin

Permalink

class ScalaJSJUnitPlugin extends Plugin

The Scala.js jUnit plugin is a way to overcome the lack of annotation information of any test class (usually accessed through reflection). This is all the information required by the Scala.js testing framework to execute the tests.

As an example we take the following test class:

class Foo {
  @Before def before(): Unit = {
    // Initialize the instance before the tests
  }
  @Test def bar(): Unit = {
    // assert some stuff
  }
  @Ignore("baz not implemented yet") @Test def baz(): Unit = {
    // assert some other stuff
  }
}

object Foo {
  @BeforeClass def beforeClass(): Unit = {
    // Initialize some global state for the tests.
  }
}

Will generate the following bootstrapper module:

object Foo$scalajs$junit$bootstrapper extends org.scalajs.junit.JUnitTestBootstrapper {

  def metadata(): JUnitClassMetadata = {
    new JUnitClassMetadata(
      classAnnotations = List(),
      moduleAnnotations = List(),
      classMethods = List(
          new JUnitMethodMetadata(name = "before",
              annotations = List(new Before)),
          new JUnitMethodMetadata(name = "bar",
              annotations = List(new Test)),
          new JUnitMethodMetadata(name = "baz",
              annotations = List(new Test, new Ignore("baz not implemented yet")))
      ),
      moduleMethods(
          new JUnitMethodMetadata(name = "beforeClass",
              annotations = List(new BeforeClass)))
    )
  }

  def newInstance(): AnyRef = new Foo()

  def invoke(methodName: String): Unit = {
    if (methodName == "0") Foo.beforeClass()
    else throw new NoSuchMethodException(methodId)
  }

  def invoke(instance: AnyRef, methodName: String): Unit = {
    if (methodName == "before") instance.asInstanceOf[Foo].before()
    else if (methodName == "bar") instance.asInstanceOf[Foo].bar()
    else if (methodName == "baz") instance.asInstanceOf[Foo].baz()
    else throw new NoSuchMethodException(methodId)
  }
}

The test framework will identify Foo$scalajs$junit$bootstrapper as a test module because it extends JUnitTestBootstrapper. It will know which methods to run based on the info returned by Foo$scalajs$junit$bootstrapper.metadata, it will create new test instances using Foo$scalajs$junit$bootstrapper.newInstance() and it will invoke test methods using invoke on the bootstrapper.

Linear Supertypes
Plugin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaJSJUnitPlugin
  2. Plugin
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaJSJUnitPlugin(global: Global)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ScalaJSJUnitPluginComponent extends PluginComponent with Transform with Compat210Component

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val components: List[PluginComponent]

    Permalink
    Definition Classes
    ScalaJSJUnitPlugin → Plugin
  8. val description: String

    Permalink
    Definition Classes
    ScalaJSJUnitPlugin → Plugin
  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. val global: Global

    Permalink
    Definition Classes
    ScalaJSJUnitPlugin → Plugin
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. def init(options: List[String], error: (String) ⇒ Unit): Boolean

    Permalink
    Definition Classes
    Plugin
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. val name: String

    Permalink
    Definition Classes
    ScalaJSJUnitPlugin → Plugin
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def options: List[String]

    Permalink
    Definition Classes
    Plugin
  22. val optionsHelp: Option[String]

    Permalink
    Definition Classes
    Plugin
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def processOptions(options: List[String], error: (String) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Plugin
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11) use Plugin#init instead

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped