Scala Test-State.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
core-macros/shared/src
core
doc
dom-zipper-jsoup/src
dom-zipper-selenium
dom-zipper-sizzle/src
dom-zipper
example-react
example-selenium/src/test/scala/teststate/example/selenium
ext-cats/shared/src
ext-nyaya/shared/src/main/scala/teststate
ext-scalajs-react/src/main/scala/teststate
ext-scalaz/shared/src
ext-selenium/src
project
util-selenium/src/main/scala/teststate/selenium/util
util/shared/src
.gitignore
.travis.yml
LICENCE
README.md
TODO.md
build.sbt
version.sbt

README.md

Scala Test-State

Test stateful stuff statelessly, and reasonably.

Build Status

Contents

What is this?

Firstly, a quick mention of what this is not:

  1. This is not a test framework.
    Use it conjunction with ScalaTest, Specs2, μTest, etc.

  2. This is not a property testing library.
    Use it conjunction with ScalaCheck, Nyaya, ScalaProps, etc.

Ok, so what is this? This is a library that:

  1. Lets you write pure, immutable, referentially-transparent tests that verify stateful, effectful code or data.

  2. Encourages composability of test concepts such as invariants/properties, pre/post conditions, dynamic actions/assertions, and more.

  3. Makes test failure and inspection easy to comprehend.

Uses

  • Unit-test a webapp with Scala.JS.
  • Integration testing.
  • UAT automation.
  • Random-test (fuzz-test) like Android's monkeyrunner or ScalaCheck's Command API.
  • Data migration.

Features

  • Compiled for Scala & Scala.JS.
  • Can run synchronously, asynchronously (Future) or in your own context-type (eg IO). Is stack-safe.
  • Everything is immutable and composable.
  • Everything can be transformed into (reused in) different contexts.
  • Combines property and imperative testing.
  • Actions and assertions can be non-deterministic and/or dependent on runtime state.
  • Transparent and informative about test execution.
  • Includes an abstract DomZipper which greatly simplifies the task of HTML/SVG observation.
  • Comes with various DomZipper implementations and backends.
  • Lots of platform-specific utilities for web testing.
  • Configurable error handling. Be impure and throw exceptions or be pure and use a custom ADT to precisely maintain all forms of failure and error in your domain; it's up to you.
  • Extension modules for various 3rd-party libraries. (Scalaz, Cats, more.)

How does this work?

The key is to take observations of anything relevant in the stateful test subject. Observations are like immutable snapshots. They capture what the state was at a particular point in time. Once an observation is captured, assertions are performed on it.

Optionally, you can specify some kind of test-only state that you modify as you test, and use to ensure the real-world observations are what you expect.
For example, if you're testing a bank account app, you could maintain your own expected balance such that when you instruct the app to make a deposit, you add the same amount to your state. You could then add an invariant that whenever the balance is shown in the app, it matches the expected state balance.

This is a (simplified) model of how tests are executed:

concept

When retries are enabled, then test execution is like this.

How do I use this?

Modules

Module Description JVM JS
core The core module. JVM JS
dom-zipper Standalone utility for observing web DOM with precision with conciseness.
This is the base API; concrete implementations below.
JVM JS
dom-zipper-jsoup DOM zipper built on Jsoup. JVM
dom-zipper-selenium DOM zipper built on Selenium.
Also comes with a fast version with uses Jsoup for nearly all operations which is 5-50x faster.
See doc/SELENIUM.md.
JVM
dom-zipper-sizzle DOM zipper built on Sizzle. JS
ext-cats Extensions for Cats. JVM JS
ext-nyaya Extensions for Nyaya. JVM JS
ext-scalajs-react Extensions for scalajs-react. JS
ext-scalaz Extensions for Scalaz. JVM JS
ext-selenium Extensions for Selenium. JVM

Examples

  • Scala.Js + React - Demonstrates DomZipper, invariants, actions, basics.
  • Selenium - Demonstrates Selenium testing of external web content, using retry scheduling (instead of Thread.sleep), parallelism and concurrency.
  • [TODO] DB triggers. - real external state, ref.
  • [TODO] Mutable sample. - fuzz, invariants.

Support

If you like what I do —my OSS libraries, my contributions to other OSS libs, my programming blog— and you'd like to support me, more content, more lib maintenance, please become a patron! I do all my OSS work unpaid so showing your support will make a big difference.