在 Github Action 中使用 ChromeHeadlessCI 运行 Angular 测试失败

Question

我引导一个简单的 Angular (v10.1) 应用程序并创建 Github 操作工作流，如下所示。请注意，我已将测试配置为使用Angular 测试文档中指定的推荐配置运行

# ./github/workflows/main.yml
name: Test master branch

on:
  push:
    branches: [master]
  pull_request:
    branches: [master]

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: [14.10]

    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      - name: Cache Node.js modules
        uses: actions/cache@v2
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.OS }}-node-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.OS }}-node-
            ${{ runner.OS }}-
      - name: Install dependencies
        run: npm install
      - name: Run lint
        run: npm lint
      - name: Run tests
        run: npm test -- --no-watch --no-progress --browsers=ChromeHeadlessCI

测试失败并显示错误Cannot load browser "ChromeHeadlessCI": it is not registered! Perhaps you are missing some plugin?。即使我尝试npm test -- --no-watch --no-progress --browsers=ChromeHeadlessCI在本地计算机上运行，也会引发相同的错误。

$ npm test -- --no-watch --no-progress --browsers=ChromeHeadlessCI

> sampleapp-frontend@0.0.0 test C:\sampleapp\sampleapp-frontend
> ng test "--no-watch" "--no-progress" "--browsers=ChromeHeadlessCI"

12 09 2020 21:33:13.888:INFO [karma-server]: Karma v5.0.9 server started at http://0.0.0.0:9876/
12 09 2020 21:33:13.892:INFO [launcher]: Launching browsers ChromeHeadlessCI with concurrency unlimited
12 09 2020 21:33:13.894:ERROR [launcher]: Cannot load browser "ChromeHeadlessCI": it is not registered! Perhaps you are missing some plugin?
12 09 2020 21:33:13.895:ERROR [karma-server]: Error: Found 1 load error
    at Server.<anonymous> (C:\sampleapp\sampleapp-frontend\node_modules\karma\lib\server.js:189:27)
    at Object.onceWrapper (events.js:420:28)
    at Server.emit (events.js:326:22)
    at emitListeningNT (net.js:1351:10)
    at processTicksAndRejections (internal/process/task_queues.js:79:21)
npm ERR! Test failed.  See above for more details.

我该如何解决这个问题ChromeHeadlessCI？

Answer 1

请务必检查以下项目是否在 karma.conf.js 中：

browsers: ['Chrome', 'ChromeHeadless', 'ChromeHeadlessCI'],
customLaunchers: {
  ChromeHeadlessCI: {
    base: 'ChromeHeadless',
    flags: ['--no-sandbox']
  }
},

这将帮助启动器找到 ChromeHeadlessCI。

Answer 2

您没有提到任何修改karma.conf.js，您可能应该在那里添加：

browsers: ['Chrome'],
customLaunchers: {
  ChromeHeadlessCI: {
    base: 'ChromeHeadless',
    flags: ['--no-sandbox']
  }
},

https://angular.io/guide/testing#configure-cli-for-ci-testing-in-chrome

如果这还不够，您可能需要在测试环境中安装 chrome/chromium。

Answer 3

上面的答案对我来说似乎不完整。这是一个工作示例：

1.安装依赖

我们用来puppeteer调用和管理 headless-chrome 实例。我们还安装karma-chrome-launcher为 Karma 提供插件。

运行npm i -D puppeteer karma-chrome-launcher以安装两者。

2. 配置 Karma

还有三行代码，我们就可以开始了。

• 我们通过以下方式将 headless-chrome 实例传递给系统puppeteer：

process.env.CHROME_BIN = require('puppeteer').executablePath()

• 导入已安装的 Karma 插件

require('karma-chrome-launcher')]

• 最后，添加ChromeHeadless到可用浏览器列表中：

browsers: ['ChromeHeadless', 'Firefox']

karma.conf.js 现在的样子：

// karma.conf.js
process.env.CHROME_BIN = require('puppeteer').executablePath() // IMPORTANT!

module.exports = function(config) {
  config.set({
    browsers: ['ChromeHeadless', 'Firefox'], // IMPORTANT! You can list & use multiple browsers
    plugins: [
        require('karma-jasmine'),
        require('karma-chrome-launcher')], // IMPORTANT!
        require('karma-firefox-launcher'),
        ...
    ],
    ...
  })
}

3.执行！

执行ng test --watch=false --browsers=ChromeHeadless并享受您的测试！我在 GitHub Action 中添加了一个别名package.json，通过该别名进行调用。npm run test-headless

"scripts": {
    ...,
    "test-headless": "ng test --watch=false --browsers=ChromeHeadless",
    ...

在桌面上时，我通过 Firefox 使用ng test --browsers=Firefox.

资料来源：

• https://github.com/karma-runner/karma-chrome-launcher
• https://developers.google.com/web/updates/2017/06/headless-karma-mocha-chai（有关 puppeteer 的更多深入信息）