Merge remote-tracking branch 'origin/main' into 30-system-implement-r…

…ide-task
UCSD-E4E · Nov 1, 2024 · 0c9cc2d · 0c9cc2d
2 parents c29055f + 02d3b80
commit 0c9cc2d
Show file tree

Hide file tree

Showing 9 changed files with 294 additions and 67 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,8 +1,36 @@
-name: Compile Firmware
+name: Compile Firmware and Tests
 
 on: [push]
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Set up environment
+      run: |
+        sudo apt-get update && sudo apt-get install -y cmake build-essential        
+
+    - name: Build and run tests
+      run: |
+        cmake -B build -DCMAKE_BUILD_TYPE=Debug
+        cd build
+        make
+        cd ..
+        ./build/googletests | tee googletest.log
+
+    - name: Upload test log
+      uses: actions/upload-artifact@v4
+      with:
+        name: test_artifact
+        path: |
+          build/googletests
+          googletest.log
+
   compile:
     runs-on: ubuntu-latest
     steps:
@@ -35,7 +63,7 @@ jobs:
                 docs/html
                 doxygen.log
   release:
-    needs: [compile]
+    needs: [compile, test]
     runs-on: ubuntu-latest
     permissions:
       id-token: write
@@ -50,6 +78,7 @@ jobs:
         fetch-depth: 0
         submodules: recursive
         ref: main
+        token: ${{ secrets.RELEASER }}
 
     - name: Set up Python
       uses: actions/setup-python@v5
@@ -73,6 +102,6 @@ jobs:
     - name: Run Semantic Release
       id: release
       env:
-        GH_TOKEN : ${{ secrets.GITHUB_TOKEN }}
+        GH_TOKEN : ${{ secrets.RELEASER }}
       run: |
         npx semantic-release@23
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+## [3.2.3](https://github.com/UCSD-E4E/smartfin-fw3/compare/v3.2.2...v3.2.3) (2024-11-01)
+
+
+### Bug Fixes
+
+* Updates components ([57f59da](https://github.com/UCSD-E4E/smartfin-fw3/commit/57f59da218af8e4a61e9b8c8711fad65c7e0aa09))
+
+## [3.2.2](https://github.com/UCSD-E4E/smartfin-fw3/compare/v3.2.1...v3.2.2) (2024-10-30)
+
+
+### Bug Fixes
+
+* add brief & details to chargetask documentation ([42ed2e6](https://github.com/UCSD-E4E/smartfin-fw3/commit/42ed2e678e276cd26609116464ea40163d388323))
+* add brief & details to ChargeTask documentation ([#105](https://github.com/UCSD-E4E/smartfin-fw3/issues/105)) ([0c004d8](https://github.com/UCSD-E4E/smartfin-fw3/commit/0c004d8c552b7aadc827b1e97362f7a6ce7d9de0))
+
 ## [3.2.1](https://github.com/UCSD-E4E/smartfin-fw3/compare/v3.2.0...v3.2.1) (2024-06-23)
 
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,10 +6,11 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 add_compile_definitions(TEST_VERSION)
 
-add_subdirectory(external/googletest )
+add_subdirectory(external/googletest)
 include_directories(external/googletest/googletest/include src/ tests)
 
 set(GTEST_SOURCE_FILES
+    tests/test_endianness.cpp
     tests/scheduler_test_system.cpp
     tests/test_ensembles.cpp
     tests/fixed_google_tests.cpp
@@ -19,6 +20,7 @@ set(GTEST_SOURCE_FILES
     tests/test_file_system.cpp
     src/states.cpp
 )
+
 set(EXAMINE_BEHAVIOR_SOURCE_FILES
     tests/scheduler_test_system.cpp
     tests/test_ensembles.cpp

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+jupyter
+numpy
+matplotlib
+schema
diff --git a/docs/sampling_algorithm.ipynb b/docs/sampling_algorithm.ipynb
diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp
@@ -13,6 +13,10 @@
 #define CHARGE_RGB_LED_PERIOD   0
 #define CHARGE_RGB_LED_PRIORITY LED_PRIORITY_IMPORTANT
 
+/**
+ * @brief Handles charging process
+ * @details Contains methods for starting charging task (setting LEDs, etc), detecting if charger is connected, and ending charging task
+ */
 class ChargeTask : public Task{
     public:
     /**

diff --git a/src/vers.hpp b/src/vers.hpp
@@ -12,7 +12,7 @@
 
 #define FW_MAJOR_VERSION    3
 #define FW_MINOR_VERSION    2
-#define FW_BUILD_NUM        1
+#define FW_BUILD_NUM        3
 #define FW_BRANCH           ""
 
 #if PRODUCT_VERSION_USE_HEX == 1

diff --git a/tests/README.md b/tests/README.md
@@ -1,3 +1,7 @@
+# Test Suites
+
+See https://google.github.io/googletest/
+
 # Overview
 The folder `tests` contains tests monatomic tests for the scheduler in the
  `src` directory. There is a bash script to manage the tests at 

diff --git a/tests/test_endianness.cpp b/tests/test_endianness.cpp
@@ -0,0 +1,31 @@
+/**
+ * @file Endianness utility functions unit tests
+ * @author Nathan Hui ([email protected])
+ * @brief
+ * @version 0.1
+ * @date 2024-10-31
+ *
+ * @copyright Copyright (c) 2024
+ *
+ */
+#include "util.hpp"
+
+#include <gtest/gtest.h>
+
+TEST(EndiannessTests, EndiannessConsistency)
+{
+    uint16_t test_value2 = 0xf00d;
+    ASSERT_EQ(test_value2, N_TO_B_ENDIAN_2(B_TO_N_ENDIAN_2(test_value2)));
+
+    uint32_t test_value4 = 0xbaadf00d;
+    ASSERT_EQ(test_value4, N_TO_B_ENDIAN_4(B_TO_N_ENDIAN_4(test_value4)));
+}
+
+TEST(EndiannessTests, OneWayTest)
+{
+    uint16_t test_value2 = 0xf00d;
+    ASSERT_EQ(0x0df0, N_TO_B_ENDIAN_2(test_value2));
+
+    uint32_t test_value4 = 0xbaadf00d;
+    ASSERT_EQ(0x0df0adba, N_TO_B_ENDIAN_4(test_value4));
+}