静的解析Klocwork とJenkins CIの連携

1© 2017 Rogue Wave Software, Inc. All Rights Reserved. 1
静的解析Klocwork と
Jenkins CIの連携
Masaru Horioka
Sales Engineering Manager, APAC

この文書について
• 背景
– 開発チームによって静的解析とJenkins CIとの統合に対する要件は異な
る
• Daily/nightly/weekly 解析
• コミットしたらすぐ解析
• コードレビューシステムとの統合、Continuous Delivery, など
– Klocwork にもJenkins CIと連携するためのいくつかのオプションがある
• この文書のゴール
– ユーザーがKlocworkとJenkins CI を統合する上でどのようなオプション
があるか理解する
• 異なる解析オプションの特徴
• 解析オプションを選択するための考慮事項
• 展開方法例の提供

アジェンダ
• KlocworkとJenkins CIの統合に関する質問
• Klocwork 解析オプション: 統合ビルド解析と継続的静的コード解析
– なぜKlocwork が継続的静的コード解析を追加したか?
• 統合ビルド解析と継続的静的コード解析がどのように動作するか？
• 展開アプローチ
• サマリー

KlocworkとJenkins CIの統合に関する質問
• Codebase/SCM/Branch model
– 解析対象のプログラミング言語(C/C++, Java, C#)?
– codebaseの行数?
– どのようなSCMを使っているか?
– どのようなbranch model を採用しているか?
• CI/Build tools/environment
– すでに Jenkins や他の CI ツールを利用している?
– 開発者はどこでコードをコンパイルするか？デスクトップ（個人PC） or 共用ビ
ルドサーバー？
– どのブランチ(リポジトリ）が解析対象か？
– 解析の頻度は?
– どのくらいの解析時間なら許容可能か？
• Klocwork
– 保有（購入予定）のビルドライセンスの数
– 保有（購入予定）のCIライセンスの数
– デスクトップ解析の使用の有無
– 全ての指摘やメトリクス情報を含む解析結果レポートの必要性および更新頻度
（日 or 週）または新規指摘、修正件数のみで十分か？

Comparing Klocwork analysis
options

Klocwork analysis options: 統合ビルド解析と継
続的静的コード解析
統合ビルド解析 (通常の
Klocwork 解析)
継続的静的コード解析(New in
Klocwork 2016)
利用可能な
Jenkins Plugin
Klocwork Community Plugin Klocwork Jenkins Plugins
サポート対象プ
ログラミング言
語
C/C++/Java/C# C/C++
必要なライセン
ス
Build license CI License
解析結果全ての指摘、メトリクス等詳細情
報を含む
新規および修正件数のみ – 既存(existing)
の指摘は表示されない
解析結果の表示
方法
Klocwork Server上でソースコー
ドとともに表示
Jenkins jobのページでメッセージ及び行
番号のみ表示
Klocwork desktop上のソースコードに
メッセージをオーバーレイして表示する
ことが可能
解析スピード通常native buildの2-5倍。差分解
析は変更が小さい場合早い
変更が小さい場合は早い。統合ビルド解
析の差分解析より早い。

統合ビルド解析と
Klocwork Community Plugin
の動作

Klocwork Community Pluginによる統合ビ
ルド解析の実行フロー
Jenkins Master
開発者
SCM: Trunk/Main branch
Jenkins Agent/
Klocwork ビルド
サーバー
Klocwork Web サーバー
1. Check-in code 2. （日
次）解析
を実行
3. Check-out
code
5. 解析結果のアップロー
ド＆レポート生成 4. 解析を実行
6. Jenkins レ
ポート生成 (デー
タは Klocwork
Web サーバーか
ら取得)

Klocwork Community Plugin: Jenkins Job
ページにKlocwork Trendが表示される

Klocwork Community Plugin: Klocwork解析
結果
指摘のリンクをク
リックすると
Klocwork Web サー
バーに遷移

継続的静的コード解析と
Klocwork Jenkins Plugin
の動作

Klocworkが継続的静的コード解析を開発
した理由
継続的静的コード解析: アジャイル開発をスローダウンさせない静的解析
• スピードに主眼
• 利用顧客プロファイル
• Androidやインフォテイメントシステム、ネットワーク機器等、大規模C/C++
コードを開発
• 静的解析を含む様々な自動テストをJenkins CI上で実施
• 静的解析に非常に時間がかかる（例えば４８時間）だと、２週間のスプリン
トに対して運用が困難
• Klocworkの詳細レポートは不要（新規不具合の混入がないことに主眼）
• その他の顧客のプロファイル
• 静的解析の早いフィードバックが必要であるが、"デスクトップ"解析の運用が困
難 (コンパイルや解析を共用ビルドマシン上で実行)
• ユースケースに応じて、統合ビルド解析、継続的静的コード解析を選択または共用する

Klocworkが継続的静的コード解析を開発した
理由
Slides from Robert Martin, "MULTI-STAGE-CI SYSTEM WITH JENKINS IN THE EMBEDDED WORLD":
https://www.cloudbees.com/sites/default/files/2014-0625-berlin-robert_martin-multi_stage_ci_0.pdf
継続的静的
コード解析の
ターゲット

Klocwork Jenkins Plugin による継続的静的
コード解析の実行フロー
高速差分解析により解析結果のフィードバックをより早く
Jenkins Master開発者
SCM: Trunk/Main branch OR
Feature/Personal branch before merge
Jenkins Agent/
Klocwork Jenkins
Plugin
Klocwork Web サーバー
1. Check-in code 3. 差分解
析をリク
エスト
4. Check-out
code
解析結果はアップロード
されない
5. 解析の実行
6. 差分解析レ
ポートを生成
2. commit通知(by
git hook etc)

継続的静的コード解析 with Klocwork
Jenkins Plugin
例：新しい指摘のためビルドを失敗と判断
Jenkinsビルドレポート
上に解析結果を表示
（Klocworkサーバー上
には解析結果は表示され
ない. Editボタンを押す
とJenkinsレポート上で
コメント入力や選別が可
能。

Jenkins Plugin
例：指摘情報の選別

Jenkins Plugin
例：指摘が修正されれビルド成功と判断

ユースケース: 統合ビルド解析とContinuous SCA の共用
C/I C/I C/I C/I C/I C/I
SCM: Trunk
Jenkins ジョ
ブ:
Continuous
SCA
Jenkins ジョブ:
統合ビルド解析
開発者
9am 6pm 0am
コミット毎にContinuous
SCA を実行しすばやく
フィードバック
夜間に統合ビルド解
析を実行し詳細レ
ポートを生成
Developer A Developer B Developer C
Jenkins job fails if new issues introduced

推奨される展開アプローチ
Level 3: カスタム統合 / Continuous Delivery
code reviewとの統合, Multi stage CI, continuous delivery, など
Level 2: 継続的静的コード解析の展開
対象: trunk/master/release向けだけではなく、
機能、個人用ブランチ
ゴール:変更による不具合の混入の早期発見
Level 1: 統合ビルド解析を自動化
対象: trunk/master/release向け等寿命の長
いブランチ
ゴール: 解析を自動化し品質を測る化、見え
る化

サマリー
• 2種類のKlocwork 解析オプションとJenkinsプラグイン:
– Klocwork Community Plugin による統合ビルド解析
• 夜間、週次解析の自動化により測る化、見える化
• 継続的静的コード解析のベースラインの作成
– Klocwork Jenkins Plugin による継続的静的コード解析
• 大規模C/C++ codebase
• コミット毎の解析
• 統合ビルド解析よりも軽量で早いフィードバック
• ユースーケースに応じて、一方または両方を活用

Klocwork Community Plugin とKlocwork
Jenkins Pluginの比較
Klocwork Community
Plugin
Klocwork Jenkins
Plugin
Created/Supported by OSS(Emenda社が主導) Rogue Wave
Analysis option
supported
統合ビルド解析継続的静的コード解析
Klocwork license
required
Build license CI license
Klocwork コマンドが
Pluginに含まれるか?
No (Pluginとは別に
Klocworkのinstallが必要
)
Yes (PluginにKlocwork
コマンドが含まれる)

参考：継続的静的コード解析の展開におけ
る考慮事項
• 継続的静的コード解析を実行するには初回の "baseline" 解析が必要にな
ります。.Klocwork Pluginは初回解析以降に追加されたコードに対して、
差分解析をおこない新規指摘のみを報告します。
– https://support.roguewave.com/documentation/klocwork/jp/current/int
egratingwithjenkins/
• 継続的静的コード解析は差分解析実行のために、 Klocwork tables dataを
使用します。差分解析を行うためには、常に同じJenkins Slave上で解析
をおこなうか、table dataを複数のJenkins Slave上で共有する仕組みを別
に作る必要があります。

参考文献
• Klocwork Community Plugin
– https://wiki.jenkins-
ci.org/display/JENKINS/Klocwork+Community+Plugin
• Klocwork Jenkins Plugin
– https://support.roguewave.com/documentation/klocwork/jp/current/se
ttingupjenkins/
• Robert Martin, "MULTI-STAGE-CI SYSTEM WITH JENKINS IN THE
EMBEDDED WORLD":
– https://www.cloudbees.com/sites/default/files/2014-0625-berlin-
robert_martin-multi_stage_ci_0.pdf

静的解析Klocwork とJenkins CIの連携

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to 静的解析Klocwork とJenkins CIの連携

Similar to 静的解析Klocwork とJenkins CIの連携 (20)

More from Masaru Horioka

More from Masaru Horioka (8)

Recently uploaded

Recently uploaded (7)

静的解析Klocwork とJenkins CIの連携