Merge branch 'feature/21' into develop

Author: suikan4github

CHANGELOG.md

@@ -12,6 +12,7 @@ The issue #12 removed public class I2cMasterInterface. But it is referred intern
 - [Issue #10](https://github.com/suikan4github/rpp_driver/issues/10) Cover APIs of the Raspberry Pi Pico SDK.
 - [Issue #15](https://github.com/suikan4github/rpp_driver/issues/15) Remove the redundant parameter check code from ConfigureSRC() 
 - [Issue #16](https://github.com/suikan4github/rpp_driver/issues/16) Change the member function name from ConfigureSRC() to ConfigureSrc().
+- [Issue #21](https://github.com/suikan4github/rpp_driver/issues/21) Add usege of the mock for each class description.
 - [Issue #22](https://github.com/suikan4github/rpp_driver/issues/22) Refactor the test_i2cmaster.cpp to use the fixture.
 ### Deprecated
 - [Issue #12](https://github.com/suikan4github/rpp_driver/issues/12)  Is I2cMasterInterface needed?  

src/codec/adau1361.hpp

@@ -40,6 +40,44 @@ namespace rpp_driver {
       kMClock,       // Master clock of UMB-ADAU1361-A[Hz].
       codec_lower);  // Inject Codec lower part dependency.
  * ```
+ * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class ::rpp_driver::MockAdau1361
+ * inside adau1361.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "codec/adau1361.hpp"
+#include "codec/umbadau1361lower.hpp"
+#include "i2c/i2cmaster.hpp"
+
+
+class UserCodeTest : public ::testing::Test {
+ protected:
+  virtual void SetUp() {
+    mock_i2c_ = new ::rpp_driver::MockI2cMaster(mock_sdk_);
+    mock_codec_lower_ = new ::rpp_driver::MockAdau1361Lower(*mock_i2c_);
+    mock_codec_ = new ::rpp_driver::MockAdau1361(*mock_codec_lower_);
+  }
+
+  virtual void TearDown() {
+    delete mock_codec_;
+    delete mock_codec_lower_;
+    delete mock_i2c_;
+  }
+
+  ::rpp_driver::SdkWrapper mock_sdk_;
+  ::rpp_driver::MockI2cMaster *mock_i2c_;
+  ::rpp_driver::MockAdau1361Lower *mock_codec_lower_;
+  ::rpp_driver::MockAdau1361 *mock_codec_;
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class Adau1361 {
  public:

src/gpio/gpiobasic.hpp

@@ -29,6 +29,41 @@ namespace rpp_driver {
  * this class, pass a GPIO pin# through the constructor.
  * So, this class initialize and deinitialize that pin in the constructor and
  * destructor, respectively.
+ *
+ * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class ::rpp_driver::MockGpioBasic.
+ * inside gpiobasic.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "gpio/gpiobasic.hpp"
+#include "sdk/sdkwrapper.hpp"
+
+
+using ::testing::_;
+class UserCodeTest : public ::testing::Test {
+ protected:
+  ::rpp_driver::MockSdkWrapper mock_sdk_;
+  ::rpp_driver::MockGpioBasic* mock_gpio_;
+
+  virtual void SetUp() {
+    EXPECT_CALL(mock_sdk_, gpio_init(_)).Times(1);
+    mock_gpio_ = new ::rpp_driver::MockGpioBasic(mock_sdk_);
+  }
+
+  virtual void TearDown() {
+    EXPECT_CALL(mock_sdk_, gpio_deinit(_)).Times(1);
+    delete (mock_gpio_);
+  }
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class GpioBasic {
  public:

src/i2c/i2cmaster.hpp

@@ -41,6 +41,43 @@ namespace rpp_driver {
  * The ReadBlocking() and WriteBlocking() functions has nostop parameter. To use
  * the restart condition, set this parameter to true.
  *
+ * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class ::rpp_driver::MockI2cMaster.
+ * inside i2cmaster.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "i2c/i2cmaster.hpp"
+
+using ::testing::_;
+class UserCodeTest : public ::testing::Test {
+ protected:
+  ::rpp_driver::MockSdkWrapper mock_sdk_;
+  ::rpp_driver::MockI2cMaster* mock_i2c_;
+
+  virtual void SetUp() {
+    // Constructor will call these functiions.
+    EXPECT_CALL(mock_sdk_, i2c_init(_, _));
+    EXPECT_CALL(mock_sdk_, gpio_set_function(_, GPIO_FUNC_I2C)).Times(2);
+    EXPECT_CALL(mock_sdk_, gpio_pull_up(_)).Times(2);
+
+    mock_i2c_ = new ::rpp_driver::MockI2cMaster(mock_sdk_);
+  }
+
+  virtual void TearDown() {
+    // We can ignore these call inside destructor
+    EXPECT_CALL(mock_sdk_, i2c_deinit(_));
+    delete mock_i2c_;
+  }
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class I2cMaster {
  public:

src/i2s/i2sslaveduplex.hpp

@@ -59,6 +59,35 @@ namespace rpp_driver {
  * output to PutFifoBLock(). To provide the high quality processing,
  * The first GetFifoBlocking() call should be as soon as possible, after
  * calling start() function.
+ *
+  * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class
+ * ::rpp_driver::MockI2sSlaveDuplex inside i2sslaveduplex.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "i2s/i2sslaveduplex.hpp"
+#include "sdk/sdkwrapper.hpp"
+
+class UserCodeTest : public ::testing::Test {
+ protected:
+  ::rpp_driver::MockSdkWrapper mock_sdk_;
+  ::rpp_driver::MockI2sSlaveDuplex* mock_i2sslaveduplex_;
+
+  virtual void SetUp() {
+    mock_i2sslaveduplex_ = new ::rpp_driver::MockI2sSlaveDuplex(mock_sdk_);
+  }
+
+  virtual void TearDown() { delete (mock_i2sslaveduplex_); }
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class I2sSlaveDuplex {
  private:

src/sdk/scripts/blocks/sdkwrapper_preumble.hpp

@@ -50,6 +50,26 @@ namespace rpp_driver {
  * the unit test.
  *
  * The mock of this class is declared in the same file with this class.
+  * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class
+ * ::rpp_driver::MockSdkWrapper inside sdkwrapper.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "sdk/sdkwrapper.hpp"
+
+class UserCodeTest : public ::testing::Test {
+ protected:
+  ::rpp_driver::MockSdkWrapper mock_sdk_;
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class SdkWrapper {
  public:

src/sdk/sdkwrapper.hpp

@@ -50,6 +50,26 @@ namespace rpp_driver {
  * the unit test.
  *
  * The mock of this class is declared in the same file with this class.
+  * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class
+ * ::rpp_driver::MockSdkWrapper inside sdkwrapper.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "sdk/sdkwrapper.hpp"
+
+class UserCodeTest : public ::testing::Test {
+ protected:
+  ::rpp_driver::MockSdkWrapper mock_sdk_;
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class SdkWrapper {
  public: