/** * Copyright 2017 Google Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ const fs = require('fs'); const os = require('os'); const path = require('path'); const {helper} = require('../lib/helper'); const rmAsync = helper.promisify(require('rimraf')); const mkdtempAsync = helper.promisify(fs.mkdtemp); const readFileAsync = helper.promisify(fs.readFile); const statAsync = helper.promisify(fs.stat); const TMP_FOLDER = path.join(os.tmpdir(), 'pptr_tmp_folder-'); const utils = require('./utils'); module.exports.addTests = function({testRunner, expect, defaultBrowserOptions, playwright, FFOX, CHROME, WEBKIT}) { const {describe, xdescribe, fdescribe} = testRunner; const {it, fit, xit} = testRunner; const {beforeAll, beforeEach, afterAll, afterEach} = testRunner; describe('Playwright', function() { describe('BrowserFetcher', function() { it.skip(WEBKIT)('should download and extract linux binary', async({server}) => { const downloadsFolder = await mkdtempAsync(TMP_FOLDER); const browserFetcher = playwright.createBrowserFetcher({ platform: 'linux', path: downloadsFolder, host: server.PREFIX }); let revisionInfo = browserFetcher.revisionInfo('123456'); server.setRoute(revisionInfo.url.substring(server.PREFIX.length), (req, res) => { server.serveFile(req, res, '/chromium-linux.zip'); }); expect(revisionInfo.local).toBe(false); expect(browserFetcher.platform()).toBe('linux'); expect(await browserFetcher.canDownload('100000')).toBe(false); expect(await browserFetcher.canDownload('123456')).toBe(true); revisionInfo = await browserFetcher.download('123456'); expect(revisionInfo.local).toBe(true); expect(await readFileAsync(revisionInfo.executablePath, 'utf8')).toBe('LINUX BINARY\n'); const expectedPermissions = os.platform() === 'win32' ? 0666 : 0755; expect((await statAsync(revisionInfo.executablePath)).mode & 0777).toBe(expectedPermissions); expect(await browserFetcher.localRevisions()).toEqual(['123456']); await browserFetcher.remove('123456'); expect(await browserFetcher.localRevisions()).toEqual([]); await rmAsync(downloadsFolder); }); }); describe.skip(WEBKIT || FFOX)('Browser.disconnect', function() { it('should reject navigation when browser closes', async({server}) => { server.setRoute('/one-style.css', () => {}); const browser = await playwright.launch(defaultBrowserOptions); const remote = await playwright.connect({...defaultBrowserOptions, browserWSEndpoint: browser.chromium.wsEndpoint()}); const page = await remote.newPage(); const navigationPromise = page.goto(server.PREFIX + '/one-style.html', {timeout: 60000}).catch(e => e); await server.waitForRequest('/one-style.css'); remote.disconnect(); const error = await navigationPromise; expect(error.message).toBe('Navigation failed because browser has disconnected!'); await browser.close(); }); it('should reject waitForSelector when browser closes', async({server}) => { server.setRoute('/empty.html', () => {}); const browser = await playwright.launch(defaultBrowserOptions); const remote = await playwright.connect({...defaultBrowserOptions, browserWSEndpoint: browser.chromium.wsEndpoint()}); const page = await remote.newPage(); const watchdog = page.waitForSelector('div', {timeout: 60000}).catch(e => e); remote.disconnect(); const error = await watchdog; expect(error.message).toContain('Protocol error'); await browser.close(); }); }); describe('Browser.close', function() { it.skip(WEBKIT || FFOX)('should terminate network waiters', async({context, server}) => { const browser = await playwright.launch(defaultBrowserOptions); const remote = await playwright.connect({...defaultBrowserOptions, browserWSEndpoint: browser.chromium.wsEndpoint()}); const newPage = await remote.newPage(); const results = await Promise.all([ newPage.waitForRequest(server.EMPTY_PAGE).catch(e => e), newPage.waitForResponse(server.EMPTY_PAGE).catch(e => e), browser.close() ]); for (let i = 0; i < 2; i++) { const message = results[i].message; expect(message).toContain('Target closed'); expect(message).not.toContain('Timeout'); } }); }); describe('Playwright.launch', function() { it('should reject all promises when browser is closed', async() => { const browser = await playwright.launch(defaultBrowserOptions); const page = await browser.newPage(); let error = null; const neverResolves = page.evaluate(() => new Promise(r => {})).catch(e => error = e); await browser.close(); await neverResolves; expect(error.message).toContain('Protocol error'); }); it('should reject if executable path is invalid', async({server}) => { let waitError = null; const options = Object.assign({}, defaultBrowserOptions, {executablePath: 'random-invalid-path'}); await playwright.launch(options).catch(e => waitError = e); expect(waitError.message).toContain('Failed to launch'); }); it.skip(WEBKIT)('userDataDir option', async({server}) => { const userDataDir = await mkdtempAsync(TMP_FOLDER); const options = Object.assign({userDataDir}, defaultBrowserOptions); const browser = await playwright.launch(options); // Open a page to make sure its functional. await browser.newPage(); expect(fs.readdirSync(userDataDir).length).toBeGreaterThan(0); await browser.close(); expect(fs.readdirSync(userDataDir).length).toBeGreaterThan(0); // This might throw. See https://github.com/GoogleChrome/puppeteer/issues/2778 await rmAsync(userDataDir).catch(e => {}); }); it.skip(WEBKIT)('userDataDir argument', async({server}) => { const userDataDir = await mkdtempAsync(TMP_FOLDER); const options = Object.assign({}, defaultBrowserOptions); if (CHROME || WEBKIT) { options.args = [ ...(defaultBrowserOptions.args || []), `--user-data-dir=${userDataDir}` ]; } else { options.args = [ ...(defaultBrowserOptions.args || []), `-profile`, userDataDir, ]; } const browser = await playwright.launch(options); expect(fs.readdirSync(userDataDir).length).toBeGreaterThan(0); await browser.close(); expect(fs.readdirSync(userDataDir).length).toBeGreaterThan(0); // This might throw. See https://github.com/GoogleChrome/puppeteer/issues/2778 await rmAsync(userDataDir).catch(e => {}); }); it.skip(WEBKIT)('userDataDir option should restore state', async({server}) => { const userDataDir = await mkdtempAsync(TMP_FOLDER); const options = Object.assign({userDataDir}, defaultBrowserOptions); const browser = await playwright.launch(options); const page = await browser.newPage(); await page.goto(server.EMPTY_PAGE); await page.evaluate(() => localStorage.hey = 'hello'); await browser.close(); const browser2 = await playwright.launch(options); const page2 = await browser2.newPage(); await page2.goto(server.EMPTY_PAGE); expect(await page2.evaluate(() => localStorage.hey)).toBe('hello'); await browser2.close(); // This might throw. See https://github.com/GoogleChrome/puppeteer/issues/2778 await rmAsync(userDataDir).catch(e => {}); }); // This mysteriously fails on Windows on AppVeyor. See https://github.com/GoogleChrome/puppeteer/issues/4111 xit('userDataDir option should restore cookies', async({server}) => { const userDataDir = await mkdtempAsync(TMP_FOLDER); const options = Object.assign({userDataDir}, defaultBrowserOptions); const browser = await playwright.launch(options); const page = await browser.newPage(); await page.goto(server.EMPTY_PAGE); await page.evaluate(() => document.cookie = 'doSomethingOnlyOnce=true; expires=Fri, 31 Dec 9999 23:59:59 GMT'); await browser.close(); const browser2 = await playwright.launch(options); const page2 = await browser2.newPage(); await page2.goto(server.EMPTY_PAGE); expect(await page2.evaluate(() => document.cookie)).toBe('doSomethingOnlyOnce=true'); await browser2.close(); // This might throw. See https://github.com/GoogleChrome/puppeteer/issues/2778 await rmAsync(userDataDir).catch(e => {}); }); it('should return the default arguments', async() => { if (CHROME) { expect(playwright.defaultArgs()).toContain('--no-first-run'); expect(playwright.defaultArgs()).toContain('--headless'); expect(playwright.defaultArgs({headless: false})).not.toContain('--headless'); expect(playwright.defaultArgs({userDataDir: 'foo'})).toContain('--user-data-dir=foo'); } else if (WEBKIT) { expect(playwright.defaultArgs().length).toBe(0); } else { expect(playwright.defaultArgs({browser: 'firefox'})).toContain('-headless'); expect(playwright.defaultArgs({browser: 'firefox', headless: false})).not.toContain('-headless'); expect(playwright.defaultArgs({browser: 'firefox', userDataDir: 'foo'})).toContain('-profile'); expect(playwright.defaultArgs({browser: 'firefox', userDataDir: 'foo'})).toContain('foo'); } }); it('should work with no default arguments', async() => { const options = Object.assign({}, defaultBrowserOptions); options.ignoreDefaultArgs = true; const browser = await playwright.launch(options); const page = await browser.newPage(); expect(await page.evaluate('11 * 11')).toBe(121); await page.close(); await browser.close(); }); it.skip(WEBKIT)('should filter out ignored default arguments', async() => { // Make sure we launch with `--enable-automation` by default. const defaultArgs = playwright.defaultArgs(defaultBrowserOptions); const browser = await playwright.launch(Object.assign({}, defaultBrowserOptions, { // Ignore first and third default argument. ignoreDefaultArgs: [ defaultArgs[0], defaultArgs[2] ], })); const spawnargs = browser.process().spawnargs; expect(spawnargs.indexOf(defaultArgs[0])).toBe(-1); expect(spawnargs.indexOf(defaultArgs[1])).not.toBe(-1); expect(spawnargs.indexOf(defaultArgs[2])).toBe(-1); await browser.close(); }); it.skip(FFOX || WEBKIT)('should have default URL when launching browser', async function() { const browser = await playwright.launch(defaultBrowserOptions); const pages = (await browser.pages()).map(page => page.url()); expect(pages).toEqual(['about:blank']); await browser.close(); }); it.skip(FFOX || WEBKIT)('should have custom URL when launching browser', async function({server}) { const options = Object.assign({}, defaultBrowserOptions); options.args = [server.EMPTY_PAGE].concat(options.args || []); const browser = await playwright.launch(options); const pages = await browser.pages(); expect(pages.length).toBe(1); const page = pages[0]; if (page.url() !== server.EMPTY_PAGE) await page.waitForNavigation(); expect(page.url()).toBe(server.EMPTY_PAGE); await browser.close(); }); it.skip(WEBKIT)('should set the default viewport', async() => { const options = Object.assign({}, defaultBrowserOptions, { defaultViewport: { width: 456, height: 789 } }); const browser = await playwright.launch(options); const page = await browser.newPage(); expect(await page.evaluate('window.innerWidth')).toBe(456); expect(await page.evaluate('window.innerHeight')).toBe(789); await browser.close(); }); it('should disable the default viewport', async() => { const options = Object.assign({}, defaultBrowserOptions, { defaultViewport: null }); const browser = await playwright.launch(options); const page = await browser.newPage(); expect(page.viewport()).toBe(null); await browser.close(); }); it('should take fullPage screenshots when defaultViewport is null', async({server}) => { const options = Object.assign({}, defaultBrowserOptions, { defaultViewport: null }); const browser = await playwright.launch(options); const page = await browser.newPage(); await page.goto(server.PREFIX + '/grid.html'); const screenshot = await page.screenshot({ fullPage: true }); expect(screenshot).toBeInstanceOf(Buffer); await browser.close(); }); }); describe.skip(WEBKIT || FFOX)('Playwright.connect', function() { it('should be able to connect multiple times to the same browser', async({server}) => { const originalBrowser = await playwright.launch(defaultBrowserOptions); const browser = await playwright.connect({ ...defaultBrowserOptions, browserWSEndpoint: originalBrowser.chromium.wsEndpoint() }); const page = await browser.newPage(); expect(await page.evaluate(() => 7 * 8)).toBe(56); browser.disconnect(); const secondPage = await originalBrowser.newPage(); expect(await secondPage.evaluate(() => 7 * 6)).toBe(42, 'original browser should still work'); await originalBrowser.close(); }); it('should be able to close remote browser', async({server}) => { const originalBrowser = await playwright.launch(defaultBrowserOptions); const remoteBrowser = await playwright.connect({ ...defaultBrowserOptions, browserWSEndpoint: originalBrowser.chromium.wsEndpoint() }); await Promise.all([ utils.waitEvent(originalBrowser, 'disconnected'), remoteBrowser.close(), ]); }); it('should support ignoreHTTPSErrors option', async({httpsServer}) => { const originalBrowser = await playwright.launch(defaultBrowserOptions); const browserWSEndpoint = originalBrowser.chromium.wsEndpoint(); const browser = await playwright.connect({...defaultBrowserOptions, browserWSEndpoint, ignoreHTTPSErrors: true}); const page = await browser.newPage(); let error = null; const [serverRequest, response] = await Promise.all([ httpsServer.waitForRequest('/empty.html'), page.goto(httpsServer.EMPTY_PAGE).catch(e => error = e) ]); expect(error).toBe(null); expect(response.ok()).toBe(true); await page.close(); await browser.close(); }); it('should be able to reconnect to a disconnected browser', async({server}) => { const originalBrowser = await playwright.launch(defaultBrowserOptions); const browserWSEndpoint = originalBrowser.chromium.wsEndpoint(); const page = await originalBrowser.newPage(); await page.goto(server.PREFIX + '/frames/nested-frames.html'); originalBrowser.disconnect(); const browser = await playwright.connect({...defaultBrowserOptions, browserWSEndpoint}); const pages = await browser.pages(); const restoredPage = pages.find(page => page.url() === server.PREFIX + '/frames/nested-frames.html'); expect(utils.dumpFrames(restoredPage.mainFrame())).toEqual([ 'http://localhost:/frames/nested-frames.html', ' http://localhost:/frames/frame.html (aframe)', ' http://localhost:/frames/two-frames.html (2frames)', ' http://localhost:/frames/frame.html (dos)', ' http://localhost:/frames/frame.html (uno)', ]); expect(await restoredPage.evaluate(() => 7 * 8)).toBe(56); await browser.close(); }); // @see https://github.com/GoogleChrome/puppeteer/issues/4197#issuecomment-481793410 it('should be able to connect to the same page simultaneously', async({server}) => { const browserOne = await playwright.launch(defaultBrowserOptions); const browserTwo = await playwright.connect({ ...defaultBrowserOptions, browserWSEndpoint: browserOne.chromium.wsEndpoint() }); const [page1, page2] = await Promise.all([ new Promise(x => browserOne.chromium.once('targetcreated', target => x(target.page()))), browserTwo.newPage(), ]); expect(await page1.evaluate(() => 7 * 8)).toBe(56); expect(await page2.evaluate(() => 7 * 6)).toBe(42); await browserOne.close(); }); }); describe('Playwright.executablePath', function() { it('should work', async({server}) => { const executablePath = playwright.executablePath(); expect(fs.existsSync(executablePath)).toBe(true); expect(fs.realpathSync(executablePath)).toBe(executablePath); }); }); }); describe('Top-level requires', function() { it('should require top-level Errors', async() => { const Errors = require(path.join(utils.projectRoot(), '/Errors')); expect(Errors.TimeoutError).toBe(playwright.errors.TimeoutError); }); it('should require top-level DeviceDescriptors', async() => { const Devices = require(path.join(utils.projectRoot(), '/DeviceDescriptors')); expect(Devices['iPhone 6']).toBe(playwright.devices['iPhone 6']); }); }); };