Skip to content
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

Tests/NamedFunctionCallArgumentsTest: various improvements #267

Merged
merged 5 commits into from
Jan 14, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jan 14, 2024

Description

Tests/NamedFunctionCallArgumentsTest: improve test markers

Make the test marker names more descriptive.

Tests/NamedFunctionCallArgumentsTest: normalize data provider arrays

... to improve scannability of the test cases covered.

See #225

Tests/NamedFunctionCallArgumentsTest: fix test description

Tests/NamedFunctionCallArgumentsTest: use named data sets

With non-named data sets, when a test fails, PHPUnit will display the number of the test which failed.

With tests which have a lot of data sets, this makes it interesting (and time-consuming) to debug those, as one now has to figure out which of the data sets in the data provider corresponds to that number.

Using named data sets makes debugging failing tests more straight forward as PHPUnit will display the data set name instead of the number.
Using named data sets also documents what exactly each data set is testing.

Aside from adding the data set name, this commit also adds the parameter name for each item in the data set, this time in an effort to make it more straight forward to update and add tests as it will be more obvious what each key in the data set signifies.

Include making the data type in the docblock more specific.

Tests/NamedFunctionCallArgumentsTest: activate two test cases

These test cases already existed in the test case file, but were not being run as tests.

Fixed now.

Suggested changelog entry

N/A

jrfnl added 5 commits January 14, 2024 06:35
Make the test marker names more descriptive.
... to improve scannability of the test cases covered.

See 225
With non-named data sets, when a test fails, PHPUnit will display the number of the test which failed.

With tests which have a _lot_ of data sets, this makes it _interesting_ (and time-consuming) to debug those, as one now has to figure out which of the data sets in the data provider corresponds to that number.

Using named data sets makes debugging failing tests more straight forward as PHPUnit will display the data set name instead of the number.
Using named data sets also documents what exactly each data set is testing.

Aside from adding the data set name, this commit also adds the parameter name for each item in the data set, this time in an effort to make it more straight forward to update and add tests as it will be more obvious what each key in the data set signifies.

Include making the data type in the docblock more specific.
These test cases already existed in the test case file, but were not being run as tests.

Fixed now.
@jrfnl jrfnl added this to the 3.8.x Next milestone Jan 14, 2024
@jrfnl jrfnl merged commit 8ecd89e into master Jan 14, 2024
46 checks passed
@jrfnl jrfnl deleted the feature/tests-namedfunctioncallargs-improvements branch January 14, 2024 05:54
@jrfnl jrfnl modified the milestones: 3.8.x Next, 3.9.0 Jan 19, 2024
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.

1 participant