持续集成(CI)
为了帮助验证您的扩展并确保其正常运行,扩展 SDK 提供了一些工具来帮助您为扩展设置持续集成。
重要的
Docker Desktop Action和 extension-test-helper 库都是 实验性的。
使用 GitHub Actions 设置 CI 环境
您需要 Docker Desktop 才能安装和验证您的扩展。您可以使用 Docker Desktop Action在 GitHub Actions 中启动 Docker Desktop ,方法是将以下内容添加到工作流文件中:
steps:
- id: start_desktop
uses: docker/desktop-action/start@v0.1.0
笔记
此操作目前仅支持 Github Action macOS 运行程序。您需要指定
runs-on: macOS-latest
端到端测试。
执行该步骤后,接下来的步骤将使用 Docker Desktop 和 Docker CLI 来安装和测试扩展。
使用 Puppeteer 验证您的扩展
一旦 Docker Desktop 在 CI 中启动,您就可以使用 Jest 和 Puppeteer 构建、安装和验证您的扩展。
首先,构建并安装测试中的扩展:
import { DesktopUI } from "@docker/extension-test-helper";
import { exec as originalExec } from "child_process";
import * as util from "util";
export const exec = util.promisify(originalExec);
// keep a handle on the app to stop it at the end of tests
let dashboard: DesktopUI;
beforeAll(async () => {
await exec(`docker build -t my/extension:latest .`, {
cwd: "my-extension-src-root",
});
await exec(`docker extension install -f my/extension:latest`);
});
然后打开 Docker 仪表板并在扩展的 UI 中运行一些测试:
describe("Test my extension", () => {
test("should be functional", async () => {
dashboard = await DesktopUI.start();
const eFrame = await dashboard.navigateToExtension("my/extension");
// use puppeteer APIs to manipulate the UI, click on buttons, expect visual display and validate your extension
await eFrame.waitForSelector("#someElementId");
});
});
最后,关闭 Docker 仪表板并卸载您的扩展:
afterAll(async () => {
dashboard?.stop();
await exec(`docker extension uninstall my/extension`);
});