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.

Sign up for GitHub

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

Jump to bottom

PHPUnit 10 Shift #208

Merged
merged 8 commits into from
Feb 6, 2024
Merged

PHPUnit 10 Shift #208

merged 8 commits into from
Feb 6, 2024

Conversation

nie7321
Copy link
Member

@nie7321 nie7321 commented Feb 6, 2024

This pull request contains changes for upgrading to PHPUnit 10 automated by the PHPUnit 10 Shift.

Before merging, you need to:

  • Checkout the shift-109588 branch
  • Review all pull request comments for additional changes
  • Run composer update (if the scripts fail, add --no-scripts)
  • Run your tests suite: vendor/bin/phpunit

If there were changes you felt could have been automated, please reply to the follow-up email with your feedback or on Twitter.

@laravel-shift
Bump PHPUnit dependencies
ccbba4d
@laravel-shift
Set return type of base TestCase methods
8751520 
From the [PHPUnit 8 release notes][1], the `TestCase` methods below now declare a `void` return type:

- `setUpBeforeClass()`
- `setUp()`
- `assertPreConditions()`
- `assertPostConditions()`
- `tearDown()`
- `tearDownAfterClass()`
- `onNotSuccessfulTest()`

[1]: https://phpunit.de/announcements/phpunit-8.html
@laravel-shift
Ignore PHPUnit cache folder
dbf090a
@laravel-shift
Add return types to test methods
027d017
@laravel-shift
Define test classes as final
4c72def
@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

⚠️ PHPUnit 10 requires PHP version 8.1 or higher. Be sure to verify you met this requirement by running php -v in your test environment.

@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

⚠️ PHPUnit 10 has made several changes to the configuration file. After running composer update, you may run vendor/bin/phpunit --migrate-configuration to have PHPUnit upgrade your configuration file.

@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

ℹ️ PHPUnit has documented using return types for test cases and data providers since PHPUnit 8. In an effort to modernize your test suite, Shift added a return type of void to your test cases and a return type of array to your data providers.

Shift understands developers have different preferences when it comes to type hints. If you do not wish to add return types, you may undo this change by running git revert 027d0174.

@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

ℹ️ PHPUnit has documented declaring test classes as final since PHPUnit 8. In an effort to modernize your test suite, Shift has declared your test classes as final.

Shift understands developers have different preferences when it comes to using final. If you do not wish to declare your test classes as final, you may undo this change by running git revert 4c72def5.

@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

⚠️ PHPUnit 10 now requires any base test class to have a TestCase suffix. In addition, this class should be defined as abstract. If you have a custom base test class, you should ensure it meets these new requirements.

@nie7321
Copy link
Member Author

nie7321 commented Feb 6, 2024

⚗️ This Shift is still being refined. Please report any issues or suggestions to shift@laravelshift.com. Your feedback is what helps improve the experience for everyone.

@nie7321 nie7321 merged commit f2948fb into main Feb 6, 2024
3 checks passed
@nie7321 nie7321 deleted the shift-109588 branch February 6, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nie7321 @laravel-shift