Ghost icon indicating copy to clipboard operation
Ghost copied to clipboard

Refactored admin i18n tests

Open ibalosh opened this issue 7 months ago • 2 comments

Related to 2fa e2e tests, I have decided to refactor one more e2e test.

This is using more reusable page objects, and cleans up a bit this test to be more readable. As more tests are added, POM objects will be improved, as it will help figure out which parts of the pages can be reused.

I did not touch things like createPostDraft in this refactor, since that function is reused a lot, and change should be done gradually.

Note: I see that fixtures are setup very deeply down in ghost-test.js and e2e-browser-utils.js , which makes it hard to figure out in this and other tests that user 1 from data generator is used. This should be more flexible, and something to consider to decouple a bit in future.

  • [x] I've read and followed the Contributor Guide
  • [x] I've explained my change
  • [x] I've written an automated test to prove my change works

ibalosh avatar May 25 '25 17:05 ibalosh

Walkthrough

The pull request refactors the end-to-end browser tests for the Ghost admin interface by adopting a page object model. It introduces new page object classes for posts, email previews, and publication language settings, and updates existing page classes to include URL path parameters. The main i18n test is rewritten to utilize these page objects instead of direct Playwright commands and helper functions. Additionally, an index module is created to export all admin page objects for easier imports, and related test files are updated to use this centralized module.

Possibly related PRs

  • TryGhost/Ghost#23006: Refactors asset generation and middleware execution, related to build and deployment processes.
  • TryGhost/Ghost#22946: Moves 2FA feature flag from labs to config and updates tests, related to authentication feature management.
  • TryGhost/Ghost#23370: Introduces new page object classes and updates existing ones, directly related to the test code structure and page interactions.

Suggested labels

browser-tests


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c63e19438c5e05761a57abdd835d20b35296c4d and ad16be275d625b5a73027df8f7b320f3195534a3.

📒 Files selected for processing (1)
  • ghost/core/test/e2e-browser/admin/pages/admin-publication.page.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • ghost/core/test/e2e-browser/admin/pages/admin-publication.page.js
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Setup
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 25 '25 17:05 coderabbitai[bot]

hey @cmraible

I hope you don't mind, I had some spare time last weekend, and I refactored bit more code - to one more existing e2e test. If nothing else, it can be use later in new e2e suite you are working on.

ibalosh avatar May 26 '25 12:05 ibalosh