Viceroy 项目使用教程

Viceroy 项目使用教程

Viceroy Viceroy provides local testing for developers working with Compute. 项目地址: https://gitcode.com/gh_mirrors/vi/Viceroy

1. 项目介绍

Viceroy 是一个用于 Fastly Compute 开发者进行本地测试的开源工具。它允许开发者在本地开发环境中运行针对 Compute API 编写的服务，并配置测试后端以供服务通信。Viceroy 通常通过 Fastly CLI 的 fastly compute serve 命令使用，但它也是一个独立的工具，具有自己的 CLI 和 Rust 库，可以嵌入到自定义的测试基础设施中。

2. 项目快速启动

安装 Viceroy

通过 Fastly CLI 安装

大多数 Compute 用户应通过 Fastly CLI 进行本地测试，而不是直接使用 Viceroy。确保你的 CLI 版本为 0.34 或更高，然后按照以下步骤操作：

fastly compute serve

作为独立工具安装

如果你需要将 Viceroy 作为独立工具使用，首先需要安装 Rust。然后运行以下命令：

cargo install viceroy

使用 Viceroy 进行本地测试

安装完成后，你可以使用 Viceroy 命令来测试你的 Compute 服务。假设你已经通过 fastly compute build 构建了你的服务，生成的 .wasm 文件位于 bin/main.wasm。你可以运行以下命令来启动本地服务器：

viceroy bin/main.wasm

默认情况下，本地服务器会在 http://127.0.0.1:7676 上运行。你可以使用 curl 或直接在浏览器中访问该 URL 来测试你的服务。

3. 应用案例和最佳实践

应用案例

Viceroy 主要用于以下场景：

• 本地开发和测试：开发者在本地环境中测试他们的 Compute 服务，确保代码在部署到生产环境之前能够正常工作。
• 集成测试：开发者可以将 Viceroy 嵌入到他们的测试基础设施中，用于运行集成测试。

最佳实践

• 使用 --release 标志：在构建或测试代码时，建议使用 --release 标志，以提高执行速度。
• 配置 GitHub Actions 缓存：如果你使用 GitHub Actions 进行 CI/CD，建议配置 Rust 构建缓存，以加快构建时间。

4. 典型生态项目

Viceroy 通常与以下项目一起使用：

• Fastly CLI：用于管理和部署 Fastly Compute 服务。
• Cargo：Rust 的包管理工具，用于管理依赖和构建项目。
• GitHub Actions：用于自动化 CI/CD 流程。

通过这些工具的结合使用，开发者可以更高效地进行本地开发、测试和部署。

Viceroy Viceroy provides local testing for developers working with Compute. 项目地址: https://gitcode.com/gh_mirrors/vi/Viceroy