How to mock time() function while testing in Laravel?

Question

I'm doing a maths contest project using Laravel. All of the controller methods in the project uses a lot of time() functions.

Questions are returned to the user depending on whether the current time is in between the contest live time.

While writing the feature test and unit tests, how do I mimic the time() functions in the controller so as to set my desired time while running tests for the project?

Answer 1

There is two options that you can do to interact with time:

Option 1: Use Laravel inbuilt function

Note: Laravel Version >= 8

Latest version of Laravel has good method to interact with time:

$this->travel(5)->milliseconds();
$this->travel(5)->seconds();
$this->travel(5)->minutes();
$this->travel(5)->hours();
$this->travel(5)->days();
$this->travel(5)->weeks();
$this->travel(5)->years();

// Travel into the past...
$this->travel(-5)->hours();

// Travel to an explicit time...
$this->travelTo(now()->subHours(6));

// Return back to the present time...
$this->travelBack();

Ref: https://laravel.com/docs/mocking#interacting-with-time

Option 2: Carbon method

Carbon::setTestNow();

Or set any dates

$knownDate = Carbon::create(2001, 5, 21, 12);
Carbon::setTestNow($knownDate); // Or any dates    
echo Carbon::now();  // will show 2001-05-21 12:00:00

Ref: https://laraveldaily.com/carbon-trick-set-now-time-to-whatever-you-want/

Answer 2

I think Carbon should be used instead of time():

Carbon::now()->timestamp // Or just now()->timestamp in 5.5+

You can easily mock Carbon instances.

If you don't use time() a lot, you could also create your own helper:

function timestamp()
{
    if (app()->runningUnitTests()) {
        return ....
    } else {
        return time();
    }
}

And use it instead of time():

timestamp()