このセクションでは、 C++test コマンドライン インターフェイス (cpptestcli) からテストを実行す る方法と具体的なオプションについて説明します。コマンドライン インターフェイスの概要につい ては 「コマンドライン インターフェイス (cli)」 を参照してください。

このセクションの内容

前提条件

コマンドライン モードを使用するには、コマンドライン インターフェイスのライセンスが 必要です ( C++test Server Edition に付属)。

• Server Edition のすべての機能にアクセスするには、Parasoft Team Server のインストー ルも必要です。
• テストを開始する前に、C++test の環境設定 (Team Server、タスクの割り当て、レ ポートなど) とチーム テスト コンフィギュレーションの構成を行うことを強く推奨します。 詳細については「設定」を参照し てください。
• コマンドラインからテストを実行するには、C++test のインストール ディレクトリをパス に設定する必要があります。 パスに設定しない場合は、 c:\parasoft\c++test\cpptestcli.exe のように絶対パスで cpptest を実行する必要があり ます。
• C++test でコードをテストするには、コードを Visual Studio プロジェクトに追加する必 要があります。プロジェクトの作成方法については「プロジェクトの作成」を参照 してください。
• 初期テストを実行する前に、プロジェクト オプションを確認して変更することを強く推奨し ます。詳細については「 ローカル設定ファイル (オプション ファイル)」を参照 してください。
• cpptestcli から各開発者の作業に関連したエラー/ 結果だけを開発者に送信するには、次の いずれかの条件を満たす必要があります。
• 「ソース管理システムのデータに基づいてコード作成者を算定するように C++test を設定している」 かつ 「ソース管理システムを使用している」 　かつ 「ソース管理システムでの各開発者のユーザー名とメール ドメインが開発者の電子 メール アドレスに一致している」 ( メール ドメインはオプション ファイルおよび「-localsettings %LOCALSETTINGS_FILE%」で解説の -localsettings オプションを使って指定)
• 「ローカル ユーザーに基づいてコード作成者を算定するように C++test を設定して いる」 　かつ 「ユーザー名およびメール ドメインが開発者の電子メール アドレスに一致している」 ( メール ドメインはオプション ファイルおよび「- localsettings %LOCALSETTINGS_FILE%」 で解説の -localsettings オプション を使って指定 )」

セットアップの概要

C++test には 2 つのユーザー モードがあります。インタラクティブにデスクトップで C++test を 使用する「GUI モード」とコマンドライン インターフェイスを介して C++test を実行する「コマ ンドライン」モードです。コマンドライン インターフェイスは Server Edition の標準機能です。

コマンドライン モードは通常、定期的/ 継続的なビルドまたは自動回帰テストのインフラストラク チャと連携して、定期的/ 継続的なコード解析とテストを実行するために使用します。C++test の コマンドライン インターフェイスは、

Visual Studio ソリューション全体、またはソリューションの 一部である 1 つ以上のプロジェクトまたはソースファイルに対して

実行できます。コマン ドライン インターフェイスの実行の一部として、C++test は次の 1 つ以上のことを実行します。

• コードの静的解析。定義されたコーディング ポリシーのチェック、実行時のバグの可能性の 解析、メトリクスの解析を含みます。
• 単体テストの実行。

•  SCM コード リポジトリの解析。最後の実行後のコードの変更を特定し、更新されたコード に対するコード レビュー セッションを開始します。

• レポートの生成と集約レポート サーバーへの送信。または開発者とマネージャーへの送信。 レポート設定での指定に従って送信されます。

実行の一部として、C++test は ( サポートされている場合) SCM クライアントを使って SCM シス テムから自動的にファイルの変更情報を取得します。そしてコード解析と実行されたテストの結果に 基づいて特定の個人のためのタスクを生成します。

 C++test 固有の実行オプションはテスト コンフィギュレーションと環境設定によって制御されま す。

テスト コンフィギュレーションについては、C++test のビルトイン テスト コンフィギュレーショ ンをベースにして作成することも、GUI モードで新規に作成することもできます。ビルトイン テス ト コンフィギュレーションは、そのまま使用するのではなく、ユーザー定義テスト コンフィギュ レーションのためのテンプレートとして利用することを推奨します。ユーザー定義テスト コンフィ ギュレーションは、ローカル マシンまたは Team Server に保存することができます。 Team Server は Parasoft Concerto デプロイメント インフラストラクチャの一部です。

 環境設定は C++test GUI から設定できます。ほとんどの環境設定は、コマンドライン インター フェイスの呼び出しにパラメーターとして渡される構成ファイルからも設定できます。構成ファイル の詳細については 245 ページの 「ローカル設定ファイル ( オプション ファイル)」 を参照してくだ さい。GUI で設定した C++test の環境設定はデフォルトで適用されます。GUI の設定は、コマン ドライン モードで使用される構成ファイルの値で個別に上書きできます。そのため、ユーザーはす べてのコマンドライン実行で使用される基本的な環境設定を保持しつつ、必要に応じて特定のテスト コンフィギュレーションの特定の実行用に構成ファイルを用意できます。たとえば、テスト実行ごと に異なる情報をレポートに含める場合や、レポート名や E-mail ヘッダーなどのレポートの E-mail オプションを変更する場合などにこの方法が役立ちます。

ステップ 1: 環境設定

C++test の環境設定と Parasoft Test 共通の環境設定を見るには、[Parasoft] メニューの [ 設定] をクリックします。次の設定から開始します。

• ライセンス ライセンス設定または License Sever 設定を指定します。
• Team Server [Team Server を有効にする] チェックボックスをオンにします。Team Server が自動検出されない場合、[ サーバー情報] > [ ホスト名] に Team Server の IP アドレスを入力します。C++test Server Edition と同じマシン上で Team Server を実行 している場合は「localhost」と入力します。Team Server のデフォルト ポート (18888) をインストール時に変更したのでない限り、[ ポート番号] は変更しないでください。[ 接続 のテスト] ボタンをクリックして接続を検証します。
• ソース管理この設定を行うと、影響があったコードまたはテスト成果物を最後に変更した 個人に対して、ツールの結果を自動的にマップすることができます。ソース管理システムを チェックし、「ソース管理リポジトリとの接続」 の説明に従って SCM に適したオプションを設定します。
• スコープと作成者「タスクの割り当てとコード作成者の設定」にあるように、環境に適したオプションを有効に します。
• レポート次のオプションはデフォルトで有効であり、このオプションから開始するのが適 しています。
  • 詳細な開発者レポート ( タスクの詳細を含む)
  • 作成者ごとのタスクの概要( 概要の表)
  • コマンドライン モードでフォーマットされたレポートを生成する
  • 抑制の詳細 ( 静的解析のみに適用される)
• E-mail レポートを E-mail で送信するための設定です。C++test テスト マシンからアク セスできるメール サーバー上にある、既存の E-mail アカウントを指定する必要がありま す。
• レポート > E-mail 通知
• 必要に応じて [ レポートを E-mail で送信する] を有効にします。この設定に関係な く、レポートは今後の参照のために常に Team Server にアップロードされます ( コマンドライン インターフェイス オプションによって制御されます)。メールの配 信には上記の [E-mail] の設定が使用されます。

• マネージャー レポートには、C++test が生成したすべてのテスト結果が含まれま す。開発者レポートには、個々の開発者のテスト結果だけが含まれます。適切なオ プションを有効にし、E-mail アドレスを指定します。

ステップ 2: テスト コンフィギュレーションのカスタマイズ

ユーザー定義テスト コンフィギュレーションを作成します。詳細については「テストコンフィギュレーションとルールの設定」 を参照してください。C++test 固有のテスト コンフィギュレーション オプションについては「テスト コンフィギュレーションの設定テスト コンフィギュレーションの設定」 を参照してください。

ステップ 3: オプション ファイルの作成

「ローカル設定ファイル (オプション ファイル)」の説明にあるようにオプション ファイルを作成します。

ステップ 4: 現在実行中のビルド システムでコマンドライン インター フェイスをアクティブにする ( たとえばバッチ スクリプト)

次は、コマンドラインの例です。

• cpptestcli -solution "c:\MySolution" -resource "ProjectToTest" -config builtin://ShouldHaveRules -publishteamserver -localsettings acme_policy.settings

バッチの実行ごとにレポートが送信され、トレンド レポートが生成されます。レポートは [Parasoft] メニューの [ 探索] > [Team Server レポート] から取得することもできます。

テストの実行

コマンドラインからテストを実行するための全般的な手順は次のとおりです。

• 適切なオプションを指定して cpptestcli ユーティリティを使用し、コマンドライン モードでテストを実行します。 主要なオプションは次のとおりです。利用できるすべてのオプションの一覧については「コマンドライン オプション」 を参照してください。
• -config テスト コンフィギュレーション。
• -resource テスト対象のリソース ( たとえばプロジェクト、フォルダー、ファイル
• -publish: DTP に結果をパブリッシュします。Publishes test results to DTP.
• -publishteamserver: Team Server に結果をパブリッシュします。
• -report: レポートを生成します。
• -localsettings: Team Server/Report Center/ メール レポートの詳細設定を渡します。詳細については「ローカル設定ファイル (オプション ファイル)」 を参照してください。

cli の呼び出し

cpptestcli の一般的な書式は次のとおりです。

• cpptestcli [OPTIONS]

通常、cpptestcli の呼び出しには次の書式を使用します。

コマンドライン オプション

利用できる cpptestcli のオプションは次のとおりです。

全般的なオプション

• -config %CONFIG_URL% - 実行する テスト コンフィギュレーションを %CONFIG_URL% で指定します。  プロジェクトをインストールするときを除き、このパラメーターは必須です。 %CONFIG_URL% は、 URL 、ビルトイン テストコンフィギュレーションの名前、またはローカル ファイルへのパスとして解釈されます。例:
  • ファイル名: -config "mylocalconfig.properties"
  • URL: -config "http://intranet.acme.com/cpptest/team_config.properties"
  • ビルトイン コンフィギュレーション: -config "builtin://Demo Configuration" -config "Demo Configuration"
  • ユーザー定義コンフィギュレーション: -config "user://My First Configuration"
  • チーム コンフィギュレーション: -config "team://Team Configuration" -config "team://teamconfig.properties"
• -help - ヘルプ情報を表示します。 テストは実行しません。
• -localsettings %LOCALSETTINGS_FILE% - オプション ファイル %LOCALSETTINGS_FILE% からグローバル設定を読み込みます。グローバル設定には、DTP、電子メール、Team Server などの設定があります。オプション ファイルはプロパティ ファイルで
す。オプション ファイルは、レポート (レポートの送信先、レポートのラベル、メール サーバー、メール ドメインなど)、Team Server、 Parasoft DTP Server、電子メールの設定を制御できます。オプション ファイルの作成の詳細については、「ローカル設定ファイル (オプション ファイル)」を参照してください。
• -nobuild - テスト前にプロジェクトをビルドしないようにします。テストの実行前にすでにプロジェクトをビルドしている場合、このオプションを使用します。
• -fail - 違反がレポートされた場合、ゼロではない終了コードを返すことによってビルドを失敗させます。
• -publish - レポートを DTP にパブリッシュします。DTP の場所は、GUI またはオプション ファイルで指定できます(「Development Testing Platform との接続」を参照)。
• -publishteamserver - レポートを Team Server にパブリッシュします。Team Server の場所は、GUI またはオプション ファイルで指定できます(-localsettings %LOCALSETTINGS_FILE% を参照)。
• -report %REPORT_FILE% - %REPORT_FILE% で指定した XML レポートと HTML レポートを生成します。拡張子が異なる、同じ名前のレポートが、同じディレクトリに生成されます(report.format オプションを指定した場合、PDF 形式またはカスタ
ム形式のレポートを生成できます)。次のすべてのコマンドは、 HTML レポートfilename.html および XML レポートfilename.xml を生成します。
  • -report filename.xml
  • -report filename.htm
  • -report filename.html

  ユーザーが指定したパスが拡張子 .html、.htm、.xml で終了している場合、このパスは、生成する HTML レポート ファイルへのパスとして扱われます。そうでない場合、パスはレポートを生成するディレクトリとして扱われます。ファイル名を明示的に指定していて、指定ディ
  レクトリに同じ名前のファイルがすでに存在する場合、既存のファイルは上書きされます。ファイル名を明示的に指定していない場合、既存のファイルは上書きされません。新しいファイル名は repXXXX.html となります。 XXXX はランダムな数字です。-report を指定しない場合、レポート ファイルはデフォルトの名前 "report.xml/html" で現行ディレクトリに作成されます。

• -dtp.autoconfig %PROJECT_NAME@SERVER_NAME:port% - DTP サーバーに格納された設定を取得します (保守を容易にするために推奨します。特にローカルに格納したローカル設定ファイルがまだない場合に推奨します)。例: -dtp.autoconfig [email protected]:8080

• -encodepass <plainpassword> - 暗号化したパスワードを生成します。「Encrypted password: <encpass>」というメッセージを表示し、cli アプリケーションを終了します。夜間プロセスが 1) Team Server にログインし、2) 電子メールを送信する場合、このオプションを使って必須のパスワードを暗号化することができます。

• -showdetails - 詳細なテスト進行状況の情報を表示します。

• -solutionConfig %SOLUTION_CONFIG_NAME% - ソリューションのビルドおよび解析に使用するソリューション構成を指定します。Debug と Release は一般的な名前です。スイッチを省略する場合、アクティブ構成が使用されます。アクティブ構成は突然変わる可能性があるため、ソリューション構成を指定することを強く推奨します。
• -targetPlatform %TARGET_PLATFORM_NAME% - ソリューションのビルドおよび解析に使用するターゲットプラットフォームを指定します。Any CPU とx86 は一般的な名前です。省略する場合、アクティブ構成が使用されます。アクティブ構成は突然変わる可能性があるため、ターゲットプラットフォームを指定することを強く推奨します。

• -appconsole stdout|% OUTPUT_FILE% - C++test のコンソール出力を標準出力または %OUTPUT_FILE% ファイルにリダイレクトします。例: -appconsole stdout (標準出力にリダイレクトされるコンソール) -appconsole console.out (console.out ファイルにリダイレクトされるコンソール)

• -list-compilers - 有効なコンパイラの種類の値を出力します。 

  このオプションは -solution. とともに使用する必要があります。

• -list-configs - 有効なテスト コンフィギュレーションの値を出力します。 

  このオプションは -solution. とともに使用する必要があります。

  
  

• -include %PATTERN%, -exclude %PATTERN% -include は、テストに含めるファイルを指定します。-exclude は、テストから除外するファイルを指定します。このオプションの後に、ファイル名またはパスを指定する必要があります。ファイル名の指定にはワイルドカード * および? を使用できます。1 つ以上のパス名のセグメントを指定するには ** を使用します。シンタックスのパターンは Ant ファイル セットの指定に似ています。例
  -include **/Bank.cpp (Bank.cpp ファイルをテストする)

  -include **/ATM/Bank/*.cpp (ATM/Bank フォルダー中のすべての .cpp ファイルをテストする)

  -include c:/ATM/Bank/Bank.cpp (c:/ATM/Bank/Bank.cpp ファイルだけをテストする)

  -exclude **/internal/** (パス中に "internal" というフォルダーがあるクラスをテストから除外する)

  -exclude **/*Test.cpp (Test.cpp で名前が終わるファイルをテストから除外する)

  さらに、拡張子が.lst のファイルを指定した場合、このファイルはパターン リスト ファイルとして扱われ、ファイル中の各行が1 つのパターンとして扱われます。たとえば、次のようにオプションを設定し、
  -include c:/include.lst
  include.lst ファイルの内容が次のとおりであるものとします。

  **/ATM/Bank/*.cpp

  c:/ATM/Bank/Bank.cpp

  この設定は、次のオプション設定と同じことになります。
  -include **/Bank.cpp -include **/ATM/Bank/*.cpp

  -include c:/ATM/Bank/Bank.cpp"

Visual Studio IDE でプロジェクトをテストするためのオプション

ローカル設定ファイル (オプション ファイル)

ローカル設定ファイルをコマンドラインで渡して、レポート、タスクの割り当て、ライセンスといったオプションを制御することができます。ローカル設定ファイルを使用すると、以下のことが可能です。

• プロジェクトごとに異なる設定を構成して使用する。
• 必要に応じて、チーム全体で使用する設定を拡張または上書きする ( たとえば、ローカル パスを含む設定)。
• GUI を開かずに設定を変更する。

オプション ファイルを使用すると、レポート、Report Center、作成者、および Team Server の設定を制御できます。プロジェクトごとにオプション ファイルを作成し、-localsettings オプションを使ってどのファイルを使用するかを指定できます。

オプション ファイルは、単純なテキスト ファイルでなければなりません。場所と名前の制限はありません。

オプション ファイルで指定されたパラメーターは、GUI の [ 設定] ダイアログで指定されたパラメーターを上書きします。オプション ファイルで指定されていないパラメーターについては、GUI で指定されたパラメーターが使用されます。

プロジェクトを作成/ インポートするオプションは、プロジェクトを作成/ インポートしている場合にだけ有効です。その後の実行でそれらのオプションは無視されます。

オプション ファイルには次の設定があります。

• レポート設定
• Parasoft DTP 設定
• Project Center Settings
• Team Server 設定
• ライセンス設定
• テクニカル サポートの設定
• 作成者とスコープの設定
• ソース管理システムの設定

• ファイルエンコーディングの設定

• その他の設定

レポート設定

Parasoft DTP/ Project Center 設定

Team Server 設定

ライセンス設定

テクニカル サポートの設定

作成者とスコープの設定

ソース管理システムの設定

AccuRev リポジトリ定義プロパティ

ClearCase リポジトリ定義プロパティ

CVS リポジトリ定義プロパティ

Git リポジトリ定義プロパティ

Perforce リポジトリ定義プロパティ

Serena Dimensions リポジトリ定義プロパティ

Subversion リポジトリ定義プロパティ

CM Synergy リポジトリ定義プロパティ

Microsoft Team Foundation Server リポジトリ定義プロパティ


Microsoft Visual Source Safe リポジトリ定義プロパティ

重要な注意事項

• リポジトリ データベースがローカルにある場合でも、repository(n).vss.ssdir プロパティは UNC 値を保持するべきです

• VSS の名前付け規則、規約、および制限事項に注意してください。名前とラベルに次の文字は使用できません。

  • ドル記号 ($)

  • アットマーク記号 (@)

  • 括弧記号 < >、[ ]、{ }、( )

  • コロン (:) およびセミコロン (;)

  • 等号 (=)

  • キャレット (^)

  • 感嘆符 (!)

  • パーセント記号 (%)

  • 疑問符 (?)

  • カンマ (,)

  • 一重引用符および二重引用符 (' ")

• プロジェクト名がドット記号 (.) で開始している場合、 Visual Studio 6 の VSS 6.0 (ビルド 8163) はプロジェクトを適切に処理できません。そのようなプロジェクト名を使用している場合、サブ プロジェクトを追加できません。

• サブ プロジェクトにカスタム作業ディレクトリを使用してはいけません。たとえばプロジェクト $/SomeProject の作業ディレクトリは C:\TEMP\VSS\SomeProject であり、そのサブ プロジェクト $/SomeProject/SomeSubProject の作業ディレクトリは D:\SomeSubProject です。

ファイル エンコーディングの設定 

その他の設定

以下に、local.properties という名前のオプション ファイルのサンプルを 2 つ記載します。

# Team Server の設定 ( これらのオプションは、GUI の [設定] > [Team Server] で    定義済みの場合があり、その場合、これらのオプションの設定は必要ない)
tcm.server.enabled=true
tcm.server.name=<team_server.company.com>

# レポート設定
report.developer_errors=true
report.developer_reports=true
report.format=html
session.tag=<project name>

# メール設定
report.mail.enabled=true
report.mail.cc=<[email protected];[email protected]>
report.mail.server=mail.company.com
report.mail.domain=company.com
report.mail.subject=<Static Analysis results on Project X>
report.mail.attachments=true

# Team Server 設定
tcm.server.enabled=true
tcm.server.name=teamserver.mycompany.com
tcm.server.port=18888
tcm.server.accountLogin=true
tcm.server.username=tcm_user
tcm.server.password=tcm_pass

# Parasoft DTP 設定
dtp.server=dtp.mycompany.com
dtp.port=32323

# メール設定
report.mail.enabled=true
report.mail.server=mail.mycompany.com
report.mail.domain=mycompany.com
report.mail.cc=project_manager
report.mail.subject=Coding Standards
concerto.log_as_nightly=true

ローカル設定 (オプション) ファイルでの変数の利用

ソリューション名

を出力します。 

ローカル設定ファイルのサンプル

# REPORTS
#Determines whether reports are emailed to developers and to the additional recipients specified with the cc setting.
#Remember that if the team is using CVS for source control and each developer's email address matches his or her CVS username + the mail domain, each developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work.
report.mail.enabled=true
#Exclude developers emails (true/false)
report.mail.exclude.developers=false
# Append developers errors to manager emails (true/false) report.developer_errors=true
# Send reports to developers (true|false) report.developer_reports=true
# Append suppressed messages (true|false) report.suppressed_msgs=false#Determines where to mail complete test reports.
#This setting is typically used to send reports to managers or architects.
#It can also be used to send reports to developers if developer reports
#are not sent automatically (for example, because the team is not using CVS).
[email protected]; ${env_var:USERNAME} @domain.com
# mail target for unknown developer errors [email protected]
#Specifies the mail server used to send reports.
report.mail.server=mail_server.domain.com
#Specifies the mail domain used to send reports.
report.mail.domain=domain.com
#Specify mali from report.mail.from=nightly
#Specifies any email addresses you do not want to receive reports.
#This setting is used to prevent from automatically sending reports to someone that worked on the code, but should not be receiving reports. This setting is only applicable if the team is using CVS for source control and developer reports are being sent automatically.
report.mail.exclude=developer1;developer2
# Specifies the subject line of the emails sent.
report.mail.subject= ${tool_name} Report - ${config_name}
# Report test params include (true|false)
report.test_params=true
# Team Server
#Determines whether the current installation is connected to the Team Server.
tcm.server.enabled=true
#Specifies the machine name or IP address of the machine running Team Server.
tcm.server.name=team_server.domain.com
#Specifies the Team Server port number.
tcm.server.port=18888
tcm.server.accountLogin=true
tcm.server.username=user
tcm.server.password=password
session.tag= ${config_name}
# Parasoft Project Center
#Determines if the current installation is connected to Parasoft Project Center.
concerto.reporting=true
#Specifies the host name of the Parasoft DTP server.
dtp.server=grs_server.domain.com
# Specifies the port number of the Parasoft Project Center report collector.
concerto.data.port=32323
# Specifies user-defined attributes for Parasoft Project Center.
#Use the format key1:value1; key2:value2
#Attributes help you mark results in ways that are meaningful to your organization.
#They also determine how results are grouped in Parasoft Project Center and how you can filter results in Parasoft Project Center.
#For example, you might want to label results by project name and/or by project component name.
#Each attribute contains two components: a general attribute category name
#and a specific identification value. For example, assume your organization wants to classify results by project.
#You might then use the attribute project:projname1. For the next project, you could use a different
#local settings file that specified an attribute such as project:projname2.
concerto.user_defined_attributes=Type:Nightly;Project:Project1
# Determines whether the results sent to Parasoft Project Center are marked as being from a nightly build.
concerto.log_as_nightly=true
# SCOPE
#code authorship based on CVS
scope.sourcecontrol=true
#code authorship based on author tag
scope.author=false
#code authorship based on local user
scope.local=false
# LICENSE
#override license settings
#cpptest.license.autoconf.timeout=40
cpptest.license.use_network=true
cpptest.license.network.host=license_server.domain.com
cpptest.license.network.port=2222
cpptest.license.network.edition=server_edition
# SOURCE CONTROL
scontrol.rep1.type=cvs
scontrol.rep1.cvs.root=:pserver:developer@cvs_server.domain.com:/home/cvs/
scontrol.rep1.cvs.pass=mypassword