在容器中运行 Node.js 测试

先决条件

从容器化 Node.js 应用程序开始,完成本指南前面的所有部分 。

概述

测试是现代软件开发的重要组成部分。测试对于不同的开发团队来说意味着很多事情。有单元测试、集成测试和端到端测试。在本指南中,您将了解在开发和构建时在 Docker 中运行单元测试。

在本地开发时运行测试

示例应用程序已经具有用于运行测试的 Jest 包,并且spec目录内有测试。在本地开发时,您可以使用 Compose 来运行测试。

运行以下命令以从package.json容器内的文件运行测试脚本。

$ docker compose run server npm run test

要了解有关该命令的更多信息,请参阅 docker compose run

您应该看到如下所示的输出。

> docker-nodejs@1.0.0 test
> jest

 PASS  spec/routes/deleteItem.spec.js
 PASS  spec/routes/getItems.spec.js
 PASS  spec/routes/addItem.spec.js
 PASS  spec/routes/updateItem.spec.js
 PASS  spec/persistence/sqlite.spec.js
  ● Console

    console.log
      Using sqlite database at /tmp/todo.db

      at Database.log (src/persistence/sqlite.js:18:25)

    console.log
      Using sqlite database at /tmp/todo.db

      at Database.log (src/persistence/sqlite.js:18:25)

    console.log
      Using sqlite database at /tmp/todo.db

      at Database.log (src/persistence/sqlite.js:18:25)

    console.log
      Using sqlite database at /tmp/todo.db

      at Database.log (src/persistence/sqlite.js:18:25)

    console.log
      Using sqlite database at /tmp/todo.db

      at Database.log (src/persistence/sqlite.js:18:25)


Test Suites: 5 passed, 5 total
Tests:       9 passed, 9 total
Snapshots:   0 total
Time:        2.008 s
Ran all test suites.

构建时运行测试

要在构建时运行测试,您需要更新 Dockerfile 以添加新的测试阶段。

以下是更新后的 Dockerfile。

# syntax=docker/dockerfile:1

ARG NODE_VERSION=18.0.0

FROM node:${NODE_VERSION}-alpine as base
WORKDIR /usr/src/app
EXPOSE 3000

FROM base as dev
RUN --mount=type=bind,source=package.json,target=package.json \
    --mount=type=bind,source=package-lock.json,target=package-lock.json \
    --mount=type=cache,target=/root/.npm \
    npm ci --include=dev
USER node
COPY . .
CMD npm run dev

FROM base as prod
RUN --mount=type=bind,source=package.json,target=package.json \
    --mount=type=bind,source=package-lock.json,target=package-lock.json \
    --mount=type=cache,target=/root/.npm \
    npm ci --omit=dev
USER node
COPY . .
CMD node src/index.js

FROM base as test
ENV NODE_ENV test
RUN --mount=type=bind,source=package.json,target=package.json \
    --mount=type=bind,source=package-lock.json,target=package-lock.json \
    --mount=type=cache,target=/root/.npm \
    npm ci --include=dev
USER node
COPY . .
RUN npm run test

CMD不要在测试阶段使用,而是用于RUN运行测试。原因是该CMD指令在容器运行时运行,而该RUN指令在构建镜像时运行,如果测试失败,构建就会失败。

运行以下命令以测试阶段为目标构建新镜像并查看测试结果。包括--progress=plain查看构建输出、--no-cache确保测试始终运行以及--target test针对测试阶段。

$ docker build -t node-docker-image-test --progress=plain --no-cache --target test .

要了解有关构建和运行测试的更多信息,请参阅 使用 Docker 构建指南

您应该看到包含以下内容的输出。

...

#11 [test 3/3] RUN npm run test
#11 1.058
#11 1.058 > docker-nodejs@1.0.0 test
#11 1.058 > jest
#11 1.058
#11 3.765 PASS spec/routes/getItems.spec.js
#11 3.767 PASS spec/routes/deleteItem.spec.js
#11 3.783 PASS spec/routes/updateItem.spec.js
#11 3.806 PASS spec/routes/addItem.spec.js
#11 4.179 PASS spec/persistence/sqlite.spec.js
#11 4.207
#11 4.208 Test Suites: 5 passed, 5 total
#11 4.208 Tests:       9 passed, 9 total
#11 4.208 Snapshots:   0 total
#11 4.208 Time:        2.168 s
#11 4.208 Ran all test suites.
#11 4.265 npm notice
#11 4.265 npm notice New major version of npm available! 8.6.0 -> 9.8.1
#11 4.265 npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
#11 4.265 npm notice Run `npm install -g npm@9.8.1` to update!
#11 4.266 npm notice
#11 DONE 4.3s

...

概括

在本部分中,您了解了如何在使用 Compose 进行本地开发时运行测试以及如何在构建映像时运行测试。

相关信息:

下一步

接下来,您将学习如何使用 GitHub Actions 设置 CI/CD 管道。