Added Lab1 & Lab2 files and disabled bot commits

Author: Bharathgopal

.github/workflows/build.yml

@@ -21,3 +21,7 @@ jobs:
         run: |
           cd Lab1
           ./Lab1
+      - name: Run unit tests
+        run: |
+          cd Lab2
+          ./Lab2

.github/workflows/disabaled/test-and-coverage.yml

@@ -0,0 +1,70 @@
+# name: Tests & Coverage
+
+# on:
+#   push:
+#     branches:
+#       - main
+
+# permissions:
+#   contents: write
+
+# jobs:
+#   test-and-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 build-essential gcovr
+      
+#       - name: Build and run unit tests
+#         id: runtest
+#         run: |
+#           cd Lab1
+#           make test_checksum
+#           OUTPUT=$(./Lab1 2>&1)
+#           echo "$OUTPUT"
+#           # Parse Unity output: "X Tests Y Failures Z Ignored"
+#           TESTS=$(echo "$OUTPUT" | grep -oP '\d+(?=\s+Tests)' | head -1 || echo "0")
+#           FAILURES=$(echo "$OUTPUT" | grep -oP '\d+(?=\s+Failures)' | head -1 || echo "0")
+#           PASSED=$((TESTS - FAILURES))
+#           echo "tests=$TESTS" >> $GITHUB_OUTPUT
+#           echo "passed=$PASSED" >> $GITHUB_OUTPUT
+#           echo "failed=$FAILURES" >> $GITHUB_OUTPUT
+      
+#       - name: Run coverage analysis
+#         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 badges
+#         if: success()
+#         run: |
+#           TESTS=${{ steps.runtest.outputs.tests }}
+#           PASSED=${{ steps.runtest.outputs.passed }}
+#           FAILED=${{ steps.runtest.outputs.failed }}
+#           PCT=${{ steps.runcov.outputs.coverage }}
+          
+#           # Determine test badge color
+#           if [ "$FAILED" -eq 0 ] && [ "$PASSED" -gt 0 ]; then TEST_COLOR="brightgreen"; else TEST_COLOR="red"; fi
+          
+#           # Determine coverage badge color based on percentage
+#           if (( $(echo "$PCT >= 80" | bc -l) )); then COVERAGE_COLOR="brightgreen"; elif (( $(echo "$PCT >= 60" | bc -l) )); then COVERAGE_COLOR="yellowgreen"; elif (( $(echo "$PCT >= 40" | bc -l) )); then COVERAGE_COLOR="orange"; else COVERAGE_COLOR="red"; fi
+          
+#           # Update both badges in README
+#           sed -i "s|badge/tests-[^-]*-[a-z]*|badge/tests-${PASSED}/${TESTS}-${TEST_COLOR}|" README.md
+#           sed -i "s|badge/coverage-[^-]*-[a-z]*|badge/coverage-${PCT}%25-${COVERAGE_COLOR}|" README.md
+          
+#           # Check if README actually changed
+#           if git diff --quiet README.md; then
+#             echo "Badges unchanged, skipping commit and push"
+#           else
+#             echo "Badges updated, committing changes"
+#             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 test (${PASSED}/${TESTS}) and coverage (${PCT}%) badges"
+#             git push
+#           fi

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

@@ -21,10 +21,3 @@ clean:
 
 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/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

Lab2/Makefile

@@ -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); 
+}

Lab2/checksum.c

@@ -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

Lab2/checksum.h

@@ -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();
+}
+