jeckel-lab/clock

Clock abstraction library

1.2.0 2021-08-30 14:55 UTC

This package is auto-updated.

Last update: 2021-12-30 15:38:31 UTC


README

Latest Stable Version Total Downloads Build Status codecov

Clock

A clock abstraction library for PHP which allow to mock system clock when testing

Installation

composer require jeckel-lab/clock

Usage

In your code, always use the JeckelLab\Contract\Infrastructure\System\Clock interface in your services when you need to access the current time. After that, you just have to define which implementation to use according to your environment (real or fake for tests).

In some framework, it can be easier to use the factory to handle the switch and inject the required configuration.

Different fake clock

There are 2 types of fake clock available:

  • frozen: This clock with always return the same value everytime we call it
  • faked: This one will return an incremented time (like a real one) but initiated at the beginning at the script with a defined date time. It's useful to continue to keep track of long process.

Fake clock can both be initiate in 2 different ways:

  • by passing the value of the initial time (fake_time_init value in configuration), This option is useful when you want to always use the same time, or initialize it with an env variable
  • by passing the path to a file where it will read the value of time (fake_time_path). This option is useful when you want to control the time of each of your process when running different tests cases.

Use with Symfony 4 and 5

With SF4 and SF5 we use the internal DI system with the factory. The factory will get different parameters according to the current environment.

Configure DI with a factory in config/services.yaml:

# config/services.yaml
    JeckelLab\Contract\Infrastructure\System\Clock:
        factory: ['JeckelLab\Clock\Factory\ClockFactory', getClock]
        arguments: ['%clock%']

Configure default parameters in config/packages/parameters.yaml:

# config/packages/parameters.yaml
parameters:
    clock:
        mode: real
        timezone: Europe/Paris  # Optional

And then configure parameters for tests environment in config/packages/test/parameters.yaml:

# config/packages/test/parameters.yaml
parameters:
    clock:
        mode: faked
        fake_time_init: '2020-12-11 14:00:00'

or

# config/packages/test/parameters.yaml
parameters:
    clock:
        mode: frozen
        fake_time_path: '%kernel.project_dir%/var/test/fake_clock'
        fallback_to_current_date: true # Default: false, if true and file is not found or has invalid valid, then fallback to RealClock

Test with Codeception

To be able to change current date in your Codeception tests, you first need to configure your fake clock to use the fake_time_path file as a time source.

Next, configure codeception with the provided helper:

# codeception.yaml

# ...
modules:
    config:
        \JeckelLab\Clock\CodeceptionHelper\Clock:
            fake_time_path: 'var/test/fake_clock'   # Required: path where the fake time should be provided to your project
            date_format: 'Y/m/d'  # Optional, date format for date value defined in your tests (default: Y/m/d)
            time_format: 'H:i:s'  # Optional, time format for time value defined in your tests (default: H:i:s)

Enable the helper in your suite:

# acceptance.suite.yml

actor: AcceptanceTester
modules:
    enabled:
        - \JeckelLab\Clock\CodeceptionHelper\Clock

Now you can set the fake time in your tests:

in BDD:

Feature: A feature description

  Scenario: A scenario description
    Given current date is "2021/03/26" and time is "08:35:00"

in other tests:

/** @var \Codeception\Actor $i */
$I->haveCurrentDateAndTime('2021/03/26', '08:35:00');

// or
$I->haveCurrentDateTime(DateTime::createFromFormat("Y/m/d H:i", "2021/03/26 08:35"));