Merge pull request #129 from arduino-libraries/integrate-ArduinoCloudThing

Integrate ArduinoCloudThing with ArduinoIoTCloud

Author: aentinger

Diff for: .github/workflows/compile-examples.yml

@@ -18,7 +18,7 @@ jobs:
 
     env:
       # libraries to install for all boards
-      UNIVERSAL_LIBRARIES: '"ArduinoCloudThing" "Arduino_ConnectionHandler" "Arduino_DebugUtils" "ArduinoMqttClient"'
+      UNIVERSAL_LIBRARIES: '"Arduino_ConnectionHandler" "Arduino_DebugUtils" "ArduinoMqttClient"'
       # sketch paths to compile (recursive) for all boards
       UNIVERSAL_SKETCH_PATHS: '"examples/ArduinoIoTCloud-Advanced" "examples/ArduinoIoTCloud-Basic" "examples/utility/ArduinoIoTCloud_Travis_CI"'
 

Diff for: .github/workflows/unit-tests.yml

@@ -38,7 +38,7 @@ jobs:
           cd "$BUILD_PATH"
           sudo apt-get --assume-yes install lcov > /dev/null
           lcov --directory . --capture --output-file coverage.info
-          lcov --quiet --remove coverage.info '*/extras/test/*' '/usr/*' --output-file coverage.info
+          lcov --quiet --remove coverage.info '*/extras/test/*' '/usr/*' '*/src/cbor/lib/*' --output-file coverage.info
           lcov --list coverage.info
 
       - name: Upload coverage report to Codecov

Diff for: extras/test/CMakeLists.txt

@@ -9,6 +9,7 @@ project(testArduinoIoTCloud)
 ##########################################################################
 
 include_directories(include)
+include_directories(../../src/cbor)
 include_directories(../../src/utility/ota)
 include_directories(external/catch/v2.12.1/include)
 include_directories(external/fakeit/v2.0.5/include)
@@ -21,14 +22,57 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 ##########################################################################
 
-set(TEST_TARGET testArduinoIoTCloud)
+set(TEST_TARGET ${CMAKE_PROJECT_NAME})
+
+##########################################################################
 
 set(TEST_SRCS
-  src/test_main.cpp
   src/test_OTALogic.cpp
-  src/OTATestData.cpp
+
+  src/test_addPropertyReal.cpp
+  src/test_callback.cpp
+  src/test_CloudColor.cpp
+  src/test_CloudLocation.cpp
+  src/test_decode.cpp
+  src/test_encode.cpp
+  src/test_publishEvery.cpp
+  src/test_publishOnChange.cpp
+  src/test_publishOnChangeRateLimit.cpp
+  src/test_readOnly.cpp
+  src/test_writeOnly.cpp
+)
+
+set(TEST_UTIL_SRCS
+  src/util/CBORTestUtil.cpp
+  src/util/OTATestUtil.cpp
+)
+
+set(TEST_DUT_SRCS
   ../../src/utility/ota/crc.cpp
   ../../src/utility/ota/OTALogic.cpp
+
+  ../../src/cbor/ArduinoCloudThing.cpp
+  ../../src/cbor/ArduinoCloudProperty.cpp
+  ../../src/cbor/lib/tinycbor/src/cborencoder.c
+  ../../src/cbor/lib/tinycbor/src/cborencoder_close_container_checked.c
+  ../../src/cbor/lib/tinycbor/src/cborerrorstrings.c
+  ../../src/cbor/lib/tinycbor/src/cborparser.c
+  ../../src/cbor/lib/tinycbor/src/cborparser_dup_string.c
+  ../../src/cbor/lib/tinycbor/src/cborpretty.c
+  ../../src/cbor/lib/tinycbor/src/cborpretty_stdio.c
+  ../../src/cbor/lib/tinycbor/src/cbortojson.c
+  ../../src/cbor/lib/tinycbor/src/cborvalidation.c
+  ../../src/cbor/lib/tinycbor/src/open_memstream.c
+)
+
+##########################################################################
+
+set(TEST_TARGET_SRCS
+  src/Arduino.cpp
+  src/test_main.cpp
+  ${TEST_SRCS}
+  ${TEST_UTIL_SRCS}
+  ${TEST_DUT_SRCS}
 )
 
 ##########################################################################
@@ -43,7 +87,7 @@ set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} "--coverage")
 
 add_executable(
   ${TEST_TARGET}
-  ${TEST_SRCS}
+  ${TEST_TARGET_SRCS}
 )
 
 ##########################################################################

Diff for: extras/test/include/Arduino.h

@@ -0,0 +1,27 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+#ifndef TEST_ARDUINO_H_
+#define TEST_ARDUINO_H_
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include <string>
+
+/******************************************************************************
+   TYPEDEF
+ ******************************************************************************/
+
+typedef std::string String;
+
+/******************************************************************************
+   FUNCTION PROTOTYPES
+ ******************************************************************************/
+
+void          set_millis(unsigned long const millis);
+unsigned long millis();
+
+#endif /* TEST_ARDUINO_H_ */

Diff for: extras/test/include/util/CBORTestUtil.h

@@ -0,0 +1,36 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+#ifndef INCLUDE_CBOR_TESTUTIL_H_
+#define INCLUDE_CBOR_TESTUTIL_H_
+
+/**************************************************************************************
+   INCLUDE
+ **************************************************************************************/
+
+#include <ArduinoCloudThing.h>
+
+#include <vector>
+
+/**************************************************************************************
+   NAMESPACE
+ **************************************************************************************/
+
+namespace cbor
+{
+
+/**************************************************************************************
+   PROTOTYPES
+ **************************************************************************************/
+
+std::vector<uint8_t> encode(ArduinoCloudThing & thing, bool lightPayload = false);
+void print(std::vector<uint8_t> const & vect);
+
+/**************************************************************************************
+   NAMESPACE
+ **************************************************************************************/
+
+} /* cbor */
+
+#endif /* INCLUDE_CBOR_TESTUTIL_H_ */

Diff for: extras/test/include/OTATestData.h renamed to extras/test/include/util/OTATestUtil.h

@@ -2,15 +2,22 @@
  * Copyright (c) 2020 Arduino.  All rights reserved.
  */
 
-#ifndef OTA_TEST_DATA_H_
-#define OTA_TEST_DATA_H_
+#ifndef OTA_TEST_DATA_GENERATOR_H_
+#define OTA_TEST_DATA_GENERATOR_H_
 
 /**************************************************************************************
    INCLUDE
  **************************************************************************************/
 
 #include <stdint.h>
 
+/**************************************************************************************
+   NAMESPACE
+ **************************************************************************************/
+
+namespace ota
+{
+
 /**************************************************************************************
    TYPEDEF
  **************************************************************************************/
@@ -33,5 +40,10 @@ union OTAData
 void generate_valid_ota_data(OTAData & ota_data);
 void generate_invalid_ota_data_crc_wrong(OTAData & ota_data);
 
+/**************************************************************************************
+   NAMESPACE
+ **************************************************************************************/
+
+} /* ota */
 
-#endif /* OTA_TEST_DATA_H_ */
+#endif /* OTA_TEST_DATA_GENERATOR_H_ */

Diff for: extras/test/src/Arduino.cpp

@@ -0,0 +1,27 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include <Arduino.h>
+
+/******************************************************************************
+   GLOBAL VARIABLES
+ ******************************************************************************/
+
+static unsigned long current_millis = 0;
+
+/******************************************************************************
+   PUBLIC FUNCTIONS
+ ******************************************************************************/
+
+void set_millis(unsigned long const millis) {
+  current_millis = millis;
+}
+
+unsigned long millis() {
+  return current_millis;
+}

Diff for: extras/test/src/test_CloudColor.cpp

@@ -0,0 +1,123 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+/**************************************************************************************
+   INCLUDE
+ **************************************************************************************/
+
+#include <catch.hpp>
+
+#include <util/CBORTestUtil.h>
+#include <ArduinoCloudThing.h>
+
+/**************************************************************************************
+  TEST CODE
+ **************************************************************************************/
+
+/************************************************************************************/
+SCENARIO("Arduino Cloud Properties ", "[ArduinoCloudThing::CloudColor]") {
+  WHEN("Set invalid color HSB") {
+    GIVEN("CloudProtocol::V2") {
+
+
+      CloudColor color_test = CloudColor(0.0, 0.0, 0.0);
+
+      Color value_color_test = color_test.getValue();
+      REQUIRE(value_color_test.setColorHSB(500.0, 20.0, 30.0) == false);
+
+    }
+  }
+
+  WHEN("Set and Get different RGB colors") {
+    GIVEN("CloudProtocol::V2") {
+
+      uint8_t r, g, b;
+
+      CloudColor color_test = CloudColor(0.0, 0.0, 0.0);
+
+      Color value_color_test = color_test.getValue();
+
+      value_color_test.setColorRGB(128, 64, 64);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 128);
+      REQUIRE(g == 64);
+      REQUIRE(b == 64);
+
+      value_color_test.setColorRGB(126, 128, 64);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 126);
+      REQUIRE(g == 128);
+      REQUIRE(b == 64);
+
+      value_color_test.setColorRGB(64, 128, 64);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 64);
+      REQUIRE(g == 128);
+      REQUIRE(b == 64);
+
+      value_color_test.setColorRGB(64, 64, 128);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 64);
+      REQUIRE(g == 64);
+      REQUIRE(b == 128);
+
+      value_color_test.setColorRGB(255, 0, 255);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 255);
+      REQUIRE(g == 0);
+      REQUIRE(b == 255);
+
+      value_color_test.setColorRGB(0, 0, 0);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 0);
+      REQUIRE(g == 0);
+      REQUIRE(b == 0);
+
+      value_color_test.setColorRGB(50, 100, 20);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 50);
+      REQUIRE(g == 100);
+      REQUIRE(b == 20);
+
+      value_color_test.setColorRGB(20, 50, 70);
+      value_color_test.getRGB(r, g, b);
+
+      REQUIRE(r == 20);
+      REQUIRE(g == 50);
+      REQUIRE(b == 70);
+
+    }
+  }
+
+  WHEN("Set HSB colors and get RGB") {
+    GIVEN("CloudProtocol::V2") {
+      bool verify;
+      uint8_t r, g, b;
+
+      CloudColor color_test = CloudColor(0.0, 0.0, 0.0);
+
+      Color value_color_test = color_test.getValue();
+
+      value_color_test.setColorHSB(240, 50, 50);
+      value_color_test.getRGB(r, g, b);
+      verify = r == 64 && g == 64 && b == 128;
+
+      REQUIRE(verify);
+
+      value_color_test.setColorHSB(120, 50, 50);
+      value_color_test.getRGB(r, g, b);
+      verify = r == 64 && g == 128 && b == 64;
+
+      REQUIRE(verify);
+
+    }
+  }
+}