複数のCodebuildを同時に「上書きでビルドを開始する」CLIツールをGoで書いた
概要
複数のCodeBuildを同時に「上書きでビルドを開始する」CLIツールをGoで書きました。
https://github.com/koh-sh/codebuild-multirunner
YAMLで実行するCodeBuildの一覧と上書きするパラメータを記載してCLI実行すると、定義した通りに実行して完了するまでstatusをチェックしてくれます。
% cat config.yaml
builds:
- projectName: testproject
- projectName: testproject2
environmentVariablesOverride:
- name: TEST_VAR
value: FOOBAR
type: PLAINTEXT
% codebuild-multirunner run --config ./config.yaml
2023/07/30 22:49:48 testproject:cb0feec0-23af-49e4-a8af-f8ca502789f4 [STARTED]
2023/07/30 22:49:48 testproject2:a71b71ef-3902-49ac-98a9-9d30a4a540f2 [STARTED]
2023/07/30 22:50:48 testproject:cb0feec0-23af-49e4-a8af-f8ca502789f4 [SUCCEEDED]
2023/07/30 22:50:48 testproject2:a71b71ef-3902-49ac-98a9-9d30a4a540f2 [IN_PROGRESS]
2023/07/30 22:51:48 testproject2:a71b71ef-3902-49ac-98a9-9d30a4a540f2 [IN_PROGRESS]
2023/07/30 22:52:48 testproject2:a71b71ef-3902-49ac-98a9-9d30a4a540f2 [IN_PROGRESS]
2023/07/30 22:53:48 testproject2:a71b71ef-3902-49ac-98a9-9d30a4a540f2 [FAILED]
モチベーション
AWS CLIだとCodeBuildの「上書きでビルドを開始する」がちょっとめんどい
AWS CLIでやろうとするとjsonで上書きするパラメータを指定してstart-buildコマンドを実行する形になる。
aws codebuild start-build --cli-input-json file://start-build.json
オプションで上書きしたいパラメータをサクッと指定できればいいが、都度Jsonをいじらないといけないので常用するのは少し手間になる。
そしておそらくCodeBuildを頻繁に「上書きでビルドを開始する」のはあまり一般的な運用ではなさそう。なのであまり事例やツールなどを見つけられなかった。
今の職場だと
- トイルっぽいタスクを(半)自動化するためスクリプトを書く
- ワンクリックで誰でも実行できるようにCodeBuildで動かせるようにする
- パラメータの概念がある場合はCodeBuildの環境変数に設定して動的に変更できるようにする
みたいなことをちょこちょこしているので割と機会が多い。
(世の中の人たちはどうしてるんだろう)
Goでなにかコードを書きたかった
正直そこまで困ってるわけでもないけど、Goの練習したかったのでちょうどよかった。
よくわからなかったこと
Go初心者なのでこれでいいのか？みたいなところがちょこちょこあった。
とりあえず動きそうなのでよしとしてるけど気になったところを書いておく。
外部ライブラリのstructをYAML (or Json)で扱う方法
今回のツールだと読み込んだYAMLをgopkg.in/yaml.v3でUnmarshalしてAWS SDKのStartBuildInputとして解釈したかった。
だけど外部ライブラリのstructにYAML用のtagをつけられないのでどうすればいいかよくわからなかった。
type T struct {
F int `yaml:"a,omitempty"`
B int
}
の yaml:"a,omitempty"の箇所。
なので今回のツールでは
- 全く同じ形のstructを自前で定義。YAML用のtagもつける
- YAMLからUnmarshalする時は自前で定義したstructへ変換する
- https://github.com/jinzhu/copierを使ってStartBuildInputのインスタンスへコピーする
といった流れで書いた。
// copy configration read from yaml to codebuild.StartBuildInput
func convertBuildConfigToStartBuildInput(build Build) codebuild.StartBuildInput {
startbuildinput := codebuild.StartBuildInput{}
copier.CopyWithOption(&startbuildinput, build, copier.Option{IgnoreEmpty: true, DeepCopy: true})
return startbuildinput
}
ただ全く同じ定義を用意するの手間だし、ネストしてるところなどコピーする時に特にバグりそうでやだなと。
正しくないんだろうなーと思いながら書いたが正解がわからなかった。
まとめ
今回Cobraを使ってみたがサブコマンドやフラグ管理がとても便利だった。
テストやリリース周りもGo本体やGitHubのみで完結するし、ロジックを考えることに集中できてよかった。
何よりシングルバイナリ/クロスコンパイルはCLIツール作るのにとてもいい。
ただやっぱり慣れが必要な感はあるのでもうちょい書きたい。
Share on: Tweet