|
|
import path from 'path'; |
|
|
import React from 'react'; |
|
|
|
|
|
import { createCache, extractStyle, StyleProvider } from '@ant-design/cssinjs'; |
|
|
import { extractStaticStyle } from 'antd-style'; |
|
|
import dayjs from 'dayjs'; |
|
|
import fse from 'fs-extra'; |
|
|
import { globSync } from 'glob'; |
|
|
import { JSDOM } from 'jsdom'; |
|
|
import MockDate from 'mockdate'; |
|
|
import type { HTTPRequest, Viewport } from 'puppeteer'; |
|
|
import rcWarning from 'rc-util/lib/warning'; |
|
|
import ReactDOMServer from 'react-dom/server'; |
|
|
|
|
|
import { App, ConfigProvider, theme } from '../../components'; |
|
|
import { fillWindowEnv } from '../setup'; |
|
|
import { render } from '../utils'; |
|
|
import { TriggerMockContext } from './demoTestContext'; |
|
|
|
|
|
jest.mock('../../components/grid/hooks/useBreakpoint', () => () => ({})); |
|
|
|
|
|
const snapshotPath = path.join(process.cwd(), 'imageSnapshots'); |
|
|
fse.ensureDirSync(snapshotPath); |
|
|
|
|
|
const themes = { |
|
|
default: theme.defaultAlgorithm, |
|
|
dark: theme.darkAlgorithm, |
|
|
compact: theme.compactAlgorithm, |
|
|
}; |
|
|
|
|
|
interface ImageTestOptions { |
|
|
onlyViewport?: boolean; |
|
|
ssr?: boolean | string[]; |
|
|
openTriggerClassName?: string; |
|
|
mobile?: boolean; |
|
|
} |
|
|
|
|
|
|
|
|
export default function imageTest( |
|
|
component: React.ReactElement, |
|
|
identifier: string, |
|
|
filename: string, |
|
|
options: ImageTestOptions, |
|
|
) { |
|
|
let doc: Document; |
|
|
let container: HTMLDivElement; |
|
|
|
|
|
beforeAll(async () => { |
|
|
const dom = new JSDOM('<!DOCTYPE html><body></body></html>', { |
|
|
url: 'http://localhost/', |
|
|
}); |
|
|
const win = dom.window; |
|
|
doc = win.document; |
|
|
|
|
|
(global as any).window = win; |
|
|
|
|
|
|
|
|
const keys = [ |
|
|
...Object.keys(win), |
|
|
'HTMLElement', |
|
|
'SVGElement', |
|
|
'ShadowRoot', |
|
|
'Element', |
|
|
'File', |
|
|
'Blob', |
|
|
].filter((key) => !(global as any)[key]); |
|
|
|
|
|
keys.forEach((key) => { |
|
|
(global as any)[key] = win[key]; |
|
|
}); |
|
|
|
|
|
|
|
|
global.ResizeObserver = function FakeResizeObserver() { |
|
|
return { |
|
|
observe() {}, |
|
|
unobserve() {}, |
|
|
disconnect() {}, |
|
|
}; |
|
|
} as unknown as typeof ResizeObserver; |
|
|
|
|
|
|
|
|
global.fetch = function mockFetch() { |
|
|
return { |
|
|
then() { |
|
|
return this; |
|
|
}, |
|
|
catch() { |
|
|
return this; |
|
|
}, |
|
|
finally() { |
|
|
return this; |
|
|
}, |
|
|
}; |
|
|
} as unknown as typeof fetch; |
|
|
|
|
|
|
|
|
win.matchMedia = (() => ({ |
|
|
matches: false, |
|
|
addEventListener: jest.fn(), |
|
|
removeEventListener: jest.fn(), |
|
|
})) as unknown as typeof matchMedia; |
|
|
|
|
|
|
|
|
fillWindowEnv(win); |
|
|
|
|
|
await page.setRequestInterception(true); |
|
|
}); |
|
|
|
|
|
beforeEach(() => { |
|
|
doc.body.innerHTML = `<div id="root"></div>`; |
|
|
container = doc.querySelector<HTMLDivElement>('#root')!; |
|
|
}); |
|
|
|
|
|
function test(name: string, suffix: string, themedComponent: React.ReactElement, mobile = false) { |
|
|
it(name, async () => { |
|
|
const sharedViewportConfig: Partial<Viewport> = { |
|
|
isMobile: mobile, |
|
|
hasTouch: mobile, |
|
|
}; |
|
|
|
|
|
await page.setViewport({ width: 800, height: 600, ...sharedViewportConfig }); |
|
|
|
|
|
const onRequestHandle = (request: HTTPRequest) => { |
|
|
if (['image'].includes(request.resourceType())) { |
|
|
request.abort(); |
|
|
} else { |
|
|
request.continue(); |
|
|
} |
|
|
}; |
|
|
|
|
|
const { openTriggerClassName } = options; |
|
|
|
|
|
const requestListener = (request: any) => onRequestHandle(request as HTTPRequest); |
|
|
|
|
|
MockDate.set(dayjs('2016-11-22').valueOf()); |
|
|
page.on('request', requestListener); |
|
|
await page.goto(`file://${process.cwd()}/tests/index.html`); |
|
|
await page.addStyleTag({ path: `${process.cwd()}/components/style/reset.css` }); |
|
|
await page.addStyleTag({ content: '*{animation: none!important;}' }); |
|
|
|
|
|
const cache = createCache(); |
|
|
|
|
|
const emptyStyleHolder = doc.createElement('div'); |
|
|
|
|
|
let element = ( |
|
|
<StyleProvider cache={cache} container={emptyStyleHolder}> |
|
|
<App>{themedComponent}</App> |
|
|
</StyleProvider> |
|
|
); |
|
|
|
|
|
|
|
|
if (openTriggerClassName) { |
|
|
element = ( |
|
|
<TriggerMockContext.Provider value={{ popupVisible: true }}> |
|
|
{element} |
|
|
</TriggerMockContext.Provider> |
|
|
); |
|
|
} |
|
|
|
|
|
let html: string; |
|
|
let styleStr: string; |
|
|
|
|
|
if ( |
|
|
options.ssr && |
|
|
(options.ssr === true || options.ssr.some((demoName) => filename.includes(demoName))) |
|
|
) { |
|
|
html = ReactDOMServer.renderToString(element); |
|
|
styleStr = extractStyle(cache) + extractStaticStyle(html).map((item) => item.tag); |
|
|
} else { |
|
|
const { unmount } = render(element, { |
|
|
container, |
|
|
}); |
|
|
html = container.innerHTML; |
|
|
styleStr = extractStyle(cache) + extractStaticStyle(html).map((item) => item.tag); |
|
|
|
|
|
unmount(); |
|
|
} |
|
|
|
|
|
|
|
|
if (!mobile) { |
|
|
styleStr = styleStr.replace(/@media\(hover:\s*none\)/g, '@media(hover:not-valid)'); |
|
|
} |
|
|
|
|
|
if (openTriggerClassName) { |
|
|
styleStr += `<style> |
|
|
.${openTriggerClassName} { |
|
|
position: relative !important; |
|
|
left: 0 !important; |
|
|
top: 0 !important; |
|
|
opacity: 1 !important; |
|
|
display: inline-block !important; |
|
|
vertical-align: top !important; |
|
|
} |
|
|
</style>`; |
|
|
} |
|
|
|
|
|
await page.evaluate( |
|
|
(innerHTML: string, ssrStyle: string, triggerClassName?: string) => { |
|
|
const root = document.querySelector<HTMLDivElement>('#root')!; |
|
|
root.innerHTML = innerHTML; |
|
|
const head = document.querySelector<HTMLElement>('head')!; |
|
|
head.innerHTML += ssrStyle; |
|
|
|
|
|
if (triggerClassName) { |
|
|
document.querySelectorAll<HTMLElement>(`.${triggerClassName}`).forEach((node) => { |
|
|
const blockStart = document.createElement('div'); |
|
|
const blockEnd = document.createElement('div'); |
|
|
node.parentNode?.insertBefore(blockStart, node); |
|
|
node.parentNode?.insertBefore(blockEnd, node.nextSibling); |
|
|
}); |
|
|
} |
|
|
}, |
|
|
html, |
|
|
styleStr, |
|
|
openTriggerClassName || '', |
|
|
); |
|
|
|
|
|
if (!options.onlyViewport) { |
|
|
|
|
|
const bodyHeight = await page.evaluate(() => document.body.scrollHeight); |
|
|
|
|
|
|
|
|
rcWarning( |
|
|
bodyHeight < 4096, |
|
|
`[IMAGE TEST] [${identifier}] may cause screenshots to be very long and unacceptable. |
|
|
Please consider using \`onlyViewport: ["filename.tsx"]\`, read more: https://github.com/ant-design/ant-design/pull/52053`, |
|
|
); |
|
|
|
|
|
await page.setViewport({ width: 800, height: bodyHeight, ...sharedViewportConfig }); |
|
|
} |
|
|
|
|
|
const image = await page.screenshot({ |
|
|
fullPage: !options.onlyViewport, |
|
|
}); |
|
|
|
|
|
await fse.writeFile(path.join(snapshotPath, `${identifier}${suffix}.png`), image); |
|
|
|
|
|
MockDate.reset(); |
|
|
page.off('request', requestListener); |
|
|
}); |
|
|
} |
|
|
|
|
|
if (!options.mobile) { |
|
|
Object.entries(themes).forEach(([key, algorithm]) => { |
|
|
const configTheme = { |
|
|
algorithm, |
|
|
token: { |
|
|
fontFamily: 'Arial', |
|
|
}, |
|
|
}; |
|
|
|
|
|
test( |
|
|
`component image screenshot should correct ${key}`, |
|
|
`.${key}`, |
|
|
<div style={{ background: key === 'dark' ? '#000' : '', padding: `24px 12px` }} key={key}> |
|
|
<ConfigProvider theme={configTheme}>{component}</ConfigProvider> |
|
|
</div>, |
|
|
); |
|
|
test( |
|
|
`[CSS Var] component image screenshot should correct ${key}`, |
|
|
`.${key}.css-var`, |
|
|
<div style={{ background: key === 'dark' ? '#000' : '', padding: `24px 12px` }} key={key}> |
|
|
<ConfigProvider theme={{ ...configTheme, cssVar: true }}>{component}</ConfigProvider> |
|
|
</div>, |
|
|
); |
|
|
}); |
|
|
|
|
|
|
|
|
} else { |
|
|
test(identifier, `.mobile`, component, true); |
|
|
test( |
|
|
identifier, |
|
|
`.mobile.css-var`, |
|
|
<ConfigProvider theme={{ cssVar: true }}>{component}</ConfigProvider>, |
|
|
true, |
|
|
); |
|
|
} |
|
|
} |
|
|
|
|
|
type Options = { |
|
|
skip?: boolean | string[]; |
|
|
onlyViewport?: boolean | string[]; |
|
|
|
|
|
ssr?: boolean | string[]; |
|
|
|
|
|
openTriggerClassName?: string; |
|
|
mobile?: string[]; |
|
|
}; |
|
|
|
|
|
|
|
|
export function imageDemoTest(component: string, options: Options = {}) { |
|
|
let describeMethod = options.skip === true ? describe.skip : describe; |
|
|
const files = globSync(`./components/${component}/demo/*.tsx`).filter( |
|
|
(file) => !file.includes('_semantic'), |
|
|
); |
|
|
|
|
|
const mobileDemos: [file: string, node: any][] = []; |
|
|
|
|
|
const getTestOption = (file: string) => ({ |
|
|
onlyViewport: |
|
|
options.onlyViewport === true || |
|
|
(Array.isArray(options.onlyViewport) && options.onlyViewport.some((c) => file.endsWith(c))), |
|
|
ssr: options.ssr, |
|
|
openTriggerClassName: options.openTriggerClassName, |
|
|
}); |
|
|
|
|
|
files.forEach((file) => { |
|
|
if (Array.isArray(options.skip) && options.skip.some((c) => file.endsWith(c))) { |
|
|
describeMethod = describe.skip; |
|
|
} else { |
|
|
describeMethod = describe; |
|
|
} |
|
|
|
|
|
describeMethod(`Test ${file} image`, () => { |
|
|
let Demo = require(`../../${file}`).default; |
|
|
if (typeof Demo === 'function') { |
|
|
Demo = <Demo />; |
|
|
} |
|
|
imageTest(Demo, `${component}-${path.basename(file, '.tsx')}`, file, getTestOption(file)); |
|
|
|
|
|
|
|
|
if ((options.mobile || []).some((c) => file.endsWith(c))) { |
|
|
mobileDemos.push([file, Demo]); |
|
|
} |
|
|
}); |
|
|
}); |
|
|
|
|
|
if (mobileDemos.length) { |
|
|
describeMethod(`Test mobile image`, () => { |
|
|
beforeAll(async () => { |
|
|
await jestPuppeteer.resetPage(); |
|
|
}); |
|
|
|
|
|
mobileDemos.forEach(([file, Demo]) => { |
|
|
imageTest(Demo, `${component}-${path.basename(file, '.tsx')}`, file, { |
|
|
...getTestOption(file), |
|
|
mobile: true, |
|
|
}); |
|
|
}); |
|
|
}); |
|
|
} |
|
|
} |
|
|
|
