このセクションでは、C/C++test ランタイムライブラリをビルドして使用する方法について説明します。

ホスト ( C++test がインストールされている環境) 以外でテストを実行するには、クロスコンパイラを使ってランタイムライブラリをビルドしなければなりません。テストをホストでだけ実行する場合は、C/C++test にはホストベースのテスト用のビルド済みライブラリが用意されているため、ランタイムライブラリのビルドは不要です。

C/C++test は、テスト実行モジュールの準備フェーズの一部として自動的にランタイムライブラリをビルドできます。C++test ランタイムライブラリのカスタムビルドを用意したい場合を除いて、C++test ランタイムライブラリを手動で準備する要はありません。

このセクションの内容

キーワード

このセクションでは、キーワードを使用して完全なパスを表します。

<C/C++test_runtime_root> = <CPPTEST_INSTALL_DIR>/bin/engine/runtime
<C/C++test_runtime_sources> = <CPPTEST_INSTALL_DIR>/bin/engine/runtime/src
<C/C++test_includes> = <CPPTEST_INSTALL_DIR>/bin/engine/runtime/include

概要

C/C++test ランタイムライブラリは、C のソースファイルとヘッダーファイルの形で C++test に付属しています。ランタイムライブラリのソースファイルは次のディレクトリにあります。 <C++test Install Dir>/engine/runtime/

ほとんどの場合、C/C++test は自動的にランタイムライブラリをビルドすることができます。必要に応じて、make ユーティリティを使って、またはサポートされるプラットフォームのための定義済み make 構成を使って、ランタイムライブラリをビルドできます (詳細については「make を使って C/C++test ランタイムライブラリをビルドする」を参照)。C++test には、一般的な IDE に対応した、ランタイムライブラリのビルドを容易にする特別なプロジェクトファイルが用意されています。

なお、ランタイムライブラリはターゲットごとにビルドする必要があるので注意してください。したがって、複数のアーキテクチャについてプロジェクトをビルドする場合、高い確率でアーキテクチャごとに 1 つ、複数の C/C++test ランタイムライブラリをビルドする必要があるでしょう。

ランタイムライブラリソースには、すべての公式にサポートされる組込みプラットフォーム対応の構成マクロだけでなく、下位レベルの関数ベースの構成も含まれます。これらのマクロは、IDE でビルド構成に合わせて適切に設定する必要があります。

一般的な方法は次の手順のとおりです。

用意されている makefile を使うか、<C/C++test_runtime_root>/projects ディレクトリにある構成済みの IDE プロジェクトを使って、ランタイムライブラリをビルドします。
生成された .a ファイルをプロジェクトプロパティの [Parasoft] > [C/C++test] > [ビルド設定] > [リンカーオプション] に設定します。
- 絶対パスを使用します。またはランタイムライブラリが同じワークスペースにある場合、 ${workspace_loc} および ${project_loc} 変数を使用します。
- 最適な選択肢は、なんらかの固定の場所にライブラリファイルを置き、複数のユーザーが変更することなくライブラリファイルをポイントできるようにすることです。
- ランタイムライブラリに対する環境変数の使用もサポートされています。

全般的な情報

C/C++test のインストゥルメントは、テストオブジェクトのリンク時に解決しなければならない数多くのシンボルを参照します。これらのシンボルは、C/C++test ランタイムライブラリで提供されています。

C/C++test には、ビルド済みでフル機能の共有ランタイムライブラリが付属しています。ただし、このランタイムライブラリはリッチホストプラットフォームをターゲットに作成されたものです。テストが実行される組込みプラットフォームの数の多さ、そしてその機能と制限事項を考えると、通常、異なる組込み環境でビルドを実行するために、ランタイムライブラリを適切に調整する必要があります。そのため、ランタイムライブラリの pure-C ソースも用意されています。

C++test ランタイムライブラリは、ターゲットプラットフォームで利用できる機能をサポートするように構成することも、利用できない機能をブロックするように構成することも可能です。デフォルトの構成はフル機能であり、場合によっては、(特に、コンパイル時または実行時にクラッシュする場合には、)面倒な機能をブロックする必要があります。使用するプラットフォームの長所と短所をよく知っている組込み開発者であれば、適切に構成したライブラリをビルドし、そのパスをリンカーコマンドラインにアペンドできます。

ランタイムライブラリのソースは <C/C++test_runtime_sources> にあります。ランタイムライブラリをビルドするために必要なヘッダーファイルは <C/C++test_includes> にあります。

ソースの変更－ベストプラクティス

<CPPTEST_INSTALL_DIR> のファイルを絶対に変更しないでください。ソースを別のディレクトリにコピーし、この新しいディレクトリのパスをプロジェクトプロパティの [ランタイムライブラリソース] に追加してください (詳細については「プロジェクトレベルまたはファイルレベルでのオプションの設定」を参照)。「C++test ランタイムライブラリのビルド」の説明にあるように、ランタイムライブラリの自動ビルド機能はこのディレクトリを使ってビルドを実行します。

ランタイムディストリビューションの構成と内容

C/C++test ランタイムディストリビューションは、
<C/C++test_runtime_root> ディレクトリにある次のサブディレクトリまたはファイルから構成されます。

src/: C ソースファイルがあるディレクトリ
listeners/: 指定の通信チャネルで単純なユーティリティとして使用できるソケットリスナーとシリアルリスナーがあるディレクトリ
target/: Makefile によって使用されるターゲット構成があるディレクトリ
tests/: 1 つのクイックテストがあるディレクトリ
Makefile: ランタイムライブラリをビルドするための Makefile
projects/: ランタイムライブラリをビルドするための事前設定済み IDE プロジェクトがあるディレクトリ
channel/: 特定の通信チャネルのための Makefile 設定があるディレクトリ
include/: C ヘッダーファイルがあるディレクトリ

target ディレクトリには、さまざまなプラットフォーム、アーキテクチャ、コンパイラで利用できる複数のビルド構成があります。ターゲット構成は、ランタイムソースファイルをコンパイルするために Makefile が使用する変数 (たとえば CC や CFLAGS など) を定義するほか、コンパイル済みソースからランタイムライブラリを作成するために Makefile が使用する変数 (LIBTOOL や LIBTOOL_FLAGS など) を定義します。「make を使って C++test ランタイムライブラリをビルドする」を参照してください。

C++test ランタイムライブラリのビルド

概要

C/C++test では、テスト用実行モジュールの準備フェーズの一部として、テスト用ランタイムを自動的にビルドすることができます。自動でビルドする方法を推奨します。ほとんどの場合、C++test ランタイムライブラリを手動で用意する必要はありません。

場合によっては、C++test ランタイムライブラリのカスタムビルドを用意したいこともあります。 <C/C++test_runtime_root> ディレクトリにある Makefileを使って InstallC++test ランタイムライブラリをビルドすることができます。または、<C/C++test_runtime_root>/projects にある事前設定済みの IDE プロジェクトを使ってランタイムライブラリをビルドすることもできます。任意に独自の IDE プロジェクトを作成することもできます。

ランタイムライブラリをビルドするには、通信チャネルを選択し、Makefile があるディレクトリで IDE のビルダーまたは make を実行します。また、デフォルトの構成が問題を引き起こす場合、あるいはコンパイラとターゲットプラットフォーム用のデフォルト構成が存在しない場合、コンパイラとプラットフォーム特有の構成を変更しなければならないことがあります (「C/C++test ランタイムライブラリの構成」を参照してください)。

自動ビルド

C/C++test ランタイムの自動ビルドには次のテスト実行ステップを使用します。

<BuildRuntimeLibStep additionalFlags="<build options>" />

このテスト実行ステップは、テスト対象プロジェクトの環境 (コンパイラの実行ファイル、ビルドオプション) を使って、C++test ランタイムライブラリソースで発見されたすべてのソースファイルをコンパイルします。コンパイルされたオブジェクトはテスト用実行モジュールにリンクされます。additionalFlags 属性を使ってビルドオプションを追加することができます。この属性の指定は任意です。

ビルド設定からのランタイムライブラリの削除

テスト実行フローの一部として C/C++test が単体テストランタイムをビルドする前に、必ず [ビルド設定] > [リンカー] オプションから C++test ランタイムライブラリを削除してください。

カスタムビルドの用意

通信チャネルを選択する

手動でランタイムライブラリをビルドするための最初のステップは、ランタイムが使用する通信チャネルの実装から 1 つを選択することです。C/C++test ランタイムディストリビューションには次の通信チャネルの実装があります。

ファイル通信
- src/transport/CppTestTransportFille.c
- src/transport/CppTestTransportFileSplit.c
- src/transport/CppTestTransportFileBuffered.c
TCP/IP ソケット
- src/transport/CppTestTransportUnixSocket.c: UNIX ソケットに基づいた通信チャネル
- src/transport/CppTestTransportWinSocket.c: Windows ソケットに基づいた通信チャネル
Serial link (rs232)
- src/transport/CppTestTransportRS232Common.c
- src/transport/CppTestTransportRS232Common.h
- src/transport/CppTestTransportRS232Unix.c: UNIX シリアルポート API に基づいた通信チャネル
- src/transport/CppTestTransportRS232Win32.c: Windows シリアルポート API に基づいた通信チャネル
- src/transport/CppTestTransportRS232STM32F103ZE.c: STM32F103 MCU UART のための通信チャネル

make コマンドラインに適切なCHANNEL_TYPE パラメーターを追加して、通信チャネルの実装を選択することができます。

CHANNEL_TYPE=file: ファイル通信を選択します (デフォルト)
CHANNEL_TYPE=file-buffered: バッファーされる書き込み操作を伴うファイル通信
CHANNEL_TYPE=unix-socket: UNIX ソケット通信を選択します
CHANNEL_TYPE=win-socket: Windows ソケット通信を選択します
CHANNEL_TYPE=win-rs232: Windows シリアル通信を選択します
CHANNEL_TYPE=unix-rs232: UNIX シリアル通信を選択します
CHANNEL_TYPE=stm32f103ze-rs232: STM32F103 MCU uart 通信を選択します

または、make ツールではなく IDE を使用する場合、次の定義の中の 1 つをコンパイラオプションに追加できます。

CPPTEST_USE_FILE_COMMUNICATIONS
CPPTEST_USE_FILE_BUFFERED_COMMUNICATION
CPPTEST_USE_UNIX_SOCKET_COMMUNICATION
CPPTEST_USE_WIN_SOCKET_COMMUNICATION
CPPTEST_USE_RS232_WIN_COMMUNICATION
CPPTEST_USE_RS232_UNIX_COMMUNICATION
CPPTEST_USE_RS232_STM32F103ZE_COMMUNICATION
CPPTEST_USE_CUSTOM_COMMUNICATION

make を使って C/C++test ランタイムライブラリをビルドする

Makefile があるディレクトリで make コマンドを呼び出すと、gcc コンパイラによってランタイムソースがコンパイルされ、ライブラリツールを使って C/C++test ランタイムライブラリが作成されます。コンパイラとライブラリツールを変更するには make コマンドラインでターゲット構成を指定する必要があります。例:

make TARGET_CFG=WR_DKM_gcc3_4_simlinux_VxWorks6_4.mk

C/C++test ランタイムディストリビューションでは次の構成を利用することができます。これらの構成は <C++test_runtime_sources>/target/ ディレクトリの下にあります。

ARM_armcc1_2_ADS1_2.mk
ARM_armcc3_0_RVDS3_0.mk
ARM_armcc3_1_RVDS3_1.mk
ARM_armcc3_1_uV3.mk
ARM_armcc4_0_RVDS4_0.mk
ARM_armcc5_0.mk
ICCARM5_3.mk
MSMobile.mk
QNX_2_9.mk
QNX_3_3.mk
QNX_4_2.mk
QNX_4_4.mk
ST20_os20.mk
ST40_os21.mk
TIARM_4.9.mk
TIARM_5.1.mk
TIARM_5.1_eabi.mk
TIARM_5.1_gcc.mk
TIC2000_4.1.mk
TIC2000_5.2.mk
TIC6000_5.1.mk
TIC6000_6.0.mk
WR_DKM_dcc5_5_simlinux_VxWorks6_4.mk
WR_DKM_dcc5_5_simnt_VxWorks6_4.mk
WR_DKM_dcc5_5_simsparc_VxWorks6_4.mk
WR_DKM_dcc5_6_simlinux_VxWorks6_6.mk
WR_DKM_dcc5_6_simnt_VxWorks6_6.mk
WR_DKM_dcc5_6_simsparc_VxWorks6_6.mk
WR_DKM_gcc3_4_simlinux_VxWorks6_4.mk
WR_DKM_gcc3_4_simnt_VxWorks6_4.mk
WR_DKM_gcc3_4_simsparc_VxWorks6_4.mk
WR_DKM_gcc4_1_simlinux_VxWorks6_6.mk
WR_DKM_gcc4_1_simnt_VxWorks6_6.mk
WR_DKM_gcc4_1_simsparc_VxWorks6_6.mk
WR_RTP_dcc5_5_simpentium_VxWorks6_4.mk
WR_RTP_dcc5_5_simsparc_VxWorks6_4.mk
WR_RTP_dcc5_6_simpentium_VxWorks6_6.mk
WR_RTP_gcc3_4_simpentium_VxWorks6_4.mk
WR_RTP_gcc3_4_simsparc_VxWorks6_4.mk
WR_RTP_gcc4_1_simpentium_VxWorks6_6.mk
eVC4_0_arm.mk
eVC4_0_mips.mk
eVC4_0_sh.mk
eVC4_0_x86.mk
gcc-shared.mk
gcc-static.mk
msvc-shared.mk
msvc-static.mk

ターゲット構成は、C/C++test ランタイムライブラリのビルド時に使用される次の変数の定義を提供します。

名前	デフォルト	説明
CC	gcc	C/C++test ランタイムソースをコンパイルするために使用されるコンパイラの実行ファイル。
CFLAGS		コンパイル時に使用されるフラグ。
CC_OUT_DIR_FLAG		コンパイル成果物を格納するディレクトリと共に使用されるフラグ。 $(CC_OUT_DIR_FLAG)"<output-dir>"
CC_OUT_FLAG	-o	出力ファイル名と共に使用されるフラグ。 $(CC_OUT_FLAG)"<output-file-name>" がコンパイラコマンドラインに追加されます。
OBJ_EXT	o	出力ファイル名を作成するときに使用される、オブジェクトファイルの拡張子。
LIBTOOL	ar	コンパイルされたソースからライブラリを作成できる実行ファイル。
LIBTOOL_FLAGS	-ruv	C/C++test ランタイムライブラリを作成するときにライブラリツールと共に使用されるフラグ。
LIBTOOL_OUT_FLAG		出力ファイル名と共に使用されるフラグ。 $(LIBTOOL_OUT_FLAG)"<output-file-name>" がライブラリツールのコマンドラインに追加されます。
LIB_PREFIX	lib	これらの値は、C++test ランタイムライブラリの名前を作成するときに使用されます。 $(LIB_PREFIX)$(LIB_NAME).$(LIB_EXT)
LIB_NAME	cpptestruntime
LIB_EXT	a

LD、LDFLAGS、LD_OUT_FLAG、および OUT_EXT も、利用可能な構成によって定義されます。ただし、C/C++test ランタイムライブラリをビルドするために必須ではありません。Makefileからの test ターゲットが呼び出されるときに単純なテスト用実行モジュールをビルドするためにだけ使用されます

独自のターゲット構成を作成するには、ターゲットを最もよく表現している既存のターゲット構成をコピーし、必要に応じて変更します。独自のターゲット構成を使って C/C++test ランタイムライブラリをビルドするには、make コマンドラインに TARGET_DIR パラメーターを追加します。

 make TARGET_DIR=<directory with my target configuration> TARGET_CFG=MyTargetConfig.mk

ランタイムライブラリが作成されるディレクトリを変更することもできます (デフォルトは ./build ディレクトリです)。変更するには make コマンドラインに OUT_DIR パラメーターを追加します。例:

make OUT_DIR=<output directory for your C/C++test runtime library> ...

ビルドの実行は、C/C++test のインストール先ディレクトリで行うことも、C/C++test ランタイムソースファイルをコピーして別の場所で行うこともできます。その場合は、C++test のインクルードファイルがある場所を必ずパスに設定してください。パスを設定するには、make ファイル中の CPPTEST_INC_DIR 変数の値を絶対パスで設定します。例:

CPPTEST_INC_DIR=/usr/local/<CPPTEST_INSTALL_DIR>/bin/engine/runtime/include

マルチスレッドのサポート

マルチスレッドをサポートするユーザー定義のランタイムライブラリをビルドするには、コンパイラのコマンドラインに -DCPPTEST_THREADS_ENABLED=1 を追加します。

C/C++test ランタイムライブラリの構成

制約事項はターゲットプラットフォームによって異なります。そのため、C/C++test ランタイムライブラリは異なる環境に合わせて容易に構成できるように設計されています。マクロ定義を設定して C/C++test ランタイムライブラリをコンパイル時に構成できます。ターゲットの制約が標準的な制約ではない場合、ランタイムソースコードの変更が必要なこともあります。

注意

ランタイムライブラリのビルドに使用される、<C/C++test_includes> にあるインクルードファイルは、生成されたテストハーネス (C/C++test によって自動生成されるテストソースファイル) によっても使用されます。インクルードファイルを変更する場合は注意して作業してください。小さな変更でもホストベーステストを「破損」する可能性があります。通常安全な方法は、プリプロセッサ条件命令 (#ifdef...#endif) を使ってターゲット固有の変更を行うことです。

利用可能なコンパイラ構成は、<C/C++test_includes>/config/ ディレクトリにあります。このディレクトリには cpptest_portinfo.h ヘッダーファイルもあり、このヘッダーファイルは C/C++test ランタイムライブラリのビルド時にどのコンパイラ構成を使うかを決定します。コンパイラ構成ヘッダーファイルは、ターゲットプラットフォームにランタイムを適応させるマクロを定義します。そのほかに、コンパイラ構成ヘッダーファイルは、ターゲットプラットフォームでサポートできない C/C++test の機能を無効にするマクロも定義します。無効にできる機能の一覧については、ヘッダーファイル cpptest_features.h を参照してください。

ほとんどの場合、構成マクロの値を変更する必要があるときに、構成ファイルを変更したり新規作成したりする必要はありません。ターゲット構成ファイルの CFLAGS 変数に (または、ランタイムのビルドに IDE を使用している場合はコンパイラオプションに)、マクロの値を必要な値にセットする適切な -D オプションを追加することができます。

利用可能な一般的なマクロ定義は次の表のとおりです。注意 ! 指定されるデフォルトは、コンパイラとターゲット環境によって異なります。

名前	説明
CPPTEST_EXPORT, CPPTEST_IMPORT	Windows プラットフォーム用に DLL をビルドするとき、__declspec(dllexport) および __declspec(dllimport) に展開されます。これらは、関数/データを DLL との間でインポート/エクスポートするための Microsoft 固有の拡張子です
CDECL_CALL	Microsoft コンパイラを使ってビルドするときに、__cdecl に展開されます。これは呼び出し規則のための Microsoft 固有の拡張子です。
CPPTEST_WCHAR_ENABLED	1 を設定した場合、ランタイムライブラリは wchar 型をサポートしてビルドされます。0 を設定した場合、C++test ランタイムライブラリは wchar 型をサポートせずにビルドされます。
CPPTEST_SETJMP_ENABLED	1 を設定した場合、テストケースの実行中に例外がスローされたときにリカバーのためにシグナル処理ルーチンが使用されます。その場合、C++test はテストケース実行の結果として例外を記録し、テストケースの実行を続けようとします。
CPPTEST_USE_ANSI_SETJMP	1 を設定した場合、シグナル処理のためにlongjmp および setjmp 関数が使用されます。0 を指定した場合、siglongjmp および sigsetjmp 関数が使用されます。および類推的に次のデータ型で使用されます。 sigjmp_buf 対 jmp_buf 注意 ! このマクロを使用するには、CPPTEST_SETJMP_ENABLED を "1" に設定する必要があります。
CPPTEST_USE_UNCAUGHT_EXCEPTION_CHECKING	1 を設定した場合、キャッチされない例外の処理に uncaught_exception 関数が使用されます。
CPPTEST_USE_STD_NS	C/C++test が std 名前空間を使うべきでない場合、またはコンパイラが名前空間をサポートしていない場合、0 に設定します。
CPPTEST_TIME_MODE	このマクロは、時間の測定のためにどの関数を使用するかを制御します。設定できる値の一覧については cpptest_time.h ヘッダーファイルを参照してください。

C++test の機能を有効/無効にできる、利用可能なマクロ定義は次の表のとおりです。

名前	説明
CPPTEST_C_STREAMS_REDIRECT_ENABLED	1 に設定すると、c ストリーム (stdin、stdout、 stderr) のリダイレクトが有効になります。無効にするには 0 を設定します。
CPPTEST_CPP_STREAMS_REDIRECT_ENABLED	1 に設定すると、cpp ストリームのリダイレクトが有効になります。無効にするには 0 を設定します。
CPPTEST_USE_WSTREAMS	1 に設定すると、cin、cout、cerr、clog の代わりに、wcin、wcout、wcerr、wclog が使用されます。注意 ! このマクロが機能するには、 CPPTEST_CPP_STREAMS_REDIRECT_ENABLED を 1 に設定する必要があります。
CPPTEST_EXCEPTIONS_ENABLED	1 に設定すると、例外処理が有効になります。無効にするには 0 を設定します。
CPPTEST_SPECIAL_STD_EXCEPTIONS_HANDLING_ENABLED	1 に設定すると、ほかの例外とは別に std::exception が処理されます。注意 ! このマクロが機能するには、 CPPTEST_EXCEPTIONS_ENABLED を 1 に設定する必要があります。
CPPTEST_DATA_SOURCES_ENABLED	1 に設定すると、データソース機能が有効になります。無効にするには 0 を設定します。
CPPTEST_CSV_DATA_SOURCE_ENABLED	1 に設定すると、CSV データソース機能が有効になります。無効にするには 0 を設定します。
CPPTEST_USE_SETUP_FOR_C_SUITES	1 に設定すると、 C 言語のテストスイートで setUp および tearDown 関数を使用できます。
CPPTEST_THREADS_ENABLED	1 に設定すると、スレッドのサポートが有効になります。無効にするには 0 を設定します。

通信モード

このセクションの内容:

ファイル通信チャネル
ソケット通信チャネル
RS232 通信チャネル

ファイル通信チャネル

ファイル通信チャネルの実装

ファイル通信チャネルは、標準のファイル I/O 操作を利用してテスト結果を保存します。テスト結果用とカバレッジ結果用の 2 つのデータストリームがあります。次の 3 種類の実装があります。

src/transport/CppTestTransportFile.c: プレーンファイルの I/O 書き込み
src/transport/CppTestTransportFileSplit.c: プレーンファイルの I/O 書き込み。設定された最大サイズに従って一連のファイルにデータを分割する
src/transport/CppTestTransportFileBuffered.c - バッファーされた書き込み操作

CppTestTransportFile.c のモードでは、テスト中に生成された各データパケットは、直ちにファイルに保存されます。実際の物理的な書き込みを行うかどうかはオペレーティングシステム次第です。

CppTestTransportFileSplit.c のモードは、CppTestTransportFile.c のモードと同様に、プレーンファイルの I/O 書き込みを使用します。ただし、CppTestTransportFileSplit.c のモードでは、データパケットは一連の複数のファイルに保存されます。各ファイルの最大サイズを指定するには、CPPTEST_MAX_ALLOWED_NUMBER_OF_BYTES_PER_FILE マクロを使用して値を設定します。デフォルトのサイズは 2000000000 バイト (2 GB) です。生成されるファイル名には番号が付けられます (例: 'cpptest_results.clog', 'cpptest_results.clog.0001', 'cpptest_results.clog.0002'。生成された結果を C++test にロードする方法については、「ReadDynamicCoverageStep」および「ReadTestLogStep」テスト実行フローステップの説明を参照してください。

CppTestTransportFileBuffered.c のモードでは、小さなデータパケットの書き込み頻度を減らすために、中間メモリバッファーが利用されます。小さなデータの塊を書き込む方が、結合されたより大きなデータを書き込むよりもコストが高い環境の場合、このモードを使用するべきです。中間メモリバッファーのサイズは FILE_COMMUNICATION_BUFFER_SIZE 定義を使って決定できます。バッファーサイズが大きければ大きいほど、書き込み操作の頻度が下がります。

ソケット通信チャネル

ソケット通信チャネルの実装

ソケット通信チャネルは、TCP/IP ソケットを利用してテスト結果を保存します。2 つのソケットがオープンされます。1 つはテスト結果用、もう 1 つはカバレッジ結果用です。次の 2 種類の実装があります。

src/transport/CppTestTransportUnixSocket.c: UNIX/Linux ベースのシステム用
src/transport/CppTestTransportWin32Socket.c: Windows ベースのシステム用

ソケットリスナー

TCP/IP ソケットを介して発せられるデータは、ソケットリスナーの助けを借りてキャプチャするべきです。ソケットリスナーは C/C++test に付属する単純なユーティリティプログラムであり、<C/C++test_runtime_root>/listeners/socket_listener ディレクトリにあります。ソケットリスナーは次のパラメーターを取ります。

名前	説明
`-cl, --channel port_number@log_file`	通信チャネルの仕様。結果をリッスンするポート番号についての情報とこのポートでキャプチャされたデータを保存するファイルについての情報。
`-sf, --sync_file filename`	同期化に使用されるファイルへのパス。ソケットリスナーはこのパスを使って 2 つの同期化ファイルを作成します。 <sync_file>.init ソケットリスナーの初期化が完了したとき <sync_file>.final ターゲットからの接続がクローズしたとき。
`-to, --timeout timeout (in seconds)`	結果を待機するタイムアウト。この時間を過ぎるとプログラムは停止します。
`--help`	ヘルプ情報を表示します。

RS232 通信チャネル

シリアル通信チャネルの実装

シリアル通信モジュールは、シリアル通信だけが利用可能なデバイスに対するテスト結果の転送を処理するために設計されています。シリアル通信の実装は、次の 2 つの部分から構成されます。

共通レイヤー: データのパッケージ、フレームのフォーミュレート、および送信の正しさの検証に関係します。実装は CppTestTransportRS232Common.c および CppTestTransportRS232Common.h ファイルで提供されます。
ターゲット固有の部分: 理的な COM ポートとのやり取りに関係します。セットアップおよび送信の関数の実装を持ちます。C++test では、Windows ベースのターゲットと UNIX ベースのターゲット用にこのレイヤーの実装の例が用意されています。STM32103ZE Cortex-M3 チップ (Keil uVision3) の単純な Bare-Metal の実装も用意されています。

ローモードとセーフモード

次の 2 つの通信モードを利用することができます。

ローモード: データは検証されずにホストマシンに送られます。このモードは安定した環境に推奨します。
セーフモード: パケットごとにチェックサムが計算されます。チェックサムが不正な場合、送信は停止します。このモードを有効にするには、コンパイルフラグ - DCPPTEST_RS232_SAFE_MODE=1 を追加します。

シリアルリンクを介して送られるデータは、パッケージに分割されます。パッケージは下記のように表現されます。これはローモードの単純なフレームの例です。

これはセーフモードの単純なフレームの例です。

使用されているシンボルの意味は次の表のとおりです。

シンボル	説明
STX (0x02)	テキストの開始 (Start of text)
ETX (0x03)	テキストの最後 (End of text )
EOT (0x04)	送信の最後 (End of transmission)
ENQ (0x05)	問い合わせ (Enquiry)
ACK (0x06)	肯定回答 (Affirmative acknowledgement)
NAK (0x15)	否定回答 (Negative acknowledgment)

セーフモードのチェックサムは、排他的 OR で計算されます。ローモードの場合、チェックサムは計算されず、すべてのフレームにゼロ値が送られます。

データの最大量のデフォルトは、250 バイトに設定されます。この値は MAX_PACKET_SIZE マクロを使って変更できます。

送信のフロー

セーフモードでは、可用性について問い合わせるためにクライアントが ENQ を送ります。ACK を受け取るまでクライアントは送信を開始できません。ACK を受け取ると、クライアントは別のフレームを送ります。各フレームは ACK によってホストマシンに確認されます。最後に、クライアントは EOT を送ります。それに応答して、ホストは ACK を送り、送信を完了します。チェックサムが計算されるのはセーフモードだけです。通常のモードでは値は常に 0 です。

ローモードでは、送信は一方向だけです。ターゲットプラットフォームは、どのデータ送信段階でも ACK を待たずにデータを発信します。

シリアル通信の新しいプラットフォーム固有の実装を追加する

シリアル通信の別の実装を追加するには、次の操作が必要です。

<C++test Install dir>/engine/runtime/src/transport ディレクトリに、カスタムシリアル通信の実装を記述した新規ファイルを追加します。次のテンプレートに従ってください。

#define CPPTEST_RUNTIME_IMPLEMENTATION
#include "cpptest_portinfo.h"
#ifdef CPPTEST_USE_RS232_MYPLATFORM_COMMUNICATION
#include "CppTestTransportRS232Common.h"
int localRsInitInternalSerial(CppTestStreamParameters *par)
{
  return RS_OK;
}
int localRsUninitInternalSerial(CppTestStreamParameters *par)
{
  return RS_OK;
}
int localRsSendInternalByte(CppTestStreamParameters *par, unsigned char
byte, unsigned char *is_send)
{
  return RS_OK;
}
int localRsSendInternalStr(CppTestStreamParameters *par, unsigned char
*bytes, int *nBytes)
{
  return RS_OK;
}
int localRsRecvInternalByte(CppTestStreamParameters *par, unsigned char
*pByte, unsigned char *is_recv)
{
  return RS_OK;
}
int localFlushInternalRS(CppTestStreamParameters *par)
{
  return RS_OK;
}
void localSetStop(int *stop_bit, int result)
{
}
void localSetParity(int *parity, char *result)
{
}
void localRsSleep(unsigned int msec)
{
}
#endif

次の関数を実装します。
- int localFlushInternalRS(CppTestStreamParameters *par);
  内部シリアルポートバッファーを消去する。CppTestStreamParameters は下記で説明。
- int localRsInitInternalSerial(CppTestStreamParameters *par);
  初期シリアルポート。
- int localRsSendInternalByte(CppTestStreamParameters *par, unsigned char byte, unsigned char *is_send);
  1 バイトを送信する。パラメーターは par (下記で説明) および送信するバイトと結果。
- int localRsSendInternalStr(CppTestStreamParameters *par, unsigned char bytes, int *nBytes);
  nBytes バイトを送信する。パラメーターは par (下記で説明)、バイト、送信するバイト、および送信された nBytes。
- int localRsRecvInternalByte(CppTestStreamParameters *par, unsigned char *pByte, unsigned char *is_recv);
  1 バイトを受け取る。パラメーターは par (下記を参照) および受け取ったバイトの結果。
- int localRsInitInternalSerial(CppTestStreamParameters *par);
  シリアルポートを閉じる。
- void localSetStop(int *stop_bit, int result);
  ストップビット送信パラメーターを設定する。
- void localSetParity(int *parity, char *result);
  パリティ送信パラメーターを設定する。
- char *localGetErrorText(void);
  バッファーを返す。エラーがある場合はエラーテキストも返す。
- void localRsSleep(unsigned int msec);
  Sleep の実装。

Struct CppTestStreamParameters:

typedef struct {
  char serial_device[16]; Device name (COM1, /dev/ttyS0, cua0 etc). Depend
on platform
  int baud_rate; Device speed
  int byte_size; Byte size
  int parity; Parity
  int stop_bit; Stop bit
  int timeout; Timeout between two operations.
  long max_timeout; If exceeded tranmision broken.
} CppTestStreamParameters;

ランタイムライブラリを使って新しい実装を統合する

ランタイムライブラリを使って新しい実装を統合するには、次の操作を行います。

channel ディレクトリで、myplatform-rs232.mk という新しいファイルを挿入します。このファイルに次の行を追加します。
"CHANNEL_CONFIG_MACRO=-DCPPTEST_USE_RS232_MYPLATFORM_COMMUNICATION"

include/cpptest_portinfo.h ファイルで、次の行を置き換えます。置き換える箇所：

#if !defined(CPPTEST_USE_FILE_COMMUNICATION) && \
    !defined(CPPTEST_USE_FILE_BUFFERED_COMMUNICATION) && \
    ...
    !defined(CPPTEST_USE_RS232_STM32F103ZE_COMMUNICATION) && \
    ...
    !defined(USE_CUSTOM_COMMUNICATION_CHANNEL)
#  define CPPTEST_USE_FILE_COMMUNICATION
#endif

置換後の内容：

#if !defined(CPPTEST_USE_FILE_COMMUNICATION) && \
    !defined(CPPTEST_USE_FILE_BUFFERED_COMMUNICATION) && \
    ...
    !defined(CPPTEST_USE_RS232_STM32F103ZE_COMMUNICATION) && \
    !defined(CPPTEST_USE_RS232_MYPLATFORM_COMMUNICATION) && \
    ...
    !defined(USE_CUSTOM_COMMUNICATION_CHANNEL)
# define CPPTEST_USE_FILE_COMMUNICATION
#endif

パラメーター CHANNEL_TYPE=myplatform-rs232 を使ってライブラリをビルドします。
Runtime Library Auto Build ステップを使用する場合、次のいずれかの操作を行います。
- C++test プロジェクトのコンパイラフラグに -DCPPTEST_USE_RS232_MYPLATFORM_COMMUNICATION を追加します。
- Runtime Auto Build ステップのテスト実行フローに次のフラグを追加します。
  <BuildRuntimeLibStep
  additionalFlags="-DCPPTEST_USE_RS232_MYPLATFORM_COMMUNICATION" />

RS232 リスナー

シリアルリンクを介してターゲットから発せられるデータは、シリアルポートリスナーの助けを借りてキャプチャするべきです。リスナーは C/C++test に付属する単純なユーティリティプログラムであり、<C/C++test_runtime_root>/listeners/rs232_listener ディレクトリにあります。リスナーは次のパラメーターを取ります。

パラメーター	説明
-d (--device) COM,SPEED,PARIT Y,STOP,BYTE_SIZE.	使用するデバイス。例： `-d 1,19200,N,1,8`この場合、COM1 ポート、速度 19200、パリティなし、1 ストップビット、8 バイトサイズ。
-sf (--syncfile) <sync file>	同期化するファイル名。
-cn (--channel) number<mode>@<fil e path>	通信チャネル。C++test はテストログとカバレッジログの 2 つのチャネルを使用します。バイナリモードは "b"、テキストモードは "t" です。デフォルトはテキストモードです。
-to (--timeout) <timeout in second>	結果を待機するタイムアウト時間。この時間を過ぎると、プログラムは停止します。
-fi <file_name>	ファイルモード。バイナリファイルから結果を読み込みます。すべての RS232 設定が無視されます。
-rm (--rawmode)	ローモード (ACK とチェックサムなし)。転送が非セーフモードで使用された場合、このオプションは必須です。
-v (--verbose)	冗長モード。

リスナーが送信のチェックサムの計算および ACK の送信を行うかどうかは、実行モード (セーフまたはロー) によります。

初期化と終了処理

テストまたはアプリケーションの実行中にランタイムライブラリに渡されるすべてのデータは、ランタイムライブラリが正しく初期化される場合にだけ、処理され、解釈され、通信ストリームに渡されます。ランタイムライブラリが初期化されない場合または終了処理された場合、カバレッジ、単体テストメッセージ、アサーション、実行時違反といったデータは無視されます。

ランタイムライブラリは CppTest_InitializeRuntime() 関数の 1 回目の呼び出しの最中に初期化されます。この関数はランタイムライブラリモジュールを初期化し、メッセージとカバレッジデータのための通信チャネルをオープンします。デフォルトでは、CppTest_InitializeRuntime() 関数はできるだけ早く呼び出されます。C++ コードがあるプロジェクトでは、グローバルオブジェクトのコンストラクターが呼び出される前に呼び出されます。C のプロジェクトでは、main() 関数の先頭で呼び出されます。ランタイムライブラリは CppTest_FinalizeRuntime() 関数の 1 回目の呼び出しの最中に最終化されます。この関数は、ランタイムライブラリモジュールを終了処理し、通信チャネルをクローズします。この関数は、グローバルオブジェクトのデストラクターが呼び出された後に自動的に呼び出されます。C プロジェクトでは、main() 関数を抜ける前に呼び出されます。

さらに、テストハーネスの実行で初期化と終了処理のために実装できる特別な関数が 2 つあります。

void CppTest_Initialize(void)

この関数は、CppTest_InitializeRuntime 関数の先頭で、C/C++test ランタイムライブラリモジュールの初期化よりも前に呼び出されます。

void CppTest_Finalize(void)

この関数は、CppTest_FinalizeRuntime の最後で、テスト結果の通信チャネルがクローズした後に呼び出されます。

これらの関数は通常、プロジェクトが早期に初期化コードを実行する必要がある場合に使用されます。たとえば、ハードウェア固有の初期化コード (たとえばウォッチドッグタイマー) や、実行シーケンスにおいて、非常に早期の実行が期待されるタイプの初期化などです。注意:

単体テストとアプリケーション検証での CppTest_Initialize/Finalize の使用

単体テストの実行時、オリジナルプロジェクト中に存在する初期化コードは、実行から除外されます。なぜなら、オリジナルアプリケーションのエントリポイント (通常 main 関数) は、C/C++test によって自動生成されたテストハーネスのエントリポイントで置換されるからです。これが、CppTest_Initialize/Finalize 関数によって初期化/終了処理コードをフックする必要がある理由です。

アプリケーションメモリエラーチェックモードでは、対照的に、C/C++test 固有の関数の形式でハードウェア初期化コードを提供する必要は通常ありません。なぜなら、アプリケーション監視モードではアプリケーションのエントリポイントを C/C++test が置換しないため、オリジナルの初期化コードがこの目的で呼び出されるべきだからです。ただし、アプリケーション監視モードで C/C++test 固有の初期化/終了処理を行う必要がある場合は、同様に CppTest_Initialize/Finalize 関数を使用できます。

CppTest_Initialize および CppTest_Finalize 関数の追加

CppTest_Initialize および CppTest_Finalize 関数は、直接プロジェクトに追加できます。また、プロジェクトに属さないソースファイルに置くこともできます。ソースファイルは、オリジナルプロジェクトの一部ではないディレクトリで、テストコンフィギュレーションで指定した場所に一致するディレクトリに配置する必要があります。

テストコンフィギュレーションを開きます。
[実行] > [シンボル] タブをクリックします。
[次の場所で発見されたファイルのシンボルも使用] フィールドで、ソースファイルがあるフォルダーを指定します。
[適用] ボタンをクリックします。

この関数の定義を提供すると、C/C++test はテストの準備中に関数定義を検出し、テスト実行モジュールの開始の初期段階で関数定義の呼び出しを生成します。

注意: テスト対象ソースと追加のソースに対してスタブインストゥルメントを有効化する必要があります

CppTest_Initialize と CppTest_Finalize のスケルトン作成

C++test には、CppTest_Initialize および CppTest_Finalize の関数スケルトンを自動的に実装するための専用ウィザードが用意されています。ウィザードを使わずに手動でこれらの関数を追加することもできます。

[ランタイム - カスタムイニシャライズ & ファイナライズ] ウィザードにアクセスするには、次の操作を行います。

[ファイル] メニューの [新規] > [その他] をクリックします。
[C++test] > [ランタイム - カスタムイニシャライズ & ファイナライズ] を選択し、[Next] をクリックします。
ソースファイルの名前と場所を指定します。ウィザードは、テストコンフィギュレーション設定の [次の場所で発見されたファイルのシンボルも使用] フィールドで指定した値と同期されるはずです (「CppTest_Initialize および CppTest_Finalize 関数の追加」を参照)。
ドロップダウンリストからファイルタイプ (C または C++) を選択し、[終了] をクリックします。

設定を適応すると、指定した場所にソースファイルが生成されます。このソースファイルには以下の空の定義があります。

void CppTest_Initialize(void)
void CppTest_Finalize(void)

カスタムの初期化/終了処理コードを追加してこれらの関数を拡張できます。

ヒント

ランタイムライブラリの初期化が早すぎ、アプリケーション検証の問題が発生する場合、ランタイムライブラリの自動初期化を無効にすることができます。無効にするには、詳細オプションの testrunner.earlyRuntimeInitialization および CppTest_InitializeRuntime() の呼び出しをソースコードの適切な位置で使用します。testrunner.earlyRuntimeInitialization の詳細については「インストゥルメントの詳細オプション」を参照してください。#ifdef PARASOFT_CPPTEST を使ってこの呼び出しを保護することを推奨します。
ランタイムライブラリを早く終了処理するために、CppTest_FinalizeRuntime() を直接ソースコード中に置くことができます。この関数が呼び出された後、カバレッジ、単体テストメッセージ、アサーション、実行時違反といったデータは無視されます。

C/C++test ランタイムライブラリが使用するシンボル

C/C++test ランタイムライブラリは次の外部シンボルを使用します。

close
dup
dup2
exit
fclose
fflush
fopen
fprintf
fputc
free
fwrite
getenv
malloc
memcmp
memcpy
memset
mkstemp
open
perror
pthread_exit
pthread_mutex_destroy
pthread_mutex_init
pthread_mutex_lock
pthread_mutex_unlock
pthread_self
read
siglongjmp
signal
sprint
stdout
strcmp
strcpy
strlen
strncmp
strstr
tolower
vprintf
vsprintf
write

注意

CPPTEST_USE_ANSI_SETJMP を 1 に設定した場合、次のシンボルがシステムライブラリから参照されます。
- longjmp
- setjmp
CPPTEST_USE_ANSI_SETJMP を 0 に設定した場合、次のシンボルが代わりに使用されます。
- siglongjmp
- sigsetjmp
CPPTEST_TIME_MODE を CPPTEST_TIME_ANSI に設定した場合、次のシンボルがシステムライブラリから参照されます。
- time
CPPTEST_TIME_MODE を CPPTEST_TIME_GETTIMEOFDAY に設定した場合、次のシンボルがシステムライブラリから参照されます。
- gettimeofday
CPPTEST_TIME_MODE を CPPTEST_TIME_TIMEB に設定した場合、次のシンボルがシステムライブラリから参照されます。
- ftime
CPPTEST_TIME_MODE を CPPTEST_TIME_TICKLIB に設定した場合、次のシンボルがシステムライブラリから参照されます。
- tickGet
- sysClkRateGet
CPPTEST_USE_FILE_COMMUNICATION を設定した場合、次のシンボルがシステムライブラリから参照されます。
- fopen
- fclose
- fputc
- fwrite
- fflush
CPPTEST_USE_UNIX_SOCKET_COMMUNICATION を設定した場合、次のシンボルがシステムライブラリから参照されます。
- socket
- gethostbyname
- htons
- inet_addr
- connect
- close
- send
CPPTEST_USE_WIN_SOCKET_COMMUNICATION を設定した場合、次のシンボルがシステムライブラリから参照されます。
- WSAStartup
- socket
- gethostbyname
- htons
- inet_addr
- connect
- closesocket
- shutdown
- WSACleanup
- send
CPPTEST_C_STREAMS_REDIRECT_ENABLED または CPPTEST_CPP_STREAMS_REDIRECT_ENABLED を設定した場合、次のシンボルがシステムライブラリから参照されます。

dup
dup2
_get_osfhandle
perror
strstr
unlink
write
open
close
GetTempFileName (_WIN32)
GetTempPath (_WIN32)
mkstemp (!_WIN32)

Page tree

Working with the C++test Runtime Library

概要