emmafinance/gcloud-pubsub-emulator

gcloud-pubsub-emulator

镜像概述和主要用途

gcloud-pubsub-emulator是Google PubSub模拟器的Docker化实现，基于https://github.com/prep/pubsubc项目构建。该镜像提供本地可运行的PubSub服务环境，允许开发和测试阶段无需连接Google Cloud即可使用PubSub功能，简化应用开发流程。

核心功能和特性

• 本地PubSub服务：在Docker容器中运行PubSub模拟器，默认监听8681端口
• 自动资源创建：支持通过环境变量在启动时自动创建项目、主题和订阅
• 多项目支持：可配置多个独立项目，每个项目包含多个主题和订阅
• 依赖检测支持：提供8682端口用于标识初始化完成状态，便于依赖服务协调

使用场景和适用范围

• 本地开发环境中测试使用PubSub的应用程序
• CI/CD流水线中的集成测试环节
• 多容器应用架构（如Docker Compose）中作为PubSub服务组件
• 需要隔离测试环境的PubSub功能验证

使用方法和配置说明

安装

从Docker Hub拉取预构建镜像

bash
docker run --rm -ti -p 8681:8681 docker.xuanyuan.run/messagebird/gcloud-pubsub-emulator:latest

本地构建镜像

bash
# 克隆仓库后执行构建
docker build -t gcloud-pubsub-emulator:latest .
# 运行本地构建的镜像
docker run --rm -ti -p 8681:8681 docker.xuanyuan.run/gcloud-pubsub-emulator:latest

基本使用

启动容器后，通过设置PUBSUB_EMULATOR_HOST环境变量将应用程序指向本地模拟器：

bash
# 临时设置环境变量并运行应用
env PUBSUB_EMULATOR_HOST=localhost:8681 ./myapp

或

bash
# 持久设置环境变量
export PUBSUB_EMULATOR_HOST=localhost:8681
./myapp

自动创建主题和订阅

环境变量格式

通过PUBSUB_PROJECTn环境变量（n为从1开始的序号，如PUBSUB_PROJECT1、PUBSUB_PROJECT2）配置项目、主题和订阅，格式如下：

PROJECTID,TOPIC1,TOPIC2:SUBSCRIPTION1:SUBSCRIPTION2,TOPIC3:SUBSCRIPTION3

• 逗号分隔项目ID和主题列表
• 冒号分隔主题ID和其订阅列表（一个主题可对应多个订阅）
• 主题可以不指定订阅

示例

创建项目company-dev，包含：

• 主题invoices，订阅invoice-calculator
• 主题chats，订阅slack-out和irc-out
• 主题notifications，无订阅

bash
docker run --rm -ti -p 8681:8681 \
  -e PUBSUB_PROJECT1=company-dev,invoices:invoice-calculator,chats:slack-out:irc-out,notifications \
  docker.xuanyuan.run/messagebird/gcloud-pubsub-emulator:latest

多项目配置

通过添加PUBSUB_PROJECT2、PUBSUB_PROJECT3等环境变量支持多个项目：

bash
docker run --rm -ti -p 8681:8681 \
  -e PUBSUB_PROJECT1=project1,topic1:sub1 \
  -e PUBSUB_PROJECT2=project2,topic2:sub2:sub3,topic3 \
  docker.xuanyuan.run/messagebird/gcloud-pubsub-emulator:latest

依赖服务检测

在Docker Compose等多容器环境中，可使用wait-for或wait-for-it脚本检测服务就绪状态：

• 未使用PUBSUB_PROJECT变量：检查8681端口可用性
• 使用PUBSUB_PROJECT变量：检查8682端口可用性（表示所有主题和订阅已创建完成）

示例wait-for-it使用：

bash
wait-for-it.sh localhost:8682 -t 60 -- ./dependent-app

环境变量说明

Docker Compose示例

yaml
version: '3'
services:
  pubsub:
    image: messagebird/gcloud-pubsub-emulator:latest
    ports:
      - "8681:8681"
    environment:
      - PUBSUB_PROJECT1=my-project,orders:order-processor,payments:payment-validator:refund-handler
    healthcheck:
      test: ["CMD", "nc", "-z", "localhost", "8682"]
      interval: 5s
      timeout: 5s
      retries: 5

  app:
    build: .
    depends_on:
      pubsub:
        condition: service_healthy
    environment:
      - PUBSUB_EMULATOR_HOST=pubsub:8681