eclipse/che-theia-plugin-broker

Che插件Broker集合

镜像概述和主要用途

这些Docker镜像包含多个Che插件Broker的实现，是Che插件生态系统的关键组件。它们负责处理Che和Theia插件的下载、配置解析、依赖管理及环境清理，确保插件在Che工作区中正确部署、加载和运行，支撑Che工作区的插件扩展能力。

核心功能和特性

che-plugin-broker

• 下载tar.gz格式的插件归档文件
• 从插件归档内的che-plugin.yaml及工作目录（或通过参数指定路径）的config.json（包含插件/编辑器元数据）评估Che工作区sidecar配置
• 复制插件归档中dependencies.yaml指定的依赖文件或文件夹至目标位置

theia-plugin-broker

• 下载.theia格式的插件归档并解压至临时文件夹
• 检查归档内package.json内容以判断插件类型：
  • 若包含{"engines.cheRuntimeContainer"}，则将其值作为远程插件sidecar的容器镜像
  • 若该字段缺失或为空，插件被判定为非远程插件
• 根据插件类型执行文件复制：
  • 非远程插件：将.theia文件复制到/plugins/目录
  • 远程插件：将解压后的.theia文件夹复制到/plugins/目录
• 生成并发送Che工作区sidecar配置至工作区主服务，配置包含：
  • 挂载projects卷和plugin卷
  • 添加随机端口（4000-6000）的端点，名称格式为port<port>
  • 工作区级环境变量：THEIA_PLUGIN_REMOTE_ENDPOINT_<plugin_publisher_and_name>（值为ws://port<port>:<port>，其中<plugin_publisher_and_name>取自package.json）
  • sidecar环境变量：THEIA_PLUGIN_ENDPOINT_PORT（值为随机端口）
• 评估并生成Theia插件作为Che远程插件在sidecar中运行的完整配置

init-plugin-broker

• 清理/plugins/目录内容
• 必须在其他Broker之前启动，避免删除后续Broker添加的插件文件

使用场景和适用范围

适用于Eclipse Che工作区的插件生命周期管理，特别是Che原生插件和Theia插件的部署流程。可满足插件下载、依赖解析、远程/非远程插件区分部署、环境清理等需求，确保插件在Che工作区中正确加载并与Theia编辑器集成运行。

开发指南

构建

代码构建

• 构建所有代码：

  shell
  CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-w -s' -a -installsuffix cgo ./...
  

• 构建che-plugin-broker二进制文件：

  shell
  CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-w -s' -a -installsuffix cgo -o che-plugin-broker brokers/che-plugin-broker/main.go
  

• 构建theia-plugin-broker二进制文件：

  shell
  CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-w -s' -a -installsuffix cgo -o theia-plugin-broker brokers/theia-plugin-broker/main.go
  

• 构建init-plugin-broker二进制文件：

  shell
  CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-w -s' -a -installsuffix cgo -o init-plugin-broker brokers/init/main.go
  

测试与代码检查

• 运行测试：

  shell
  go test -v -race ./...
  

• 运行代码检查：

  shell
  golangci-lint run -v
  

• 本地Docker环境执行CI检查（含构建、测试、代码检查）：

  shell
  docker build -f Dockerfile.CI .
  

依赖管理

项目依赖通过Go Dep管理。添加或更新依赖后，需执行以下命令将依赖下载至vendor目录并更新锁文件，随后提交更改：

shell
dep ensure

注意：dep ensure不会自动修改包含依赖约束的Gopkg.toml，引入或修改依赖时需手动更新该文件。