Testing Workflow 🐍🧪

Author: c1m50c

.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+# This workflow installs the required dependencies, and runs tests with pytest over multiple versions of Python.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Python Versions to Test
+        # 3.9 for built-in `list` static typing, TODO maybe redo the code to support older versions?
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set Up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    # Install required dependencies with `requirements.txt`
+    - 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
+    
+    # Test with PyTest -Verbose
+    - name: Test w/PyTest
+      run: |
+        pytest -v

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+minversion = 6.0
+addopts = -ra -q
+testpaths =
+    src

src/test_algorithms.py

@@ -0,0 +1,65 @@
+# Functions that test the algorithm implementations, for `pytest` #
+
+from algorithms.selection_sort import selection_sort
+from algorithms.insertion_sort import insertion_sort
+from algorithms.bubble_sort import bubble_sort
+from algorithms.quick_sort import quick_sort
+from algorithms.merge_sort import merge_sort
+from algorithms.gnome_sort import gnome_sort
+from algorithms.shell_sort import shell_sort
+from algorithms.comb_sort import comb_sort
+from algorithms.heap_sort import heap_sort
+
+
+def test_selection_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    selection_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_insertion_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    insertion_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_bubble_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    bubble_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_quick_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    quick_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_merge_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    merge_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_gnome_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    gnome_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_shell_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    shell_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_comb_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    comb_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]
+
+
+def test_heap_sort():
+    arr: list[int] = [ 5, 3, 2, 1, 5 ]
+    heap_sort(arr)
+    assert arr == [ 1, 2, 3, 5, 5 ]