統合ビルド用の高度なレポート
以下の記事では、Klocwork Static Code Analysis で使用可能なレポート機能を拡張またはカスタマイズするための情報を提供します。
指摘のオーナーを割り当てると、デベロッパーが独自の指摘のバックログを管理し、マネージャーがデベロッパーの進行状況を追跡する際に役立ちます。次の 2 つの方法でオーナーシップを割り当てることができます。
- ファイル別に、ソースオーナーシップファイルを使用する方法
- 指摘別に、静的コード解析で行う方法
これら 2 つの方法は別々に、または一緒に使用できます。
静的コード解析で、使用できるメトリックレポートをカスタマイズすることができます。そのためには、デフォルトのサイズと複雑度の各レポートタイプをカスタマイズし、Klocwork メトリックに基づく新しいレポートタイプを追加し、自分で定義するメトリックに基づくカスタムレポートタイプを追加します。このリストに新しいメトリックレポートタイプを追加すると、それらのタイプに基づくレポートを生成し、保存し、パブリックにして、静的コード解析の全ユーザーがそれらを [レポート] ツリーで確認することもできます。
Klocwork は、組織の基準と優先度に基づいて設定されたメトリックしきい値違反を検出して報告することができます。デフォルトのメトリックしきい値構成ファイルは、いくつかの基本メトリックをカバーするレポートを生成します。ただし、この構成ファイルを変更することで、コード品質目標との関連性が高いエラーを Klocwork に報告させることができます。
追加の情報を開発チームが入手できるようにするには、静的コード解析で表示可能な独自のドキュメントを作成できます。テキストファイル、ドキュメントファイル、HTML ファイルなど、多くの種類のドキュメントを追加できます。画像ファイルはサポートされていないことに注意してください。ブラウザーでファイルタイプを表示できる場合、ユーザーは静的コード解析の右側のペインでドキュメントコンテンツを表示できます。ブラウザーでファイルタイプを表示できない場合、ユーザーはドキュメントリンクを右クリックし、ファイルをダウンロードすることでこれを表示できます。
静的コード解析にバグ追跡システムを統合すると、Klocwork の指摘のバグチケットを追跡システムに送信し、そのトラッカーのバグ ID、バグチケットのリンク、バグトラッカーから取得されたその他の情報を静的コード解析で表示できます。
Klocwork Web API は、管理者に Klocwork データベースに対するスクリプト可能なインターフェイスを提供します。現時点で Web API の対象は、検出された指摘とメトリックについての情報のみです。
