Added branch protection and limited automated testing

.github/workflows/dev.yml

@@ -0,0 +1,51 @@
+name: Deploy Images to GHCR
+
+on:
+  push:
+    branches: [ "dev" ]
+
+jobs:
+  unit-tests: 
+    runs-on: ubuntu-latest 
+    defaults:
+      run:
+        working-directory: '.'    
+    steps:    
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - name: Install pip and pytest
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r docker/requirements.txt
+    - name: Test with pytest
+      run: |
+        python3 -m pytest --import-mode=append tests/
+
+  build-dev:
+    # if: github.ref == 'refs/heads/dev'
+    needs: unit-tests
+    runs-on: ubuntu-latest 
+    defaults:
+      run:
+        working-directory: '.'
+    steps: 
+      - name: 'Checkout GitHub Action'
+        uses: actions/checkout@main
+
+      - name: 'Login to GitHub Container Registry'
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{github.actor}}
+          password: ${{secrets.GITHUB_TOKEN}}
+
+      - name: "Build, Tag, and push the Docker image"
+        env:
+          IMAGE_NAME: ghcr.io/manimatter/decluttarr
+          IMAGE_TAG: dev
+        run: |
+          docker build -f docker/Dockerfile -t $IMAGE_NAME:$IMAGE_TAG .
+          docker push $IMAGE_NAME:$IMAGE_TAG

.github/workflows/main.yml

@@ -0,0 +1,100 @@
+name: Deploy Images to GHCR
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+jobs:
+  # unit-tests: 
+  #   runs-on: ubuntu-latest 
+  #   defaults:
+  #     run:
+  #       working-directory: '.'    
+  #   steps:    
+  #   - uses: actions/checkout@v4
+
+  #   - name: Set up Python
+  #     uses: actions/setup-python@v4
+  #     with:
+  #       python-version: '3.x'
+  #   - name: Install pip and pytest
+  #     run: |
+  #       python -m pip install --upgrade pip
+  #       pip install -r docker/requirements.txt
+  #   - name: Test with pytest
+  #     run: |
+  #       python3 -m pytest --import-mode=append tests/
+
+  build-main:
+    # if: github.ref == 'refs/heads/main'
+    # needs: unit-tests
+    runs-on: ubuntu-latest 
+    defaults:
+      run:
+        working-directory: '.'
+    steps: 
+      - name: 'Checkout GitHub Action'
+        uses: actions/checkout@main
+
+      - name: 'Login to GitHub Container Registry'
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{github.actor}}
+          password: ${{secrets.GITHUB_TOKEN}}
+
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+
+      - name: Bump version and push tag
+        uses: anothrNick/[email protected]
+        id: setversion
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+
+      - name: "Build, Tag, and push the Docker image"
+        env:
+          IMAGE_NAME: ghcr.io/manimatter/decluttarr
+          IMAGE_TAG: ${{ steps.setversion.outputs.new_tag }}
+        run: |
+          docker build -f docker/Dockerfile -t $IMAGE_NAME:$IMAGE_TAG .
+          docker push $IMAGE_NAME:$IMAGE_TAG
+
+      - name: "Build, Tag, and push the Docker image"
+        env:
+          IMAGE_NAME: ghcr.io/manimatter/decluttarr
+          IMAGE_TAG: latest
+        run: |
+          docker build -f docker/Dockerfile -t $IMAGE_NAME:$IMAGE_TAG .
+          docker push $IMAGE_NAME:$IMAGE_TAG 
+
+  # build-dev:
+  #   if: github.ref == 'refs/heads/dev'
+  #   needs: unit-tests
+  #   runs-on: ubuntu-latest 
+  #   defaults:
+  #     run:
+  #       working-directory: '.'
+  #   steps: 
+  #     - name: 'Checkout GitHub Action'
+  #       uses: actions/checkout@main
+
+  #     - name: 'Login to GitHub Container Registry'
+  #       uses: docker/login-action@v1
+  #       with:
+  #         registry: ghcr.io
+  #         username: ${{github.actor}}
+  #         password: ${{secrets.GITHUB_TOKEN}}
+
+  #     - name: "Build, Tag, and push the Docker image"
+  #       env:
+  #         IMAGE_NAME: ghcr.io/manimatter/decluttarr
+  #         IMAGE_TAG: dev
+  #       run: |
+  #         docker build -f docker/Dockerfile -t $IMAGE_NAME:$IMAGE_TAG .
+  #         docker push $IMAGE_NAME:$IMAGE_TAG

.gitignore

@@ -2,5 +2,4 @@ __pycache__/
 .pytest_cache/
 .vscode/
 config/config.conf
-test*.py
 ToDo 

docker/requirements.txt

@@ -2,4 +2,6 @@ requests
 aiohttp
 asyncio
 python-dateutil
-verboselogs
+verboselogs
+pytest
+pytest-asyncio

tests/test_nest_functions.py

@@ -0,0 +1,53 @@
+import pytest
+from src.utils.nest_functions import nested_set, add_keys_nested_dict, nested_get
+import asyncio
+
+# Dictionary that is modified / queried as part of tests
+input_dict =              { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1992, 'actors': ['Weter', 'Waul', 'Wpacey']}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+
+@pytest.mark.asyncio
+async def test_nested_set():
+    expected_output    =  { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1994, 'actors': ['Weter', 'Waul', 'Wpacey']}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+    output = input_dict
+    await nested_set(output, [2, 'data' ,'year'], 1994)
+    assert expected_output == output
+
+@pytest.mark.asyncio
+async def test_nested_set_conditions():
+    input               = { 1: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}],
+                            2: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}]}
+    expected_output     = { 1: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}],
+                            2: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'LOW'}]}
+    output = input
+    await nested_set(output, [2, 'rating'], 'LOW', {'year': 2003})
+    assert expected_output == output
+
+@pytest.mark.asyncio
+async def test_nested_set_conditions_multiple():
+    input               = { 1: [{'rating': 'high', 'color': 1, 'stack': 1}, {'rating': 'high', 'color': 2, 'stack': 2}, {'rating': 'high', 'color': 2, 'stack': 1}]}
+    expected_output     = { 1: [{'rating': 'high', 'color': 1, 'stack': 1}, {'rating': 'high', 'color': 2, 'stack': 2}, {'rating': 'LOW', 'color': 2, 'stack': 1}]}
+    output = input
+    await nested_set(output, [1, 'rating'], 'LOW', {'color': 2, 'stack': 1})
+    assert expected_output == output
+
+@pytest.mark.asyncio
+async def test_add_keys_nested_dict():
+    expected_output    =  { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1994, 'actors': ['Weter', 'Waul', 'Wpacey'], 'spaceship': True}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+    output = input_dict
+    await add_keys_nested_dict(output, [2, 'data' ,'spaceship'], True)
+    assert expected_output == output
+
+
+@pytest.mark.asyncio
+async def test_nested_get():
+    input               = { 1: [{'name': 'A', 'color': 1, 'stack': 1}, {'name': 'B', 'color': 2, 'stack': 2}, {'name': 'C', 'color': 2, 'stack': 1}]}
+    expected_output     = ['C']
+    output = await nested_get(input[1], 'name', {'color': 2, 'stack': 1})
+    assert expected_output == output
+