このセクションの内容

はじめに

GNU make、CMake、QMake といったビルド ツールを使用している場合、cpptestscan または cpptesttrace ユーティリティを使用して、C++test プロジェクトを作成することができます。これらのユーティリティは、プロジェクトを自動作成するために C++test が使用できる既存のコードの ビルド プロセスから情報を収集します。ユーティリティが収集した情報を使って、プロジェクトを ビルドして手動で構成することもできます。

ビルド データ ファイルの概念

作業ディレクトリ、コンパイルのコマンドライン オプション、オリジナル ビルドのリンク プロセスといったビルド情報は、「ビルド データ ファイル」というファイルに保存されます。以下のサンプルはビルド データ ファイルからの抜粋です。

------- cpptestscan v. 9.4.x.x -------
working_dir=/home/place/project/hypnos/pscom
project_name=pscom
arg=g++
arg=-c
arg=src/io/Path.cc
arg=-Iinclude
arg=-I.
arg=-o
arg=/home/place/project/hypnos/product/pscom/shared/io/Path.o

ビルド データ ファイルは、プロジェクトのソース ファイル、コンパイラの実行ファイル、コンパイラ オプション、リンカーの実行ファイル、およびプロジェクトをビルドするために使用されるオプションについての情報のソースとして使用できます。ビルド データ ファイルを使ってプロジェクトを作成するには、以下の 3 種類の方法があります。

• プロジェクトのオプション ソースとして [ビルド データ ファイルのオプションを使用] を手動で設定し、適切なビルド データ ファイルを選択する (「GUI からの C++test プロジェクトの作成」を参照)。
• GUI を使ってプロジェクトを自動的にインポートする(「GUI ウィザードで BDF ファイルをインポートしてプロジェクトを作成する」を参照)。

• コマンドラインを使ってプロジェクトを自動的にインポートする (「コマンドラインからインポートする」を参照)。

  注意

  以下の条件に当てはまる場合、必要な環境変数もビルド データ ファイルに格納できます。

  • コンパイラとリンカーが適切に動作するよう、必要な環境変数をビルド システムがセット アップする。
  • C++test を実行するときに、その環境ではこれらの変数を使用できない。

  以下の --cpptestscanEnvInOutput オプションの説明を参照してください。

cpptestscan または cpptesttrace を使ってビルド データ ファイルを作成する

cpptestscan および cpptesttrace の実行ファイルは C++test インストール ディレクトリの下に あります。これらのユーティリティは、既存のコードのビルド プロセスから情報を収集し、その情 報を使ってビルド データ ファイルを生成し、各実行についての情報をファイルに追加します。

cpptestscan ユーティリティは、標準ビルド中にコンパイラあるいはリンカーのラッパーとして使用されます。既存のコードで cpptestscan を使用するには、コンパイラ/ リンカーの実行ファイル の接頭辞として cpptestscan を指定してコードをビルドします。これは次の 2 つの方法で実行できます。

• コンパイラ/ リンカーの実行ファイルのラッパーとして cpptestscan を呼び出すようにビルド コマンドを変更する。
• コマンドラインでコンパイラ変数を上書きしたくない場合 (または上書きできない場合)、実際の Makefile またはビルド スクリプト中に cpptestscan を埋め込む。

既存のコードで cpptesttrace を使用するには、コンパイラ/ リンカーの実行ファイルの接頭辞として cpptesttrace を指定してコードをビルドします。cpptesttrace は、ビルド中に実行されたコンパイラとリンカーのプロセスをトレースし、トレースした内容をビルド データ ファイルに格納しま す。

どちらの場合も、PATH 環境変数に C++test インストール ディレクトリを追加するか、 cpptestscan または cpptesttrace ユーティリティへのフル パスを指定する必要があります。

cpptestscan と cpptesttrace で使用できるオプションは、以下の表のとおりです。オプションは、cpptestscan コマンドに直接指定するか、環境変数を介して指定できます。コマンドラインの接頭辞を変えることで、ほとんどのオプションが cpptestscan または cpptesttrace に適用できます。

基本的な cpptestscan の使用法:

• Windows: cpptestscan.exe [options] [compile/link command]
• Linux: cpptestscan [options] [compile/link command]

基本的な cpptesttrace の使用法:

• Windows: cpptesttrace.exe [options] [build command]
• Linux: cpptesttrace [options] [build command]

-- cpptestscanOutputFile= <OUTPUT_FILE>

-- cpptesttraceOutputFile= <OUTPUT_FILE>

例: cpptestscan を使用するように GNU make ビルド コマンドを変更する

make ベースのビルドで、コンパイラ変数が CXX であり、オリジナル コンパイラが g++ であるものとします。

      make -f </path/to/makefile> <make target> [user-specific options] CXX="cpptestscan --cpptestscanOutputFile=/path/to/name.bdf --cpptestscanProjectName=<projectname> g++"

このコマンドは、通常と同じようにコードをビルドするだけでなく、指定されたディレクトリにビルド データ ファイル (name.bdf) を生成します。

例: cpptesttrace を使用するように GNU make ビルド コマンドを変更する

通常の make ベースのビルドでは次のコマンドを使用するものとします。

     make clean all

次のコマンドラインを使用できます。

     cpptesttrace --cpptesttraceOutputFile=/path/to/name.bdf --cpptesttraceProjectName=<projectname> make clean all

このコマンドは、通常と同じようにコードをビルドするだけでなく、指定されたディレクトリにビルド データ ファイル (name.bdf) を生成します。

例: cpptestscan を使用するように GNU Makefile を変更する

Makefile でコンパイラ実行ファイルの変数として CXX を使用し、通常は CXX=g++ として定義している場合、変数を再定義することができます。

     ifeq ($(BUILD_MODE), PARASOFT_CPPTEST)
     CXX="/usr/local/parasoft/cpptestscan --cpptestscanOutputFile=<selected_location>/MyProject.bdf --cpptestscanProjectName=MyProject g++"
     else
     CXX=g++
     endif

次に、通常と同じようにビルドを実行し、make に BUILD_MODE 変数を追加します。

     make BUILD_MODE=PARASOFT_CPPTEST

コードがビルドされ、ビルド データ ファイル (MyProject.bdf) が作成されます。生成されたビルドデータ ファイルを使って、GUI またはコマンドラインからプロジェクトを作成することができます。

例: CMake ビルドで cpptesttrace を使用する

CMake ベースのビルドがあり、cpptesttrace を使ってビルド データ ファイルを生成できるものとします。

1. CMake を使って Makefile を生成するために、オリジナルの CMake コマンドを実行します。例:

   cmake -G "Unix Makefiles" ../project_root

2. cpptestscan の環境変数を設定します。出力ファイルのパスには必ず絶対パスを使用します。

   export CPPTEST_SCAN_PROJECT_NAME=my_project export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf

3. PATH 変数で cpptesttrace 実行ファイルが設定されていることを確認します。
4. プロジェクトのビルドを通常と同じにように実行します。ただし、ラッパーとして cpptesttrace を使用します。たとえば、通常のビルド コマンドが make clean all である場合、cpptesttrace を使ったコマンドは cpptesttrace make clean all となります。

CPPTEST_SCAN_OUTPUT_FILE 変数で定義された場所にビルド データ ファイルが生成されます。この変数を設定していない場合、ビルド データ ファイルは Makefile の場所に生成されます。

例: CMake ビルドで cpptestscan を使用する

すべてのスクリプトとコマンドは bash ベースです。別のシェルについては必要に応じて適合させてください。

CMake ベースのビルドがあるものとします。以下の操作を行って、cpptestscan を使ってビルド データ ファイルを生成します。

1. コンパイラの接頭辞として cpptestscan を使用し、CMake を使って Makefile を再生成します。PATH 変数で cpptestscan の実行ファイルが設定されていることを確認してください。

   1. オリジナルの CMake コマンドが cmake -G “Unix Makefiles” ../project_root である場合、既存の CMake のキャッシュを削除して cmake を実行し、コンパイラ変数を上書きします。次の例は、C コンパイラとして gcc を使用し、 C++ コンパイラとして g++ を使用するものとします。

      rm CMakeCache.txt CC="cpptestscan gcc" CXX="cpptestscan g++" cmake -G "Unix Makefiles" ../project_root

   2. MakeCache.txt ファイルを参照して、CMAKE_*_COMPILER 変数が cpptestscan をポイントしているかどうかを確認します。
   3. Makefile が再生成される場合、ステップ 5 に進みます。コンパイラが認識されなかったためにブートストラップのフェーズで cmake が失敗した場合、そのままステップ 2 に進みます。

2. 以下の BASH スクリプトを作成して、CMake コンパイラのように振る舞う cpptestscan ラッパー スクリプトを用意します。この例では、C コンパイラとして gcc を使用し、C++ コンパイラとして g++ を使用するものとします。

   >cat cpptest_gcc.sh
   #!/bin/bash
   cpptestscan gcc --cpptestscanRunOrigCmd=no $* > /dev/null 2>&1 gcc $*
   exit $?
   
   >cat cpptest_g++.sh
   #!/bin/bash
   cpptestscan g++ --cpptestscanRunOrigCmd=no $* > /dev/null 2>&1 g++ $*
   exit $?

   
   

   • 1 番目のスクリプトは cpptestscan を起動し、コンパイラを実行せずにオプションを抽出します。2 番目のスクリプトは実際のコンパイラを実行します。その目的は、CMake によって「認められる」ためにスクリプト全体が見た目も動作もコンパイラのようになるためです。
3. 2 つのスクリプトに実行可能属性を与えて共通の場所に置き、Makefile をスキャンする必要があるユーザーが皆スクリプトにアクセスできるようにします。PATH 変数に cpptestscan とスクリプトを必ず設定してください。
4. 用意されたスクリプトから Makefile を再生成するオプションを使ってオリジナルの CMake コマンドを拡張します。CMake を使って、コンパイラとして使用されるスクリプトによって Makefile を再生成します。

   • オリジナルの CMake コマンドが cmake -G “Unix Makefiles” ../project_root である場合、既存の CMake のキャッシュを削除して cmake を実行し、コンパイラ変数を上書きします。次の例は、C コンパイラとして gcc を使用し、 C++ コンパイラとして g++ を使用するものとします。

     rm CMakeCache.txt
     cmake -G "Unix Makefiles" -D CMAKE_C_COMPILER=cpptest_gcc.sh -D CMAKE_CXX_COMPILER=cpptest_g++.sh ../project_root

   • CMakeCache.txt ファイルを参照し、用意されたラッパーを CMAKE_*_COMPILER 変数がポイントしているかどうかを確認します。

5. cpptestscan の環境変数を設定します。 出力する .bdf ファイルを必ず絶対パスで指定してください。

   export CPPTEST_SCAN_PROJECT_NAME=my_project export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf

6. どの make 変数も上書きすることなく、通常と同じようにプロジェクト ビルドを実行します。 CPPTEST_SCAN_OUTPUT_FILE 変数で定義された場所にビルド データ ファイルが生成されます。この変数を設定していない場合は Makefile の場所に生成されます。

他のビルド システムでの cpptestscan または cpptestrace の使用

make ベースではないビルド システムの場合も、cpptestscan と cpptesttrace の使用方法は上記の例と非常に似ています。通常、コンパイラはビルド スクリプト中のどこかで変数として定義されます。cpptestscan を使ってこのビルド システムからビルド データ ファイルを作成するには、オリジナルのコンパイラ実行ファイルに接頭辞として cpptestscan を付加します。cpptesttrace を使ってこのビルド システムからビルド データ ファイルを作成するには、ビルド コマンド全体に接頭辞として cpptesttrace を付加します。

GUI ウィザードで BDF ファイルをインポートしてプロジェクトを作成する

C++test でテストしたいプロジェクトのビルド データ ファイルを cpptestscan または cpptesttrace で作成したら、プロジェクト作成ウィザードを使って C++test プロジェクトを作成できます。

ビルド データ ファイルからプロジェクトを作成するには、次の操作を行います。

1. [ファイル] メニューの [新規] > [その他] をクリックし、[C++test] > [ビルド データ ファイルからプロジェクトを作成] を選択して [次へ] ボタンをクリックします。ウィザードの最初の画面が表示されます。
2. 次の設定を行った後、[次へ] ボタンをクリックします。
   • ビルド データ ファイル 作成したビルド データ ファイルの場所を入力します (ビルド データ ファイルの作成については「cpptestscan または cpptesttrace を使ってビルド データ ファイルを作成する」を参照)。
   • プロジェクトの場所 インポートしたプロジェクトの保存先を指定します。ワークスペースまたは外部の場所を指定できます。ワークスペースを指定した場合、プロジェクトはワークスペース内のサブ ディレクトリに作成されます。外部の場所を指定した場合、 インポートするプロジェクトが 1 つであれば、その場所の直下にプロジェクトが作成されます。インポートするプロジェクトが複数の場合、指定の場所にプロジェクトごとにサブディレクトリが作成されます。
     • 利用可能なプロジェクト作成オプションとその影響については、「C++test プロジェクトでの作業」を参照してください。
   • コンパイラ設定 コンパイラの種類を指定します。その他のオプションは自動的に設定されます。
     • 有効なコンパイラの種類の値のリストを取得するには、 cpptestcli コマンドの -list-compilers スイッチを使用します。
       
       
       
       
3. 作成されるプロジェクトのツリー構造が表示されます。プロジェクトの構造と内容を検証し、必要に応じて修正します。そして [次へ] ボタンをクリックします。
   • 第 1 レベルには、作成されるすべてのプロジェクトが表示されます。プロジェクトの名前を変更したりプロジェクトへのフォルダーをさらにリンクしたりするには、プロジェクト名を右クリックして適切なショートカット メニュー コマンドを実行します。
   • 第 2 レベルには、リンクされるすべてのフォルダーが表示されます。フォルダーの名前を変更したり、プロジェクトから除外したりするには、フォルダー名を右クリックして適切なショートカット メニュー コマンドを実行します。
   • 第 3 レベル以降には、リンクされたフォルダー中のすべてのフォルダーおよびファイルが表示されます。緑色のチェックマークは、 .bdf ファイルから参照されるファイルを表します。
     
     
     
     
4. (オプション) 必要に応じてパス変数を指定します。そして [次へ] ボタンをクリックします。
   • リンクされたフォルダーでパス変数を使用するには、[パス変数を使用してリンクされたフォルダーの場所を定義する] チェックボックスをオンにします。
   • 定義済みのパス変数を使用する場合、[パス変数リスト] から選択します。
   • カスタム パス変数を使用する場合、[パス変数リスト] から [カスタム] を選択してパス変数名とパス変数値をそれぞれ入力します。
     
     
     
     

[終了] ボタンをクリックします。指定の場所に指定のプロジェクトが作成されます。作成されたプロジェクトには、オプションがスキャンされたすべてのソース ファイルが含まれます。また、プロジェクトのプロパティが適切に設定されているはずです。

コマンドラインからプロジェクトを作成する

コマンドラインからビルド データ ファイル ベースのプロジェクトを作成することもできます。-bdf <cpptestscan.bdf> スイッチを cpptestcli に渡します。

プロジェクトの作成直後に、たとえば静的解析やテスト生成などの解析を実行したい場合、-config を使用して、目的のテスト コンフィギュレーションを指定します。例:

cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -config "team://Team Configuration"  -localsettings "</path/to/name.properties>" -bdf  "</path/to/name.bdf>"

解析を実行せずに単純にプロジェクトを作成したい場合、 -config オプションを省略します。例:

cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -localsettings "</path/to/name.properties>" -bdf  "</path/to/name.bdf>"

過去のバージョンの C++test では、テストを実行せずにプロジェクトを作成するために -config "util/CreateProjectOnly" を使用しました。現行バージョンの C++test はこのオプションをもう使用しません。偽のテスト コンフィギュレーション "util/CreateProjectOnly" はもうサポートされません。

カスタム プロジェクト設定は、プレーン テキストのオプション ファイルで設定できます。-localsettings スイッチを使ってオプション ファイルを cpptestcli に渡します。詳細については「ローカル設定ファイル (オプション ファイル)」を参照してください。

例

ここでは、cpptestscan を使ってコマンドラインから C++test プロジェクトを作成する方法について説明します。この例では C++test の ATM サンプルを使用します。このサンプルは <INSTALL_DIR>/Examples/ATM ディレクトリにあります。

この例では make ベースのビルドを使用しますが、ビルド データ ファイル (.bdf ファイル) はどのビルド システムからも生成できます。

仮定と前提

• cpptestscan の実行ファイルが $PATH 変数に指定されているものとします ( cpptestscan の実行ファイルは、C++test のインストール ディレクトリにあります)。
• cpptestcli の実行ファイルが $PATH 変数に指定されているものとします ( cpptestcli の実行ファイルは、C++test のインストール ディレクトリにあります)。
• g++ がオリジナル コンパイラの実行ファイルであるものとします。
• ワークスペースおよび .bdf ファイルの場所は、shell/ コマンド プロンプトがサポートする形式で入力する必要があります。例:
  • /home/MyWorkspace on UNIX/Cygwin
  • c:\home\MyWorkspace on Windows
  • c:/home/MyWorkspace on Cygwin
• テストを実行せずにプロジェクトを作成するには、-config を省略します。
• 新規にプロジェクトを作成してテストを実行するには、適切なテスト コンフィギュレーションを使用します。 ( 例： -config MustHaveRules)
• make の実行ですべてのオブジェクトが確実にビルドされるよう、完全なプロジェクトのリビルド (clean all) が実行されます。

例 1 - デフォルトの設定でワークスペースの場所に C++test プロジェクトを作成する

1. オリジナルの Makefile をベースにして、ビルド データ ファイル (.bdf ファイル) を作成します。
   1. <INSTALL_DIR>/Examples/ATM ディレクトリに移動します。
   2. オリジナル コンパイラの実行ファイル名の前に cpptestscan を付加して、ATM プロジェクトをビルドします:
      > make CC="cpptestscan g++" clean all
   3. 新しいビルド データ ファイル (cpptestscan.bdf) が <INSTALL_DIR>/Examples/ATM ディレクトリに作成されたことを確認します。
2. ビルド データ ファイルをベースにして、C++test プロジェクトを作成します。次の操作を行います。
   1. コマンドライン cpptestcli を使って、新しいプロジェクトを /home/MyWorkspace ワークスペースに作成します。:
      > cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf
   2. 新しい C++test プロジェクト (ATM) が MyWorkspace に作成されました。このプロジェクトには、オリジナルの <INSTALL_DIR>/Examples/ATM プロジェクトのすべてのソース ファイルとビルド オブジェクトが含まれます。

例 2 - Visual C++ 7.1 をコンパイラとして設定し、myProject をプロジェクトとして設定して、オリジナル プロジェクトの場所に C++test プロジェクトを作成する

1. オリジナルの Makefile をベースにして、ビルド データ ファイル (.bdf ファイル) を作成します。
   1. <INSTALL_DIR>/Examples/ATM ディレクトリに移動します。
   2. オリジナル コンパイラの実行ファイル名の前に cpptestscan を付加して、ATM プロジェクトをビルドします:
      > make CC="cpptestscan --cpptestscanProjectName=myProject g++" clean all
   3. 新しいビルド データ ファイル (cpptestscan.bdf) が <INSTALL_DIR>/Examples/ATM ディレクトリに作成されたことを確認します。myProject がプロジェクト名として設定されている点に注目してください。
2. ビルド データ ファイルをベースにして、C++test プロジェクトを作成します。次の操作を行います。
   • まず、デフォルト設定をオーバーライドします。
     1. <INSTALL_DIR>/Examples/ATM に、opts.properties という名前でテキスト ファイルを作成します。
     2. opts.properties ファイルに bdf.import.compiler.family=vc_7_1 と入力して、コンパイラの種類に Visual C++ 7.1 をセットします。
     3. 
        opts.properties ファイルに bdf.import.location=BDF_LOC と入力し、目的のプロジェクトの場所として cpptestscan.bdf ファイルがある場所を設定します (cpptestscan.bdf ファイルは、オリジナル プロジェクトのディレクトリにあります)。
   • 次に、コマンドライン cpptestcli を使って、新しいプロジェクトを /home/MyWorkspace ワークスペースに作成します。
     cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf -localsettings opts.properties
   • 新しい C++test プロジェクト (myProject) が <INSTALL_DIR>/Examples/ATM に作成されました。このプロジェクトには、オリジナルの <INSTALL_DIR>/Examples/ATM プロジェクトのすべてのソース ファイルとビルド オブジェクトが含まれており、コンパイラの種類として Visual C++ 7.1 がセットされています。

注意:

• この例では、サポートされるコンパイラのリストにある vc_7_1 を使用しました。カスタムコンパイラを使用するには、[Parasoft] メニューの [設定] をクリックし、[コンフィギュレーション] > [カスタム ディレクトリ] > [カスタム コンパイラ] でパスを指定します。詳細については「カスタム コンパイラを使用するテストの設定」を参照してください。
• プロジェクトの場所として、BDF_LOC 変数を使用しました。この変数は cpptestscan.bdf ファイルの場所を参照します。

生成されたビルド データ ファイルを使って、GUI またはコマンドラインからプロジェクトを作成することができます。