在容器中執行 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

在測試階段中，使用 `RUN` 而不是 `CMD` 來執行測試。原因是 `CMD` 指令在容器執行時執行，而 `RUN` 指令在映象構建時執行，如果測試失敗，構建將失敗。

執行以下命令，使用測試階段作為目標構建新映象並檢視測試結果。包含 `--progress=plain` 以檢視構建輸出，`--no-cache` 以確保測試始終執行，以及 `--target test` 以指定測試階段。

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

你應該會看到包含以下內容的輸出。

...

#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 管道。

為你的 Node.js 應用程式配置 CI/CD »