テーマ別の解説テーマ:CI/CDの設計:検査から配信と回復まで
CIとは?変更の自動テストと、成功しても分からないこと
CI(継続的インテグレーション)は、小さな変更を頻繁に共有・統合し、自動のビルドやテストで問題を早く見つける開発の進め方です。ポート番号を判定する短い関数を例に、「何を検査したか」「成功から何が言えるか」を追います。GitHubやAWSのアカウントは使いません。
変更・対象revision・期待結果・実行済みの検査を対応させ、テストの成功と本番の保証を分けて説明できる。
Gitのコミットは履歴上の特定の内容を表します。revisionは、その検査が読む版のことです。CIの実行サービスの操作やプログラムの暗記は不要です。
CIは、変更へ早く結果を返す
対象の版と変更した条件を記録する。
入力と期待結果を比べ、結果を残す。
未実行・対象違い・不足条件も確かめる。
要件とレビュー、必要な検査から判断する。
概念の区分です。実行ログや、本番配信まで自動で完了する流れではありません。
CIはGitHub Actionsという製品名と同じ意味ではありません。変更を小さく共有し、繰り返せる検査から早く結果を得ることが中心です。ActionsのworkflowはCIにも配信にも使えますが、workflowが存在するだけでCIの目的を満たすとは限りません。
ビルドは、ソースから実行物や配信物を作る工程。テストは、定めた条件の入力と期待結果を比べる工程です。静的な設定チェックや書式検査も組み合わせられます。どの変更で何を実行し、どの結果を取り込みの条件にするかを決めます。
例:正の数なら、ポート番号としてよい?
架空の設定検査C1では、listenPortに受け入れる値を「数値型の整数で、1以上65535以下」と決めます。文字列の自動変換はしません。これは入力規則の練習で、実際のサーバーへ接続する検査ではありません。
// Fictional input check, not a server configuration
const validPort = value => Number(value) > 0;
// Number("443") becomes 443; the original type is lost.
// 65536 and 443.5 are also positive.| 入力 | 期待 | 変更案Bの実際 | 判定 |
|---|---|---|---|
| 443(数値) | 受入 | 受入 | 一致 |
| 0(数値) | 拒否 | 拒否 | 一致 |
| "443"(文字列) | 拒否 | 受入 | 不一致 |
| 65535(数値) | 受入 | 受入 | 一致 |
| 65536(数値) | 拒否 | 受入 | 不一致 |
| 443.5(数値) | 拒否 | 受入 | 不一致 |
443と0の2入力だけなら、Bも2件とも一致します。検査が成功しても、未検査の文字列・上限・小数の規則は確認できません。 期待結果は実装に合わせて変えるのではなく、先に定めた入力規則から決めます。
条件を直し、同じ期待結果で確かめる
const validPort = value =>
Number.isInteger(value) && value >= 1 && value <= 65535;
// All six C1 inputs now match their specified expectations.Cでは6入力すべてが期待と一致します。Bの不一致を検出したケースは、同じ欠陥の再混入を見つけるために残します。失敗時には、対象の版、入力、期待、実際を読んで、実装の誤り・期待結果の誤り・実行環境の違いを切り分けます。
緑の表示を見る前に、対象と実行を読む
| 項目 | この例で確認すること |
|---|---|
| 対象revision | BかCか。古いAの結果をCへ流用しない。 |
| 実行した入力 | 443と0だけか、6入力すべてか。 |
| 期待と実際 | 不一致が失敗として記録されているか。 |
| 実行状態 | 実行したのか、skip・中断・未起動か。 |
| 環境と範囲 | ランタイムや依存を記録。本番の通信検査とは分ける。 |
GitHubのchecksでは、条件でスキップされたjobが成功扱いになる場合があります。そのjobの成功表示から、内部のテストが実行されたとは言えません。workflow全体が起動されなかった場合とも区別し、対象・実行条件・ログやテスト結果を確認します。
PRでは、提案側の版と取り込み結果を検査する版が異なる場合があります。Actions教材で実際に読んだrevisionを確認してください。CIサービスの名前より、何を入力にどの検査が行われたかが大切です。
入力テストと、本番の通信は別に確かめる
Cが443を受け入れても、サーバーが起動した、443で待受けている、経路やファイアウォールを通れる、TLS証明書が正しい、という結果は出ていません。値の形式・プロセス・経路・暗号化・利用者からの動作を分けて確認します。
- 変更した条件を、入力と期待結果で書く。
- 正常値だけでなく、型・境界・異常値を選ぶ。
- 現在のrevisionで検査を実行し、不一致を失敗として報告する。
- 未実行や対象違いを、成功の代わりに数えない。
- レビュー・成果物・配信先・本番確認を、次のパイプライン設計でつなぐ。
CIの結果を読み分ける
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- C1の入力規則を自分の言葉で説明する。
- Bが6入力のうち3件で不一致になる理由を示す。
- revision・実行条件・期待・実際を確認する。
- 入力検査から分からない本番の条件を挙げる。
理解を確かめる: Cの6件が成功したので、本番のTLS通信まで検証済みと言える?
言えません。Cは数値型・整数・範囲の判定です。実行物と配信先を特定し、待受け、経路、アクセス制御、TLS、利用者の動作を別に確認します。
成功の範囲を、検査した条件から広げすぎないことがCIを正しく使う基本です。
出典と確認した条件
説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。
確認した内容・条件小さい変更を頻繁に統合し、ビルド・テスト等で問題を早く見つける原理。GitHub Actionsは適用例でありCIの唯一の製品ではない。 公式資料を確認。実GitHub/AWSの検証ではありません。
参照した本文CIは、変更へ早く結果を返す
確認した内容・条件jobのskippedは成功扱いになる。実行済み検査の証拠とは分ける。workflow全体の起動スキップとは同一視しない。 公式資料を確認。実GitHub/AWSの検証ではありません。
参照した本文緑の表示を見る前に、対象と実行を読む
確認した内容・条件開いたマージ可能PRのpull_requestで、既定の検査用refとhead.shaを区別。別イベント・checkout指定の変更は別途確認。 公式資料の確認であり、実環境の検証ではありません。
参照した本文緑の表示を見る前に、対象と実行を読む