meshcloud/gate-resource

gate-resource

https://img.shields.io/docker/build/meshcloud/gate-resource.svg](https://hub.docker.com/r/meshcloud/gate-resource/) https://img.shields.io/docker/pulls/meshcloud/gate-resource.svg?maxAge=2592000](https://hub.docker.com/r/meshcloud/gate-resource/)

Concourse CI的通用质量门资源，用于建模质量门和管道控制流，基于Git仓库实现，并包装了https://github.com/concourse/git-resource%E3%80%82

欢迎贡献：本资源是新开发的，欢迎反馈和贡献！

示例

查看使用gate-resource的示例管道，请访问https://github.com/Meshcloud/gate-resource-example%E3%80%82

Git仓库结构

text
.
├── my-gate
│   ├── 1
│   └── 2
└── my-autogate
    ├── a
    └── b.autogate

注意：门仓库目前是仅追加模式，不期望删除或清理文件。

gate-resource支持两种类型的门：简单门和自动门。

简单门

仓库中的每个文件夹代表一个门，每个门文件夹中的文件代表通过该门的项。文件可以为空或包含任何需要跟踪的元数据。例如上述的my-gate就是简单门。

自动门

自动门会根据其他门的项自动关闭。自动门包含.autoclose项，这是一个文本文件，每行列出依赖项（"autoclose spec"）。例如b.autoclose依赖my-gate中的两个项：

b
my-gate/2
my-gate/3
# metadata after this line
任意内容在此处

当所有依赖项通过后，autoclose项会关闭并去掉.autoclose扩展名。autoclose文件还可包含额外元数据，gate-resource会在遇到以#开头的行时停止解析后续内容，区分spec和元数据。

"none"版本

Concourse不支持从out输出空版本集，但gate-resource在更新中可能未找到可关闭的autoclose项，因此使用none版本作为 workaround。in步骤遇到此版本时会无操作。

源配置

• git：必填。仓库配置，参考https://github.com/concourse/git-resource%E7%9A%84%E9%80%89%E9%A1%B9%E3%80%82
  注意：不支持paths和ignore_path参数。
• gate：可选。要跟踪的门。

行为

check：检查门的变化

克隆（或拉取）仓库，检查指定gate从给定版本以来的提交中通过门的项。

注意：若要确保资源对每个通过门的项触发，需使用version: every。

in：获取通过门的项

输出两个文件：

• passed：包含通过门的项名称
• metadata：包含门项中的内容，可用于环境配置或审批流程文档。

out：将项通过门

执行以下操作之一以更改门状态：

参数

需提供以下之一：

• item_file：包含要通过门的项的文件路径，允许通配符但需匹配单个项，文件也可以是.autogate文件。
• update_autoclose：处理仓库中待处理的autoclose项。

注意：门的put操作是幂等的。当put新门项或.autoclose spec时，资源会检查是否已有匹配项通过门，若有则输出之前产生该项目的版本。

创建.autoclose项

.autoclose项可像普通项一样put到门，但输出的版本可能不同：

• 若匹配的目标项（无.autoclose扩展名的文件名）已存在，输出产生该目标项的版本；
• 若.autoclose项可立即关闭（所有依赖项已通过），关闭该项并输出版本；
• 否则输出none版本（见上文）。

开发

前提条件

• 需安装docker，测试过17.06.x版本，更早版本可能也适用。

运行测试

测试已嵌入Dockerfile，确保测试环境一致。构建镜像时会在容器内运行测试，失败则停止构建。
运行测试命令：

sh
docker build -t gate-resource .