/** * Copyright 2019 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 { waitEvent } = require('../utils'); const util = require('util'); const fs = require('fs'); const path = require('path'); const os = require('os'); const readFileAsync = util.promisify(fs.readFile); const rmAsync = util.promisify(require('rimraf')); const mkdtempAsync = util.promisify(fs.mkdtemp); const statAsync = util.promisify(fs.stat); const TMP_FOLDER = path.join(os.tmpdir(), 'pptr_tmp_folder-'); module.exports.addTests = function({testRunner, expect, defaultBrowserOptions, playwright, WIN}) { const {describe, xdescribe, fdescribe} = testRunner; const {it, fit, xit} = testRunner; const {beforeAll, beforeEach, afterAll, afterEach} = testRunner; describe('CrPlaywright', function() { describe('Playwright.launch', function() { it('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('userDataDir argument', async({server}) => { const userDataDir = await mkdtempAsync(TMP_FOLDER); const options = Object.assign({}, defaultBrowserOptions); options.args = [ ...(defaultBrowserOptions.args || []), `--user-data-dir=${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('should return the default arguments', async() => { 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'); }); it('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(); }); }); describe('Playwright.launch |browserURL| option', function() { it('should be able to connect using browserUrl, with and without trailing slash', async({server}) => { const originalBrowser = await playwright.launch(Object.assign({}, defaultBrowserOptions, { args: ['--remote-debugging-port=21222'] })); const browserURL = 'http://127.0.0.1:21222'; const browser1 = await playwright.connect({browserURL}); const page1 = await browser1.newPage(); expect(await page1.evaluate(() => 7 * 8)).toBe(56); browser1.disconnect(); const browser2 = await playwright.connect({browserURL: browserURL + '/'}); const page2 = await browser2.newPage(); expect(await page2.evaluate(() => 8 * 7)).toBe(56); browser2.disconnect(); originalBrowser.close(); }); it('should throw when using both browserWSEndpoint and browserURL', async({server}) => { const originalBrowser = await playwright.launch(Object.assign({}, defaultBrowserOptions, { args: ['--remote-debugging-port=21222'] })); const browserURL = 'http://127.0.0.1:21222'; let error = null; await playwright.connect({browserURL, browserWSEndpoint: originalBrowser.chromium.wsEndpoint()}).catch(e => error = e); expect(error.message).toContain('Exactly one of browserWSEndpoint, browserURL or transport'); originalBrowser.close(); }); it('should throw when trying to connect to non-existing browser', async({server}) => { const originalBrowser = await playwright.launch(Object.assign({}, defaultBrowserOptions, { args: ['--remote-debugging-port=21222'] })); const browserURL = 'http://127.0.0.1:32333'; let error = null; await playwright.connect({browserURL}).catch(e => error = e); expect(error.message).toContain('Failed to fetch browser webSocket url from'); originalBrowser.close(); }); it('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 it('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 => {}); }); }); describe('Playwright.launch |pipe| option', function() { it('should support the pipe option', async() => { const options = Object.assign({pipe: true}, defaultBrowserOptions); const browser = await playwright.launch(options); expect((await browser.pages()).length).toBe(1); expect(browser.chromium.wsEndpoint()).toBe(''); const page = await browser.newPage(); expect(await page.evaluate('11 * 11')).toBe(121); await page.close(); await browser.close(); }); it('should support the pipe argument', async() => { const options = Object.assign({}, defaultBrowserOptions); options.args = ['--remote-debugging-pipe'].concat(options.args || []); const browser = await playwright.launch(options); expect(browser.chromium.wsEndpoint()).toBe(''); const page = await browser.newPage(); expect(await page.evaluate('11 * 11')).toBe(121); await page.close(); await browser.close(); }); it('should fire "disconnected" when closing with pipe', async() => { const options = Object.assign({pipe: true}, defaultBrowserOptions); const browser = await playwright.launch(options); const disconnectedEventPromise = new Promise(resolve => browser.once('disconnected', resolve)); // Emulate user exiting browser. browser.process().kill(); await disconnectedEventPromise; }); }); }); describe('Browser target events', function() { it('should work', async({server}) => { const browser = await playwright.launch(defaultBrowserOptions); const events = []; browser.chromium.on('targetcreated', () => events.push('CREATED')); browser.chromium.on('targetchanged', () => events.push('CHANGED')); browser.chromium.on('targetdestroyed', () => events.push('DESTROYED')); const page = await browser.newPage(); await page.goto(server.EMPTY_PAGE); await page.close(); expect(events).toEqual(['CREATED', 'CHANGED', 'DESTROYED']); await browser.close(); }); }); describe('Browser.Events.disconnected', function() { it('should be emitted when: browser gets closed, disconnected or underlying websocket gets closed', async() => { const originalBrowser = await playwright.launch(defaultBrowserOptions); const browserWSEndpoint = originalBrowser.chromium.wsEndpoint(); const remoteBrowser1 = await playwright.connect({browserWSEndpoint}); const remoteBrowser2 = await playwright.connect({browserWSEndpoint}); let disconnectedOriginal = 0; let disconnectedRemote1 = 0; let disconnectedRemote2 = 0; originalBrowser.on('disconnected', () => ++disconnectedOriginal); remoteBrowser1.on('disconnected', () => ++disconnectedRemote1); remoteBrowser2.on('disconnected', () => ++disconnectedRemote2); await Promise.all([ waitEvent(remoteBrowser2, 'disconnected'), remoteBrowser2.disconnect(), ]); expect(disconnectedOriginal).toBe(0); expect(disconnectedRemote1).toBe(0); expect(disconnectedRemote2).toBe(1); await Promise.all([ waitEvent(remoteBrowser1, 'disconnected'), waitEvent(originalBrowser, 'disconnected'), originalBrowser.close(), ]); expect(disconnectedOriginal).toBe(1); expect(disconnectedRemote1).toBe(1); expect(disconnectedRemote2).toBe(1); }); }); describe('BrowserFetcher', function() { it('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 = WIN ? 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); }); }); };