-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Changes from 4 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. creates (missing "s") - not need for "only" I suppose |
||
``time()`` you will use the mock instead of the default one. | ||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Extra empty line can be removed. |
||
.. code-block:: php | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can be replaced by There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You mean I can replace
By
How can I show the output of this file locally? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So I can indent also the code-block ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes! |
||
|
||
namespace App\Tests; | ||
|
||
use App\MyClass; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
There was a problem hiding this comment.
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"?