Lab1 example with Unit testing example and CI Workflows

Author: Bharathgopal

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: Build and Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y make gcc gcov
+      - name: Build
+        run: |
+          cd C/Checksum
+          make all
+      - name: Run unit tests
+        run: |
+          cd Lab1
+          ./Lab1

.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+name: Coverage
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y make gcc gcov
+      - name: Run coverage and capture percentage
+        id: runcov
+        run: |
+          cd Lab1
+          make coverage
+          PCT=$(grep 'Lines executed' coverage_checksum.txt | head -1 | sed -E 's/.*:([0-9.]+)%.*$/\1/')
+          echo "coverage=$PCT" >> $GITHUB_OUTPUT
+      - name: Update README badge
+        if: success()
+        run: |
+          cd Lab1
+          PCT=$(grep 'Lines executed' coverage_checksum.txt | head -1 | sed -E 's/.*:([0-9.]+)%.*$/\1/')
+          cd ../../
+          sed -i 's/badge\/coverage-[0-9]\+\.?[0-9]*%25/badge\/coverage-'"$PCT"'%25/' README.md
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add README.md
+          git commit -m "Update coverage badge to $PCT%" || echo "No changes to commit"
+          git push

.gitignore

@@ -53,3 +53,8 @@ dkms.conf
 
 # debug information files
 *.dwo
+
+# Coverage temporary files
+*.gcda
+*.gcno
+Checksum

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 TechEvents-FOSS
+Copyright (c) 2026 BHARATH G
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Lab1/Makefile

@@ -0,0 +1,30 @@
+PROJECT = Lab1
+
+SRC = checksum.c test_checksum.c
+TEST_SRC = unity.c
+INCLUDE += -I.
+
+CC = gcc
+CFLAGS += -Wall -Wextra -Werror
+COVERAGE_FLAGS += -fprofile-arcs -ftest-coverage
+
+
+.PHONY: all clean
+
+all: test_checksum
+
+test_checksum: $(SRC) $(TEST_SRC)
+	$(CC) $(CFLAGS) $(INCLUDE) -o $(PROJECT) $^
+
+clean:
+	rm -f $(PROJECT) *.gcda *.gcno *.gcov coverage_checksum.txt *.out
+
+run: test_checksum
+	./$(PROJECT)
+
+coverage: $(SRC) $(TEST_SRC)
+	$(CC) $(COVERAGE_FLAGS) $(CFLAGS) $(INCLUDE) -o $(PROJECT) $^
+	./$(PROJECT)
+	if [ -f Lab1-checksum.gcda ]; then mv Lab1-checksum.gcda checksum.gcda; fi
+	if [ -f Lab1-checksum.gcno ]; then mv Lab1-checksum.gcno checksum.gcno; fi
+	gcov -a checksum.c > coverage_checksum.txt

Lab1/checksum.c

@@ -0,0 +1,13 @@
+#include "checksum.h"
+
+uint8_t calculate_checksum(uint8_t *buffer, uint8_t buffer_length) 
+{
+    uint16_t result_checksum = 0;
+    uint8_t loop_index = 0;
+
+    for (loop_index = 0; loop_index < buffer_length; loop_index ++) 
+    {
+        result_checksum += buffer[loop_index ];
+    }
+    return (uint8_t)(result_checksum % 256); 
+}

Lab1/checksum.h

@@ -0,0 +1,22 @@
+/**
+ * @file checksum.h
+ * @brief Header file contains the declarations for checksum module
+ * 
+ */
+
+ #ifndef CHECKSUM_H
+#define CHECKSUM_H
+
+#include <stdint.h>
+
+/**
+ * @brief Function to calculate the checksum of a given buffer of data. 
+ * The checksum is computed by summing all the bytes in the buffer and taking the result modulo 256.
+ * 
+ * @param buffer Buffer of data for which the checksum is to be calculated.
+ * @param length Length of the buffer.
+ * @return uint8_t The calculated checksum result.
+ */
+uint8_t calculate_checksum(uint8_t *buffer, uint8_t length);
+
+#endif

Lab1/test_checksum.c

@@ -0,0 +1,44 @@
+#include "checksum.h"
+#include "unity.h"
+
+void setUp(void) 
+{
+    /* This function is called before each test case. 
+    You can use it to set up any common test data or state. */
+}
+
+void tearDown(void) 
+{
+    /* This function is called after each test case. 
+    You can use it to clean up any resources allocated in setUp or during the test. */
+}
+
+void test_calculate_checksum_with_valid_data(void) {
+    uint8_t data[] = {0x01, 0x02, 0x03, 0x04};
+    uint8_t expected_checksum = 10;  // (0x01 + 0x02 + 0x03 + 0x04) % 256 = 10
+    uint8_t actual_checksum = calculate_checksum(data, sizeof(data));
+    TEST_ASSERT_EQUAL_UINT8(expected_checksum, actual_checksum);
+}
+
+void test_calculate_checksum_with_empty_data(void) {
+    uint8_t data[] = {};
+    uint8_t expected_checksum = 0;
+    uint8_t actual_checksum = calculate_checksum(data, sizeof(data));
+    TEST_ASSERT_EQUAL_UINT8(expected_checksum, actual_checksum);
+}
+
+void test_calculate_checksum_with_max_values(void) {
+    uint8_t data[] = {0xFF, 0xFF, 0xFF, 0xFF};
+    uint8_t expected_checksum = 252;  // (0xFF + 0xFF + 0xFF + 0xFF) % 256 = 252
+    uint8_t actual_checksum = calculate_checksum(data, sizeof(data));
+    TEST_ASSERT_EQUAL_UINT8(expected_checksum, actual_checksum);
+}
+
+int main(void) {
+    UNITY_BEGIN();
+    RUN_TEST(test_calculate_checksum_with_valid_data);
+    RUN_TEST(test_calculate_checksum_with_empty_data);
+    RUN_TEST(test_calculate_checksum_with_max_values);
+    return UNITY_END();
+}
+