Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,22 +320,22 @@ Upstream's `4982d8d` (#1333, ported with #1224) makes the browser engine's seman
`skills/migrate-to-e2e/` ports upstream's third skill (`e6885dc`, `feat(skills): add migrate-to-e2e (#1109)`, and `6609428`). Install it with `npx skills add hardkoded/e2e-dotnet --skill migrate-to-e2e`; like upstream, it is not bundled in `E2E.Cli`. Differences:

- The source runners are Playwright .NET, Selenium .NET, and Appium (the .NET client or WebdriverIO), with upstream's Node ones (Playwright, Cypress, Detox, Maestro) kept. The `Appium` row of the detection table and its `appium` guide are upstream's (tester-army/e2e#1597); the port adds `Appium.WebDriver` in a `.csproj`. The e2e side is an NUnit or xUnit v3 test project run with `dotnet test`, in place of `e2e.config.ts`, `*.e2e.ts` files, `npx e2e init` (the port's `e2e init` creates the test project), `e2e run --repeat-each 3`, and `e2e list`.
- The migration guides are ported: see [Migration guides](#migration-guides). The skill reads the guide for the source runner first, as upstream's does, and treats "Not yet", "No equivalent", and `missing` as gap markers (tester-army/e2e#1611): a step with a workaround takes it, one without stays in the old runner. The TesterArmy section of `SKILL.md` keeps its inlined MCP commands and agent-call names in C#, and points to the `testerarmy` guide's "Port the project" and "Map each step" tables. The hand-over offers an issue at `hardkoded/e2e-dotnet` in place of `e2e feedback`.
- The migration guides are ported: see [Migration guides](#migration-guides). The skill reads the guide for the source runner first, as upstream's does, and treats the guide's "What e2e doesn't have yet" section as the gap list (tester-army/e2e#1611, #1714): a step with a workaround takes it, one without stays in the old runner. The TesterArmy section of `SKILL.md` keeps its inlined MCP commands and agent-call names in C#, and points to the `testerarmy` guide's "Port the project" and "Map each step" tables. The hand-over offers an issue at `hardkoded/e2e-dotnet` in place of `e2e feedback`.
- Not ported: the plugin copy (`plugins/e2e/skills/migrate-to-e2e`), since the port has no plugin; the `AGENTS.md` and `CONTRIBUTING.md` lines about it map to `CONTRIBUTING.md` here.
- The harness step runs `e2e doctor` and fixes its checks, then `--check-model` when a model is configured (upstream's `npx e2e doctor`, tester-army/e2e#1653). Upstream's note that the doctor needs e2e 0.23.0 or newer is an npm version, so the step names none.
- Upstream added no tests for this skill, so none are ported.
- `docs-site/src/content/docs/coding-agents.mdx` ports upstream's `docs/coding-agents.mdx` for the commands the port has.

## Migration guides

`docs-site/src/content/docs/migrate/` ports upstream's `docs/migrate/*.mdx` (`index`, `playwright`, `selenium`, `cypress`, `appium`, `detox`, `maestro`, `testerarmy`) as read at `7b1b8b27`, with `index`, `detox`, and `maestro` brought to `a016b3e4` (tester-army/e2e#1597, #1579, #1602, #1610, #1618; `8537abc7`, tester-army/e2e#1441; `b81b7d75`, tester-army/e2e#1411; `d52e9b01`, tester-army/e2e#1468; `a60310f9`, tester-army/e2e#1508; `f6d0679f`, tester-army/e2e#1361), and `appium` to `e83fdf9` (tester-army/e2e#1651). They keep upstream's file names, headings, and order. Each guide's tables use the port's C# names, and the sidebar has a Migrate group. Differences:
`docs-site/src/content/docs/migrate/` ports upstream's `docs/migrate/*.mdx` (`index`, `playwright`, `selenium`, `cypress`, `appium`, `detox`, `maestro`, `testerarmy`) as read at `7b1b8b27`, with `index`, `detox`, and `maestro` brought to `a016b3e4` (tester-army/e2e#1597, #1579, #1602, #1610, #1618; `8537abc7`, tester-army/e2e#1441; `b81b7d75`, tester-army/e2e#1411; `d52e9b01`, tester-army/e2e#1468; `a60310f9`, tester-army/e2e#1508; `f6d0679f`, tester-army/e2e#1361), and `appium` to `e83fdf9` (tester-army/e2e#1651). Every guide then takes the "What e2e doesn't have yet" rewrite of `9c9c01f` (tester-army/e2e#1714): Planned, Not yet, and Not planned tables with a workaround, "What differs on purpose", and `Defaults that differ` where upstream has them. `skills/migrate-to-e2e/SKILL.md` points to that section. A row's status follows the port where it differs from upstream: `--shard`, `--watch`, `--step`, the trace page, and `describe` options (`serial`, `.only`) are Not yet in the port, so the rows that use them name the framework's equivalent. They keep upstream's file names, headings, and order. Each guide's tables use the port's C# names, and the sidebar has a Migrate group. Differences:

- The `playwright` guide maps Playwright for .NET (`PageTest`, `ContextOptions()`, `Page.GetByRole(AriaRole...)`), where upstream maps Node Playwright. Playwright .NET has no `playwright.config.ts`, so the config tables map `BrowserNewContextOptions`, `.runsettings`, and the environment variables instead of `testDir`, `webServer`, `projects`, and `reporter`. The `selenium` guide maps Selenium for .NET, where upstream's example is Java. The `cypress`, `detox`, `maestro`, and `testerarmy` guides keep their source runners and write the target in C#, in a new .NET test project beside the old suite. The `appium` guide maps the `mobile:` commands and WebdriverIO calls upstream lists, and shows the Appium .NET client (`Appium.WebDriver`) in its source examples where upstream shows WebdriverIO. Upstream's example project `docs/examples/appium/` (checked by `scripts/check-docs-examples.ts`) has no counterpart: the port's guides hold their snippets inline.
- Every code sample has an NUnit form, and an xUnit v3 form where the two differ. A short NUnit and xUnit table in the overview replaces upstream's `test`, `describe`, hook, tag, and retry names.
- Upstream's `SetupPrompt` card (a copyable prompt) is a `text` block named "Agent prompt". The prompts use `e2e init --yes`, `e2e guide`, `e2e login`, and `dotnet test --filter` in place of `npx e2e init --yes`, `npx e2e guide`, `npx e2e login`, and `npx e2e run`.
- The Detox, Maestro, and Appium prompts have a step that runs `e2e doctor` (upstream's `npx e2e doctor`). Upstream's note that it needs e2e 0.23.0 or newer (tester-army/e2e#1615) is an npm version of upstream's package, so the port's prompts name none.
- Upstream's `CardGroup` and `Card` components are lists of links, and `AccordionGroup` is a heading for each table.
- No counterpart in the port, marked `missing` or `by design` in the tables: `e2e run` and `e2e list` (use `dotnet test`), the `tests`, `workers`, `output`, `--shard`, `--watch`, `--changed-since`, `--repeat-each`, `--max-failures`, and `--update-snapshots` flags and keys (the framework owns selection, retries, and parallelism; `--last-failed` is the `E2E_LAST_FAILED` variable and the `LastFailed` member of the run fixture, see [Test filters](#test-filters)), `describe` options (`serial`, `skip`, `retries`, `timeout`), `test.extend` fixtures and `base.extend` page objects as fixtures (a page object takes `Screen` and `Browser` in a `[SetUp]` or `InitializeAsync`), several targets in one run (the port runs one), the HTML and markdown run summaries, `unique()` as a free function (`Values.Unique`), `credentials` entries for TOTP (`secrets` hold values, not code), and the `inbox` credential. A row names a feature with `Not yet` where the port has no way to do it, such as `.tapBackspaceKey()`, a pinch, or `device.shake()`. The tap `position`, `Screen.TapAtAsync`, and the screen-level `SwipeAsync` are ported and the device engine declares their pointer actions, so the Detox, Maestro, and Appium rows map to them.
- No counterpart in the port, listed under "What e2e doesn't have yet" in each guide: `e2e run` and `e2e list` (use `dotnet test`), the `tests`, `workers`, `output`, `--shard`, `--watch`, `--changed-since`, `--repeat-each`, `--max-failures`, and `--update-snapshots` flags and keys (the framework owns selection, retries, and parallelism; `--last-failed` is the `E2E_LAST_FAILED` variable and the `LastFailed` member of the run fixture, see [Test filters](#test-filters)), `describe` options (`serial`, `skip`, `retries`, `timeout`), `test.extend` fixtures and `base.extend` page objects as fixtures (a page object takes `Screen` and `Browser` in a `[SetUp]` or `InitializeAsync`), several targets in one run (the port runs one), the HTML and markdown run summaries, `unique()` as a free function (`Values.Unique`), `credentials` entries for TOTP (`secrets` hold values, not code), and the `inbox` credential. A row names a feature with `Not yet` where the port has no way to do it, such as `.tapBackspaceKey()`, a pinch, or `device.shake()`. The tap `position`, `Screen.TapAtAsync`, and the screen-level `SwipeAsync` are ported and the device engine declares their pointer actions, so the Detox, Maestro, and Appium rows map to them.
- The `detox`, `maestro`, and `testerarmy` rows that use `ToHaveScreenshotAsync` on a device say the port documents the matcher for the web engine only. Nothing in the port runs it on a device.
- The prompt's step to port `.detoxrc.js` and `config.yaml` into one device target relies on `E2E_MOBILE_PLATFORM` and `E2E_MOBILE_APP_PATH` to switch between iOS and Android, since `e2e.config.json` holds one target (see [MobileAppTest](#mobileapptest-not-in-upstream)).
- The snippets were written against the port's public API and compiled by reading, not run. The docs site build checks the pages, not the C#.
Expand Down
Loading
Loading