李钟意讲前端

外观

咨询/接单/付费bug修复/学习交流群

在容器中运行 Node.js 测试 ​

原文：https://docs.docker.com/language/nodejs/run-tests/

前提条件 ​

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

概述 ​

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

在本地开发时运行测试 ​

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

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

console
docker compose run server npm run test

要了解更多关于命令的信息，请参见docker compose run。

您应该看到如下输出。

console
> 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
      使用 sqlite 数据库在 /tmp/todo.db

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

    console.log
      使用 sqlite 数据库在 /tmp/todo.db

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

    console.log
      使用 sqlite 数据库在 /tmp/todo.db

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

    console.log
      使用 sqlite 数据库在 /tmp/todo.db

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

    console.log
      使用 sqlite 数据库在 /tmp/todo.db

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


测试套件：5 通过，共 5 个
测试：     9 通过，共 9 个
快照：     0 总数
时间：     2.008 s
运行所有测试套件。

在构建时运行测试 ​

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

以下是更新后的 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

在测试阶段中使用 RUN 而不是 CMD 来运行测试。原因是 CMD 指令在容器运行时执行，而 RUN 指令在构建镜像时执行，并且如果测试失败，构建将会失败。

运行以下命令使用测试阶段为目标构建新镜像，并查看测试结果。包

括 --progress=plain 以查看构建输出，--no-cache 确保总是运行测试，并且 --target test 指向测试阶段。

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

要了解更多关于构建和运行测试的信息，请参见使用 Docker 构建指南。

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

console
...

#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 流水线。