Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement the Puppeteer CLI (#11344)
- Loading branch information
Showing
10 changed files
with
226 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| /** | ||
| * Copyright 2023 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. | ||
| */ | ||
|
|
||
| import {CLI, Browser} from '@puppeteer/browsers'; | ||
| import {PUPPETEER_REVISIONS} from 'puppeteer-core/internal/revisions.js'; | ||
|
|
||
| import puppeteer from '../puppeteer.js'; | ||
|
|
||
| // TODO: deprecate downloadPath in favour of cacheDirectory. | ||
| const cacheDir = | ||
| puppeteer.configuration.downloadPath ?? | ||
| puppeteer.configuration.cacheDirectory!; | ||
|
|
||
| void new CLI({ | ||
| cachePath: cacheDir, | ||
| scriptName: 'puppeteer', | ||
| prefixCommand: { | ||
| cmd: 'browsers', | ||
| description: 'Manage browsers of this Puppeteer installation', | ||
| }, | ||
| allowCachePathOverride: false, | ||
| pinnedBrowsers: { | ||
| [Browser.CHROME]: PUPPETEER_REVISIONS.chrome, | ||
| [Browser.FIREFOX]: PUPPETEER_REVISIONS.firefox, | ||
| }, | ||
| }).run(process.argv); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /** | ||
| * Copyright 2023 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. | ||
| */ | ||
|
|
||
| import assert from 'assert'; | ||
| import {spawnSync} from 'child_process'; | ||
| import {existsSync} from 'fs'; | ||
| import {readdir} from 'fs/promises'; | ||
| import {join} from 'path'; | ||
|
|
||
| import {configureSandbox} from './sandbox.js'; | ||
|
|
||
| describe('Puppeteer CLI', () => { | ||
| configureSandbox({ | ||
| dependencies: ['@puppeteer/browsers', 'puppeteer-core', 'puppeteer'], | ||
| env: cwd => { | ||
| return { | ||
| PUPPETEER_CACHE_DIR: join(cwd, '.cache', 'puppeteer'), | ||
| PUPPETEER_SKIP_DOWNLOAD: 'true', | ||
| }; | ||
| }, | ||
| }); | ||
|
|
||
| it('can launch', async function () { | ||
| const result = spawnSync('npx', ['puppeteer', '--help'], { | ||
| // npx is not found without the shell flag on Windows. | ||
| shell: process.platform === 'win32', | ||
| cwd: this.sandbox, | ||
| }); | ||
| assert.strictEqual(result.status, 0); | ||
| assert.ok( | ||
| result.stdout.toString('utf-8').startsWith('puppeteer <command>') | ||
| ); | ||
| }); | ||
|
|
||
| it('can download a browser', async function () { | ||
| assert.ok(!existsSync(join(this.sandbox, '.cache', 'puppeteer'))); | ||
| const result = spawnSync( | ||
| 'npx', | ||
| ['puppeteer', 'browsers', 'install', 'chrome'], | ||
| { | ||
| // npx is not found without the shell flag on Windows. | ||
| shell: process.platform === 'win32', | ||
| cwd: this.sandbox, | ||
| env: { | ||
| ...process.env, | ||
| PUPPETEER_CACHE_DIR: join(this.sandbox, '.cache', 'puppeteer'), | ||
| }, | ||
| } | ||
| ); | ||
| assert.strictEqual(result.status, 0); | ||
| const files = await readdir(join(this.sandbox, '.cache', 'puppeteer')); | ||
| assert.equal(files.length, 1); | ||
| assert.equal(files[0], 'chrome'); | ||
| }); | ||
| }); |