Refactor some integration tests

[acicovic]

Description

This PR refactors some integration test functions, as a groundwork for more integration tests work to come.

The most notable change is the introduction of $user_login and $user_role arguments in assert_enqueued_status() functions. This is due to the introduction of the User Role permissions system we've introduced for PCH recently.

Motivation and context

Lay the groundwork to write some more integration tests, and accommodate for the PCH's User Role permissions system.

How has this been tested?

Integration tests pass! 🙂

Summary by CodeRabbit

• New Features

  • Introduced enhanced user role management in tests with clearer method names.
  • Updated asset enqueueing tests to consider user context, improving validation based on user roles and login status.

• Bug Fixes

  • Adjusted test methods to utilize updated user setup methods, ensuring consistent behavior across tests.

• Refactor

  • Streamlined user management methods and parameters, improving clarity and maintainability of test code.

• Documentation

  • Enhanced test descriptions and assertions to reflect new parameters and functionality.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes focus on enhancing test clarity and maintainability by renaming user management methods across various test classes. Key modifications include replacing methods like `set_admin_user()` with more descriptive alternatives such as `set_current_user_to_admin()`, and adding parameters to assert methods to accommodate user roles and logins. This refactor improves code readability, ensuring that user context is explicitly defined in tests, which is crucial for accurate validation of asset enqueueing and API calls. ## Changes | Files | Change Summary | |--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | `tests/Integration/BaseUserMetaEndpointTest.php` | Renamed `set_admin_user()` to `set_current_user_to_admin()` for clarity in user role management. | | `tests/Integration/ContentHelperFeatureTest.php` | Enhanced `assert_enqueued_status` method with user context parameters; added `assert_enqueued_status_default`. | | `tests/Integration/Endpoints/AnalyticsPostsProxyEndpointTest.php` | Replaced `set_admin_user()` with `set_current_user_to_admin()` in multiple test methods for clarity. | | `tests/Integration/Endpoints/EditorSidebarSettingsEndpointTest.php`| Renamed `set_admin_user()` to `set_current_user_to_admin()` for clarity. | | `tests/Integration/Endpoints/ReferrersPostDetailProxyEndpointTest.php`| Updated method names for setting admin user across multiple tests for improved clarity. | | `tests/Integration/Endpoints/StatsPostDetailProxyEndpointTest.php`| Consistently renamed `set_admin_user()` to `set_current_user_to_admin()` across test methods. | | `tests/Integration/ProxyEndpointTest.php` | Changed `login_as_contributor()` to `set_current_user_to_contributor()` for better clarity. | | `tests/Integration/RemoteAPI/AnalyticsPostsRemoteAPITest.php` | Replaced `login_as_contributor()` with `set_current_user_to_contributor()` in API tests for consistency. | | `tests/Integration/ScriptsTest.php` | Renamed `set_admin_user()` to `set_current_user_to_admin()` in several test cases for better readability. | | `tests/Integration/TestCase.php` | Introduced `set_current_user_to()` method for user management; refactored existing methods for clarity. | | `tests/Integration/content-helper/ContentHelperDashboardWidgetTest.php`| Updated `assert_enqueued_status` for explicit user parameters. | | `tests/Integration/content-helper/ContentHelperEditorSidebarTest.php`| Adjusted `assert_enqueued_status` to include user context parameters; refactored for clarity. | | `tests/Integration/content-helper/ContentHelperPostListStatsTest.php`| Modified `set_up` and `assert_enqueued_status` to improve clarity with new parameters for user context. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant T as Test Cases participant U as User Management participant A as Asset Management T->>U: set_current_user_to_admin() U->>U: Verify or create admin user U->>T: Admin user context set T->>A: assert_enqueued_status(user_context) A-->>T: Enqueueing status validated ``` ```mermaid sequenceDiagram participant T as Test Cases participant U as User Management T->>U: set_current_user_to_contributor() U->>U: Verify or create contributor user U->>T: Contributor user context set ```

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.