*

Eclipseで単体テストするときの注意点(?)

公開日: : 最終更新日:2020/03/25 HACK, 開発

どもです。

今回のエントリは、Eclipse/cygwinで単体テストを行う際にハマってしまった内容について書きます。
単体テストの対象としているのは、ここ最近作成しているライブラリです

なお、開発は以下の環境で開発を行っています。
(今更ですが…)

項目スペック
OSWindows10 Pro(ver.1903)
CPUi7-8700
コンパイラgcc/cygwin
開発環境Eclipse Version:2019-06(4.12.0)
メモリ16GB

作成しているライブラリについては、下記のエントリを参照して下さい。
ライブラリでRasPiのピンにアクセス(1)-ライブラリを作ります
ライブラリでRasPiのピンにアクセス(2)-ライブラリを作ります
ライブラリでRasPiのピンにアクセス(3)-ライブラリを作ります

1.今回のテーマ

今回のテーマは、「単体テスト」です。

実装した各クラスの単体テストを行っていたのですが、この単体テストのコードが期待した通りに動かずテストができない、という状況に陥りました。
今回のエントリでは、この「状況」の原因と、その解決策について書きます。

2.発生した状況

一部ですが、具体例を示しながら状況を説明します。

2.1.基本的なフォルダ構成

現在、以下のようなフォルダ構成で開発を行っています。
raspiberrypi_gpio_lib_ex_001_001
ノートPCががEclipseのワークスペース、CPart_UTestとRaspiGpioLibraryがEclipseのプロジェクトに、それぞれ対応しています。
RaspiGpioLibraryのCPartクラスの単体テストを、CPart_UTestプロジェクトで行う、という構成になっています。
ここで、CPartの単体テストを行う際に、そのプロジェクトであるCPart_UTestにCPartクラスのソースコード(.cppと.h)を「リンクする」形式で取り込んでいました。
CPartクラスのソースコードはRaspiGpioLibrary/srcに配置されており、テストコードはCPart_UTest/srcに配置される、という構成です。

2.2.問題となった状況

問題となったのは、CPartの単体テストで作成したCGpioのスタブです。
CPart本体はCGpio.hをインクルードするのですが、これがRaspiGpioLibrary/srcにある「CGpio.h」をインクルードします。
しかしCGpioのスタブはCPart_UTest/srcにあり、テストコードはこちらをインクルードします。
1つのプロジェクトで、CGpio.hが複数存在し、かつファイルによってインクルードするファイルが異なる、という現状況が発生します。
raspiberrypi_gpio_lib_ex_001_002
これに対して、ビルドに使用されるCGpioのクラス/ソースコードは1つ(ここでは、CPart_UTest/srcに配置された「スタブ」)です。
即ち、「クラスの宣言と定義で齟齬がある」という状況です。
これが、問題なのです。
raspiberrypi_gpio_lib_ex_001_003

2.3.何が起きる?

私の環境では、「関数が、期待通りに呼び出されない」という現象が発生しました。
例えば、CPartでCGpioのメソッドAを呼び出す処理があった場合、本来であればスタブのメソッドAを呼び出したいにも関わらず、スタブのメソッドBが呼び出される、という現象です。

詳細な原因は調べられていませんが、先にも書いた通り、「クラスの宣言と定義で齟齬がある」ことが原因と考えています。

3.解決策

残念ながら、上記の現象の詳細な解析はできていません。
なので、ここで紹介する対処方法は、根本的な原因の解決にはならないかと思います。
…というか、なっていません。
その点を理解して、読み進めてください。

3.1.何をした?

対策として、テスト対象のソースコード(CPart.cpp/.h)を「リンクする」から、「コピーする」方式に変えました。
こうすることで、テスト対象のソースコードが参照/インクルードするCGpioのファイルがスタブのものになり、結果として期待する通りの関数呼び出しが行われるようになります。

3.2.更新した場合は?

しかしこの対応では、RaspiGpioLibrary/srcのCPartを更新したら、それを逐次CPartの単体テスト環境(CPart_UTest/src)にコピーしなければならない、という作業が新たに発生します。
この作業を忘れてしまうと、更新されていないコードに対して単体テストを行うだけで、まったく意味がありません。
忘れてしまうと、致命的な間違いになってしまいます。

3.3.ではどうする?

今回は、Eclipseの機能を使って対応することにしました。
CPart_UTestプロジェクトのプロパティダイアログを開いて、[C/C++ビルド]-[設定]-[ビルド・ステップ]タブを開きます。
表示された画面において、「ビルド前のステップ」にファイルのコピーを実行する処理を記載します。
eclipse_post_build_cp_001
これにより、ビルドを実行する前に、必ずRaspiGpioLibrary/src/のCPart.cpp/.hが、テストフォルダにコピーされるようになり、「コピー忘れ」の発生を回避できます。

4.まとめ

このエントリ、分かりにくい内容になっているかと思います。
それでも、Eclipseで単体テストを行っている、またはこれから行おうという方の助けになれることを願っています。

ではっ!

関連記事

google_test

C言語でEV3開発(6)

どもです。 今回のエントリーは、前回のエントリーの続き、google testでの単体テスト環境に

記事を読む

RasPi_Qt

Rasbianの新しいバージョンが出たので、クロス環境を更新してみた。(さらにその後)

どもです。 前回の投稿から、かなり時間が空いてしまいましたが、今回は前回の続きとして、「QtC

記事を読む

GitHub

Windowsでのカバレッジ測定-OpenCppCoverageを使ってみた(2)

どもです。 前回のエントリーで、OpenCppCoverageというカバレッジを測定する、フリーの

記事を読む

no image

C言語でEV3開発(15)-TOPPERS/HRP2 EV3 で PID制御

どもです。 今回のエントリーは、コレまでのエントリーから内容を変えて、モーターの動作の制御をします

記事を読む

cygwin_my_image

cygwinでstartコマンド

どもです。 このエントリでは、cygwinでWindows/コマンドプロンプトの「start」

記事を読む

Arduino_Logo

ホールセンサーの種類と使い方(割込み編)

どもです。 前回に引き続き、今回もホールセンサーについてです。 1.前回からの違い 前回の

記事を読む

GitHub

C/C++のスタブを自動生成するツールを公開しました

どもです。 突然ですが、C/C++の単体テストで使用する「スタブ」を自動で生成するツールを公開

記事を読む

toppers

C言語でEV3開発(27)-EV3にヒステリシス処理を実装してみた

どもです。 今回は、モーターから読み出した値に対するヒステリシス・フィルター処理です。 0.

記事を読む

cygwin_my_image

Windows10/cygwinの音を消す

どもです。 最近、Windows10/cygwinで作業をする場面がありました。 このcyg

記事を読む

toppers

C言語でEV3開発(18)-モードの遷移の設計-コマンド通信処理の準備

 どもです。  今回は、前回紹介したEv3とBluetoothで通信する機能を

記事を読む

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA


次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code class="" title="" data-url=""> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre class="" title="" data-url=""> <span class="" title="" data-url="">

c_sharp_eye_catch
Windowsでのカバレッジ測定-OpenCoverageを使ってみた

どもです。 以前、OpenCppCoverageを使用してWindo

EF_GRY-OR_png
Eclipseで単体テストするときの注意点(?)

どもです。 今回のエントリは、Eclipse/cygwinで単体

cygwin_my_image
Windows10/cygwinの音を消す

どもです。 最近、Windows10/cygwinで作業をする場

raspberry-pi
ライブラリでRasPiのピンにアクセス(3)-SPIのインターフェース追加(その2)

どもです。 今回のエントリも、前回に引き続き、Raspberry

cygwin_my_image
cygwinでstartコマンド

どもです。 このエントリでは、cygwinでWindows/コマ

→もっと見る

PAGE TOP ↑