bmorton/gcloud-pubsub-emulator

gcloud-pubsub-emulator

镜像概述

gcloud-pubsub-emulator是Google PubSub模拟器的Docker化实现，基于https://github.com/prep/pubsubc%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E4%BA%86%E6%9C%AC%E5%9C%B0%E8%BF%90%E8%A1%8C%E7%9A%84PubSub%E6%9C%8D%E5%8A%A1%E7%8E%AF%E5%A2%83%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E5%BC%80%E5%8F%91%E5%92%8C%E6%B5%8B%E8%AF%95%E9%98%B6%E6%AE%B5%EF%BC%8C%E9%81%BF%E5%85%8D%E7%9B%B4%E6%8E%A5%E4%BE%9D%E8%B5%96%E4%BA%91%E7%AB%AFGoogle Cloud PubSub服务，降低开发成本并提高测试效率。

核心功能与特性

• 本地PubSub服务：在Docker容器中运行PubSub模拟器，提供与云端PubSub兼容的API
• 自动资源创建：支持启动时自动创建项目、主题和订阅
• 多项目支持：通过环境变量配置多个独立项目
• 服务就绪检测：提供专用端口用于检测服务及资源创建完成状态

使用场景

• 本地开发环境：为依赖PubSub的应用提供本地测试环境
• 集成测试：在CI/CD流程中构建隔离的测试环境
• 功能验证：验证PubSub主题、订阅的配置及消息处理逻辑

安装与使用

安装方式

直接使用Docker Hub镜像

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

本地构建镜像

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

基本使用方法

启动容器后，通过设置PUBSUB_EMULATOR_HOST环境变量让应用连接到模拟器：

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

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

自动创建主题和订阅

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

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

• 第一个参数为项目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 \
  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 \
  messagebird/gcloud-pubsub-emulator:latest

服务就绪检测

在Docker Compose等场景中，可通过端口检测服务状态：

• 未使用PUBSUB_PROJECT：检测端口8681（服务启动完成）
• 使用PUBSUB_PROJECT：检测端口8682（服务及所有主题/订阅创建完成）

示例（使用wait-for-it）：

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

配置参数

端口说明