org.scalatest

Tag

class Tag extends AnyRef

Class whose subclasses can be used to tag tests in types FunSuite, Spec, FlatSpec, WordSpec, FeatureSpec, and their sister traits in the org.scalatest.fixture package. For example, if you define:

object SlowTest extends Tag("SlowTest")

then you can tag a test as a SlowTest in a FunSuite or FixtureFunSuite like this:

import org.scalatest.FunSuite

class MySuite extends FunSuite {

test("my test", SlowTest) { Thread.sleep(1000) } }

or in a Spec or FixtureSpec like this:

import org.scalatest.Spec

class MySpec extends Spec {

it("should sleep for a second", SlowTest) { Thread.sleep(1000) } }

or in a FlatSpec or FixtureFlatSpec like this:

import org.scalatest.FlatSpec

class MySpec extends FlatSpec {

it should "sleep for a second" taggedAs(SlowTest) in { Thread.sleep(1000) } }

or in a WordSpec or FixtureWordSpec like this:

import org.scalatest.WordSpec

class MySpec extends WordSpec {

"should sleep for a second" taggedAs(SlowTest) in { Thread.sleep(1000) } }

or in a FeatureSpec or FixtureFeatureSpec like this:

import org.scalatest.FeatureSpec

class MySpec extends FeatureSpec {

scenario("should sleep for a second", SlowTest) { Thread.sleep(1000) } }

Alternatively you can create Tag objects using new or by using the factory method in the Tag object. E.g., using the example scenario from above:

  scenario("should sleep for a second", new Tag("SlowTest"))

or just:

  scenario("should sleep for a second", Tag("SlowTest"))

If you have created Java annotation interfaces for use as tag names in direct subclasses of org.scalatest.Suite, then you may want to use group names on your FunSuites and Specs that match. To do so, simply pass the fully qualified names of the Java interface to the Tag constructor. For example, if you've defined a Java annotation interface with fully qualified name, com.mycompany.testtags.SlowTest, then you could create a matching group for FunSuites like this:

object SlowTest extends Tag("com.mycompany.testtags.SlowTest")

known subclasses: Group
Go to: companion

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
    Go to: companion
  2. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
    Go to: companion
  3. val name: String

  4. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
    Go to: companion

Instance constructors

  1. new Tag(name: String)

  2. new Tag()