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

Account Protection: Add tests for newly added code #41463

Merged
merged 7 commits into from
Jan 31, 2025

Conversation

ArSn
Copy link
Member

@ArSn ArSn commented Jan 31, 2025

Proposed changes:

  • Add PHP unit test coverage for the new account protection module, as we're lacking test coverage at all so far.

After this PR, test coverage looks as follows:

image

Which means we still have room for improvement. It has to be said though, that some of the methods are for decoupling dependencies, like exiting the script, or doing a static call to the Jetpack Client for the connection API call. It is sad that it is a static method call, but nothing we can easily change in this PR.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

https://github.com/Automattic/jetpack-scan-team/issues/1669

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

As an aside, I think this whole thing might also warrant some E2E tests, but these need to go into the jetpack and protect plugins, and are not part of this PR.

@ArSn ArSn changed the title Created new branch with cherrypicked changes from tests because somet… Account Protection: Add tests for newly added code Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/account-protection-tests-new branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/account-protection-tests-new
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented Jan 31, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jan 31, 2025
*
* @return never
*/
protected function redirect_and_exit( string $redirect_location ) {
Copy link
Member Author

Choose a reason for hiding this comment

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

I added these functions because if you exit; in your code, you'll have a hard time running PHPUnit tests against it. This way, it can be disabled dynamically by the tests.

* @return \WP_User|null The user object.
*/
protected function load_user( int $user_id ) {
return get_user_by( 'ID', $user_id );
Copy link
Member Author

Choose a reason for hiding this comment

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

I tried hard to find a way to solve this with filters or something, but was ultimately unable to do so.

For example, I tried using wp_cache_set so that this function could just read the user from the cache under the hood, but that didn't work with WordDBless.

I even added Brain\Monkey as a dev requirement, however, then found that it does not seem to go well together with WorDBless, as that is loaded first and then the function already exists, so brain monkey can not redefine it.

Happy to hear suggestions for better solutions.

@ArSn ArSn added [Status] Needs Team Review Your teammate needs to review this PR. and removed [Status] In Progress labels Jan 31, 2025
@ArSn ArSn marked this pull request as ready for review January 31, 2025 19:48
@ArSn ArSn requested a review from a team January 31, 2025 19:50
Copy link
Contributor

@dkmyta dkmyta left a comment

Choose a reason for hiding this comment

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

All 45 tests pass running cd projects/packages/account-protection && composer phpunit.

I agree with all the proposed adjustments to class methods and all functionality appears to remain intact.

Very nicely done - a fantastic addition that we can use as a reference and build upon as we go. I'll make a not to consider adding E2Es once the remainder of the features are in place.

@dkmyta dkmyta merged commit 98a8ba7 into add/account-protection Jan 31, 2025
60 checks passed
@dkmyta dkmyta deleted the add/account-protection-tests-new branch January 31, 2025 22:56
@dkmyta dkmyta mentioned this pull request Jan 31, 2025
3 tasks
@github-actions github-actions bot removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] In Progress [Status] Needs Team Review Your teammate needs to review this PR. labels Jan 31, 2025
nateweller pushed a commit that referenced this pull request Feb 20, 2025
* Created new branch with cherrypicked changes from tests because something to screwed up with the base branch.

* Added tests for email service.

* Added tests for account protection module class.

* Added tests for password detection class.

* Added changelog entry.

* Fix PHP 8 consistency issue in test.

* Fixed phan issues.
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.

2 participants