このセクションの内容
既存のビルド システムを使用して自動的にプロジェクトを作成するには、コードのビルド プロセスに関する情報が必要です。C/C++test に必要な情報を提供するには、通常は GNU make、CMake、QMake といったビルド ツールを使用してビルドを実行するように、cpptestscan または cpptesttrace ユーティリティを実行して、C++test プロジェクトを作成することができます。ユーティリティは、C/C++test が必要とする情報を含むビルド データ ファイルを出力します (詳細は「ビルド データ ファイルについて (.bdf)」を参照)。別の方法として、ユーティリティが収集した情報を使って、プロジェクトを ビルドして手動で構成することもできます。
CMake を使用している場合、CMake ビルド ファイルで直接 C/C++test プロジェクトを定義することもできます。すると、CMake でのビルド時に自動的に C/C++test プロジェクトを生成できます。cpptestscan または cpptesttrace を実行する必要はありません。詳細は「CMake ビルドへの C/C++test の統合」を参照してください。
C/C++test のプロジェクト作成ウィザードを使用して CMake JSON 定義ファイルをインポートすることもできます。このプロジェクト作成方法の詳細については、「GUI ウィザードで BDF ファイルをインポートしてプロジェクトを作成する」を参照してください。
作業ディレクトリ、コンパイルのコマンドライン オプション、オリジナル ビルドのリンク プロセスといったビルド情報は、「ビルド データ ファイル」というファイルに保存されます。以下のサンプルはビルド データ ファイルからの抜粋です。
------- 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 を使ってプロジェクトを自動的にインポートする(「GUI ウィザードで BDF ファイルをインポートしてプロジェクトを作成する」を参照)。
以下の条件に当てはまる場合、必要な環境変数もビルド データ ファイルに格納できます。
以下の |
cpptestscan または cpptesttrace を使ってビルド データ ファイルを作成するcpptestscan および cpptesttrace の実行ファイルは <INSTALL_DIR>/bin ディレクトリにあります。これらのユーティリティは、既存のコードのビルド プロセスから情報を収集し、その情報を使ってビルド データ ファイルを生成し、各実行についての情報をファイルに追加します。
cpptestscan ユーティリティは、通常のビルド時にコンパイラおよび/またはリンカーのラッパーとして使用します。既存のコードで cpptestscan を使用するには、コンパイラ/リンカーの実行ファイルの接頭辞として cpptestscan を指定してコードをビルドします。これは次の 2 つの方法で実行できます。
cpptestscan を呼び出すようにビルド コマンドを変更する。cpptestscan を埋め込む。既存のコードで cpptesttrace を使用するには、コンパイラ/ リンカーの実行ファイルの接頭辞として cpptesttrace を指定してコードをビルドします。cpptesttrace は、ビルド中に実行されたコンパイラとリンカーのプロセスをトレースし、トレースした内容をビルド データ ファイルに格納します。
どちらの場合も、PATH 環境変数に C++test インストール ディレクトリを追加するか、 cpptestscan または cpptesttrace ユーティリティへのフル パスを指定する必要があります。
cpptestscan および cpptesttrace のその他のオプションは次の表にまとめられています。オプションは cpptestscan コマンドに直接指定するか、環境変数を通じて指定します。コマンドラインの接頭辞を変えることで、ほとんどのオプションが cpptestscan または cpptesttrace に適用できます。
基本的な cpptestscan の使用法:
cpptestscan.exe [options] [compile/link command]cpptestscan [options] [compile/link command]基本的な cpptesttrace の使用法:
cpptesttrace.exe [options] [build command]cpptesttrace [options] [build command]| オプション | 環境変数 | 説明 | デフォルト |
|---|---|---|---|
-- cpptestscanOutputFile= <OUTPUT_FILE> -- cpptesttraceOutputFile= <OUTPUT_FILE> | CPPTEST_SCAN_OUTPUT_FILE) | ビルド情報を追加するファイルを定義します。 | cpptestscan.bdf |
| CPPTEST_SCAN_PROJECT_NAME | C++test プロジェクトの名前の候補を定義します。 | 現在の作業ディレクトリ名 |
| CPPTEST_SCAN_RUN_ORIG_CMD | yes の場合、オリジナル コマンドラインが実行されます。 | yes |
| CPPTEST_SCAN_QUOTE_CMD_LINE_MODE | C++test がコマンドラインの実行を準備するときに、どのようにパラメーターを引用符で囲むかを指定します。
cpptestscanQuoteCm dLineMode はLinux ではサポートされません。 | all |
| CPPTEST_SCAN_CMD_LINE_PREFIX | [empty] ではなく、かつオリジナル実行ファイルの実行がオンの場合、指定のコマンドがオリジナル コマンドラインの前に付けられます。 | [empty] |
| CPPTEST_SCAN_ENV_IN_OUTPUT | 選択された環境変数およびファイルを出力するコマンドライン引数のダンプを有効化します。さらに詳しく設定するには --cpptestscanEnvFile または--cpptestscanEnvars オプションを使用します。 | no |
| CPPTEST_SCAN_ENV_FILE | 有効な場合、指定したファイルにはすべてのビルド コマンドに共通の環境変数が保持されます。メインの出力ファイルは差分だけを保持します。メインの出力ファイルのサイズを縮小するには、このオプションを使用します。– cpptestscanEnvInOutを有効にしてこのオプションを使用してください。 | [empty] |
| CPPTEST_SCAN_ENVARS | ダンプする環境変数名を指定するか、'*' を選択してすべての環境変数を指定します。 --cpptestscanEnvInOutput を有効にしてこのオプションを使用してください。 | * |
| CPPTEST_SCAN_USE_VARIABLE | スキャンされたビルド情報中の各 "VALUE" 文字列を "${VAR_NAME}" 変数の使用で置き換えます。 | [empty] |
--cpptesttraceTraceCommand | CPPTEST_SCAN_TRACE_COMMAND | ビルド プロセス情報を収集するときにトレースするコマンド名を定義します。コマンド名は正規表現で指定します。コマンド名はビルド プロセスで使用されるオリジナルのコンパイラ/リ ンカー コマンドと一致しなければなりません。 |
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) を生成します。
複数のディレクトリでビルドを実行する場合:
|
通常の make ベースのビルドでは次のコマンドを使用するものとします。
make clean all
次のコマンドラインを使用できます。
cpptesttrace --cpptesttraceOutputFile=/path/to/name.bdf --cpptesttraceProjectName=<projectname> make clean all
このコマンドは、通常と同じようにコードをビルドするだけでなく、指定されたディレクトリにビルド データ ファイル (name.bdf) を生成します。
コンパイラあるいはリンカーのファイル名がデフォルトの |
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 を使って Makefile を生成するために、オリジナルの CMake コマンドを実行します。例:
cmake -G "Unix Makefiles" ../project_root |
cpptestscan の環境変数を設定します。出力ファイルのパスには必ず絶対パスを使用します。
export CPPTEST_SCAN_PROJECT_NAME=my_project export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf |
cpptesttrace 実行ファイルが設定されていることを確認します。cpptesttrace を使用します。たとえば、通常のビルド コマンドが make clean all である場合、cpptesttrace を使ったコマンドは cpptesttrace make clean all となります。CPPTEST_SCAN_OUTPUT_FILE 変数で定義された場所にビルド データ ファイルが生成されます。この変数を設定していない場合、ビルド データ ファイルは Makefile の場所に生成されます。
すべてのスクリプトとコマンドは bash ベースです。別のシェルについては必要に応じて適合させてください。
CMake ベースのビルドがあるものとします。以下の操作を行って、cpptestscan を使ってビルド データ ファイルを生成します。
オリジナルの 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 |
cmake が失敗した場合、そのままステップ 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 $? |
cpptestscan を起動し、コンパイラを実行せずにオプションを抽出します。2 番目のスクリプトは実際のコンパイラを実行します。その目的は、CMake によって「認められる」ためにスクリプト全体が見た目も動作もコンパイラのようになるためです。cpptestscan とスクリプトを必ず設定してください。オリジナルの 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 |
cpptestscan の環境変数を設定します。 出力する .bdf ファイルを必ず絶対パスで指定してください。
export CPPTEST_SCAN_PROJECT_NAME=my_project export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf |
デフォルトでは、CMake 生成の Makefile は、実行されたアクションについての情報だけを出力します。実際のコンパイラ/ リンカーのコマンドラインは出力しません。実行された コンパイラ/ リンカーのコマンドラインを確認するには、make コマンドに “VERBOSE=1” を追加します。 |
make ベースではないビルド システムの場合も、cpptestscan と cpptesttrace の使用方法は上記の例と非常に似ています。通常、コンパイラはビルド スクリプト中のどこかで変数として定義されます。cpptestscan を使ってこのビルド システムからビルド データ ファイルを作成するには、オリジナルのコンパイラ実行ファイルに接頭辞として cpptestscan を付加します。cpptesttrace を使ってこのビルド システムからビルド データ ファイルを作成するには、ビルド コマンド全体に接頭辞として cpptesttrace を付加します。
いつ cpptestscan を使うべきかビルド データ ファイルを準備する手続きをビルド システムに統合することを強く推奨します。統合すると、通常のビルドを実行するときに、別のアクションを実行することなく、ビルド データファイルを生成することができます。 それには、Makefile またはビルド スクリプトで、 コンパイラとリンカーの実行ファイルに接頭辞として cpptestscan を付加します。 いつ cpptesttrace を使うべきかMakefile / ビルド スクリプトを変更できない場合、またはビルド コマンドラインからコンパイラ/ リンカーの実行ファイルに接頭辞を付加するのがあまりにも複雑な場合、ビルド コマンド全体の接頭辞として cpptesttrace を使用します。 |
プロジェクト作成ウィザードを使用して BDF または CMake ビルド定義ファイルをインポートし、C++test プロジェクトを作成できます。
カスタム コンパイラを使用している場合、GUI ウィザードを開く前に、カスタム コンパイラを追加してください。詳細については「カスタム コンパイラを使用するテストの設定」を参照してください。 |
ビルド データ/定義ファイルからプロジェクトを作成するには、次の操作を行います。
-list-compilers スイッチを指定して cpptestcli を実行すると、サポート対象コンパイラの一覧を参照できます。
コマンドラインからビルド データ ファイル ベースのプロジェクトを作成することもできます。-bdf <cpptestscan.bdf> スイッチを cpptestcli に渡します。
プロジェクトの作成直後に、たとえば静的解析やテスト生成などの解析を実行したい場合、-config を使用して、目的のテスト コンフィギュレーションを指定します。例:
cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -config "team://Team Configuration" -settings "</path/to/name.properties>" -bdf "</path/to/name.bdf>"
解析を実行せずに単純にプロジェクトを作成したい場合、 -config オプションを省略します。例:
cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -settings "</path/to/name.properties>" -bdf "</path/to/name.bdf>"
過去のバージョンの C/C++test では、テストを実行せずにプロジェクトを作成するために -config "util/CreateProjectOnly" を使用しました。現行バージョンの C/C++test はこのオプションをもう使用しません。偽のテスト コンフィギュレーション "util/CreateProjectOnly" はもうサポートされません。
カスタム プロジェクト設定は、プレーン テキストのオプション ファイルで設定できます。-settings スイッチを使ってオプション ファイルを cpptestcli に渡します。詳細については「設定ファイル (オプション ファイル)」を参照してください。
ここでは、cpptestscan を使ってコマンドラインから C/C++test プロジェクトを作成する方法について説明します。サンプルでは、次の場所にある ATM サンプル プロジェクトを使用します。 <INSTALL_DIR>/examples
この例では make ベースのビルドを使用しますが、ビルド データ ファイル (.bdf ファイル) はどのビルド システムからも生成できます。
cpptestscan 実行モジュールが PATH 環境変数に追加されていること:
<INSTALL_DIR>/bin/cpptestscancpptestcli 実行モジュールが PATH 環境変数に追加されていること: <INSTALL_DIR>/cpptestcli
g++ がオリジナル コンパイラの実行ファイルであるものとします。/home/MyWorkspace on UNIX/Cygwinc:\home\MyWorkspace on Windowsc:/home/MyWorkspace on Cygwin-config を省略します。-config MustHaveRules)<INSTALL_DIR>/Examples/ATM ディレクトリに移動します。cpptestscan を付加して、ATM プロジェクトをビルドします: > make CC="cpptestscan g++" clean all(cpptestscan.bdf) が <INSTALL_DIR>/Examples/ATM ディレクトリに作成されたことを確認します。 /home/MyWorkspace ワークスペースに作成します。: > cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf<INSTALL_DIR>/Examples/ATM プロジェクトのすべてのソース ファイルとビルド オブジェクトが含まれます。<INSTALL_DIR>/Examples/ATM ディレクトリに移動します。cpptestscan を付加して、ATM プロジェクトをビルドします:> make CC="cpptestscan --cpptestscanProjectName=myProject g++" clean all(cpptestscan.bdf) が <INSTALL_DIR>/Examples/ATM ディレクトリに作成されたことを確認します。myProject がプロジェクト名として設定されている点に注目してください。<INSTALL_DIR>/Examples/ATM に、opts.properties という名前でテキスト ファイルを作成します。opts.properties ファイルに bdf.import.compiler.family=vc_7_1 と入力して、コンパイラの種類に Visual C++ 7.1 をセットします。opts.properties ファイルに bdf.import.location=BDF_LOC と入力し、目的のプロジェクトの場所として cpptestscan.bdf ファイルがある場所を設定します (cpptestscan.bdf ファイルは、オリジナル プロジェクトのディレクトリにあります)。/home/MyWorkspace ワークスペースに作成します。 cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf -settings opts.properties注意:
BDF_LOC 変数を使用しました。この変数は cpptestscan.bdf ファイルの場所を参照します。生成されたビルド データ ファイルを使って、GUI またはコマンドラインからプロジェクトを作成することができます。
C/C++test には、CMake の構文を使用して CMakeLists.txt ビルド ファイルに直接 C/C++test プロジェクトを定義できるようにする CMake 用拡張が付属しています。拡張には、プロジェクトの場所、構造、内容を含めた C/C++test プロジェクトを定義するための cpptest_add_executable() CMake 関数があります。結果として、CMake ビルド時に C/C++test プロジェクト定義ファイル (.project および .parasoft) とビルド データ ファイル (.bdf) が自動生成されます。ビルドが完了したら、C/C++test プロジェクト ファイルと BDF をワークスペースにインポートし、解析やテストを実行できます。
CMake 統合のサポートは、以下のコンポーネントで構成されます。
<CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-project.cmake – CMake 用 C/C++test 拡張です。C/C++test プロジェクト定義を生成するには、これを CMakeFiles.txt ビルド ファイルに追加する必要があります。<CPPTEST_INSTALL_DIR>/integration/cmake/cpptest.templates/*.in – 自動生成されるプロジェクト定義ファイルの C/C++test テンプレートです。CMake 用拡張を柔軟にカスタマイズできます。また、<CPPTEST_INSTALL_DIR>/examples/CMakeProject ディレクトリには、C/C++test 拡張を使用した CMake 統合のサンプル プロジェクトがあります。
CMakeLists.txt ビルド ファイルに <INSTALL_DIR>/integration/cmake/cpptest-project.cmake をインクルードします。cpptest_add_executable() 関数を使用して C/C++test プロジェクトに対応するターゲットを定義します (「C/C++test プロジェクトの定義」を参照)。CPPTEST_PROJECT=ON 変数を使用して C/C++test 拡張をアクティベートし、configure および build コマンドを使用して CMake を実行することで C/C++test プロジェクト設定ファイルを生成します。-import <ROOT_FOLDER_OR_PROJECT_FILE>) から Eclipse ワークスペースにインポートします。テスト ケースやスタブなどのテスト成果物をソース管理システムに保存する場合、自動生成されたプロジェクト定義ファイルやビルド データ ファイル (.bdf) をチェックインしないでください。これらのファイルは、CMake プロジェクトをビルドするたびに生成する必要があります。
CMake による C/C++test プロジェクト ファイルの自動生成を有効にするには、cpptest_add_executable() 関数を使用して、C/C++test プロジェクトに対応するターゲットを定義する必要があります。最低限でも、以下を設定する必要があります。
target_include_directories() や target_link_libraries() などの通常の CMake 関数を使用します。以下のオプションがあります。
| オプション名 | 説明 | デフォルト |
|---|---|---|
| <target_name> | ターゲットの名前です。 | デフォルト値はありません。必ずこのオプションを設定する必要があります。 |
| CPPTEST_COMPILER_ID | ターゲット固有の C/C++test コンパイラ識別子です。すべてのターゲットに対して同じコンパイラを指定するには、 | gcc_9-64 |
| CPPTEST_PROJECT_NAME | C/C++test プロジェクトの名前です。 | ターゲットの名前と同じです。 |
| CPPTEST_PROJECT_LOC | C/C++test プロジェクトの場所です。 | カレント フォルダー |
| CPPTEST_PROJECT_FOLDERS | C/C++test プロジェクトにインクルードするその他のソース フォルダーです。追加するフォルダーごとに名前と場所を指定します。 | デフォルトでは、ルート ディレクトリだけが C/C++test プロジェクトに含まれます。 |
| EXCLUDE_FROM_ALL | 指定されている場合、現在のターゲットがデフォルトの | 無効 |
| SOURCES | C/C++test プロジェクトに追加するソースのリストです。 | デフォルト値はありません。必ずこのオプションを設定する必要があります。 |
| TARGETS | 既存の CMake ターゲットのリストです。指定されている場合、指定されたターゲットのソース ファイルのリストが C/C++test プロジェクトに追加されます。 | デフォルト値はありません。必ずこのオプションを設定する必要があります。 |
cpptest_add_executable( <target_name> [CPPTEST_COMPILER_ID <compiler_id>] [CPPTEST_PROJECT_NAME <test_project_name>] [CPPTEST_PROJECT_LOC <test_project_location>] [CPPTEST_PROJECT_FOLDERS <name1=location1> <name2=location2> ...] [EXCLUDE_FROM_ALL] SOURCES <src1.cpp> <src2.cpp> ... | TARGETS <target1> <target2> ... ) |
このセクションでは、<CPPTEST_INSTALL_DIR>/examples/CMakeProject ディレクトリにあるサンプル プロジェクトを使用して、CMake との統合を説明します。
<CPPTEST_INSTALL_DIR>/examples/CMakeProject に移動します。modules/mod1/CMakeLists.txt および <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-project.cmake のデフォルトのコンパイラ識別子 gcc_9-64 を使用しているコンパイラの識別子に置き換えます。次のコマンドを実行してサンプル プロジェクトをビルドします。
> cd <CPPTEST_INSTALL_DIR>/examples/CMakeProject > mkdir build > cd build > cmake -DCPPTEST_PROJECT=ON .. > make |
CMake はプロジェクトをビルドし、C/C++test プロジェクトを生成します。次の CMakeLists.txt ファイルは、異なるプロジェクト レイアウトと設定オプションを持つ C/C++test プロジェクトを定義しています。
-app/CMakeLists.txtmodules/mod1/CMakeLists.txttests/cpptest_modules/CMakeLists.txt<CPPTEST_INSTALL_DIR>/examples/CMakeProject ディレクトリを参照して自動生成された 3 つのプロジェクトを IDE にインポートします。builtin://Generate Unit Tests テスト コンフィギュレーションを使用してテスト ケースを生成します。builtin://Run Unit Tests テスト コンフィギュレーションを利用してテスト ケースを実行します。