2019/09/12

google testでrosパッケージの単体テストを行う方法

背景

rosパッケージを作成する際に、品質担保のために通常単体テストを行う。
googleテストの使用方法やCMakeListsの書き方を備忘録として記載する。

記事の目的

google testでrosパッケージの単体テストを行う

google test

google testでrosパッケージの単体テストを行う方法について記載する。

google testとは

google testは、google社が提供するオープンソースのテストフレームワークである。

特徴

  • マクロを使用してテストケースを容易に記述できる
  • rosの標準のテストフレームワークである

テンプレートのパッケージ構成

google testでrosパッケージの単体テストを行うrosパッケージの構成を記載する。
  1. $ tree
  2. .
  3. ├── CMakeLists.txt -> /opt/ros/kinetic/share/catkin/cmake/toplevel.cmake
  4. └── sample_pkg                # google testでテストを行うサンプルパッケージ
  5.      ├── CMakeLists.txt       # CMakeListsファイル
  6.      ├── include
  7.      │   └── sample_pkg
  8.      │       └── sample.hpp  # headerファイル
  9.      ├── launch
  10.      │   └── sample.launch   #(オプション)launchファイル
  11.      ├── package.xml          # Packageファイル
  12.      ├── src
  13.      │   ├── main.cpp        # ソースファイル(main関数のみ)
  14.      │   └── sample.cpp      # ソースファイル(その他関数, クラス)
  15.      └── test
  16.           └── utest.cpp       # 単体テストファイル

テンプレートのheaderファイルとソースファイル

テンプレートのheaderファイルとソースファイルを記載する。
  1. // sample.hpp
  2. #include <ros/ros.h>
  4. namespace sample
  5. {
  6.     int  func1(int a, int b);
  7.     bool func2(int c, int d);
  8.     class class3
  9.     {
  10.         public:
  11.             class3();
  12.             ~class3();
  13.             void func4(int e);
  14.             void func5(int &f);
  15.         protected:
  16.             int internal_variable_ = 0;
  17.     };
  18. };

  1. // sample.cpp
  2. #include <sample_pkg/sample.hpp>
  4. int sample::func1(int a, int b)
  5. {
  6.     return a+b;
  7. }
  9. bool sample::func2(int a, int b)
  10. {
  11.     if (a == b)
  12.     {
  13.         return true;
  14.     }
  15.     return false;
  16. }
  18. sample::class3::class3()
  19. {}
  21. sample::class3::~class3()
  22. {}
  24. void sample::class3::func4(int e)
  25. {
  26.     internal_variable_ = e;
  27. }
  29. void sample::class3::func5(int &f)
  30. {
  31.     f = internal_variable_;
  32. }

  1. // main.cpp
  2. #include <sample_pkg/sample.hpp>
  4. int main(int argc, char **argv){
  5.     int A = sample::func1(1,3);
  6.     
  7.     return A;
  8. }


テンプレートの単体テストファイル

テンプレートの単体テストファイルを記載する。
  1. // utest.cpp
  2. #include <sample_pkg/sample.hpp>
  3. #include <gtest/gtest.h>
  5. // sample::func1のテスト
  6. TEST(Factorial1Test, func1Test)
  7. {
  8.     int A = sample::func1(1,2);
  9.     EXPECT_EQ(3, A); // A == 3 かチェック
  10. }
  12. // sample::func2のテスト
  13. TEST(Factorial2Test, func2Test)
  14. {
  15.     EXPECT_TRUE(sample::func2(1,1)); // a == bの時、戻り値がtrueかチェック
  16.     EXPECT_FALSE(sample::func2(1,2)); // a != bの時、戻り値がfalseかチェック
  17. }
  19. // sample::class3のテスト
  20. TEST(Class3Test, func4_5Test1)
  21. {
  22.     sample::class3 c;
  23.     int a;
  24.     c.func5(a);
  25.     EXPECT_EQ(0, a); // 初期状態でc.func5(a)のa==0かチェック
  26. }
  28. // sample::class3のテスト
  29. TEST(Class3Test, func4_5Test2)
  30. {
  31.     sample::class3 c;
  32.     int a = 4;
  33.     int b = 0;
  34.     c.func4(a);
  35.     c.func5(b);
  36.     EXPECT_EQ(a, b); // c.func4(a)を行った後、c.func5(b)のb==aかチェック
  37. }
  39. // Run all the tests that were declared with TEST()
  40. int main(int argc, char **argv){
  41.     testing::InitGoogleTest(&argc, argv);
  42.     return RUN_ALL_TESTS();
  43. }

テンプレートのCMakeListsファイルとPackageファイル

テンプレートのCMakeListsファイルとPackageファイルを記載する。
  1. # CMakeLists.txt
  2. cmake_minimum_required(VERSION 2.8.3)
  3. project(sample_pkg)
  5. ## Compile as C++11, supported in ROS Kinetic and newer
  6. add_compile_options(-std=c++11 -Wall -g -O3)
  8. ## Find catkin macros and libraries
  9. find_package(catkin REQUIRED COMPONENTS
  10.              roscpp
  11. )
  13. ###################################
  14. ## catkin specific configuration ##
  15. ###################################
  17. ## Declare things to be passed to dependent projects
  18. catkin_package(
  19.    INCLUDE_DIRS include
  20.    LIBRARIES sample_pkg
  21. )
  23. ###########
  24. ## Build ##
  25. ###########
  27. ## Specify additional locations of header files
  28. include_directories(include
  29.                     /usr/local/include
  30.                     ${catkin_INCLUDE_DIRS}
  31. )
  33. ## Declare a C++ library
  34. add_library(${PROJECT_NAME}_lib
  35.             src/sample.cpp
  36. )
  38. ## Declare a C++ executable
  39. add_executable(${PROJECT_NAME}
  40.                src/main.cpp
  41. )
  43. ## Specify libraries to link a library or executable target against
  44. target_link_libraries(${PROJECT_NAME}_lib
  45.                       ${catkin_LIBRARIES}
  46. )
  48. target_link_libraries(${PROJECT_NAME}
  49.                       ${PROJECT_NAME}_lib
  50.                       ${catkin_LIBRARIES}
  51. )
  53. #############
  54. ## Install ##
  55. #############
  57. ## Mark executables and/or libraries for installation
  58. install(TARGETS ${PROJECT_NAME}
  59.         ARCHIVE DESTINATION ${CATKIN_PACKAGE_LIB_DESTINATION}
  60.         LIBRARY DESTINATION ${CATKIN_PACKAGE_LIB_DESTINATION}
  61.         RUNTIME DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}
  62. )
  64. ## Mark cpp header files for installation
  65. install(DIRECTORY include/${PROJECT_NAME}/
  66.         DESTINATION ${CATKIN_PACKAGE_INCLUDE_DESTINATION}
  67.         FILES_MATCHING PATTERN "*.hpp"
  68. )
  70. #############
  71. ## Testing ##
  72. #############
  74. ## Add gtest based cpp test target and link libraries
  75. catkin_add_gtest(${PROJECT_NAME}_test test/utest.cpp)
  76. target_link_libraries(${PROJECT_NAME}_test
  77.                       ${PROJECT_NAME}_lib
  78.                       ${catkin_LIBRARIES}
  79. )

  1. <!-- package.xml -->
  2. <?xml version="1.0"?>
  3. <package format="2">
  4.   <name>sample_pkg</name>
  5.   <version>0.0.0</version>
  6.   <description>The sample package</description>
  8.   <!-- One maintainer tag required, multiple allowed, one person per tag -->
  9.   <maintainer email="xxx@yyy.zz">EmptySet</maintainer>
  11.   <!-- One license tag required, multiple allowed, one license per tag -->
  12.   <!-- Commonly used license strings: -->
  13.   <!--   BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3 -->
  14.   <license>MIT</license>
  16.   <!-- Url tags are optional, but multiple are allowed, one per tag -->
  17.   <!-- Optional attribute type can be: website, bugtracker, or repository -->
  18.   <url type="website">https://ittechnicalmemos.blogspot.com</url>
  20.   <!-- Author tags are optional, multiple are allowed, one per tag -->
  21.   <!-- Authors do not have to be maintainers, but could be -->
  22.   <author email="xxx@yyy.zz">EmptySet</author>
  24.   <!-- The *depend tags are used to specify dependencies -->
  25.   <!-- Dependencies can be catkin packages or system dependencies -->
  26.   <buildtool_depend>catkin</buildtool_depend>
  27.   <build_depend>roscpp</build_depend>
  28.   <build_export_depend>roscpp</build_export_depend>
  29.   <exec_depend>roscpp</exec_depend>
  30. </package>

テンプレートの単体テスト実行方法

テンプレートの単体テスト実行方法及び結果を記載する。
  1. $ catkin_make run_tests
  2. ...
  3. - run_tests.py: execute commands
  4.   /home/emptySet/work_space/devel/lib/sample_pkg/sample_pkg_test --gtest_output=xml:/home/emptySet/work_space/build/test_results/sample_pkg/gtest-sample_pkg_test.xml
  5. [==========] Running 4 tests from 3 test cases.
  6. [----------] Global test environment set-up.
  7. [----------] 1 test from Factorial1Test
  8. [ RUN      ] Factorial1Test.func1Test
  9. [       OK ] Factorial1Test.func1Test (0 ms)
  10. [----------] 1 test from Factorial1Test (0 ms total)
  12. [----------] 1 test from Factorial2Test
  13. [ RUN      ] Factorial2Test.func2Test
  14. [       OK ] Factorial2Test.func2Test (0 ms)
  15. [----------] 1 test from Factorial2Test (0 ms total)
  17. [----------] 2 tests from Class3Test
  18. [ RUN      ] Class3Test.func4_5Test1
  19. [       OK ] Class3Test.func4_5Test1 (0 ms)
  20. [ RUN      ] Class3Test.func4_5Test2
  21. [       OK ] Class3Test.func4_5Test2 (0 ms)
  22. [----------] 2 tests from Class3Test (0 ms total)
  24. [----------] Global test environment tear-down
  25. [==========] 4 tests from 3 test cases ran. (0 ms total)
  26. [  PASSED  ] 4 tests.
  27. -- run_tests.py: verify result "/home/emptySet/work_space/build/test_results/sample_pkg/gtest-sample_pkg_test.xml"
  28. ...

テスト結果がNGの場合は、下記のように表示される。
  1. $ catkin_make run_tests
  2. ...
  3. /home/emptySet/work_space/src/sample_pkg/test/utest.cpp:31: Failure
  4. Value of: a
  5.   Actual: 4
  6. Expected: 2
  7. [  FAILED  ] Class3Test.func4_5Test2 (0 ms)
  8. ...
  9. [  FAILED  ] 1 test, listed below:
  10. [  FAILED  ] Class3Test.func4_5Test2
  12.  1 FAILED TEST
  13. ...

備考

  • google testのマクロはここを参照。

まとめ

  • google testでrosパッケージの単体テストを行う方法を調査、記載した

参考文献


変更履歴

  1. 2019/09/12: 新規作成
時刻:
ラベル: ,

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)

MQTTの導入

背景 IoTデバイスの接続環境構築のため、MQTT(mosquitto)の導入を行った。 記事の目的 MQTT(mosquitto)をUbuntuに導入する mosquitto ここではmosquittoについて記載する。 MQTT MQTT(Message Qu...