Merge branch 'add-test-framework' of https://github.com/Pyhass/Pyhiveapi

 into dev

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+source = src
+omit =
+    */__init__.py
+    */debugger.py

.github/workflows/ci.yml

@@ -35,19 +35,19 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
           restore-keys: |
-            ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{ steps.python.outputs.python-version }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements_test.txt') }}-
-            ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{ steps.python.outputs.python-version }}-${{ hashFiles('requirements.txt') }}
+            ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{ steps.python.outputs.python-version }}-${{ hashFiles('requirements_all.txt') }}-${{ hashFiles('requirements_test_all.txt') }}-
+            ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{ steps.python.outputs.python-version }}-${{ hashFiles('requirements_all.txt') }}
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{ steps.python.outputs.python-version }}-
       - name: Create Python virtual environment
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
           python -m venv venv
           . venv/bin/activate
           pip install -U "pip<20.3" setuptools
-          pip install -r requirements.txt -r requirements_test.txt
+          pip install -r requirements_all.txt -r requirements_test_all.txt
       - name: Restore pre-commit environment from cache
         id: cache-precommit
         uses: actions/[email protected]
@@ -83,8 +83,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -127,8 +127,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -171,8 +171,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -218,8 +218,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -265,8 +265,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -312,8 +312,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -356,8 +356,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -403,8 +403,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
@@ -447,8 +447,8 @@ jobs:
           key: >-
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-venv-${{
             steps.python.outputs.python-version }}-${{
-            hashFiles('requirements.txt') }}-${{
-            hashFiles('requirements_test.txt') }}
+            hashFiles('requirements_all.txt') }}-${{
+            hashFiles('requirements_test_all.txt') }}
       - name: Fail job if Python cache restore failed
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |

.github/workflows/python-package.yml

@@ -23,7 +23,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install flake8
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          if [ -f requirements_all.txt ]; then pip install -r requirements_all.txt; fi
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors.

.gitignore

@@ -10,11 +10,11 @@ __pycache__/
 build
 dist
 pyhiveapi.egg-info
+*.coverage
 
 # due to using tox and pytest
 .tox
 .cache
-test*
 custom_tests/*
 
 # virtual environment folder

.vscode/settings.json

@@ -1,5 +1,9 @@
 {
-    "python.testing.pytestArgs": [],
+    "python.testing.pytestArgs": ["--disable-warnings"],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "[python]": {
+        "editor.showUnused": false,
+    },
+    "python.formatting.provider": "black",
 }

.vscode/tasks.json

@@ -0,0 +1,115 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "label": "Pytest",
+        "detail": "Execute pytest tests for pyhiveapi/apyhiveapi",
+        "type": "shell",
+        "command": "pytest --timeout=10 tests",
+        "dependsOn": ["Install all Test Requirements", "Install Package Locally"],
+        "group": {
+          "kind": "test",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Flake8",
+        "detail": "Run flake8 checks on the libary",
+        "type": "shell",
+        "command": "pre-commit run flake8 --all-files",
+        "group": {
+          "kind": "test",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Pylint",
+        "detail": "Run pylint checks on the libary",
+        "type": "shell",
+        "command": "pylint src",
+        "dependsOn": ["Install all Requirements"],
+        "group": {
+          "kind": "test",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Code Coverage",
+        "detail": "Generate local code coverage report.",
+        "type": "shell",
+        "command": "pytest --cov-report html --cov=apyhiveapi tests/apyhiveapi && pytest --cov-report html --cov=pyhiveapi  --cov-append tests/pyhiveapi",
+        "dependsOn": ["Install all Test Requirements", "Install Package Locally"],
+        "group": {
+          "kind": "test",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Install all Requirements",
+        "detail": "Install all requirements needed to run pyhiveapi/apyihiveapi ",
+        "type": "shell",
+        "command": "pip3 install --use-deprecated=legacy-resolver -r requirements_all.txt",
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Install all Test Requirements",
+        "detail": "Install all test requirement for pytest.",
+        "type": "shell",
+        "command": "pip3 install --use-deprecated=legacy-resolver -r requirements_test_all.txt",
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Install Package Locally",
+        "detail": "Install pyhiveapi/apyhiveapi locally.",
+        "type": "shell",
+        "command": "pip3 install --upgrade --use-deprecated=legacy-resolver .",
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "new"
+        },
+        "problemMatcher": []
+      },
+    ],
+    "inputs": []
+  }
+

MANIFEST.in

@@ -1,4 +1,4 @@
-recursive-include pyhiveapi *
-include requirements.txt
-include requirements_test.txt
+recursive-include src *
+include requirements_all.txt
+include requirements_test_all.txt
 recursive-include data *