Temporal Generators

Temporal generators provide the ability to generate Java 8+ Temporal values. These are values related to time and dates.

Temporal API

The Temporal generators follow the Temporal API. This API has three possible subsets depending on the type of temporal value being generated but all follow the same naming structure. The Temporal API is as follows:

The generation scale for each of these values is relative to the scale of Temporal value being generated. For example:

Generate.localTime.distantPast will be on the scale of time and therefore measured in hours.
Generate.localDateTime.distantPast will be on the scale of dates and therefore measured in years.

As with all of the generators you can use the apply method to supply your own ranges. In the case of the Temporal API the apply method takes two functions: A => A. With A being the Temporal type you are generating. Use these to define relative based max and min:

Generate.localDate(min = _.minusDay(10), max = _.plusDays(20))

Date Scale Based Generators

There are three date scale based generators. These are temporal generators that include a date portion. The date scale based generators are:

As discussed above the date scale based generators are measured in a scale of years (in the largest case). Below are the ranges of the Temporal API for date scale based generators:

Time Scale Based Generators

There is only one time scale based generator. These are temporal generators that include time but no date portion. The time scale based generators are:

Time Scale generators are measured in a scale of hours (in the largest case). Below are the ranges of the Temporal API for time scale based generators:

Instant Generator

The instant generator is a unique case within the temporal generators. It is the generator which powers all other temporal generators in TestCharged. It does include both date and time but it is unique in the Java 8+ temporal values. The instant generator is below:

The instant generator is unique in its Temporal API ranges. Below are the ranges for the instant generator:

Now Provider

The default Temporal API is a relative based system. All dates are generated based off of now. Now is determined by an object called a NowProvider. By default the NowProvider will define now using Clock.systemDefaultZone. This can be overridden using the NowDsl.

import com.github.fulrich.testcharged.generators._

class TemporalTesting extends FunSuite with Matchers {
  // Define a NowProvider implicitly for this test suite
  // Generated will use this implicit NowProvider within this test
  implicit val nowForSuite = now(LocalDateTime.of(2018, Month.JUNE, 20, 10, 30))

  test("Override this test only based now provider") {
    // For this test I want to use a one time now provider for this case.
    // I can define it and use it right here
    Generate.localDateTime.distantPast(now(LocalDateTime.of(1990, Month.AUGUST, 20, 10, 10)))
  }
}

If you have a more complex case you can override NowProvider directly instead of using the NowDsl helper.

import com.github.fulrich.testcharged.generators._

class TemporalTesting extends FunSuite with Matchers {
  // Define an entire NowProvider to handle any other cases you might encounter
  implicit val nowForSuite = new NowProvider {
    def apply(): Clock = 
      Clock.fixed(LocalDateTime.of(2018, Month.JUNE, 20, 10, 30).toInstant(ZoneOffset.UTC), ZoneOffset.UTC)
  }
}