Skip to content

e2e

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

e2e

readme.md

E2E Testing

Cimo's end-to-end tests verify client-side upload interception, settings, post-upload stats, freemium chrome, and (when premium is mounted) bulk optimization across WordPress admin.

WordPress is provided by @wp-playground/cli (WASM PHP + SQLite, no Docker). Playwright's webServer boots it automatically before the suite runs.

Prerequisites

Just Node 20+ — no Docker, Composer, or separate WordPress install.

For premium specs you also need pro__premium_only/ checked out under the free plugin root (clone bfintal/cimo-premium into that directory). Playground mounts the plugin tree as a real directory, so a symlink that points outside the mount will not expose premium files inside WASM PHP.

For Elementor specs, run npm run e2e:fetch-elementor once (or use test:e2e:elementor, which fetches automatically) so e2e/fixtures/plugins/elementor.zip exists. Playground installs that local zip.

Usage

Free suite

Build the plugin assets first (Playground mounts this repo; enqueue needs build/):

npm run build:e2e

Run free e2e tests (Playground starts on port 9410 if nothing is already listening):

npm run test:e2e

or with the Playwright UI:

npm run test:debug

Premium suite

# Mount premium (once), e.g.:
# ln -sfn /path/to/cimo-premium pro__premium_only

npm run build:e2e:premium
npm run test:e2e:premium

or with the Playwright UI:

npm run test:debug:premium

Premium uses port 9411, playwright.premium.config.js, and e2e/playground-blueprint.premium.json (seeds a mock Freemius premium plan).

Elementor suite

npm run build:e2e
npm run test:e2e:elementor

Elementor uses port 9412, playwright.elementor.config.js, and e2e/playground-blueprint.elementor.json. The suite installs Elementor from a local zip at e2e/fixtures/plugins/elementor.zip (gitignored). test:e2e:elementor fetches that zip automatically via scripts/fetch-elementor-fixture.js.

After premium builds, restore the free build type if you need free packaging:

node scripts/update-build-type.js free

Locally, Playwright reuses an already-running Playground on the suite's port when present (fast repeat runs). In CI it always boots fresh. If a stale instance is misbehaving after editing PHP/JS that Playground mounted at boot, kill whatever is listening on that port and re-run.

Optional overrides (defaults differ per config):

WP_PORT=9410          # free; premium config defaults to 9411
WP_BASE_URL=http://127.0.0.1:9410
WP_USERNAME=admin
WP_PASSWORD=password

CI

Repo Workflow Suites
Free (gambitph/Cimo) .github/workflows/e2e-tests.yml Free (build:e2e → test:e2e) and Elementor (test:e2e:elementor, parallel job with PWDEBUG=console)
Premium (bfintal/cimo-premium) pro__premium_only/.github/workflows/e2e-tests.yml Free then premium (checks out free as root + premium as pro__premium_only/)

What is covered

Free

Surface Flow
Image block Upload button → JPG → WebP
Image block Media Library modal drop → JPG → WebP
Block editor Drop JPG on canvas → WebP image block
Page sidebar Drop JPG on Featured Image → WebP
Media → Add New File picker → JPG → WebP in library
Settings Load/save, quality + max dimension affect upload
Settings Recommended / Reset image presets
Settings Stats rise after optimized uploads
General WP automatic scaling on/off for oversized uploads
General Thumbnail generation on/off (intermediate sizes)
Quality Lower WebP quality → smaller file than higher quality
Already-WebP Re-upload stays image/webp
Animated WebP GIF → animated WebP; still GIF → still WebP; animated WebP stays animated; transparent GIF keeps alpha
Media Library grid Drop → WebP
Media modal Select Files → WebP
PNG / multi-file Convert to WebP
Progress modal Cancel when visible
Post-upload Sidebar stats + attachment meta box
Freemium Locked premium sections (LQIP/video/audio/SVG/stealth), bulk upsell, plugins links
Developer API Frontend enqueue + PHP selectors convert JPG → WebP; unrelated inputs stay JPEG; optimizeFiles() returns WebP + metadata
Elementor Image widget media upload → WebP

Premium (e2e/tests/premium/)

Surface Flow
Settings Gated controls enabled; LQIP/video/audio/stealth present; no upsell/placeholders
Bulk optimizer Progress to 100%, stop mid-run, one-by-one, search, restore, filters, view original vs optimized sizes, skipped excluded from 100%
Smart optimization On by default; smaller uploads than quality-only mode
Media uploads MP4 and MP3 optimize on Media → Add New
Media uploads Video/audio stay near-original when optimization disabled
Optimization toggle Off → JPG stays JPEG; On → WebP
Optimize All Frontend <input type="file"> converts JPG → WebP
SVG / HEIC SVG optimizes in place; HEIC → WebP
LQIP Published image block gets data-cimo-lqip-src
Stealth Hides sidebar/meta branding; toggle says Media Optimization

Files

Path Role
../playwright.config.js Free suite; Playground on 9410; ignores tests/premium/ and tests/elementor/; mounts e2e/fixtures/mu-plugins
../playwright.premium.config.js Premium suite; Playground on 9411
../playwright.elementor.config.js Elementor smoke; Playground on 9412
playground-blueprint.json Login + activate Cimo (free)
fixtures/mu-plugins/ Free-suite mu-plugin that registers integrator selectors and enqueues Cimo on Dev API e2e pages
playground-blueprint.premium.json Activate + seed Freemius premium plan
playground-blueprint.elementor.json Install Elementor + activate Cimo
config/global-setup.js Cookie-authenticates via RequestUtils.setup(), persists storageState
test-utils/ Shared fixtures + upload/settings/drop helpers
tests/*.spec.ts Free browser specs
tests/premium/*.spec.ts Premium browser specs
tests/elementor/*.spec.ts Elementor browser specs
.auth/ Gitignored; written by global setup

Troubleshooting

  • browserType.launch: Executable doesn't exist — run npx playwright install chromium once per machine.
  • Stale plugin behaviour after editing PHP — Playground snapshots the mount at boot. Stop the process on the suite port and re-run.
  • Composer/settings never appear / cimoSettings missing — run npm run build:e2e (or build:e2e:premium) so build/admin/ exists for enqueue.
  • Premium suite missing Bulk Optimizer — ensure pro__premium_only/ is present, CIMO_BUILD is premium, and the Freemius seed in the premium blueprint applied. Kill any stale Playground on port 9411 so the blueprint re-runs.

Dev Notes