tf-summarize 架构探秘Reader→Parser→State→Writer 四层流水线源码解析【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarizetf-summarize是一个开源的 Terraform plan 摘要命令行工具它读取terraform plan的输出把成百上千行难以阅读的变更日志压缩成一张新增 / 删除 / 更新 / 重建 / 导入 / 移动一目了然的摘要表。想跟读源码先把仓库克隆到本地git clone https://gitcode.com/gh_mirrors/tf/tf-summarize先看它实际跑起来是什么效果——一条命令整个 plan 的变化就浓缩成了几行带颜色的变更清单 一张图看懂四层流水线tf-summarize 的核心设计可以概括为一句话输入 → 解析 → 归类 → 渲染每一层都是一个接口 工厂函数互不耦合tfplan 文件 / stdin │ [1] reader 包 —— 把输入读成原始字节 │ [2] parser 包 —— 把字节解析成 tfjson.Plan 结构体 │ [3] terraformstate 包 —— 过滤 no-op按动作类型分类变更 │ [4] writer 包 —— 渲染成表格 / 树 / JSON / HTML │ stdout 或 -out 指定文件下面逐层拆解。 第一层Reader —— tfplan 数据从哪里来Reader 层位于reader/reader.go只定义了一个极简接口Read()返回原始字节Name()返回输入名称。它的工作就是把数据从哪来这件事隔离掉。入口工厂函数CreateReader的规则非常直观命令行带了一个文件名参数→ 创建FileReader见reader/file.go从磁盘读取没带参数→ 创建StdinReader见reader/stdin.go从标准输入读取名字固定叫stdin。这个设计正是它支持管道用法terraform show -json tfplan | tf-summarize的原因。另外Name()返回的字符串并不是摆设——第二层要靠它判断输入类型这是两层之间最小气却最关键的数据契约。 第二层Parser —— JSON 与二进制双路解析Plan 文件有两种形态terraform show -json输出的JSON和terraform plan -outtfplan生成的二进制文件。Parser 层在parser/parser.go的CreateParser中用一条规则自动分流输入名是stdin或文件名以.json结尾 → 走JSONParserparser/json-parser.go直接json.Unmarshal进官方的tfjson.Plan结构体其他情况 → 走BinaryParserparser/binary-parser.go它在内部执行terraform show -json 文件把二进制 plan 转成 JSON 再解析。BinaryParser还有两个贴心细节支持环境变量TF_BINARY指定其他二进制比如terragrunt并自动附加--terragrunt-log-disable参数解析失败时给出请确认在正确目录且已执行 init的友好报错。️ 第三层State —— 变更分类引擎这是整个工具的大脑位于terraformstate/terraform_state.go。它做两件事1. 降噪FilterNoOpResources先把no-op无实际变化的资源剔除——但会保留 moved地址变更和 import导入类型的条目避免漏报。2. 分类GetAllResourceChanges把剩余变更按动作分桶并按资源地址排序输出六个类别add、delete、update、recreate先删后建动作数为 2 的变更、import、moved。输出变更output同样按add / update / delete分桶。顺带一提()(-)(~)(→)这类带颜色的后缀标记也是在这一层用 ANSI 转义码定义好的。渲染出来的效果就是下面这张表——每个资源只占一行变更类型和数量清清楚楚️ 第四层Writer —— 六种输出格式的工厂Writer 层位于writer/writer.go接口只有一个方法Write(io.Writer)。工厂函数CreateWriter根据命令行开关依次匹配未匹配则回落到默认表格视图开关Writer实现文件说明默认TableWriterwriter/table.go表格视图-md输出 Markdown-treeTreeWriterwriter/tree.go按模块层级展示-draw输出 2D 图形树-separate-treeSeparateTreewriter/separate_tree.go按变更类型分块的独立树-jsonJSONWriterwriter/json.go完整变更明细 JSON-json-sumJSONSumWriterwriter/json-sum.go只有各类变更的计数-htmlHTMLWriterwriter/html.go基于writer/templates/下的 HTML 模板渲染所有 Writer 都只面向io.Writer抽象写入所以在main.go里切换输出到终端和输出到-out指定的文件只需要换掉这个io.Writer实例——这就是最后一块拼图的巧妙之处。 main.go把四层串成一条流水线main.go本身就是流水线的最小实现逻辑一目了然解析命令行参数并校验冲突比如-tree和-md不能同时用→CreateReader→Read→CreateParser→Parse→FilterNoOpResources→CreateWriter→Write。每一步出错都走统一的logIfErrorAndExit兜底输出错误后干净退出。 总结这套架构值得抄的三个设计接口 工厂每一层只暴露一个接口新增输入源或输出格式只需加一个实现 工厂里加一行分支层间数据契约极小Reader 只给字节和名字Parser 只给tfjson.Plan测试时可以轻松 mocktestdata/mocks/下就有现成的 mock writer面向io.Writer渲染同一份摘要天然支持 stdout、文件、管道、Docker 容器等多种出口。如果你每天和terraform plan打交道这套读取 → 解析 → 分类 → 渲染的流水线思路同样适合你手头的任何 CLI 小工具。✨【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考