Skip to content

[PhpUnitBridge] Replace "weak-verbose" by "deprecations upper bound" mode #16937

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

Merged
merged 1 commit into from
Dec 11, 2015

Conversation

nicolas-grekas
Copy link
Member

Q A
Bug fix? yes
New feature? yes
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets #16789, #14475
License MIT
Doc PR -

This is a "new feature" that replaces a "new feature" not yet released but merged into 2.8.1. See #16789.
It is way more flexible to be able to specify the upper bound of remaining deprecation notices that you allow in your test suite. This allows lowering this number while deprecations are removed, step after step.

ping @wouterj @Tobion @craue @fabpot @stof

@nicolas-grekas nicolas-grekas changed the title [PhpUnitBridge] Replace "weak-verbose" by "deprecations upper bound" … [PhpUnitBridge] Replace "weak-verbose" by "deprecations upper bound" mode Dec 10, 2015
@@ -28,6 +27,9 @@ public static function register($mode = false)
if (self::$isRegistered) {
return;
}
if (self::MODE_WEAK !== $mode) {
$mode = preg_match('/^[1-9][0-9]*$/', $mode) ? (int) $mode : 0;
Copy link
Member

Choose a reason for hiding this comment

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

this will break the regex filtering feature

Copy link
Member Author

Choose a reason for hiding this comment

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

indeed... fixed!

@stof
Copy link
Member

stof commented Dec 10, 2015

I suggest adding some phpdoc on the register method describing the different accepted values for the mode

@nicolas-grekas
Copy link
Member Author

@stof good idea, done

@craue
Copy link
Contributor

craue commented Dec 10, 2015

I actually like the weak-verbose mode. What's wrong with it? But as long as I just need to set a very high number to achieve the same, I'm fine with it.

@nicolas-grekas
Copy link
Member Author

@craue that's how you can get the equivalent of weak-verbose yes

@wouterj
Copy link
Member

wouterj commented Dec 10, 2015

👍 This is indeed a better solution.

/**
* Registers and configures the deprecation handler.
*
* @param string|int $mode Configures the reporting mode:
Copy link
Member

Choose a reason for hiding this comment

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

the default value false does not match the document types :)

Copy link
Member Author

Choose a reason for hiding this comment

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

default value set to 0

Copy link
Member

Choose a reason for hiding this comment

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

Well, accepting false should be kept, for easy usage with getenv

Copy link
Member Author

Choose a reason for hiding this comment

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

ok :) updated

* - use a number to define the upper bound of allowed deprecations,
* making the test suite fail whenever more notices are trigerred.
*
* @param scalar $mode The reporting mode. Defaults to not allowing any deprecations.
Copy link
Member

Choose a reason for hiding this comment

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

Is scalar supported by common IDEs or should we use int|string|bool instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

you're right, scalar is not a keyword of phpdoc: http://phpdoc.org/docs/latest/references/phpdoc/types.html

@nicolas-grekas nicolas-grekas merged commit 58cd3ee into symfony:2.8 Dec 11, 2015
nicolas-grekas added a commit that referenced this pull request Dec 11, 2015
…s upper bound" mode (nicolas-grekas)

This PR was merged into the 2.8 branch.

Discussion
----------

[PhpUnitBridge] Replace "weak-verbose" by "deprecations upper bound" mode

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #16789, #14475
| License       | MIT
| Doc PR        | -

This is a "new feature" that replaces a "new feature" not yet released but merged into 2.8.1. See #16789.
It is way more flexible to be able to specify the upper bound of remaining deprecation notices that you allow in your test suite. This allows lowering this number while deprecations are removed, step after step.

ping @wouterj @Tobion @craue @fabpot @stof

Commits
-------

58cd3ee [PhpUnitBridge] Replace "weak-verbose" by "deprecations upper bound" mode
@nicolas-grekas nicolas-grekas deleted the max-deprec branch December 11, 2015 09:00
* - use a number to define the upper bound of allowed deprecations,
* making the test suite fail whenever more notices are trigerred.
*
* @param int|string|false $mode The reporting mode. Defaults to not allowing any deprecations.
Copy link
Contributor

Choose a reason for hiding this comment

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

What false does doesn't seem to be defined at all.

This was referenced Dec 26, 2015
wouterj added a commit to symfony-cmf/Testing that referenced this pull request Dec 29, 2015
It's the first release with the deprecations upper bound feature included: symfony/symfony#16937
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants