Skip to content

Replace the "Coming Soon!" end-to-end testing stub with the actual situation - #599

Open
karl-bullock wants to merge 1 commit into
flarum:mainfrom
karl-bullock:docs-testing-e2e-section
Open

karl-bullock wants to merge 1 commit into
flarum:mainfrom
karl-bullock:docs-testing-e2e-section

Conversation

@karl-bullock

Copy link
Copy Markdown
Member

The testing guide ends with an ## E2E Tests heading whose entire body is Coming Soon!. That has been shipping in the 2.x docs, and nothing in the framework backs it: there is no Playwright, Cypress, Puppeteer or Selenium dependency anywhere in the monorepo, and no e2e directory in core or in any bundled extension. It is a promise with no timeline attached, in a spot where a reader following the page's table of contents lands expecting content.

Rather than delete the heading outright, the section now says what is actually true, which is more useful than either the stub or silence:

  • Flarum ships no end-to-end harness and core does not have one.
  • That is a smaller gap than it sounds, because an integration test already boots a real application and sends a real request through the real middleware stack against a real database.
  • What those tests genuinely cannot reach is the browser: rendering, navigating between pages, and anything that only misbehaves once JavaScript is running.
  • If you need that layer, you are supplying your own tooling and pointing it at a running install. There is nothing Flarum-specific to install.

Cross-references deliberately use #backend-tests and #frontend-tests rather than #using-integration-tests, because "Using Integration Tests" appears twice on this page and so the second one has a positional -1 anchor that moves if a section is added above it. Same reasoning as #595.

If the team would rather keep this as a stub because an E2E harness is actually planned, I am happy to close this instead. I could not find any sign of one in the framework, which is why I assumed not.

Verified with npx docusaurus build --locale en: no errors, and Docusaurus reports no broken anchors on the page.

…tuation

The testing guide ended with an "## E2E Tests" heading whose entire body was "Coming Soon!", which has been shipping in the 2.x docs while nothing in the framework backs it: there is no Playwright, Cypress, Puppeteer or Selenium dependency anywhere in the monorepo, and no e2e directory in core or any bundled extension.

Rather than leave a promise with no timeline behind it, the section now says plainly that Flarum ships no end-to-end harness, points out that integration tests already cover much of the same ground because they boot a real app and exercise real requests against a real database, names what they genuinely cannot reach (the browser, so rendering and navigation), and tells anyone who needs that layer that they are bringing their own tooling and pointing it at a running install.

Cross-references use the two top-level section anchors rather than "Using Integration Tests", which appears twice on the page and therefore has a positional anchor.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant