Kong Pongo 使用教程

1. 项目介绍

Kong Pongo 是一个用于在 Kong 上运行插件测试的工具。它通过创建 Docker 容器和网络来隔离环境，并提供 Kong 通常需要的依赖项（如 Cassandra、PostgreSQL 等）。Pongo 使得开发者可以在本地环境中轻松测试 Kong 插件，而无需将插件部署到开发或 staging 服务器上。

2. 项目快速启动

2.1 安装 Pongo

首先，克隆 Pongo 仓库并安装 Pongo：

PATH=$PATH:~/local/bin
git clone https://github.com/Kong/kong-pongo.git
mkdir -p ~/local/bin
ln -s $(realpath kong-pongo/pongo.sh) ~/local/bin/pongo

2.2 配置 Pongo

在插件目录中，创建一个 pongo/pongorc 文件来配置 Pongo。例如，如果你不需要 Cassandra 数据库，可以在 pongorc 文件中添加以下内容：

--no-cassandra

2.3 运行测试

假设当前目录是一个用 Lua 编写的 Kong 插件目录，运行测试的命令如下：

KONG_VERSION=$(VER) ~/local/bin/pongo.sh run --no-cassandra --no-postgres

3. 应用案例和最佳实践

3.1 插件开发与测试

在开发 Kong 插件时，Pongo 提供了一个隔离的环境来运行和测试插件逻辑。开发者可以在本地编写测试代码，并模拟依赖项（如 API 调用和数据库调用），从而在不部署到开发或 staging 服务器的情况下验证插件功能。

3.2 CI/CD 集成

Pongo 可以轻松集成到 CI/CD 设置中。以下是一个基于 GitHub Actions 的示例配置：

name: "Test"
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        kongVersion: ["2.8.x", "3.5.x", "dev"]
    steps:
      - uses: actions/checkout@v3
      - uses: Kong/kong-pongo-action@v1
        with:
          pongo_version: master
          kong_version: $[[ matrix.kongVersion ]]
      - run: pongo run

4. 典型生态项目

4.1 Kong Gateway

Kong Gateway 是一个开源的 API 网关，Pongo 是用于测试 Kong 插件的工具。通过 Pongo，开发者可以在本地环境中模拟生产环境，确保插件在部署到生产环境之前能够正常工作。

4.2 Docker

Pongo 依赖 Docker 和 Docker Compose 来创建隔离的测试环境。开发者需要安装 Docker 和 Docker Compose 才能使用 Pongo。

4.3 LuaRocks

LuaRocks 是 Lua 的包管理器，Pongo 使用 LuaRocks 来管理插件的依赖项。开发者可以通过 LuaRocks 安装和管理插件所需的库。

通过以上步骤，开发者可以快速上手并使用 Kong Pongo 进行插件开发和测试。