[PhpUnitBridge] Doc for @expectedDeprecation & new configuration env vars #7074
Conversation
This file contains 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
This was referenced Oct 21, 2016
stof
reviewed
Oct 21, 2016
| /** | ||
| * @group legacy | ||
| * @expectedDeprecation This "%s" method is deprecated. | ||
| * @expectedDeprecation The second argument of the "%s" method is deprecated. |
There was a problem hiding this comment.
is the order of annotations important ? If they must be in the same order than the triggered deprecation, this should be documented (or changed in the code)
There was a problem hiding this comment.
yes it is, open for discussion for sure
javiereguiluz
approved these changes
Oct 21, 2016
| @@ -18,9 +18,9 @@ It comes with the following features: | |||
|
|
|||
| * Displays the stack trace of a deprecation on-demand; | |||
|
|
|||
| * Provides a ``ClockMock`` helper class for time-sensitive tests. | |||
| * Provides a ``ClockMock`` and ``DnsMock`` helpers class for time or network-sensitive tests. | |||
There was a problem hiding this comment.
helpers class -> helper classes
nicolas-grekas
force-pushed
the
phpunit-new
branch
2 times, most recently
from
db04ea6 to
845d094
Compare
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Oct 21, 2016
…cation` (nicolas-grekas) This PR was merged into the 3.2-dev branch. Discussion ---------- [PhpUnitBridge] Replace ErrorAssert by `@expectedDeprecation` | Q | A | ------------- | --- | Branch? | 3.2 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18880 | License | MIT | Doc PR | symfony/symfony-docs#7074 For 3.2, that's what the feat. freeze is for in this case. ping @xabbuh See https://github.com/symfony/symfony/pull/20255/files?w=1 Commits ------- c344203 [PhpUnitBridge] Drop ErrorAssert in favor of @expectedDeprecation
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Oct 21, 2016
…unit versions (nicolas-grekas) This PR was merged into the 3.2-dev branch. Discussion ---------- [PhpUnitBridge] Allow configuring removed deps and phpunit versions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#7074 Allowing greater reuse of the wrapper. Commits ------- fb1c5b8 [PhpUnitBridge] Allow configuring removed deps and phpunit versions
symfony-splitter
pushed a commit
to symfony/phpunit-bridge
that referenced
this pull request
Oct 21, 2016
…unit versions (nicolas-grekas) This PR was merged into the 3.2-dev branch. Discussion ---------- [PhpUnitBridge] Allow configuring removed deps and phpunit versions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#7074 Allowing greater reuse of the wrapper. Commits ------- fb1c5b8 [PhpUnitBridge] Allow configuring removed deps and phpunit versions
wouterj
requested changes
Oct 21, 2016
| Write Assertions about Deprecations | ||
| ----------------------------------- | ||
|
|
||
| When adding deprecations to your code, you might like writting tests that verify |
| When adding deprecations to your code, you might like writting tests that verify | ||
| that they are triggered as required. To do so, the bridge provides the | ||
| ``@expectedDeprecation`` annotation that you can use on your test methods, | ||
| alongside with the expected message, given in the same format than for the |
There was a problem hiding this comment.
"[...] that you can use on your test methods. It requires you to pass the expected message, [...]"
| ``@expectedDeprecation`` annotation that you can use on your test methods, | ||
| alongside with the expected message, given in the same format than for the | ||
| `PHPUnit assertStringMatchesFormat()`_ method. If you expect more than one | ||
| deprecation messages for a given test method, you can use the annotation several |
| .. tip:: | ||
|
|
||
| Set the ``SYMFONY_PHPUNIT_REMOVE`` env var to ``symfony/yaml`` if you need | ||
| ``prophecy`` but not ``symfony/yaml``. |
There was a problem hiding this comment.
What does "if you need" mean? Am I not able to use Prophecy if I don't set this env var to symfony/yaml?
There was a problem hiding this comment.
Yes: as stated before, the default is to have prophecy and symfony/yaml removed
| that they are triggered as required. To do so, the bridge provides the | ||
| ``@expectedDeprecation`` annotation that you can use on your test methods, | ||
| alongside with the expected message, given in the same format than for the | ||
| `PHPUnit assertStringMatchesFormat()`_ method. If you expect more than one |
There was a problem hiding this comment.
"PHPUnit's assertStringMatchesFormat() method"
nicolas-grekas
force-pushed
the
phpunit-new
branch
from
845d094 to
a1682de
Compare
|
Comments addressed |
wouterj
approved these changes
Oct 23, 2016
|
👍 |
|
Thank you @nicolas-grekas. |
xabbuh
added a commit
that referenced
this pull request
Oct 26, 2016
…iguration env vars (nicolas-grekas) This PR was merged into the master branch. Discussion ---------- [PhpUnitBridge] Doc for @expectedDeprecation & new configuration env vars Related to symfony/symfony#20255 & symfony/symfony#20256 Commits ------- a1682de [PhpUnitBridge] Doc for @expectedDeprecation & new configuration env vars
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to symfony/symfony#20255 & symfony/symfony#20256