add auto test workflow

Author: MaJerle

.github/workflows/build-and-test.yml

@@ -0,0 +1,35 @@
+name: Windows CMake Build & Test
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install MinGW
+        run: |
+          choco install mingw --version=12.2.0 -y
+          echo "C:\ProgramData\chocolatey\lib\mingw\tools\install\mingw64\bin" >> $GITHUB_PATH
+          gcc --version
+
+      - name: Build
+        run: |
+          mkdir __build__
+          cd __build__
+          cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=gcc -S.. -G Ninja
+          cmake --build .
+
+      - name: Run Tests
+        working-directory: __build__
+        run: |
+          ctest . --output-on-failure

CMakeLists.txt

@@ -6,6 +6,7 @@ project(LwLibPROJECT)
 if(NOT PROJECT_IS_TOP_LEVEL)
     add_subdirectory(lwshell)
 else()
+    enable_testing()
     add_executable(${PROJECT_NAME})
     target_sources(${PROJECT_NAME} PRIVATE
         ${CMAKE_CURRENT_LIST_DIR}/dev/main.c
@@ -23,4 +24,7 @@ else()
     # Add compile options to the library, which will propagate options to executable through public link
     target_compile_definitions(lwshell PUBLIC WIN32 _DEBUG CONSOLE LWSHELL_DEV)
     target_compile_options(lwshell PUBLIC -Wall -Wextra -Wpedantic)
+
+    # Add test
+    add_test(NAME Test COMMAND $<TARGET_FILE:${CMAKE_PROJECT_NAME}>)
 endif()

dev/main.c

@@ -18,7 +18,7 @@
 #endif
 
 void example_minimal(void);
-extern void run_test(void);
+extern int run_test(void);
 
 #if LWSHELL_CFG_USE_OUTPUT
 
@@ -28,7 +28,7 @@ extern void run_test(void);
  * \param[in]       lw: LwSHELL instance
  */
 static void
-shell_output(const char* str, lwshell_t* lw) {
+prv_shell_output(const char* str, lwshell_t* lw) {
     (void)lw;
     printf("%s", str);
     if (*str == '\r') {
@@ -133,17 +133,14 @@ static const lwshell_cmd_t static_cmds[] = {
 /* Program entry point */
 int
 main(void) {
-    /* Init library */
-    lwshell_init();
+    return run_test();
 
+#if 0
 #if LWSHELL_CFG_USE_OUTPUT
     /* Add optional output function for the purpose of the feedback */
-    lwshell_set_output_fn(shell_output);
+    lwshell_set_output_fn(prv_shell_output);
 #endif /* LWSHELL_CFG_USE_OUTPUT */
 
-    /* Run the test */
-    run_test();
-
 #if LWSHELL_CFG_USE_DYNAMIC_COMMANDS
     /* Define shell commands */
     lwshell_register_cmd("addint", addint_cmd, "Adds 2 integer numbers and prints them");
@@ -173,4 +170,5 @@ main(void) {
         lwshell_input(str, strlen(str));
     }
     return 0;
+#endif
 }

tests/test.c

@@ -48,6 +48,7 @@ static const test_str_t commands[] = {
     },
 };
 static uint32_t current_cmd_index;
+static int failed = 0;
 
 /**
  * \brief           Test command function
@@ -66,6 +67,7 @@ prv_test_cmd(int32_t argc, char** argv) {
     if (cmd_args_count != argc) {
         printf("Test failed: Expected argument count (%02u) does not match actual argument count (%02u)\r\n",
                (unsigned)cmd_args_count, (unsigned)argc);
+        failed = 1;
         return -1;
     }
 
@@ -75,6 +77,7 @@ prv_test_cmd(int32_t argc, char** argv) {
         if (strcmp(cmd->args_list[idx], argv[idx]) != 0) {
             printf("Test failed: Argument index %02u, value \"%s\" does not match actual argument value \"%s\"\r\n",
                    (unsigned)idx, cmd->args_list[idx], argv[idx]);
+            failed = 1;
             return -1;
         }
     }
@@ -86,15 +89,18 @@ prv_test_cmd(int32_t argc, char** argv) {
  * \brief           Global test run function
  * 
  */
-void
+int
 run_test(void) {
-    lwshell_register_cmd("test", prv_test_cmd, "Test command function\r\n");
+    failed = 0;
 
     printf("Running test...\r\n");
+    lwshell_init();
+    lwshell_register_cmd("test", prv_test_cmd, "Test command function\r\n");
 
     /* Run all commands */
     for (current_cmd_index = 0; current_cmd_index < LWSHELL_ARRAYSIZE(commands); ++current_cmd_index) {
         lwshell_input(commands[current_cmd_index].command, strlen(commands[current_cmd_index].command));
     }
     printf("Tests completed...\r\n");
+    return failed ? -1 : 0;
 }