SDKMAN CLI:用 Go 重写版本管理工具的探索

文章目录

  • SDKMAN CLI:用 Go 重写版本管理工具的探索

SDKMAN CLI:用 Go 重写版本管理工具的探索

SDKMAN 是一个管理多个软件开发工具包(SDK)并行版本的工具,在开发者群体中有一定的使用基础。目前它的命令行实现主要基于 Bash 脚本,而这个项目是用 Go 语言重写 CLI 的一次尝试。

项目的定位是探索性质的 spike,目的是验证 Go 语言实现 CLI 的可行性,并为后续的正式重写积累经验。团队同时也在评估 Rust 作为替代方案的可能性。

目前 Bash 版本的 SDKMAN 仍然在生产环境中正常运行,功能完整,没有受到影响。

测试驱动的开发方式

这个项目有一个比较鲜明的特点:开发完全由测试驱动。团队使用 Cucumber 来描述 CLI 的行为,用自然语言编写功能描述文件,存放在 features 目录下。

这些 Cucumber 特性文件构成了项目的"活文档",随着代码实现一起演进。每个特性文件背后都有对应的 Step Definition,也就是匹配执行的代码片段。

这种做法的好处是,非技术人员也能读懂功能描述,同时测试和文档保持同步,不会出现文档过时的问题。

开发环境搭建

使用这个项目需要在系统上安装 Go 语言环境。安装完成后,可以选择性地安装 Godog 工具,用来直接运行 Cucumber 规格:

$ go get github.com/DATA-DOG/godog/cmd/godog

运行测试有两种方式。一种是使用 Go 内置的测试支持,同时运行单元测试和 Cucumber 测试:

$ cd path/to/the/repo/sdk $ go test --godog.format=pretty

另一种是单独运行 Cucumber 规格:

$ godog

构建和运行

在正式构建之前,可以先用 go run 快速验证:

$ go run sdk.go version

确认没有问题后,构建可执行文件:

$ go build $ ./sdk

项目现状

这个 Go 重写版本目前处于 spike 阶段,主要价值在于技术验证和经验积累。团队从这个探索中获得的结论将指导下一阶段的 CLI 开发方向。

对于想要了解 SDKMAN 内部实现,或者对 Go 语言 CLI 开发感兴趣的开发者来说,这个项目的代码和测试用例还是有参考价值的。特别是 Cucumber 特性文件的组织方式,以及 Go 与 Cucumber 的集成方案,都可以作为学习材料。

考价值的。特别是 Cucumber 特性文件的组织方式,以及 Go 与 Cucumber 的集成方案,都可以作为学习材料。