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

feat(corrections): Unit tests for Corrections functionality #3776

Merged
merged 4 commits into from
Feb 26, 2025

Conversation

Takshil-Kunadia
Copy link
Collaborator

@Takshil-Kunadia Takshil-Kunadia commented Feb 24, 2025

All Submissions:

Changes proposed in this Pull Request:

This PR adds unit tests for the Corrections class methods. The tests cover functionality such as:

Enabling the corrections feature.

  • Adding, updating and deleting corrections.
  • REST route registration and its callback/permission checks.
  • Updating corrections for a post with the REST API.
  • Shortcode handling and output of corrections on post content.

These tests will help ensure that any future changes to the Corrections class maintain expected behavior and improve overall code stability.

How to test the changes in this Pull Request:

  1. Run unit tests specific to corrections class with vendor/bin/phpunit --filter Test_Corrections.

Other information:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you successfully ran tests with your changes locally?

@Takshil-Kunadia Takshil-Kunadia marked this pull request as ready for review February 24, 2025 12:22
@Takshil-Kunadia Takshil-Kunadia requested a review from a team as a code owner February 24, 2025 12:22
Copy link
Member

@naxoc naxoc left a comment

Choose a reason for hiding this comment

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

This looks great!

I added a small comment - feel free to merge once that function is removed (unless you disagree).

Don't forget to use the "Squash and Merge" option when hitting the merge button. :)

/**
* Tear down test fixtures.
*/
public function tear_down() {
Copy link
Member

Choose a reason for hiding this comment

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

This function is not necessary. WP_UnitTestCase cleans up between tests already.

@github-actions github-actions bot added the [Status] Approved The pull request has been reviewed and is ready to merge label Feb 26, 2025

Corrections::init();

self::$post_id = $this->factory->post->create( [ 'post_type' => 'post' ] );
Copy link
Member

Choose a reason for hiding this comment

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

The direct use of the factory field is deprecated. Not a big deal, but also very easy to fix by adding (): There is one more in the file further down too.

Suggested change
self::$post_id = $this->factory->post->create( [ 'post_type' => 'post' ] );
self::$post_id = $this->factory()->post->create( [ 'post_type' => 'post' ] );

@Takshil-Kunadia
Copy link
Collaborator Author

Thanks for taking a look! 🙇 @naxoc. Made the suggested changes ✅ . Merging this PR 🚀

@Takshil-Kunadia Takshil-Kunadia merged commit ae58933 into trunk Feb 26, 2025
7 checks passed
@Takshil-Kunadia Takshil-Kunadia deleted the test/corrections-functionality branch February 26, 2025 14:03
Copy link

Hey @Takshil-Kunadia, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

matticbot pushed a commit that referenced this pull request Feb 27, 2025
# [6.0.0-alpha.2](v6.0.0-alpha.1...v6.0.0-alpha.2) (2025-02-27)

### Bug Fixes

* **memberships:** ensure user membership is linked to the correct subscription ([#3768](#3768)) ([a942616](a942616))
* undo forcing WC order attribution to off ([#3771](#3771)) ([c9cb52a](c9cb52a))
* **woo:** page template meta leaking to other types ([#3782](#3782)) ([325a21c](325a21c))

### Features

* add corrections customize settings ([#3751](#3751)) ([11dbc5e](11dbc5e))
* **corrections:** Unit tests for Corrections functionality ([#3776](#3776)) ([ae58933](ae58933))
* **my-account:** add change email template ([#3772](#3772)) ([32bef3c](32bef3c))
* **my-account:** add pending email change state ([#3763](#3763)) ([c9ba046](c9ba046))
* **my-account:** verify email change ([#3764](#3764)) ([b50c980](b50c980))
@matticbot
Copy link
Contributor

🎉 This PR is included in version 6.0.0-alpha.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released on @alpha [Status] Approved The pull request has been reviewed and is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants