このセクションの内容:
| Table of Contents | ||
|---|---|---|
|
はじめに
Key Performance Indicator (KPI) スライスは、開発プロジェクトでコード解析ルールに割り当てられた重み付けに基づいて、スコアを計算します。重み付けは、開発目標に合わせてカスタマイズできるプロファイルで定義されます。このスライスが呼び出されると、プロジェクトの各ファイルについてルール違反の数がカウントされます。各ルールについて、プロファイルで指定されたルールの重み付けで違反カウントを乗算します。ルールに対してルール プロファイルに定義された重みがない場合、そのルールのカウントは収集されません。KPI スコアを出すために、重み付けされたカウントの合計が論理コード行 このスライスは、定義済みの重み付けされたルール プロファイルを開発プロジェクトに適用することで、KPI (METRIC.KPIIF) スコアを計算します。重み付けされたルール プロファイルを利用すると、ルールのカスタム セットを定義し、各ルールに個別に重み付けを適用することができます。このスライスを呼び出すと、プロジェクト中の各ファイルのルール違反の数がカウントされます。ルールごとに、「ルール違反の数」が「ルール プロファイルで指定されたルールの重み付け」で乗算されます。ルールに対してルール プロファイルに定義された重みがない場合、そのルールのカウントは収集されません。KPI スコアを出すために、重み付けされたカウントの合計がファイルの論理コード行 (METRIC.NOLLOCIF) で除算されます。このアーティファクトのダウンロードとライセンスについては Parasoft 製品テクニカル サポート センターまでお問い合わせください。このアーティファクトも このアーティファクトは Security Compliance Pack for DTP 5.4.2 23 に同梱されています。これには、セキュリティ コンプライアンス標準に関連する KPI を計算するためのコンフィギュレーションが含まれます。
このセクションの内容:
KPI Slice Workflow
- Security Compliance Pack をインストールします。KPI スライスおよび重み付けされたプロファイルがインストールされます。
- DTP 環境に KPI スライスをデプロイします。
- Security Compliance Pack テスト コンフィギュレーションのいずれかを使用してコード解析ツールを実行します (詳細については「Security Compliance Pack for DTP 5.4.3」を参照)。
- Metrics テスト コンフィギュレーションを使用してコード解析ツールを実行します。ファイルの論理行数メトリクス (METRIC.NOLLOCIF) を有効にする必要があります。
- KPI スライスの REST エンドポイントを呼び出して計算を実行します。フィルター ID、ビルド ID、および重み付けが定義された KPI プロファイルを含める必要があります。計算は長時間実行されるプロセスであり、通常、自動夜間コード解析の一部として実行するのが最適です。
- KPI プロファイルに従ってデータを表示するように構成されたメトリクス ウィジェットを追加します。
...
要件
- DTP および DTP Enterprise Pack 5.4.3
- Parasoft C/C++test、dotTEST、Jtest 10.4.23
- ファイルの論理コード行数 (METRIC.NOLLOCIF) を DTP にレポートするようにコード解析ツールを設定する必要があります。正しいフィルターとビルド ID を使って設定する必用もあります。フィルターとビルドの詳細およびコード解析ツールでこれらを設定する方法については、「DTP の概念」を参照してください。
- 静的解析データを持つビルドが DTP になければなりません。静的解析を持つ最新ビルドでメトリクスが DTP にレポートされます。
追加されるコンポーネント
KPI スライスをインストールすると、4 つのサンプル プロファイル (下記で説明) が追加されます。
インストール
- アーティファクトのインストール方法については 「アーティファクトのダウンロードとインストール」 を参照してください。
- Extension Designer のアクション メニューから [読み込み] > [ライブラリ] > [Process Intelligence] > [Key Performance Indicator] > [Key Performance Indicator] を選択してサービスにアーティファクトをインポートします。
- [デプロイ] をクリックします。
アップグレードについての注意事項
KPI 2.1 にアップグレードしている場合、モデルとプロファイルを含め、アーティファクトから以前のバージョンをアンインストールします。
バージョン 2.1 より、プロファイルごとにメトリクス ID を定義することができます。特定のメトリクス ID とプロファイルを関連付けると、結果を上書きせずに複数のメトリクスについて KPI を参照できます。
- になければなりません。KPI 計算リクエストにビルド ID を含めない場合 (「計算の実行」を参照)、メトリクスは、静的解析データを含む最新のビルドで DTP にレポートされます。それ以外の場合、計算は指定されたビルドにレポートされます。
インストール
KPI スライスは Security Compliance Pack for DTP 5.4.3 と共にインストールされます。Security Compliance Pack をインストールした後、Extension Designer を使用してスライスをデプロイする必要があります。
バージョン 2.0 以前の KPI からのアップグレード
KPI スライスのスタンドアロン インスタンス (DTP 5.3.3 でサポート) からアップグレードする場合は、最新バージョンをインストールする前に、モデルやプロファイルを含め、以前のバージョンのアーティファクトをアンインストールしてください。以前のバージョンに同梱のデフォルト 以前のバージョンに同梱のデフォルト プロファイルを変更した場合、またはカスタム プロファイルを作成した場合、プロファイルをエクスポートし、以下の属性を追加します (「プロファイルのエクスポートとインポート」も参照)。
...
デフォルト値を変更する場合、メトリクス ID 接頭辞を METRIC.KPI.<スペースなしのプロファイル名> に設定することを推奨します。メトリクスには完結な名前を使用してください (最大 30 文字)。
構成
このスライスは、KPI モデル プロファイル タイプを使って KPI スコアを計算します。プロファイルは、ウィジェット リクエストで送られた “profile” クエリー パラメーターから決定されます。このスライスにはサンプル プロファイルがいくつか含まれており、[モデル プロファイル] タブで確認できます。
詳細については「モデル プロファイルの使用」を参照してください。
フィルター ID はウィジェットによってクエリー パラメーターとして渡されます。これは、プロファイルがどの DTP フィルターに対して計算すべきかを決定します。以下のサンプル プロファイルは、モデル プロファイルの設定を簡単にするためにディストリビューションと共にインストールされます。
| Scroll Table Layout | ||
|---|---|---|
|
...
スライスのデプロイ
- Extension Designer を開き、[サービス] タブをクリックします。
- サービス カテゴリを展開し、既存のサービスをクリックするか、KPI スライスをデプロイする新しいサービスを作成します。
- スライスを既存のサービスにデプロイする場合は、[+] ボタンをクリックして新しいタブを追加します。それ以外の場合は、次の手順に進みます。
- アクション メニューから [読み込み] > [ライブラリ] > [Workflows] > [Security] > [Key Performance Indicator] を選択します。
- タブ内の領域をクリックしてノードをドロップし、[デプロイ] をクリックします。
| Anchor | ||||
|---|---|---|---|---|
|
Security Compliance Pack for DTP 5.4.3 をインストールすると、いくつかの KPI プロファイルが追加されます。各プロファイルには、一連のセキュリティ コンプライアンス ガイドラインをチェックする Parasoft ルール用の重み付けが含まれています。デフォルトの重み付けを使用するか、各ルールを確認して独自の重み付けを適用できます。
重み付けを変更するには:
- プロファイルをクリックし、[編集] をクリックします。
- ルールをクリックして [重み] フィールドの値を変更します。
- [保存] をクリックします。
プロファイルにないルールを追加して、計算に含めることもできます。詳細については「モデル プロファイルの使用」を参照してください。
| Anchor | ||||
|---|---|---|---|---|
|
KPI スライスは長時間実行するスライスです。理想的には夜間ジョブの一部として、サード パーティによって実行されたときにだけ計算されるべきです。
計算の実行
KPI スライスは長時間実行するスライスです。理想的には夜間ジョブの一部として、サード パーティによって実行されたときにだけ計算されます。
- [サービス] タブでサービス カテゴリをクリックし、エンドポイントを表示します。API または直接のエンドポイント パスを使用できます (詳細については「サービス カテゴリ ページ」を参照してください)。
- エンドポイントをコピーし、必須パラメーターと共に REST リクエストをエンドポイントに送ります。利用可能な場合 API エンドポイントを使用します (詳細については「フローの使用」を参照してください)。以下の表で必須パラメーターについて説明します。
...
| Code Block |
|---|
curl "http://localhost:83218314/api/v1/services/5dcc38b803c7380f707268b9/slices/a37fbfb6bd858e5f.59b87965978?filterId=712&buildId=docs-2019-11-13&profile=All%20RulesCWE%20Security%20Impact%20-%20Java" |
成功の場合、以下のようなレスポンスを受け取ります。
| Code Block |
|---|
{{
"success": {title: "KPI", message
"message": "Calculation has successfully started for filter 'Parabank-v3jtest' using profile 'CWE Security Impact - Java'. Check debug output for any errors during calculation.",
"title": "KPI"
}
} |
...
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
計算が完了して KPI メトリクスが DTP にレポートされたら、DTP のダッシュボードにメトリクス ウィジェットを追加し、ウィジェットを追加し、セキュリティ コンプライアンス ガイドラインに関連するメトリクスを [メトリクス] ドロップダウン メニューから Key Performance Indicator を選択できます。詳細については「メニューから選択できます。ドロップダウン メニューの値は、プロファイルの [メトリクス名] フィールドから取得されます (「構成」を参照)。DTP ダッシュボードへのウィジェットの追加に関する情報については「ウィジェットの追加」を参照してください。
ユーザーの指定に従ってウィジェットにメトリクスが表示されます。
ウィジェットをクリックすると、その詳細を メトリクス エクスプローラー で確認できます。
ウィジェットをクリックして 単一メトリクスの概要 レポート を表示します。
メトリクス エクスプローラー でデータを確認するには、レポートのリンクをクリックします。