헤드리스 Chrome 시작하기

에릭 비델만
Twitter GitHub 홈페이지

요약

헤드리스 Chrome은 Chrome 59에서 출시됩니다. 헤드리스 환경에서 Chrome 브라우저를 실행하는 방법입니다. Chrome 없이 Chrome을 실행하는 것이죠 이 도구는 Chromium 및 Blink 렌더링 엔진에서 제공하는 모든 최신 웹 플랫폼 기능을 명령줄에 제공합니다.

그것이 왜 유용한가요?

헤드리스 브라우저는 가시적인 UI 셸이 필요하지 않은 서버 환경을 자동화하고 테스트하는 데 유용한 도구입니다. 예를 들어 실제 웹페이지에 대해 테스트를 실행하거나, PDF를 만들거나, 브라우저에서 URL을 렌더링하는 방법만 검사해야 할 수 있습니다.

헤드리스 시작하기 (CLI)

헤드리스 모드를 시작하는 가장 쉬운 방법은 명령줄에서 Chrome 바이너리를 여는 것입니다. Chrome 59 이상이 설치되어 있다면 --headless 플래그를 사용하여 Chrome을 시작합니다.

chrome \
--headless \                   # Runs Chrome in headless mode.
--disable-gpu \                # Temporarily needed if running on Windows.
--remote-debugging-port=9222 \
https://www.chromestatus.com   # URL to open. Defaults to about:blank.

chrome이(가) Chrome 설치를 가리켜야 합니다. 정확한 위치는 플랫폼마다 다릅니다. 저는 Mac을 사용 중이므로 설치한 Chrome 버전별로 편리한 별칭을 만들었습니다

Chrome의 공개 버전 채널을 사용 중이며 베타를 다운로드할 수 없는 경우 chrome-canary를 사용하는 것이 좋습니다.

alias chrome="/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome"
alias chrome-canary="/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary"
alias chromium="/Applications/Chromium.app/Contents/MacOS/Chromium"

여기에서 Chrome Canary를 다운로드합니다.

명령줄 기능

경우에 따라 헤드리스 Chrome을 프로그래매틱 방식으로 스크립트 작성할 필요가 없을 수도 있습니다. 일반적인 작업을 실행하는 데 유용한 유용한 명령줄 플래그가 있습니다.

DOM 인쇄

--dump-dom 플래그는 document.body.innerHTML를 stdout에 출력합니다.

    chrome --headless --disable-gpu --dump-dom https://www.chromestatus.com/

PDF 만들기

--print-to-pdf 플래그는 페이지의 PDF를 만듭니다.

chrome --headless --disable-gpu --print-to-pdf https://www.chromestatus.com/

스크린샷 촬영

페이지의 스크린샷을 캡처하려면 --screenshot 플래그를 사용합니다.

chrome --headless --disable-gpu --screenshot https://www.chromestatus.com/

# Size of a standard letterhead.
chrome --headless --disable-gpu --screenshot --window-size=1280,1696 https://www.chromestatus.com/

# Nexus 5x
chrome --headless --disable-gpu --screenshot --window-size=412,732 https://www.chromestatus.com/

--screenshot를 사용하여 실행하면 현재 작업 디렉터리에 screenshot.png라는 파일이 생성됩니다. 전체 페이지 스크린샷을 찾고 싶다면 조금 더 복잡합니다 David Schnurr의 블로그 게시물을 참고해 보세요. 헤드리스 Chrome을 자동화된 스크린샷 도구로 사용 을 확인하세요.

REPL 모드 (읽기-평가-인쇄 루프)

--repl 플래그는 브라우저에서 명령줄에서 바로 JS 표현식을 평가할 수 있는 모드에서 헤드리스로 실행됩니다.

$ chrome --headless --disable-gpu --repl --crash-dumps-dir=./tmp https://www.chromestatus.com/
[0608/112805.245285:INFO:headless_shell.cc(278)] Type a Javascript expression to evaluate or "quit" to exit.
>>> location.href
{"result":{"type":"string","value":"https://www.chromestatus.com/features"}}
>>> quit
$

브라우저 UI 없이 Chrome을 디버깅하시나요?

--remote-debugging-port=9222로 Chrome을 실행하면 DevTools 프로토콜이 사용 설정된 상태로 인스턴스가 시작됩니다. 프로토콜은 Chrome과 통신하고 헤드리스 브라우저 인스턴스를 구동하는 데 사용됩니다. 또한 Sublime, VS Code, Node와 같은 도구가 애플리케이션을 원격으로 디버깅하는 데 사용합니다. #synergy

페이지를 볼 수 있는 브라우저 UI가 없으므로 다른 브라우저에서 http://localhost:9222로 이동하여 모든 것이 제대로 작동하는지 확인합니다. 클릭하면 헤드리스가 렌더링되는 항목을 확인할 수 있는 검사 가능한 페이지 목록이 표시됩니다.

DevTools 원격
DevTools 원격 디버깅 UI

여기에서 익숙한 DevTools 기능을 사용하여 평소와 같이 페이지를 검사, 디버그, 조정할 수 있습니다. 프로그래매틱 방식으로 헤드리스를 사용하는 경우 이 페이지는 모든 원시 DevTools 프로토콜 명령을 확인하고 브라우저와 통신하는 강력한 디버깅 도구이기도 합니다.

프로그래매틱 방식으로 사용 (노드)

인형 조종자

Puppeteer는 Chrome팀에서 개발한 노드 라이브러리입니다. 헤드리스(또는 전체) Chrome을 제어하는 상위 수준 API를 제공합니다. Phantom 및 NightmareJS와 같은 다른 자동 테스트 라이브러리와 유사하지만 최신 버전의 Chrome에서만 작동합니다.

무엇보다도 Puppeteer를 사용하면 쉽게 스크린샷을 찍고, PDF를 만들고, 페이지를 탐색하고, 페이지에 관한 정보를 가져올 수 있습니다. 브라우저 테스트를 빠르게 자동화하려면 라이브러리를 사용하는 것이 좋습니다 이 도구는 DevTools 프로토콜의 복잡성을 숨기고 Chrome의 디버그 인스턴스 실행과 같은 중복 작업을 처리합니다.

설치합니다.

npm i --save puppeteer

예 - 사용자 에이전트 출력

const puppeteer = require('puppeteer');

(async() => {
  const browser = await puppeteer.launch();
  console.log(await browser.version());
  await browser.close();
})();

예 - 페이지 스크린샷 찍기

const puppeteer = require('puppeteer');

(async() => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://www.chromestatus.com', {waitUntil: 'networkidle2'});
  await page.pdf({path: 'page.pdf', format: 'A4'});

  await browser.close();
})();

전체 API에 관한 자세한 내용은 Puppeteer 문서를 참고하세요.

CRI 라이브러리

chrome-remote-interface는 Puppeteer의 API보다 하위 수준의 라이브러리입니다. 원한다면 DevTools 프로토콜을 직접 사용하는 것이 좋습니다.

Chrome 실행 중

chrome-remote-interface는 Chrome을 자동으로 실행하지 않으므로 내가 직접 관리해야 합니다.

CLI 섹션에서는 --headless --remote-debugging-port=9222를 사용하여 Chrome을 수동으로 시작했습니다. 하지만 테스트를 완전히 자동화하려면 애플리케이션에서 Chrome을 생성하는 것이 좋습니다.

한 가지 방법은 child_process을 사용하는 것입니다.

const execFile = require('child_process').execFile;

function launchHeadlessChrome(url, callback) {
  // Assuming MacOSx.
  const CHROME = '/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome';
  execFile(CHROME, ['--headless', '--disable-gpu', '--remote-debugging-port=9222', url], callback);
}

launchHeadlessChrome('https://www.chromestatus.com', (err, stdout, stderr) => {
  ...
});

그러나 여러 플랫폼에서 작동하는 이식 가능한 솔루션을 원하는 경우 까다로운 일이 발생합니다. 하드 코딩된 Chrome 경로를 보세요.

ChromeLauncher 사용

Lighthouse는 웹 앱의 품질을 테스트할 수 있는 놀라운 도구입니다. Chrome 출시를 위한 강력한 모듈이 Lighthouse 내에서 개발되었으며 이제 독립형으로 추출되었습니다. chrome-launcher NPM 모듈은 Chrome이 설치된 위치를 찾아 디버그 인스턴스를 설정하고 브라우저를 실행하고 프로그램이 완료되면 종료합니다. 가장 좋은 점은 Node 덕분에 크로스 플랫폼에서 작동한다는 것입니다.

기본적으로 chrome-launcher는 Chrome Canary가 설치된 경우 (설치된 경우) 실행을 시도하지만 이를 변경하여 사용할 Chrome을 수동으로 선택할 수 있습니다. 사용하려면 먼저 npm에서 설치하세요.

npm i --save chrome-launcher

예: chrome-launcher를 사용하여 Headless 실행

const chromeLauncher = require('chrome-launcher');

// Optional: set logging level of launcher to see its output.
// Install it using: npm i --save lighthouse-logger
// const log = require('lighthouse-logger');
// log.setLevel('info');

/**
 * Launches a debugging instance of Chrome.
 * @param {boolean=} headless True (default) launches Chrome in headless mode.
 *     False launches a full version of Chrome.
 * @return {Promise<ChromeLauncher>}
 */
function launchChrome(headless=true) {
  return chromeLauncher.launch({
    // port: 9222, // Uncomment to force a specific port of your choice.
    chromeFlags: [
      '--window-size=412,732',
      '--disable-gpu',
      headless ? '--headless' : ''
    ]
  });
}

launchChrome().then(chrome => {
  console.log(`Chrome debuggable on port: ${chrome.port}`);
  ...
  // chrome.kill();
});

이 스크립트를 실행해도 별다른 작업은 하지 않지만 about:blank를 로드한 작업 관리자에서 Chrome 인스턴스가 실행되는 것을 확인할 수 있습니다. 브라우저 UI가 없다는 것을 기억하세요. 우리는 헤드리스입니다.

브라우저를 제어하려면 DevTools 프로토콜이 필요합니다.

페이지에 관한 정보 가져오기

라이브러리를 설치해 보겠습니다.

npm i --save chrome-remote-interface
예

예 - 사용자 에이전트 출력

const CDP = require('chrome-remote-interface');

...

launchChrome().then(async chrome => {
  const version = await CDP.Version({port: chrome.port});
  console.log(version['User-Agent']);
});

HeadlessChrome/60.0.3082.0과(와) 유사한 검색결과

예 - 사이트에 웹 앱 매니페스트가 있는지 확인

const CDP = require('chrome-remote-interface');

...

(async function() {

const chrome = await launchChrome();
const protocol = await CDP({port: chrome.port});

// Extract the DevTools protocol domains we need and enable them.
// See API docs: https://chromedevtools.github.io/devtools-protocol/
const {Page} = protocol;
await Page.enable();

Page.navigate({url: 'https://www.chromestatus.com/'});

// Wait for window.onload before doing stuff.
Page.loadEventFired(async () => {
  const manifest = await Page.getAppManifest();

  if (manifest.url) {
    console.log('Manifest: ' + manifest.url);
    console.log(manifest.data);
  } else {
    console.log('Site has no app manifest');
  }

  protocol.close();
  chrome.kill(); // Kill Chrome.
});

})();

예: DOM API를 사용하여 페이지의 <title>를 추출합니다.

const CDP = require('chrome-remote-interface');

...

(async function() {

const chrome = await launchChrome();
const protocol = await CDP({port: chrome.port});

// Extract the DevTools protocol domains we need and enable them.
// See API docs: https://chromedevtools.github.io/devtools-protocol/
const {Page, Runtime} = protocol;
await Promise.all([Page.enable(), Runtime.enable()]);

Page.navigate({url: 'https://www.chromestatus.com/'});

// Wait for window.onload before doing stuff.
Page.loadEventFired(async () => {
  const js = "document.querySelector('title').textContent";
  // Evaluate the JS expression in the page.
  const result = await Runtime.evaluate({expression: js});

  console.log('Title of page: ' + result.result.value);

  protocol.close();
  chrome.kill(); // Kill Chrome.
});

})();

Selenium, WebDriver, ChromeDriver 사용

현재 Selenium은 Chrome의 전체 인스턴스를 엽니다. 즉, 자동화된 솔루션이지만 완전히 헤드리스가 아닙니다. 하지만 약간의 작업으로 헤드리스 Chrome을 실행하도록 Selenium을 구성할 수 있습니다. 직접 설정하는 방법에 관한 자세한 안내를 보려면 헤드리스 Chrome으로 Selenium을 실행하는 것이 좋습니다. 쉽게 시작할 수 있도록 아래에 몇 가지 예를 포함해 두었습니다.

ChromeDriver 사용

ChromeDriver 2.32는 Chrome 61을 사용하며 헤드리스 Chrome과 원활하게 작동합니다.

설치합니다.

npm i --save-dev selenium-webdriver chromedriver

예:

const fs = require('fs');
const webdriver = require('selenium-webdriver');
const chromedriver = require('chromedriver');

const chromeCapabilities = webdriver.Capabilities.chrome();
chromeCapabilities.set('chromeOptions', {args: ['--headless']});

const driver = new webdriver.Builder()
  .forBrowser('chrome')
  .withCapabilities(chromeCapabilities)
  .build();

// Navigate to google.com, enter a search.
driver.get('https://www.google.com/');
driver.findElement({name: 'q'}).sendKeys('webdriver');
driver.findElement({name: 'btnG'}).click();
driver.wait(webdriver.until.titleIs('webdriver - Google Search'), 1000);

// Take screenshot of results page. Save to disk.
driver.takeScreenshot().then(base64png => {
  fs.writeFileSync('screenshot.png', new Buffer(base64png, 'base64'));
});

driver.quit();

WebDriverIO 사용

WebDriverIO는 Selenium WebDriver를 기반으로 하는 상위 수준의 API입니다.

설치합니다.

npm i --save-dev webdriverio chromedriver

예: chromestatus.com에서 CSS 기능 필터링

const webdriverio = require('webdriverio');
const chromedriver = require('chromedriver');

const PORT = 9515;

chromedriver.start([
  '--url-base=wd/hub',
  `--port=${PORT}`,
  '--verbose'
]);

(async () => {

const opts = {
  port: PORT,
  desiredCapabilities: {
    browserName: 'chrome',
    chromeOptions: {args: ['--headless']}
  }
};

const browser = webdriverio.remote(opts).init();

await browser.url('https://www.chromestatus.com/features');

const title = await browser.getTitle();
console.log(`Title: ${title}`);

await browser.waitForText('.num-features', 3000);
let numFeatures = await browser.getText('.num-features');
console.log(`Chrome has ${numFeatures} total features`);

await browser.setValue('input[type="search"]', 'CSS');
console.log('Filtering features...');
await browser.pause(1000);

numFeatures = await browser.getText('.num-features');
console.log(`Chrome has ${numFeatures} CSS features`);

const buffer = await browser.saveScreenshot('screenshot.png');
console.log('Saved screenshot...');

chromedriver.stop();
browser.end();

})();

추가 자료

다음은 시작하는 데 도움이 되는 리소스입니다.

문서

도구

  • chrome-remote-interface - DevTools 프로토콜을 래핑하는 노드 모듈
  • Lighthouse - 웹 앱 품질을 테스트하는 자동화된 도구로, 프로토콜을 많이 사용합니다.
  • chrome-launcher - Chrome을 실행하기 위한 노드 모듈로, 자동화가 가능합니다.

데모

  • 'The Headless Web' - api.ai에서 Headless를 사용하는 방법에 관한 Paul Kinlan의 유용한 블로그 게시물

FAQ

--disable-gpu 플래그가 필요한가요?

Windows에서만 지원됩니다. 다른 플랫폼에서는 더 이상 이 API가 필요하지 않습니다. --disable-gpu 플래그는 몇 가지 버그를 임시로 해결하는 방법입니다. 향후 버전의 Chrome에서는 이 플래그가 필요하지 않습니다. 자세한 내용은 crbug.com/737678을 참고하세요.

그래도 Xvfb가 필요한가요?

아니요. 헤드리스 Chrome은 창을 사용하지 않으므로 Xvfb와 같은 디스플레이 서버가 더 이상 필요하지 않습니다. 이 도구 없이도 자동화된 테스트를 손쉽게 실행할 수 있습니다.

Xvfb란 무엇인가요? Xvfb는 Unix와 유사한 시스템용 인메모리 디스플레이 서버로, 연결된 실제 디스플레이 없이 그래픽 애플리케이션 (예: Chrome)을 실행할 수 있도록 합니다. 많은 사람들이 Xvfb를 사용하여 이전 버전의 Chrome을 실행하여 '헤드리스' 테스트를 수행합니다.

헤드리스 Chrome을 실행하는 Docker 컨테이너를 만들려면 어떻게 해야 하나요?

lighthouse-ci를 확인해 보세요. 이 파일에는 node:8-slim를 기본 이미지로 사용하고 App Engine Flex에서 Lighthouse를 설치 및 실행하는 Dockerfile 예시가 있습니다.

Selenium / WebDriver / ChromeDriver와 함께 사용할 수 있나요?

예. selenium, WebDriver, ChromeDriver 사용을 참고하세요.

PhantomJS와는 어떤 관련이 있나요?

헤드리스 Chrome은 PhantomJS와 같은 도구와 유사합니다. 둘 다 헤드리스 환경에서 자동화된 테스트에 사용할 수 있습니다. 두 가지의 주요 차이점은 Phantom은 이전 버전의 WebKit을 렌더링 엔진으로 사용하는 반면 헤드리스 Chrome은 최신 버전의 Blink를 사용한다는 점입니다.

현재 Phantom은 DevTools 프로토콜보다 상위 수준의 API도 제공합니다.

버그는 어디에 신고하나요?

헤드리스 Chrome에 대한 버그의 경우 crbug.com에서 신고하세요.

DevTools 프로토콜의 버그는 github.com/ChromeDevTools/devtools-protocol에서 버그를 신고하세요.