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

moroine · 2017-12-18T02:09:52Z

Hi,

I got some trouble mocking using the ClockMock feature. After dig into the code, I figure myself how it works !

So I decided to do a PR, but I'm not sure of the formatting,

Hi, I got some trouble mocking using the ClockMock feature. After dig into the code, I figure myself how it works ! So I decided to do a PR, but I'm not sure of the formatting,

OskarStark · 2018-01-23T11:17:04Z

components/phpunit_bridge.rst

+        }
+    }
+
+    class MyClass


no need to add this again, or remove the code sample above

True ! Thanks, I removed it

moroine · 2018-06-27T11:40:57Z

@ndench @OskarStark @Jean85 any update ?

Jean85 · 2018-06-27T13:07:22Z

Build is broken, maybe we should re-trigger it to see if now is ok?

HeahDude

Thanks for your work on this.

HeahDude · 2018-05-06T21:50:03Z

components/phpunit_bridge.rst

+
+.. code-block::
+
+    namespace Tests/App;


App\Tests

HeahDude · 2018-05-06T21:51:25Z

components/phpunit_bridge.rst

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


if you want to mock a time based function into ... or if you want to get a time based function mocked into ...?

HeahDude · 2018-05-06T21:53:50Z

components/phpunit_bridge.rst

+    namespace Tests/App;
+
+    use PHPUnit\Framework\TestCase;
+    use App\MyClass;


Can you please use an alpha order?

moroine · 2018-06-28T09:22:43Z

Thanks for reviewing, just updated according to your feedbacks

HeahDude

Looks good, thanks! last comments from me.

HeahDude · 2018-06-28T09:58:56Z

components/phpunit_bridge.rst

+    only create a mock of the time based functions into the same namespace as your class. So when using
+    ``time()`` you will use the mock instead of the default one.
+
+


Extra empty line can be removed.

HeahDude · 2018-06-28T09:59:30Z

components/phpunit_bridge.rst

+    ``time()`` you will use the mock instead of the default one.
+
+
+.. code-block:: php


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

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?

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.

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.

HeahDude · 2018-06-28T10:00:40Z

components/phpunit_bridge.rst

+        }
+    }
+
+.. code-block:: php


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

So I can indent also the code-block ?

nicolas-grekas · 2018-07-01T08:04:32Z

components/phpunit_bridge.rst

+.. 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


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

nicolas-grekas · 2018-07-01T08:07:15Z

components/phpunit_bridge.rst

+    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


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

nicolas-grekas · 2018-07-01T08:59:03Z

@moroine it could be great to add a note to fix #9620 also btw, could you have a look? This seems very related to me.

moroine · 2018-07-02T02:44:35Z

Done

HeahDude

Thanks!

moroine · 2018-07-13T10:20:04Z

@nicolas-grekas @Jean85 I think it's ready to be merged 👼

This PR was squashed before being merged into the 2.8 branch (closes #8899). Discussion ---------- Add details on how the ClockMock::register works Hi, I got some trouble mocking using the ClockMock feature. After dig into the code, I figure myself how it works ! So I decided to do a PR, but I'm not sure of the formatting, Commits ------- a103731 Add details on how the ClockMock::register works

javiereguiluz · 2018-10-15T10:01:52Z

@moroine thanks for improving this doc! I'm sorry it took us so long to merge it. Also, congrats on your first Symfony Docs contribution!

Add details on how the ClockMock::register works

4df9d4c

Hi, I got some trouble mocking using the ClockMock feature. After dig into the code, I figure myself how it works ! So I decided to do a PR, but I'm not sure of the formatting,

carsonbot added the Status: Needs Review label Dec 18, 2017

OskarStark reviewed Jan 23, 2018

View reviewed changes

Remove duplicated code-block

542b047

xabbuh added the PHPUnitBridge label Jan 28, 2018

ndench approved these changes Apr 24, 2018

View reviewed changes

OskarStark approved these changes Apr 24, 2018

View reviewed changes

Jean85 approved these changes May 6, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 6, 2018

Jean85 mentioned this pull request May 6, 2018

Added support for GitHub reviews symfony-tools/carsonbot#58

Merged

HeahDude suggested changes Jun 28, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Jun 28, 2018

Integrate HeahDude feedbacks

c60d63b

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 28, 2018

Fix travis build

a93b0be

HeahDude reviewed Jun 28, 2018

View reviewed changes

Fix indentation

372867b

nicolas-grekas reviewed Jul 1, 2018

View reviewed changes

HeahDude added Status: Needs Work and removed Status: Needs Review labels Jul 1, 2018

integrate nicolas grekas feedbacks

9ce6bce

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 2, 2018

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jul 2, 2018

HeahDude approved these changes Jul 2, 2018

View reviewed changes

javiereguiluz added this to the 2.8 milestone Oct 15, 2018

javiereguiluz closed this Oct 15, 2018

moroine deleted the patch-1 branch October 23, 2018 08:31

moroine restored the patch-1 branch October 23, 2018 08:32

moroine deleted the patch-1 branch October 23, 2018 08:33

javiereguiluz mentioned this pull request Apr 9, 2019

[PHPUnit Bridge] Time sensitive tests #9620

Closed

		only create a mock of the time based functions into the same namespace as your class. So when using
		``time()`` you will use the mock instead of the default one.

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


		.. code-block:: php

Uh oh!

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

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

Uh oh!

Conversation

moroine commented Dec 18, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moroine commented Jun 27, 2018

Uh oh!

Jean85 commented Jun 27, 2018

Uh oh!

HeahDude left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moroine commented Jun 28, 2018

Uh oh!

HeahDude left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Jul 1, 2018

Uh oh!

moroine commented Jul 2, 2018

Uh oh!

HeahDude left a comment

Choose a reason for hiding this comment

Uh oh!

moroine commented Jul 13, 2018

Uh oh!

javiereguiluz commented Oct 15, 2018

Uh oh!

Uh oh!