com.spotify.scio.testing

JobTest

object JobTest

Set up a Scio job for end-to-end unit testing. To be used in a PipelineSpec. For example:

import com.spotify.scio.testing._

class WordCountTest extends PipelineSpec {

  // Mock input data, mock distributed cache and expected result
  val inData = Seq("a b c d e", "a b a b")
  val distCache = Map(1 -> "Jan", 2 -> "Feb", 3 -> "Mar")
  val expected = Seq("a: 3", "b: 3", "c: 1", "d: 1", "e: 1")

  // Test specification
  "WordCount" should "work" in {
    JobTest("com.spotify.scio.examples.WordCount")
    // Or the type safe version
    // JobTest[com.spotify.scio.examples.WordCount.type]

      // Command line arguments
      .args("--input=in.txt", "--output=out.txt")

      // Mock input data
      .input(TextIO("in.txt"), inData)

      // Mock distributed cache
      .distCache(DistCacheIO("gs://dataflow-samples/samples/misc/months.txt", distCache)

      // Verify output
      .output(TextIO("out.txt")) { actual => actual should containInAnyOrder (expected) }

      // Run job test
      .run()
  }
}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JobTest
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Builder(className: String, cmdlineArgs: Array[String], inputs: Map[TestIO[_], Iterable[_]], outputs: Map[TestIO[_], (SCollection[_]) ⇒ Unit], distCaches: Map[DistCacheIO[_], _]) extends Product with Serializable

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. def apply[T](implicit arg0: ClassTag[T]): Builder

    Create a new JobTest.

    Create a new JobTest.Builder instance.

  7. def apply(className: String): Builder

    Create a new JobTest.

    Create a new JobTest.Builder instance.

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. def isTestId(appName: String): Boolean

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

    Definition Classes
    AnyRef

  18. def newTestId(className: String = "TestClass"): String

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  22. def toString(): String

    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped