Tests and coverage (#128)

* printf() cleanup to support qtest
* machine instance for stm32f030
* Initial GPIO module test
* patch qtest to support non-bool IRQs and intercepting named GPIOs
* Add unit test workflow
* Add coverage badge

Author: vintagepc

.github/workflows/tests.yml

@@ -0,0 +1,93 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Unit Tests
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ MINI404 ]
+  pull_request:
+    branches: [ MINI404 ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build_linux:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    # if: "!contains(github.event.head_commit.message, 'NO_BUILD')"
+  #   # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - name: Checkout ${{ github.event.pull_request.head.ref }}
+      uses: actions/checkout@v3
+      if: ${{ github.event.pull_request }}
+      with:
+        repository: ${{ github.repository }}
+        ref: ${{ github.event.pull_request.head.sha }}
+        submodules: false
+
+    - name: Checkout ${{ github.event.ref }}
+      uses: actions/checkout@v3
+      if: ${{ !github.event.pull_request }}
+      with:
+        repository: ${{ github.repository }}
+        ref: ${{ github.event.ref }}
+        submodules: false
+
+    - name: Cache packages
+      uses: actions/cache@v3.0.11
+      id: cache-pkgs
+      with:
+          path: "packages"
+          key: "${{ runner.os }}-packages-1_0_0"
+          restore-keys: ${{ runner.os }}-packages-
+
+    - name: Setup cache dir
+      if:  ${{ ! steps.cache-valgrind.outputs.cache-hit }}
+      run: mkdir -p packages/partial
+
+    - name: Install packages
+      run: |
+          sudo apt-get update
+          sudo apt-get -o Dir::Cache::Archives=`pwd`/packages install libelf-dev libglew-dev freeglut3-dev ninja-build libusb-1.0.0-dev libgtk-3-dev lcov
+
+    - name: Cache permissions
+      run: sudo chmod -R 744 packages
+
+    - name: Test Symlink
+      run: ln -s ${{ runner.workspace }}/MINI404/hw/arm/prusa ${{ runner.workspace }}/MINI404/tests/qtest/
+
+    - name: Configure build
+      run: cd ${{ runner.workspace }}/MINI404 && ./configure --target-list="buddy-softmmu" --enable-libusb --enable-gtk --enable-gcov
+
+    - name: Build qemu-system-buddy
+      run: cd ${{ runner.workspace }}/MINI404/build && ninja
+    
+      # Right now this will fail some tests due to SIGABRT from the CPU crashing. Ignore it until that's fixed.
+    - name: Run QTest
+      run: cd ${{ runner.workspace }}/MINI404/build && make check-qtest-buddy -j4
+      continue-on-error: true
+
+    - name: Generate Coverage report
+      run: cd ${{ runner.workspace }}/MINI404/build && make coverage-html -j4
+
+    - name: Strip down Coverage report
+      run: cd ${{ runner.workspace }}/MINI404/build/meson-logs && lcov -extract coverage.info '*/arm/prusa/*' --rc lcov_branch_coverage=1 --output-file=c2.info
+
+    - name: Upload to codecov.io
+      uses: codecov/codecov-action@v3
+      with: 
+        # Comma-separated list of files to upload
+        files: ${{ runner.workspace }}/MINI404/build/meson-logs/c2.info
+        # Specify whether or not CI build should fail if Codecov runs into an error during upload
+        fail_ci_if_error: true
+        # Comma-separated list, see the README for options and their usage
+        # functionalities: # optional
+        # Specify whether the Codecov output should be verbose
+        verbose: true
+
+
+
+ 

.vscode/tasks.json

@@ -18,6 +18,21 @@
             },
             "problemMatcher": []
         },
+        {
+            "label": "Configure QEMU (coverage)",
+            "type": "shell",
+            "command": "./configure --target-list=buddy-softmmu --disable-docs --enable-libusb --enable-gcov",
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": true
+            },
+            "problemMatcher": []
+        },
         {
             "label": "Configure QEMU (Debugging)",
             "type": "shell",
@@ -146,6 +161,42 @@
                 "showReuseMessage": true,
                 "clear": true
             }
+        },
+        {
+            "label": "Run Tests",
+            "type": "shell",
+            "command": "make check-qtest-buddy -j10",
+            "group": "build",
+            "problemMatcher": [
+                "$gcc"
+            ],
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": true
+            }
+        },
+        {
+            "label": "Make HTML Report",
+            "type": "shell",
+            "command": "make coverage-html -j10",
+            // lcov -extract coverage.info '*/arm/prusa/*' --rc lcov_branch_coverage=1 --output-file=c2.info
+            // genhtml --output-directory c2 --legend --show-details --branch-coverage c2.info
+            "group": "build",
+            "problemMatcher": [
+                "$gcc"
+            ],
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": true
+            }
         }
     ]
 }

README.md

@@ -10,6 +10,7 @@ Remaining To-Dos of note:
 
 - ![CI Build](https://github.com/vintagepc/MINI404/workflows/CI%20Build/badge.svg)
 - ![Code Lint](https://github.com/vintagepc/MINI404/workflows/Code%20Lint/badge.svg)
+- [![Coverage](https://codecov.io/gh/vintagepc/MINI404/branch/master/graph/badge.svg)](https://codecov.io/gh/vintagepc/MINI404)
 
 # Getting Started (Building):
 

hw/arm/prusa/meson.build

@@ -30,6 +30,11 @@ endif
 pngdep = dependency('libpng', fallback : ['libpng', 'png_dep'])
 arm_ss.add(when: 'CONFIG_BUDDYBOARD', if_true: [pngdep])
 
+# Add test sources only if coverage is enabled.
+if config_host_data.get('CONFIG_GCOV')
+    subdir('stm32_tests')
+endif
+
 subdir('stm32_common')
 subdir('stm32f407')
 subdir('stm32f030')

hw/arm/prusa/parts/encoder_input.c

@@ -164,7 +164,6 @@ OBJECT_DEFINE_TYPE_SIMPLE_WITH_INTERFACES(InputState, encoder_input, ENCODER_INP
 
 static void encoder_input_finalize(Object *obj)
 {
-    printf("Input_finalize\n");
 }
 
 static void encoder_input_reset(DeviceState *dev)

hw/arm/prusa/parts/pinda.c

@@ -49,7 +49,7 @@ struct PindaState {
 };
 
 enum {
-    ACT_SET_MBL, 
+    ACT_SET_MBL,
 
 };
 
@@ -85,7 +85,7 @@ static void pinda_update(PindaState *s) {
 
 }
 
-static void pinda_move(void *opaque, int n, int level) 
+static void pinda_move(void *opaque, int n, int level)
 {
     PindaState *s = PINDA(opaque);
     s->current_pos[n] = level;
@@ -95,8 +95,9 @@ static void pinda_move(void *opaque, int n, int level)
 }
 
 static void pinda_rebuild_mesh(PindaState *s) {
-    printf("MBL Grid: \n");
+    printf("# MBL Grid: \n");
     for (int i=0; i<4; i++) {
+		printf("# ");
         for (int j=0; j<4; j++) {
             s->step_mesh[i][j] = (s->mesh_mm[i][j])*Z_MM_TO_STEPS;
             printf("%f ",s->mesh_mm[i][j]);
@@ -118,7 +119,7 @@ static int pinda_process_action(P404ScriptIF *obj, unsigned int action, script_a
             float fZ = scripthost_get_float(args, 2);
             if (iX<0 || iY <0 || iX>3 || iY>3 || fZ<-0.99) {
                 fprintf(stderr, "Scripting error - MBL argument out of range! (index 0-4, z > -1) \n");
-                return ScriptLS_Error; // Bad input. 
+                return ScriptLS_Error; // Bad input.
             } else {
                 s->mesh_mm[iY][iX] = 1.F + fZ;
                 pinda_rebuild_mesh(s);

hw/arm/prusa/parts/software_spi.c

@@ -123,7 +123,6 @@ static void software_spi_init(Object *obj)
 	qdev_init_gpio_out_named(dev, &s->miso, "miso", 1);
 
     s->ssi = ssi_create_bus(dev, "ssi");
-	printf("Init swspi");
 }
 
 static void software_spi_class_init(ObjectClass *klass, void *data)

hw/arm/prusa/stm32_common/stm32_common.c

@@ -1,7 +1,12 @@
 #include "qemu/osdep.h"
+#include "qemu/log.h"
 #include "qom/object.h"
 #include "sysemu/block-backend.h"
+#include "hw/boards.h"
 #include "hw/qdev-core.h"
+#include "qapi/error.h"
+#include "hw/arm/armv7m.h"
+#include "hw/arm/boot.h"
 #include "hw/qdev-properties.h"
 #include "stm32_common.h"
 #include "stm32_chip_macros.h"
@@ -248,7 +253,7 @@ extern void stm32_soc_realize_peripheral(DeviceState* soc_state, stm32_periph_t
 		}
 		else
 		{
-			printf("Warning: Peripheral %s does not support the STM32 Common interface\n", _PERIPHNAMES[id]);
+			qemu_log_mask(LOG_UNIMP, "Warning: Peripheral %s does not support the STM32 Common interface\n", _PERIPHNAMES[id]);
 		}
 	}
 	if (!sysbus_realize(SYS_BUS_DEVICE(s->perhiperhals[id]), errp)) {
@@ -352,3 +357,20 @@ static void stm32_base_register_types(void)
 }
 
 type_init(stm32_base_register_types);
+
+extern void stm32_soc_machine_init(MachineState *machine)
+{
+	DeviceState *dev;
+	STM32SocMachineClass *smc = STM32_MACHINE_GET_CLASS(OBJECT(machine));
+
+    dev = qdev_new(smc->soc_type);
+	object_property_add_child(OBJECT(machine), "soc", OBJECT(dev));
+    qdev_prop_set_string(dev, "cpu-type", smc->cpu_type);
+    qdev_prop_set_uint32(dev,"sram-size", machine->ram_size);
+	uint64_t flash_size = stm32_soc_get_flash_size(dev);
+	sysbus_realize(SYS_BUS_DEVICE(dev), &error_fatal);
+
+	armv7m_load_kernel(ARM_CPU(first_cpu),
+					machine->kernel_filename,
+					flash_size);
+}

hw/arm/prusa/stm32_common/stm32_common.h

@@ -6,6 +6,7 @@
 #include "qemu/osdep.h"
 #include "qemu/units.h"
 #include "sysemu/blockdev.h"
+#include "hw/boards.h"
 #include "hw/sysbus.h"
 #include "../utility/macros.h"
 #include "stm32_shared.h"
@@ -61,8 +62,20 @@ typedef struct STM32PeripheralClass
 
 // Common class data for variant storage.
 
-// Base class for a SOC with a config blob.
+// Machine class templates:
+typedef struct STM32SocMachineClass {
+    MachineClass        parent;
+
+    const char          *soc_type;
+    const char          *cpu_type;
+} STM32SocMachineClass;
+
+#define STM32_MACHINE_CLASS(klass)                                    \
+    OBJECT_CLASS_CHECK(STM32SocMachineClass, (klass), TYPE_STM32_MACHINE)
+#define STM32_MACHINE_GET_CLASS(obj)                                  \
+    OBJECT_GET_CLASS(STM32SocMachineClass, (obj), TYPE_STM32_MACHINE)
 
+// Base class for a SOC with a config blob.
 typedef struct STM32SOCClass {
 	SysBusDeviceClass parent_class;
     const struct stm32_soc_cfg_t* cfg; // Chip variant configuration store.
@@ -82,9 +95,10 @@ typedef struct STM32SOC {
 	bool has_sys_memory;
 } STM32SOC;
 
-
 OBJECT_DECLARE_TYPE(STM32SOC, STM32SOCClass, STM32_SOC);
 
+extern void stm32_soc_machine_init(MachineState *machine);
+
 extern hwaddr stm32_soc_get_flash_size(DeviceState* soc);
 extern hwaddr stm32_soc_get_sram_size(DeviceState* soc);
 extern hwaddr stm32_soc_get_ccmsram_size(DeviceState* soc);

hw/arm/prusa/stm32_common/stm32_dma.c

@@ -494,7 +494,7 @@ static void stm32_common_dma_realize(DeviceState *dev, Error **errp)
 	COM_STRUCT_NAME(Dma) *s = STM32COM_DMA(dev);
 	if (s->cpu_mr == NULL)
 	{
-		printf("No CPU memory region specified for %s - using global system memory.\n", _PERIPHNAMES[s->parent.periph]);
+		qemu_log_mask(LOG_UNIMP, "No CPU memory region specified for %s - using global system memory.\n", _PERIPHNAMES[s->parent.periph]);
 		s->cpu_mr = get_system_memory();
 	}
 	gchar* name = g_strdup_printf("STM32COM_DMA_%d", s->parent.periph - STM32_P_DMA_BEGIN);