README.md

joda-time-fake

Provides utilities to fake current time gotten by joda-time. This is useful for test.

Getting started

Add dependency in your build.sbt as the following.

libraryDependencies ++= Seq(
  "com.github.shibayu36" %% "joda-time-fake" % "0.0.2"
)

The library is available on Maven Central. Currently, supported Scala versions are 2.11 and 2.12.

Basic usage

import com.github.shibayu36.jodatimefake.FakeTimer
import org.joda.time.DateTime

// fake by millis
val result = FakeTimer.fake(1515974400000L) {
    println(DateTime.now.toString) // 2018-01-15T00:00:00.000Z
    "hoge"
}

// current time is restored after block
println(DateTime.now.toString) // current time is printed

// You can get the value returned from block
println(result) // hoge

// You can also pass DateTime instance
FakeTimer.fake(new DateTime(2018, 2, 13, 14, 59)) {

}

// You can also pass ISODateTimeFormat
FakeTimer.fake("2018-03-02T12:34:56+09:00") {

}

// If you use fakeWithTimer, a timer instance is passed to block.
// You can advance time using tick() method.
FakeTimer.fakeWithTimer(1515974400000L) { t =>
    println(DateTime.now.toString) // 2018-01-15T00:00:00.000Z
    t.tick(3000) // Advance time by 3000ms
    println(DateTime.now.toString) // 2018-01-15T00:00:03.000Z
}

Usage in parallel test by thread

By extending ExecutionContext with withFakeTimer method, you can use FakeTimer in parallel test.

import com.github.shibayu36.jodatimefake.FakeTimer
import com.github.shibayu36.jodatimefake.Implicits._
import org.joda.time.DateTime
import java.util.concurrent.Executors
import scala.concurrent._

// If you use in parallel test, extend ExecutionContext with withFakeTimer method
implicit val ec = ExecutionContext.fromExecutorService(Executors.newFixedThreadPool(3)).withFakeTimer

// The usage is the same as in Basic Usage
val f1 = Future {
    // fake by millis
    val result = FakeTimer.fake(1515974400000L) {
        println(DateTime.now.toString) // 2018-01-15T00:00:00.000Z
        "hoge"
    }

    // current time is restored after block
    println(DateTime.now.toString) // current time is printed

    // You can get the value returned from block
    println(result) // hoge
}

val f2 = Future {
    FakeTimer.fake(1515974400000L) {
        println(DateTime.now.toString) // 2018-01-15T00:00:00.000Z
        t.tick(3000) // Advance time by 3000ms
        val f = Future {
            // Time is inherited from the parent thread
            println(DateTime.now.toString) // 2018-01-15T00:00:03.000Z
        }
        Await.result(f, duration.Duration.Inf)
        println(DateTime.now.toString) // 2018-01-15T00:00:03.000Z
    }
}

println(DateTime.now.toString) // current time is printed
Await.result(f1 zip f2, duration.Duration.Inf)