Merge pull request #5 from PKD667/ci-automation

Add CI automation for tests and benchmarks

Author: PKD667

.github/workflows/run_benchmarks.yml

@@ -0,0 +1,23 @@
+name: Benchmark Suite
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  run-benchmarks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y make gcc
+      - name: Run benchmark suite
+        run: make benchmark

.github/workflows/run_tests.yml

@@ -0,0 +1,34 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest
+    - name: Run CUtils Tests
+      run: make test

README.md

@@ -36,7 +36,22 @@ The benchmark results are displayed in nanoseconds (ns) and provide an insight i
 
 The repository is configured with GitHub Actions to automatically run the benchmarking suite and update the `README.md` with the latest results upon every push. This ensures that the performance data is always up-to-date.
 
+## Automated Testing and Benchmarking with GitHub Actions
+
+CUtils now leverages GitHub Actions to automatically run the test suite and benchmarking suite upon every push to the repository and on pull requests. This ensures that the code quality and performance are consistently monitored and maintained.
+
+### Test Suite Automation
+
+The test suite is executed automatically using the `make test` command through the GitHub Actions workflow defined in `.github/workflows/run_tests.yml`. This workflow triggers on every push and pull request to the repository.
+
+![Test Workflow Status](https://github.com/PKD667/cutils/actions/workflows/run_tests.yml/badge.svg)
+
+### Benchmark Suite Automation
+
+Similarly, the benchmarking suite is run using the `make benchmark` command via the GitHub Actions workflow found in `.github/workflows/run_benchmarks.yml`. This workflow is triggered on every push to the repository.
+
+![Benchmark Workflow Status](https://github.com/PKD667/cutils/actions/workflows/run_benchmarks.yml/badge.svg)
+
 ## Contributing
 
 Contributions to CUtils are welcome. Please submit a pull request or open an issue to discuss proposed changes or additions.
-