Skip to content

Add details on how the ClockMock::register works #8899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,51 @@ test::

And that's all!

.. caution::

The ``@group time-sensitive`` annotation is equivalent to ``ClockMock::register(MyTest::class)``,
so if you want to get a time based function mocked into one of the source code you will need to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

time-based (missing dash)
I don't understand "into one of the source code". Maybe "into another class"?

add it explicitly using ``ClockMock::register(MyClass::class)``. The ``ClockMock::register`` method
only create a mock of the time based functions into the same namespace as your class. So when using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

creates (missing "s") - not need for "only" I suppose
time-based

``time()`` you will use the mock instead of the default one.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra empty line can be removed.

.. code-block:: php
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be replaced by :: at the end of line 241 instead of the dot.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean I can replace

``time()`` you will use the mock instead of the default one.

.. code-block:: php

By

``time()`` you will use the mock instead of the default one::

How can I show the output of this file locally?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, that's what I meant. Fon't bother you can push and let our host hook build the demo, its link will be accessible in the PR checks.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, it isn't deployed on Platform.sh as specified here https://symfony.com/doc/current/contributing/documentation/overview.html#review-your-changes while branch 2.8 is in a maintained branch.


namespace App;

class MyClass
{
public function getTimeInHours()
{
return time() / 3600;
}
}

.. code-block:: php
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the code added here should keep an extra indent to be part of the caution block.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I can indent also the code-block ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!


namespace App\Tests;

use App\MyClass;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please use an alpha order?

use PHPUnit\Framework\TestCase;

/**
* @group time-sensitive
*/
class MyTest extends TestCase
{
public function testGetTimeInHours()
{
ClockMock::register(MyClass::class);

$my = new MyClass();

$result = $my->getTimeInHours();

$this->assertEquals(time() / 3600, $result);
}
}

.. tip::

An added bonus of using the ``ClockMock`` class is that time passes
Expand Down