【CICD2021】デプロイメントパイプラインの原理原則を再確認する / Confirm Deployment Pipeline Principle

Slide 1

Slide 1 text

デプロイメントパイプラインの原理原則を再確認する #CICD2021 #CICD2021_B 髙市智章 (Tomoaki Takaichi) Sep, 3, 2021 CI/CD Conference 2021 by CloudNative Days

Slide 2

Slide 2 text

自己紹介 @Takaichi00 tomoaki.takaichi.5 ・髙市智章（タカイチトモアキ）・Java でのシステム開発・CI / CD ・Container / k8s ・アジャイル開発実践共著: クリーンなコードへの SonarQube即効活用術 http://u0u0.net/RSvx

Slide 3

Slide 3 text

❏ なぜ CI / CD /デプロイメントパイプラインが必要なのか ❏ デプロイメントパイプライントについて ❏ 全体の流れ・実施するテストのテスト戦略・プラクティス ❏ 具体的なツールの利用方法、詳細な方法論というよりかは、デプロイメントパイプラインでどういったことを意識して実行すべきかという点に着目 ❏ 主に開発者の方を対象として想定しているが、プロダクトの開発に関わっている全ての方に対しても参考になれば幸い本日お話すること

Slide 4

Slide 4 text

CI / CD の必要性

Slide 5

Slide 5 text

❏ 「LeanとDevOpsの科学」では、組織のパフォーマンス (収益性 / 市場専有率 / 生産性) は、「ソフトウェアデリバリのパフォーマンス」が予測要因の一つとされているなぜ CI / CD を行う必要があるか出典: https://img.ips.co.jp/ij/18/1118101029/1118101029-520x.jpg 出典: https://d2l930y2yx77uc.cloudfront.net/production/uploads/images/17728222/picture_pc_7ad9d39bﬀ46bb8813d1c7c8812fa5c9.png

Slide 6

Slide 6 text

❏ 「ソフトウェアデリバリのパフォーマンス」を統計的に優位な形で改善できる24のケイパビリティの中に、「継続的インテグレーション (CI) の実装」「継続的デリバリ (CD) の実践」が含まれている ❏ 組織のパフォーマンス(収益性 / 市場専有率 / 生産性)を向上させるために、CI / CD の実践は効果的であるなぜ CI / CD を行う必要があるか組織のパフォーマンス CI / CD の実践向上

Slide 7

Slide 7 text

❏ CI / CD を実践していないプロジェクトでは以下のような問題が往々にして起こりがち ❏ 何日も main ブランチにマージされずに機能開発が並行して行われ、リリース間際にマージ作業。しかしコンフリクトが多発し、マージしてもシステムが動作しないで遅延。 ❏ リリース期限ギリギリに本番環境にデプロイ。しかし本番環境特有の設定値が考慮されておらず、外部システムと連携できなかったり、パフォーマンスに問題が生じて遅延。 CI / CD を実践しないとどうなるか

Slide 8

Slide 8 text

❏ 継続的にコードをマージし、CI を実践することで常に動作するソフトウェアを維持する ❏ トランクベース開発と組み合わせて実施することでより効果を発揮する ❏ 継続的にデプロイを行い、リリースによるリスクを早期に発見し対処する ❏ CI / CD を含めた、ソフトウェアの変更をバージョン管理システムに反映してからユーザーの手に渡すまでのプロセスをデプロイメントパイプラインと呼ぶ CI / CD のメリットは自動化だけではない

Slide 9

Slide 9 text

デプロイメントパイプラインの流れ

Slide 10

Slide 10 text

❏ 「継続的デリバリー」の本では、デプロイメントパイプラインはいくつかのステージに分割されると記載されている ❏ ステージが進むにつれてリリースの自信が増し、環境がどんどん本番に近づく一方、フィードバックは遅くなるデプロイメントパイプラインのステージコミットステージ受け入れステージユーザー受け入れテストキャパシティステージ本番リリースに対する自信が増す・本番に環境が近くなるフィードバックは遅くなっていく

Slide 11

Slide 11 text

コミットステージ

Slide 12

Slide 12 text

❏ コミットステージは、開発者が変更をバージョン管理システムに反映したタイミングで、最初に実行されるステージ ❏ 本番環境にデプロイするにはふさわしくないビルドを排除し、そもそもアプリケーションが壊れていないかということを素早く知ることが目的コミットステージの概要バージョンコントロールコミットステージ成果物リポジトリ開発者チェックイン実行バイナリレポートメタデータ

Slide 13

Slide 13 text

❏ コミットステージでは以下のようなことを実施するコミットステージの内容 1. 「コミットステージテスト」を実行する 2. ソースコードの解析を行い、健全性をチェックする 3. ビルドを実行する 4. すべて問題なければ、生成されたリリース候補となる生成バイナリをアップロードする

Slide 14

Slide 14 text

❏ 素早く実行できるように最適化されたテスト一式のこと ❏ ほとんどはユニットテストになる (xUnit 系) ❏ ユニットテスト以外のテストも少し選び出し、このステージに含める (コンポーネントテストなど) ❏ コミットステージが通れば、アプリケーションが実際に動くのだと強い自信を持って言えるようにするコミットステージテスト

Slide 15

Slide 15 text

❏ SonarQube などの静的解析ツールを実行し、コードカバレッジ、Bug の恐れがあるコード、循環的複雑度などの統計情報を計測する ❏ 閾値を超えた場合はパイプラインを失敗させるといったことも考えるソースコードの解析項目失敗させる設定例コードカバレッジ 70%未満 Bugs の深刻度 (Severity) が Major 以上の項目 1個以上コードの重複率 5%以上

Slide 16

Slide 16 text

❏ 利用している商用ソフトウェアや OSS に脆弱性がないかを検査し、脆弱性があるものの利用を検知したらパイプラインを失敗させる ❏ SourceClear のようなツールを利用する脆弱性チェック

Slide 17

Slide 17 text

❏ コミットステージのすべてのステップが成功したときのみ、今後の受け入れステージや本番環境で利用するバイナリを成果物リポジトリ (Artifactory など) にアップロードする ❏ リリース候補となるバイナリを生成するのはコミットステージの最後ただ一度きりにする ❏ デプロイ環境ごとにビルドはしない ❏ バイナリの再生成の際に何らかの変更が紛れ込んでしまうというリスク ❏ 再コンパイルに時間がかかりフィードバックが遅くなるリリース候補となるバイナリを生成する

Slide 18

Slide 18 text

❏ CI はツールでなくプラクティスである。以下のような規律をチームで守ることで CI は実現されるコミットステージのプラクティス 1. 定期的に main ブランチにチェックインをする (最低でも1日2回) 2. ビルドが壊れているときはチェックインしない 3. コミットテストが通るまで次の作業を始めない a. 変更の記憶があるうちに素早くエラーを修正したい 4. テストが失敗してもビルドは続ける a. テスト以外にも失敗要因はあるかもしれない 5. 5分以内で終わるようにする (10分以上かかってはいけない)

Slide 19

Slide 19 text

受け入れステージ

Slide 20

Slide 20 text

❏ コミットステージで生成されたバイナリを擬似本番環境で実行させ、顧客の期待する価値をシステムがデリバリーできていることを検証する受け入れステージの概要成果物リポジトリ受け入れステージバイナリ成果物リポジトリコミットステージ実行レポート環境設定アプリ設定疑似本番環境用にデプロイするための設定バイナリ

Slide 21

Slide 21 text

❏ コミットステージテストでは検証できないような、ビジネス視点での検証を本番とほぼ同じように動いているアプリケーションに対して行うことが目的受け入れステージの目的 1. ユーザーの求める価値を提供しているか? 2. 環境や設定ファイルに起因する問題はないか? 3. 新しい変更によって既存のふるまいにバグが生じていないか?

Slide 22

Slide 22 text

❏ 受け入れステージのテストは、受け入れ基準に基づき、エンドユーザーにとって価値があるテストでなければならない ❏ Cucumber のような Garkin 記法という自然言語を用いてテストケースを記載できるツールを利用することもある受け入れステージのテスト

Slide 23

Slide 23 text

1. 受け入れステージが失敗したら即座にチーム全体で修正する 2. 自動受け入れテストは自分たちの開発環境で実行できるようにする a. 失敗した場合開発者のマシンで再現できなければならない 3. 外部システムとすべて統合された環境で実行しない a. テストダブルを利用し、外部システムのふるまいはこちらで定義できように 4. 受け入れテストは実行可能な仕様として機能するよう、ビジネスの言葉(ユビキタス言語)で表現する 5. 本番環境と同じプロセスでデプロイを行う a. 自動デプロイメントのテストという意味合いもあるため受け入れステージのプラクティス

Slide 24

Slide 24 text

コミットステージと受け入れステージの例

Slide 25

Slide 25 text

Kubernetes で実行されるアプリケーションの場合 GitHub コミットテストソースコード解析脆弱性チェックビルド/バイナリ生成 Artifactory 自動デプロイ kubernetes (疑似本番環境) 自動受け入れテストテストのセットアップ DB (疑似本番環境) 疑似外部システム ← 外部システムをスタブに切り替えるテーブル再作成データ投入

Slide 26

Slide 26 text

コミットステージ・受け入れステージテスト戦略

Slide 27

Slide 27 text

❏ コミットステージ / 受け入れステージで実施するテストはどのように設計すればいいだろうか? どのようにテストを設計するか? コミットステージ受け入れステージ ● 素早く実行できる ● そもそもアプリケーションは起動するか? ● 開発者視点のテスト ● 疑似本番環境で実行する ● 機能的な価値を満たしているか? ● 顧客視点のテスト

Slide 28

Slide 28 text

❏ 「実践アジャイルテスト」では、アジャイルテストの4象限 / テストピラミッドを用いてソフトウェアにおけるテストにはどのような種類があり、どう自動化すると良いかが説明されているアジャイルテストの4象限 / テストピラミッド出典: https://notta55.hatenablog.com/entry/2015/05/03/161631 … EtoE, SystemTest (ST) … IntegrationTest (IT) と呼ばれることも

Slide 29

Slide 29 text

❏ コミットステージでは主に Q1, 単体テスト/コンポーネントテストを実施する ❏ xUnit 系のテストで、クラスや関数に対してテストを実施することが多い (JUnit, PHPUnit など) ❏ 境界値試験など多くのテストケースが発生するテストはなるべくコミットステージで実施するコミットステージで実施するテスト出典: https://notta55.hatenablog.com/entry/2015/05/03/161631

Slide 30

Slide 30 text

❏ 受け入れステージでは主に Q2, Q3, API レイヤー, GUI に対してのテストを実施する ❏ これらのテストは実行に時間がかかり、特に GUI のテストは少しの変更で壊れやすいため、単体テストほど厚くテストをしない ❏ 境界値試験のようなテストはあまり実施しないようにする受け入れステージで実施するテスト出典: https://notta55.hatenablog.com/entry/2015/05/03/161631

Slide 31

Slide 31 text

❏ 近年コンピューターリソースが向上し、GUI を含むシステムテストや DB アクセスのコストが低下したことで生まれた考え方テストアワーグラス (砂時計) ユニットテストシステムテストインテグレーションテスト ❏ システムテストが少ないため、「なぜその機能が必要なのか」を忘れてしまう ❏ インテグレーションテストがあっても、今意味がある機能なのかがわからないためメンテナンスコストが高くなってしまうテストピラミッドの欠点:

Slide 32

Slide 32 text

❏ GUI テストは一般的に時間がかかるが、並列実行などで工夫すれば時間を短縮することができる ❏ 例えばメルカリ様では、Selenium Grid をベースに作られた Zalenium と Kubernetes を組み合わせることで、従来では1時間かかっていた GUI テストを 6~7 分で実施することに成功 GUI テストの実行時間を短くする取り組み「メルカリWeb版のUIテスト自動化で目指している世界と、そのために作った Selenium Grid・Zalenium 環境 on Azure Kubernetes Service(AKS)」 (https://engineering.mercari.com/blog/entry/2019 -04-16-060000/)

Slide 33

Slide 33 text

❏ 一般的なテストピラミッドの考え方は持ちつつも、システムの特徴にあったテスト戦略を考える ❏ 例) GUI を持たないアプリケーションでは、EtoE 試験を厚くしテストアワーグラスのような構造をとる ❏ 例) GUI テストが高速に実行できる基盤、ナレッジがあるので、GUI テストを厚くしテストアワーグラスのような構造をとるシステムの特徴によってテスト戦略は変わる

Slide 34

Slide 34 text

テスト戦略の具体例をを考える ※発表者の見解であり、正解ではありません

Slide 35

Slide 35 text

❏ SpringBoot、Thymeleaf を用いてサーバーサイドレンダリングで簡単な GUI を提供し、画面操作を通じて DB の値を操作する管理システムの場合例: 簡単な GUI をもつ Java (SpringBoot) の管理システム DB サーバーサイドレンダリング

Slide 36

Slide 36 text

例: 簡単な GUI をもつ Java (SpringBoot) の管理システム .Class コミットステージ .Class .Class .Class .Class Test MockMVC 受け入れステージユニットテスト ※ MockMVC … アプリケーションサーバ上にデプロイすることなくSpring MVC の動作を再現できる Cucumber を使い自然言語でテストケースを記載 Selenide を使って自動 GUI テストを実行コンポーネントテスト (クラスを結合させて動作検証する)

Slide 37

Slide 37 text

❏ それぞれのテストの割合はテストピラミッドの考え方に近づける例: 簡単な GUI をもつ Java (SpringBoot) の管理システムユニットテスト (コミットステージ) コンポーネントテスト (コミットステージ) 自動 GUI 受け入れテスト (受け入れステージ)

Slide 38

Slide 38 text

❏ REST API を提供する複数の SpringBoot アプリケーションからなるシステムの場合例: 複数の REST API からなるシステム DB REST API REST API App A App B

Slide 39

Slide 39 text

例: 複数の REST API からなるシステム .Class コミットステージ .Class .Class .Class .Class Test 受け入れステージユニットテスト API ごとの受け入れテスト App A App B (スタブ) App B DB API を結合させた受け入れテスト App A App B DB

Slide 40

Slide 40 text

❏ それぞれのテストの割合はテストピラミッドの考え方に近づける例: 複数の REST API からなるシステムユニットテスト (コミットステージ) API ごとの受け入れテスト (受け入れステージ) API を結合させた受け入れテスト (受け入れステージ)

Slide 41

Slide 41 text

❏ Spring Boot CLI を用いて CLI アプリケーションを作成する例: CLI アプリケーション CLI .Class コミットステージ .Class .Class .Class .Class Test ユニットテスト受け入れステージ自動受け入れテスト受け入れ基準となるテストケースを元に、実際に CLI を実行して動作を検証する

Slide 42

Slide 42 text

❏ CLI アプリケーションであり、自動受け入れテストのコストテストの割合は低くなるため、それぞれのテストの割合はテストアワーグラスの考え方に近づける例: 複数の REST API からなるシステムユニットテスト (コミットステージ) 自動受け入れテスト (受け入れステージ)

Slide 43

Slide 43 text

テスト戦略の具体例をを考える ※発表者の見解であり、正解ではありません

Slide 44

Slide 44 text

キャパシティステージ

Slide 45

Slide 45 text

❏ 受け入れステージの後、もしくは受け入れステージやユーザー受け入れテストと並列で実行するステージ ❏ ある変更がシステムのキャパシティに対して影響を及ぼしているかどうかを確認する ❏ キャパシティ: 一定の負荷がかかった状態で、個々のリクエストを許容範囲内のレスポンスでさばききれる最大スループットキャパシティステージの概要コミットステージ受け入れステージユーザー受け入れテストキャパシティステージ本番リリースに対する自信が増す・本番に環境が近くなるフィードバックは遅くなっていく

Slide 46

Slide 46 text

❏ 非機能要件の扱いは以下のようになりがち ❏ 開発初期からあまり気を払わず、ある程度時間が経過したタイミングで問題が発覚する ❏ 機能要件に比べて軽視されがちであり、問題がリリース終盤まで発覚しない ❏ 過剰に非機能要件を意識してしまい、作り込みすぎてしまう ❏ 高速化のための可読性の低いトリッキーなコードが生まれてしまう (しかし本当に非機能要件を達成するために必要なコードかわからず、無駄なコストとなるかも) 非機能要件の扱い

Slide 47

Slide 47 text

キャパシティステージの目的 ❏ 開発初期にどの非機能要件が重要なのかを見つけ、計測する方法を探し、可能であればデプロイメントパイプラインに組み込む ❏ キャパシティが低下していた場合、対象となる変更を特定できるようにする ❏ パフォーマンスが要求されるシステムの場合、キャパシティ要件を満たせていない場合はパイプラインを失敗させる ❏ 本番環境でしか発生しないような不具合の事前検知、アプリケーションや環境の設定値のチューニングの実施

Slide 48

Slide 48 text

❏ 実際にありえるシナリオをテストする ❏ 既存の受け入れテストからいくつかピックアップ ❏ 個々のテストで成功したとみなせる条件を定義し、システムに負荷をかけた状態で閾値を満たせるかどうかを確認する ❏ 可能な限り、本番環境を再現したテスト環境を用意する ❏ 本番環境の再現が難しい場合は、等倍構成で実現できないか考える ❏ テストが成功となる閾値を事前に決めておき、テストが通るたびに閾値を微調整するキャパシティテストのプラクティス

Slide 49

Slide 49 text

デプロイ・リリース

Slide 50

Slide 50 text

❏ 各疑似本番環境や本番環境に対し、アプリケーションや設定を反映し、必要であればユーザーへ公開する ❏ 各環境のデプロイ、ロールバックなどは、対象のバージョンを指定してボタンを押すだけで実行できるようにするデプロイ・リリースの概要コミットステージ受け入れステージユーザー受け入れテストキャパシティステージ本番ロールバックデプロイ

Slide 51

Slide 51 text

❏ リリース戦略を初期に決定し、最初のリリースに向けて徐々にブラッシュアップする ❏ システム設計、ハードウェア環境の構成の決定 ❏ 技術選定、各環境の決定、SLA やキャパシティの決定、リリース方式の決定 ❏ これらを機能要件・非機能要件を決定する材料とするデプロイ・リリースのプラクティス ⇒ 受け入れステージやキャパシティステージなど、デプロイメントパイプラインを構築する材料とする

Slide 52

Slide 52 text

❏ 本番環境のデプロイメントは、他の環境のデプロイメントと同じ手順で実施する ❏ 各ステージで実施する疑似本番環境へのデプロイは本番環境へのデプロイのテストでもある ❏ デプロイメントが正しく実施されたかどうかをスモークテストで確かめる ❏ 外部接続先など、本番の設定情報が正しく反映されており、アプリケーションは動作する状態か? デプロイ・リリースのプラクティス

Slide 53

Slide 53 text

❏ 障害などが発生しても本番環境を直接修正しない ❏ 障害対応を本番環境で実施してしまうと、二次・三次障害の原因になる ❏ 本番環境だけ違う状態となり、他の環境で検証できたプロセスが本番環境で再現しない ❏ 障害が発生しても素早くロールバックできる機構を作る ❏ ブルーグリーン・デプロイメントやカナリアリリースを取り入れることで実現可能 ❏ 取り入れる必要があるかどうかも含めて判断ゼロダウンタイムリリース・ロールバック

Slide 54

Slide 54 text

❏ 変更をできるだけ早く本番環境に投入することで、個々のリリースのリスクを軽減することを目的とするのが継続的デプロイメント ❏ 「本番環境への自動デプロイメント」をデプロイメントパイプラインの最終ステップに追加する ❏ アプリケーション全体を網羅した自動テストが必要 ❏ 自動化され、繰り返し実行可能な状態にする ❏ 実際にはテストが通過する度に本番環境にリリースすることはなくても、やろうと思えばいつでもできるという状態を目指す継続的デプロイメント

Slide 55

Slide 55 text

デプロイメントパイプラインを活用する

Slide 56

Slide 56 text

デプロイメントパイプラインを実装するタイミング ❏ デプロイメントパイプラインのプロセスは、プロジェクトの最初のうちに整備したほうが、イテレーションを何度か行ったあとに整備するのに比べて遥かにコストが低い ❏ プロジェクトの初期からデプロイメントパイプラインが整備されていることで、自動テストや自動受け入れテストが前提となる開発になり、結果よい設計で開発が進み保守性が上がる ❏ イテレーション0 のような準備期間で、動くスケルトンをもとにデプロイメントパイプラインを実装するのが理想 ❏ プロジェクトの途中に導入する場合は、最も一般的で価値が高く、重要なユースケースから徐々に導入する

Slide 57

Slide 57 text

CI / CD はツールではなくプラクティス ❏ デプロイメントパイプラインを構築し、そこで様々なツールが駆使されていても CI / CD は実現されない ● ブランチを分けて開発者ごとに並行開発。イテレーションの最後にならないと main ブランチにマージされず、イテレーションの最初はデプロイメントパイプラインは実行されていない。イテレーションの最後はマージによるコンフリクトを修正するので精一杯。イテレーション開始イテレーション終了 main branch コンフリクト地獄例...

Slide 58

Slide 58 text

CI / CD はツールではなくプラクティス ● コードの変更が main ブランチに加わるたびに SonarQube によるコード解析が実行される。しかし開発者は機能開発に追われ、 SonarQube を活用したアクションは何も取っていない。結果テストのカバレッジは2-30%, バグの恐れのあるコードがどんどん積み重なっていく。カバレッジ: 25% Bugs: 125件とにかく次イテレーションのデモができるように機能開発優先だ！

Slide 59

Slide 59 text

CI / CD はツールではなくプラクティス ● 厳しいスケジュールの中で全ての機能要件を満たすため、リリースのための作業はさておいて機能開発を優先して実施。イテレーションごとに擬似本番環境にデプロイしてデモは実施しているものの、それ以外は何もできていない。コミットステージ受け入れステージユーザー受け入れテストキャパシティステージ本番

Slide 60

Slide 60 text

CI / CD はツールではなくプラクティス ❏ そして以下のようなケースが訪れてしまうかもしれない ● リリースも間近になり、いざ性能試験を実施すると SLA を満たせないことが判明。何が原因なのか、特定に時間がかかる。 ● QA チームに指摘を受け、SonarQube を確認してみるとコード品質に問題があり、満足なテストも実施されていないためバグがあるかどうかもわからない ● なんとか修正を実施し、本番環境にデプロイ&リリース。しかし本番環境特有の設定値が考慮されておらず、アプリケーションはエラー頻発。緊急メンテナンスを実施し、ユーザー影響が出てしまう。

Slide 61

Slide 61 text

炎上スプリント ❏ 機能開発以外のコストは忘れがちで、リリース前になって初めてリリースコストの重大さに気づく。機能開発を進めていれば直感的には進捗が出ていると錯覚してしまう。 ❏ 例: スクラムでのリリーススプリント (別名: 炎上スプリント) ● リスクと透明性の欠如 ● 遅延と柔軟性の欠如出典: https://less.works/img/framework/undone-work/causing-risk-and-delay.png

Slide 62

Slide 62 text

プラクティスを理解して実践する ❏ 不確実なものを先延ばしにしてしまうという人間の本能を理解する ❏ デプロイメントパイプラインを早めに構築し、プラクティスを実施することでリリースのリスクを徐々に下げていく ❏ 開発者だけでなく、ビジネスサイドも含めたプロダクトに関わる全ての人が CI / CD というプラクティスを理解することでより良いプロダクト開発ができるのでは

Slide 63

Slide 63 text

さいごに

Slide 64

Slide 64 text

❏ 今回の発表ではデプロイメントパイプラインに関するプラクティスと自分が経験した具体的な方法論についてご紹介した ❏ 今後はセキュリティテストをどうデプロイメントパイプラインに組み込むか (DevSecOps) などにも挑戦したい ❏ 皆様が携わっている業務に少しでもお役に立てれば幸いさいごに

Slide 65

Slide 65 text

継続的デリバリー参考書籍実践アジャイルテスト LeanとDevOpsの科学実践テスト駆動開発テスト駆動開発出典: https://img.ips.co.jp/ij/18/1118101029/1118101029-520x.jpg 出典: https://images-na.ssl-images-amazon.com/images/I/51TkJaY4jPL._SX400_BO1,204,203,200_.jpg 出典: https://m.media-amazon.com/images/I/51v3XabFauL._SX260_.jpg 出典: https://images-na.ssl-images-amazon.com/images/I/51hsd-b1RTL._SX350_BO1,204,203,200_.jpg 出典: https://images-na.ssl-images-amazon.com/images/I/61UOZrEZR6L._SX398_BO1,204,203,200_.jpg エンジニアリング組織論への招待出典: https://images-na.ssl-images-amazon.com/images/I/51zMvVL4MeL._SX351_BO1,204,203,200_.jpg

Slide 66

Slide 66 text

ご清聴ありがとうございました