adding unit testing

Author: andreagilardoni

.github/workflows/unit-tests.yml

@@ -0,0 +1,57 @@
+name: Unit Tests
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/unit-tests.yml"
+      - 'extras/test/**'
+      - 'src/**'
+
+  push:
+    paths:
+      - ".github/workflows/unit-tests.yml"
+      - 'extras/test/**'
+      - 'src/**'
+
+jobs:
+  test:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+
+    env:
+      COVERAGE_DATA_PATH: extras/coverage-data/coverage.info
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: arduino/cpp-test-action@main
+        with:
+          runtime-paths: |
+            - extras/test/build/bin/testArduinoIoTCloud
+          coverage-exclude-paths: |
+            - '*/extras/test/*'
+            - '/usr/*'
+            - '*/src/cbor/lib/*'
+          coverage-data-path: ${{ env.COVERAGE_DATA_PATH }}
+
+      # A token is used to avoid intermittent spurious job failures caused by rate limiting.
+      - name: Set up Codecov upload token
+        run: |
+          if [[ "${{ github.repository }}" == "arduino-libraries/ArduinoIoTCloud" ]]; then
+            # In order to avoid uploads of data from forks, only use the token for runs in the parent repo.
+            # Token is intentionally exposed.
+            # See: https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954
+            CODECOV_TOKEN="47827969-3fda-4ba1-9506-e8d0834ed88c"
+          else
+            # codecov/codecov-action does unauthenticated upload if empty string is passed via the `token` input.
+            CODECOV_TOKEN=""
+          fi
+          echo "CODECOV_TOKEN=$CODECOV_TOKEN" >> "$GITHUB_ENV"
+
+      - name: Upload coverage report to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: "${{ env.COVERAGE_DATA_PATH }}"
+          fail_ci_if_error: true
+          token: ${{ env.CODECOV_TOKEN }}

extras/test/CMakeLists.txt

@@ -0,0 +1,44 @@
+cmake_minimum_required(VERSION 3.5)
+project(testArduinoCloudUtils)
+
+Include(FetchContent)
+
+FetchContent_Declare(
+  Catch2
+  GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+  GIT_TAG        v3.4.0
+)
+
+FetchContent_MakeAvailable(Catch2)
+
+set(TEST_TARGET ${CMAKE_PROJECT_NAME})
+
+##########################################################################
+
+set(CMAKE_CXX_STANDARD 11)
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+include_directories(../../src)
+include_directories(../../src/lzss)
+
+set(TEST_SRCS
+  src/lzss/test_lzssDecoder.cpp
+)
+
+set(TEST_DUT_SRCS
+  ../../src/lzss/lzssDecoder.cpp
+)
+
+##########################################################################
+
+add_compile_definitions(HOST)
+add_compile_options(-Wall -Wextra -Wpedantic -Werror)
+add_compile_options(-Wno-cast-function-type)
+
+set(CMAKE_C_FLAGS   ${CMAKE_C_FLAGS}   "--coverage")
+set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} "--coverage -Wno-deprecated-copy")
+
+add_executable( ${TEST_TARGET} ${TEST_SRCS} ${TEST_DUT_SRCS} )
+
+target_link_libraries( ${TEST_TARGET} Catch2WithMain )

extras/test/README.md

@@ -0,0 +1,5 @@
+# adding tests
+
+follow guide in https://github.com/catchorg/Catch2/tree/devel/docs in order to add more tests
+
+Add the source file for the test in `extras/test/CMakeLists.txt` inside of `${TEST_SRCS}` variable and eventually the source file you want to test in `${TEST_DUT_SRCS}`

extras/test/src/lzss/test_lzssDecoder.cpp

@@ -0,0 +1,49 @@
+#include <catch2/catch_test_macros.hpp>
+
+#include <lzssDecoder.h>
+#include <stdio.h>
+
+using namespace arduino::lzss;
+
+SCENARIO( "Decoding an LZSS stream of data", "[lzss::Decoder]" ) {
+    GIVEN( "A LZSS compressed file and an LZSS Decoder" ) {
+        // the lzss file provided as test when decompressed are made by incrementing a 4 byte integer
+        // starting from 0, up to (file size-1)/4, thus it is easy to validate the correctness of the result
+
+        FILE *f = fopen("test_files/test-64k.lzss", "r");
+        uint32_t value = 0;
+        uint64_t position = 0;
+
+        auto decoder = arduino::lzss::Decoder([&value, &position](const uint8_t b) {
+            REQUIRE(((value >> ((3-(position%4))<<3)) & 0xFF) == b); // make this an assertion, not a require
+
+            if(position % 4 == 0 && position != 0) {
+                value++;
+            }
+            position++;
+        });
+
+        THEN( "File is open" ) {
+            REQUIRE( f != nullptr );
+        }
+
+        WHEN( "Decompress is called on the decoder" ) {
+            uint8_t buf[64];
+            size_t read_bytes;
+            do {
+                read_bytes = fread(buf, 1, 64, f);
+
+                if(read_bytes > 0) {
+                    decoder.decompress(buf, read_bytes);
+                }
+            } while(read_bytes > 0);
+
+            REQUIRE(value == (1<<14) -1);
+        }
+        THEN( "There is no error on the file" ) {
+            REQUIRE(feof(f) == 0);
+            REQUIRE(ferror(f) == 0);
+            REQUIRE(fclose(f) == 0);
+        }
+    }
+}