-
-
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
Closed
Closed
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -232,6 +232,48 @@ 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:: | ||
|
||
namespace App; | ||
|
||
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. |
||
class MyClass | ||
{ | ||
public function getTimeInHours() | ||
{ | ||
return time() / 3600; | ||
} | ||
} | ||
|
||
.. code-block:: php | ||
|
||
namespace App\Tests; | ||
|
||
use App\MyClass; | ||
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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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"?