mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-23 14:01:20 +08:00
3086c9c1ad
Issue number: N/A --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> In addition to migrating away from `toMatchSnapshot` as found in PRs such as https://github.com/ionic-team/ionic-framework/pull/28083, I think it would be valuable to have a lint rule to prevent developers from accidentally using this API in the future. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - Adds a lint rule which errors if `toMatchSnapshot` is being used in `*.e2e.ts` files. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> ~Note: This PR's lint step will continue to fail until the remaining `toHaveScreenshot` migration PRs have been merged. Do note merge this PR until that has been completed.~ All set! --------- Co-authored-by: Brandy Carney <brandyscarney@users.noreply.github.com>
96 lines
2.3 KiB
TypeScript
96 lines
2.3 KiB
TypeScript
import type { PlaywrightTestConfig, PlaywrightTestOptions, PlaywrightWorkerOptions, Project } from '@playwright/test';
|
|
import { devices, expect } from '@playwright/test';
|
|
|
|
import { matchers } from './src/utils/test/playwright';
|
|
|
|
expect.extend(matchers);
|
|
|
|
const projects: Project<PlaywrightTestOptions, PlaywrightWorkerOptions>[] = [
|
|
{
|
|
/**
|
|
* This is really just desktop Firefox
|
|
* but with a mobile viewport.
|
|
*/
|
|
name: 'Mobile Firefox',
|
|
use: {
|
|
browserName: 'firefox',
|
|
/**
|
|
* This is the Pixel 5 configuration.
|
|
* We can't use devices['Pixel 5']
|
|
* because the "isMobile" option is
|
|
* not supported on Firefox.
|
|
*/
|
|
viewport: {
|
|
width: 393,
|
|
height: 727
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'Mobile Chrome',
|
|
use: {
|
|
browserName: 'chromium',
|
|
...devices['Pixel 5']
|
|
}
|
|
},
|
|
{
|
|
name: 'Mobile Safari',
|
|
use: {
|
|
browserName: 'webkit',
|
|
...devices['iPhone 12']
|
|
}
|
|
}
|
|
];
|
|
|
|
/**
|
|
* See https://playwright.dev/docs/test-configuration.
|
|
*/
|
|
const config: PlaywrightTestConfig = {
|
|
testMatch: '*.e2e.ts',
|
|
expect: {
|
|
/**
|
|
* Maximum time expect() should wait for the condition to be met.
|
|
* For example in `await expect(locator).toHaveText();`
|
|
*/
|
|
timeout: 5000,
|
|
toHaveScreenshot: {
|
|
threshold: 0.1
|
|
}
|
|
},
|
|
/* Fail the build on CI if you accidentally left test.only in the source code. */
|
|
forbidOnly: !!process.env.CI,
|
|
maxFailures: 0,
|
|
retries: 2,
|
|
reportSlowTests: null,
|
|
/* Opt out of parallel tests on CI. */
|
|
workers: process.env.CI ? 1 : undefined,
|
|
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
|
reporter: [
|
|
['html'],
|
|
['github']
|
|
],
|
|
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
|
|
use: {
|
|
/* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
|
|
actionTimeout: 0,
|
|
/**
|
|
* All failed tests should create
|
|
* a trace file for easier debugging.
|
|
*
|
|
* See https://playwright.dev/docs/trace-viewer
|
|
*/
|
|
trace: 'retain-on-failure',
|
|
baseURL: 'http://localhost:3333',
|
|
},
|
|
|
|
/* Configure projects for major browsers */
|
|
projects,
|
|
webServer: {
|
|
command: 'serve -p 3333',
|
|
port: 3333,
|
|
reuseExistingServer: !process.env.CI
|
|
}
|
|
};
|
|
|
|
export default config;
|