qacli report

Perforce QACプロジェクトの解析結果に基に解析レポートを生成します。

使用方法

report  [-P <directory>] [-K <config name>] [-C <solution-name>] -t <acronym> [-j <n>] [-n <report name>] [-o <directory>] [-F <file>] [-i] [--] [-h]

詳しい説明

ユーザのプロジェクトに対し、レポートの標準セットのうち１つを生成します。 ユーザはレポートの正確なフォーマットおよび、内容をカスタマイズすることにより追加のレポートを作成することができます（Python　を使用）。

オプション

オプション名、短縮形 デフォルト 説明
‑‑cma‑solution, ‑C   クロスモジュール解析(CMA)の結果をレポートから抽出したり、レポートに含めたりするために使用するCMAソリューションの名前を指定します。
‑‑config, ‑K   複数の設定をもつプロジェクトに対し、どの設定を使用するかを指定します。 指定がない場合、デフォルト設定が使用されます。
‑‑files, ‑F   レポートを生成するプロジェクトのファイルリストがあるファイルへのパスを指定します。 指定がない場合、レポートはプロジェクトの全ファイルに対して生成されます。
‑‑help, ‑h   使用方法の情報を表示し、終了します。
‑‑ignore, ‑i   ファイルの従属性チェックを無視します。 出力はドラフトとして扱う必要があります。100％完全ではない可能性があります。
‑‑ignore-rest, ‑‑   このフラグ以降のラベルの付いた引数をすべて無視します。
‑‑jobs, ‑j 4 レポート生成時に同時に実行することができる処理の最大数を指定します。 同時に実行できる手順は限られています。
‑‑output-name, ‑n <name_of_project>_<report type>_<date>_<time>.<format> 任意のレポート名（末尾の拡張子なし）を指定します。
‑‑output-path, ‑o prqa/configs/<config-name>/reports レポートを配置するディレクトリへのパスを指定します。 このディレクトリは書込み可能でなければなりません。 ディレクトリが存在しない場合は作成されます。
‑‑qaf-project, ‑P . 有効な Perforce QAC プロジェクトへのパスを指定します。
‑‑type, ‑t  

生成されるレポートの種類を指定します。

  • CRR - コードレビューレポート
  • HMR - HIS メトリックスレポート
  • MCR - MISRA 準拠レポート
  • MDR - メトリックスデータレポート
  • RCR - ルール準拠レポート
  • SCR - 標準準拠レポート
  • SUR - 抑止レポート

例


コードレビューレポート （CRR)　の生成

デフォルトの名前と場所を使用してコードレビューレポートを生成するには以下のコマンドを使用します。

qacli report -P . --type CRR

レポートは prqa\configs\Initial\reports サブディレクトリに生成され、レポート名は以下のフォーマットになります。

<Project Name>_<type>_DDMMYYYY_HHMMSS.<format>


ファイル従属性チェックの省略

（例えばRCMA　がツールチェーンにあるためなど）解析結果が期限切れのままになっているファイルを含めたレポートを生成するためファイル従属性チェックを省略したい場合、以下のコマンドを使用します。 

qacli report -P . -t <report_type> --ignore
上記の ‑‑ignore (または、‑i)オプションを使用する場合は、従属性チェックが実行されていないため（さらに、それ以降の解析が実行されていないということです）、レポートが100%完了していない可能性があることに留意してください。

そのため、このオプションを使用して生成されたHTML/XMLのレポートにはすべて「ドラフト」の印がつけられています。


名前および場所のカスタマイズ

デフォルトですべてのレポートは予め決められた以下の場所に出力されます。

prqa/configs/<config-name>/reports)

この場所は、 ‑‑output‑path (または、‑o)オプションでオーバーライドできます。

qacli report -P . -t <report_type> --output-path my_dir

出力先を変更しても名前はデフォルト名のままです。 名前を変更する場合には、 ‑‑output‑name (または、
‑n) オプションを使用します。

qacli report -P . -t <report_type> --output-path my_dir --output-name my_reports

このディレクトリへの書き込みには、書き込み権限が必要です。ディレクトリが存在しない場合は、ディレクトリが作られます。
ファイル拡張子は、自動的に付くので指定する必要はありません。

並行レポートの生成

レポート生成の種々の段階は同時に行うことができるので、レポート生成の時間を短縮できます。 ‑j (または、
‑‑jobs)は、同時に実行する処理の数を設定するオプションです。

最適の数を決定するには何回か試してみる必要があります　－　過度に大きな数値は逆にレポート生成時間を増やすことになる可能性があります。 値が指定されていない場合は、デフォルト値の4が使用されます。


カスタムレポートのオプション

MCR、SCR　など、レポートの種類によっては、レポートをカスタマイズする任意のカスタムパラメータが使用可能です。

このパラメータは　CLIで "‑‑" オプションの後に続けて記述します。 例えば、以下のコマンドを使用するとMISRAレポートのサマリページのみが生成されます。

qacli report -P . -t MCR -- --summary-only

以下のコマンドは標準準拠レポートで各表における出力の上限を100行に制限する例です。

qacli report -P . -t SCR -- -L 100

ヘッダに診断がまったく含まれていないときに、すべての未使用の抑止を抑止レポート（SUR）に表示するためには以下のコマンドを使用します。

qacli report -P . -t SUR – --unused-sup-all-headers

最小限の検証しか実行されないため、カスタムオプションが正しく記述されていることを確実にしてください。

カスタムのオプショナルパラメータについての詳細は標準レポートの種類を参照してください。


CMAソリューションでのプロジェクトのレポートを生成する

CMAソリューション(つまり、 qacli analyze --cma-solution | -C コマンドを使用して解析されたプロジェクト)の一部として解析されたプロジェクトのレポートを生成するには、そのソリューションを指定しなければなりません。例： 

qacli report -P . --type <report-type> --cma-solution <solution-name>