[wip] adding unit tests

technobly · technobly · commit 33ff8bf82d34 · 2021-11-15T12:22:50.000-06:00
diff --git a/services/inc/ncp_fw_update.h b/services/inc/ncp_fw_update.h
@@ -19,7 +19,6 @@
 
 #include "hal_platform.h"
 #include "system_tick_hal.h"
-#include "core_hal.h"
 #include "system_defs.h"
 #include "system_mode.h"
 #include "system_network.h"
@@ -196,6 +195,7 @@ class SaraNcpFwUpdate {
     void logSaraNcpFwUpdateData(SaraNcpFwUpdateData& data);
 };
 
+#ifndef UNIT_TEST
 class NcpFwUpdateDiagnostics: public AbstractUnsignedIntegerDiagnosticData {
 public:
     NcpFwUpdateDiagnostics() :
@@ -207,6 +207,7 @@ class NcpFwUpdateDiagnostics: public AbstractUnsignedIntegerDiagnosticData {
         return 0; // OK
     }
 };
+#endif // UNIT_TEST
 
 } // namespace services
 
diff --git a/services/src/ncp_fw_update.cpp b/services/src/ncp_fw_update.cpp
@@ -35,7 +35,6 @@ LOG_SOURCE_CATEGORY(SARA_NCP_FW_UPDATE_LOG_CATEGORY);
 
 #include "check.h"
 #include "delay_hal.h"
-#include "platform_headers.h"
 #include "system_network.h"
 
 // Change to 0 for debugging faster
diff --git a/test/unit_tests/README.md b/test/unit_tests/README.md
@@ -21,3 +21,13 @@ Build and run the tests and coverage:
 ```bash
 make all test coverage
 ```
+
+
+MacOSX
+------
+
+Github issue: https://github.com/Homebrew/homebrew-core/issues/67427
+
+You may run into an error `ld: library not found for -licudata` and will need to export the following before running `make`
+
+`export LIBRARY_PATH=${LIBRARY_PATH}:/usr/local/opt/icu4c/lib`
diff --git a/test/unit_tests/services/CMakeLists.txt b/test/unit_tests/services/CMakeLists.txt
@@ -7,6 +7,8 @@ add_executable( ${target_name}
   ${TEST_DIR}/util/random.cpp
   ${DEVICE_OS_DIR}/services/src/simple_file_storage.cpp
   ${DEVICE_OS_DIR}/services/src/str_util.cpp
+  ${DEVICE_OS_DIR}/services/src/ncp_fw_update.cpp
+  ncp_fw_update.cpp
   simple_file_storage.cpp
   str_util.cpp
   varint.cpp
@@ -17,6 +19,7 @@ add_executable( ${target_name}
 target_compile_definitions( ${target_name}
   PRIVATE PLATFORM_ID=3
   PRIVATE HAL_PLATFORM_FILESYSTEM=1
+  PRIVATE HAL_PLATFORM_NCP_FW_UPDATE=1
 )
 
 # Set compiler flags specific to target
diff --git a/test/unit_tests/services/ncp_fw_update.cpp b/test/unit_tests/services/ncp_fw_update.cpp
@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "ncp_fw_update.h"
+// #include "system_error.h"
+
+// #include "mock/filesystem.h"
+// #include "mock/ncp_fw_update.h"
+// #include "util/random.h"
+
+#include <catch2/catch.hpp>
+#include <hippomocks.h>
+
+#include <string>
+// #include <unordered_map>
+
+
+using namespace particle;
+
+TEST_CASE("SaraNcpFwUpdate") {
+    // MockRepository mocks;
+    SECTION("init()") {
+        SECTION("initialize callbacks") {
+            SaraNcpFwUpdateCallbacks saraNcpFwUpdateCallbacks;
+            memset(&saraNcpFwUpdateCallbacks, 0, sizeof(saraNcpFwUpdateCallbacks));
+            // saraNcpFwUpdateCallbacks.size = sizeof(saraNcpFwUpdateCallbacks);
+            // saraNcpFwUpdateCallbacks.system_get_flag = system_get_flag;
+            // saraNcpFwUpdateCallbacks.spark_cloud_flag_connected = spark_cloud_flag_connected;
+            // saraNcpFwUpdateCallbacks.spark_cloud_flag_connect = spark_cloud_flag_connect;
+            // saraNcpFwUpdateCallbacks.spark_cloud_flag_disconnect = spark_cloud_flag_disconnect;
+            // saraNcpFwUpdateCallbacks.publishEvent = publishEvent;
+            // saraNcpFwUpdateCallbacks.system_mode = system_mode;
+            // services::SaraNcpFwUpdate::instance()->init(saraNcpFwUpdateCallbacks);
+            // CHECK(strcmp(n.init(), "path/to/file") == 0);
+        }
+    }
+}
diff --git a/test/unit_tests/stub/module_info.h b/test/unit_tests/stub/module_info.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+typedef struct module_store_t {
+} module_store_t;
+
+typedef struct module_info_t {
+} module_info_t;
+
+typedef struct module_info_crc_t {
+} module_info_crc_t;
+
+typedef struct module_info_suffix_t {
+} module_info_suffix_t;
+
+typedef struct module_function_t {
+} module_function_t;
diff --git a/test/unit_tests/stub/ncp_fw_update_types.h b/test/unit_tests/stub/ncp_fw_update_types.h
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+typedef struct AtResponseReader {
+} AtResponseReader;
diff --git a/test/unit_tests/stub/spark_wiring_diagnostics.h b/test/unit_tests/stub/spark_wiring_diagnostics.h
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
diff --git a/test/unit_tests/stub/system_mode.h b/test/unit_tests/stub/system_mode.h
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+typedef enum
+{
+  DEFAULT=0, AUTOMATIC = 1, SEMI_AUTOMATIC = 2, MANUAL = 3, SAFE_MODE=4
+} System_Mode_TypeDef;
+
+void set_system_mode(System_Mode_TypeDef mode);
+System_Mode_TypeDef system_mode();
diff --git a/test/unit_tests/stub/system_network.h b/test/unit_tests/stub/system_network.h
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2021 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
