RFC: Added true e2e test suite

[cmraible]

This PR creates a brand new e2e test suite from scratch. The apps/e2e/README.md file included in this PR is the best place to start to get acquainted with:

• What is this new test suite?
• Why do we need another test suite?
• How this test suite works
• How to use this test suite

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[ErisDS]

I would like to see this merged! However, I have additional requirements:

• This suite must be run in CI
• It should be required to pass for all changes
• It must work on PRs from forks (so mocked mode?)

Thoughts?

[cmraible]

I would like to see this merged! However, I have additional requirements:

This suite must be run in CI It should be required to pass for all changes It must work on PRs from forks (so mocked mode?)

@ErisDS No disagreement, makes sense. Just thinking outloud: the main challenge to meeting those criteria is that these tests will depend, at least in part, on using docker compose in CI — ideally for the whole setup including Ghost, but we could also use local Ghost + backing services in compose setup. This setup would be a lighter lift initially, since we aren't currently building the docker image in CI. Does a hybrid approach sound okay to you, for the sake of getting this test suite merged and operational ASAP?

My ideal "dream state" for our CI is that we replace the current setup step with a build step, which builds the docker image, then all the downstream jobs can run their tests against the built image, with whatever backing services are needed running in compose. However, doing that means pretty much a full rewrite of our CI processes, which I'd love to do but probably is out of scope for the sake of this specific change.

[ErisDS]

I am in complete agreement on both the dream end state and intermediate steps 🙌

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 72.48%. Comparing base (69d1dab) to head (ceca727). Report is 191 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #23479      +/-   ##
==========================================
- Coverage   72.48%   72.48%   -0.01%     
==========================================
  Files        1529     1530       +1     
  Lines      111832   111839       +7     
  Branches    13741    13738       -3     
==========================================
+ Hits        81057    81062       +5     
- Misses      29750    29751       +1     
- Partials     1025     1026       +1     

Flag	Coverage Δ
admin-tests	48.59% <ø> (+<0.01%)	:arrow_up:
e2e-tests	72.48% <ø> (-0.01%)	:arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[cmraible]

I've let this PR go stale 🙈

I think the right path forward here is to use this PR as a reference, but start from scratch with a super minimal implementation:

• e2e package created at the top level, same as this
• enough of a docker compose setup to boot Ghost and run the tests locally and in CI
• a simple playwright test that just visits the site's frontend and asserts that it renders

That will give us the foundation of a test suite that we can run locally and in CI, that runs on every PR and must pass before allowing the PR to merge. We can then incrementally add tests and complexity (i.e. run tinybird local) as needed for the tests we plan to write.

[cmraible]

Closing in favor of https://github.com/TryGhost/Ghost/pull/23941