EN JP CN

チュートリアル - 分類基準の作成と結果の表示

チュートリアル - 分類基準の作成と結果の表示

チュートリアル - 分類基準の作成と結果の表示

チュートリアル - 分類基準の作成と結果の表示

このチュートリアルでは、次の方法について説明します。

  • Klocwork Static Code Analysis に分類基準を設定して、内部コーディングポリシーをサポートします。
  • Klocwork Static Code Analysisconnected desktops (コネクテッドデスクトップ) に分類基準を適用します。

これらのタスクを実行するには、"プロジェクト設定の変更" 権限が必要です。

分類基準と Configuration Editor の使用の詳細情報については、統合ビルド解析用チェッカーの設定 を参照してください。

ヒント: リリース 9.2 より前は、desktop の指摘タイプによりフィルタリングを行うことや、Klocwork Static Code Analysis の指摘タイプにより範囲を決定することができました。このチュートリアルは、分類基準とビューを使用して同じ操作を行う方法について説明します。

フィールド例示する企業では、すべての null ポインター逆参照 (NPD) の指摘、すべてのバッファオーバーフロー (ABR と ABV) の指摘、およびSV.INCORRECT_RESOURCE_HANDLING.URH と SV.INCORRECT_RESOURCE_HANDLING.WRONG_STATUS という 2 つのセキュリティ脆弱性にフラグを付けて排除するポリシーを取っています。

企業ポリシー分類基準の設定

最初に、Configuration Editor で企業ポリシー分類基準を設定する必要があります。

  1. スタンドアロン分類基準エディター を起動します。
    分類基準エディターが表示されます。
  2. 任意の空白部分を右クリックし、[新しい分類基準] をクリックします。
  3. [新しい分類基準を作成] ダイアログに「企業ポリシー」と入力して、[OK] をクリックします。
  4. C とC++ 分類基準を展開します。
  5. Ctrl キーを押しながら [バッファオーバーフロー] カテゴリと [null ポインター逆参照] カテゴリをクリックします。
  6. 右クリックして [コピー] を選択します。
  7. [企業ポリシー] を右クリックして [貼り付け] を選択します。
  8. ここで、2 つのセキュリティ脆弱性チェッカーを分類基準に追加します。
    [企業ポリシー] を右クリックして [指摘を追加] を選択します。
  9. [指摘コード] フィールドに、最初の数文字の SV.INを入力します。
    オートコンプリート機能により残りの名前が入力され、最初の数文字に一致するチェッカーが提案されます。
  10. SV.INCORRECT_RESOURCE_HANDLING.URH を選択して [OK] をクリックします。
  11. 前の 2 つのステップを繰り返し、今回は [SV.INCORRECT_RESOURCE_HANDLING.WRONG_STATUS] を選択します。
  12. [OK ] をクリックし、新しい分類基準ファイルをわかりやすい場所に配置します。
  13. Klocwork Static Code Analysis にログインします。
  14. Klocwork Static Code Analysis のプロジェクトリストで、ファイルをアップロードする先のプロジェクトをクリックします。
    プロジェクト詳細が表示されます。
  15. プロジェクト詳細で、[構成] をクリックします。
  16. [構成] ページで [構成ファイルの追加] をクリックします。
  17. [ファイルの選択] ダイアログで次を参照します。
    <projects_root>/projects/<project_name>/rules/<yourtaxonomyfile>.tconf (または、分類基準ファイルの保存用に選択した別のパス)
    ただし、<project_name> はコピーする構成があるプロジェクトです。
  18. [アップロード] をクリックします。
    ツリーに新しい企業ポリシー分類基準が表示されます。
  19. 企業ポリシー分類基準を展開し、すべての NPD チェッカーと ABV チェッカーが有効になっていることを確認します。
  20. SV.INCORRECT_RESOURCE_HANDLING.URH および SV.INCORRECT_RESOURCE_HANDLING.WRONG_STATUS にチェックを追加して有効にします。
  21.  をクリックImage:Config editor save.png をクリックして変更を保存します。
ヒント: すべての新しいプロジェクトに分類基準を適用する方法を学ぶには、すべての新しいプロジェクトへの設定のコピー を参照してください。

次に Klocwork Static Code Analysis で分類基準を使用します。

レポートおよび指摘管理のための Klocwork Static Code Analysisでの分類基準の使用

企業ポリシー分類基準の指摘のみを表示するためのビューを作成します。

  1. Klocwork Static Code Analysis のプロジェクトリストで、構成するプロジェクトをクリックします。
  2. [ビュー] をクリックします。
  3. [ビュー] ページで [新しいビューの作成] をクリックします。
  4. テキストフィールドに 企業ポリシー と入力します。
  5. 検索フィールドに以下を入力します。
    taxonomy: Company Policy
  6. [パブリック] チェックボックスをオンにします。これにより、このプロジェクトへのアクセス権を持つすべてのユーザーがビューを使用できるようになります。
  7. [作成] をクリックしてビューを保存します。
    リストにビューが表示されます。[企業ポリシー] ビューの未解決の指摘の件数がデフォルトビューと異なることに注意してください。
    Image:Review_views_list_company_policy_taxonomy.png
  8. [企業ポリシー] ビュー内の未解決の指摘のリンクをクリックします。
    [企業ポリシー] ビューがブレッドクラムに表示され、別のビューに簡単に切り替えられることに注意してください。
    Image:Review_issues_in_company_policy_view.png
  9. 右上の [レポート] をクリックします。
    レポートデータも [企業ポリシー] ビューによりフィルターされることに注意してください。
  10. 上位 10 の未解決の指摘 をクリックします。
    レポートには、企業ポリシー分類基準に含めたタイプの指摘のみが表示されます。
    Image:Review_report_company_policy_view.png

connected desktop (コネクテッドデスクトップ) の分類基準でのグループ化とフィルター

connected desktop (コネクテッドデスクトップ) ユーザーは、分類基準により指摘をフィルターおよびグループ化することにより、企業ポリシーの実績を明確に表示することができます。この例では、Visual Studio 2008 を使用します。

分類基準別にグループ化

指摘を分類基準別にグループ化することで、複数の分類基準にわたる指摘の分散状況を把握することができます。そのためには、 Image:vsgroupbytaxonomy.png アイコンをクリックします。

分類基準に分布する指摘が表示されます。同じ指摘が複数の分類基準に検出された場合は、指摘が該当する各分類基準の下に表示されます。

分類基準でフィルター

特定の分類基準の指摘のみを表示するには、分類基準でのフィルターを使用します。

  1. をクリックしますImage:vsfiltericon.png フィルターアイコンをクリックします。
    Visual Studio ユーザーに対する注意:フィルターアイコンにより、ローカルな指摘のみがフィルターされます。分類基準でフィルターするには、[分類基準] リストを使用します。
  2. [分類基準] の下の [企業ポリシー] を除くすべての項目をオフにします。
  3. [OK] をクリックします。

これにより、企業ポリシー分類基準に含めたタイプの指摘のみが表示されます。