Tests refacto

.dockerignore

@@ -0,0 +1,30 @@
+**/__pycache__
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.github
+**/.gitignore
+**/.project
+**/.pytest_cache
+**/.settings
+**/.toolstarget
+**/.venv
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/charts
+**/htmlcov
+**/docker-compose*
+**/Dockerfile*
+**/junit
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/site
+**/values.dev.yaml

.github/workflows/tester.yml

@@ -0,0 +1,81 @@
+name: "🎳 Tester"
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - "**.py"
+
+  pull_request:
+    branches: [master]
+    paths:
+      - "**.py"
+
+env:
+  PROJECT_FOLDER: "qgis_resource_sharing"
+  PYTHON_VERSION: 3.9
+
+jobs:
+  tests-unit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Get source code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: "pip"
+          cache-dependency-path: "requirements/testing.txt"
+
+      - name: Install Python requirements
+        run: |
+          python -m pip install -U pip setuptools wheel
+          python -m pip install -U -r requirements/testing.txt
+
+      - name: Run Unit tests
+        run: pytest -p no:qgis tests/unit/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+
+  test-qgis:
+    runs-on: ubuntu-latest
+
+    container:
+      image: qgis/qgis:release-3_22
+      env:
+        CI: true
+        DISPLAY: ":1"
+        MUTE_LOGS: true
+        NO_MODALS: 1
+        PYTHONPATH: "/usr/share/qgis/python/plugins:/usr/share/qgis/python:."
+        QT_QPA_PLATFORM: "offscreen"
+        WITH_PYTHON_PEP: false
+      options: -v /tmp/.X11-unix:/tmp/.X11-unix -v ${{ github.workspace }}:/tests_directory
+
+    steps:
+      - name: Get source code
+        uses: actions/checkout@v3
+
+      - name: Print QGIS version
+        run: qgis --version
+
+      - name: Setup plugin
+        run: qgis_setup.sh qgis_resource_sharing
+
+      - name: Install Python requirements
+        run: |
+          python3 -m pip install -U pip setuptools wheel
+          python3 -m pip install --no-deps -U -r requirements/embedded.txt -t ${{ env.PROJECT_FOLDER }}/embedded_external_libs
+          python3 -m pip install -U -r requirements/testing.txt
+
+      - name: Run Unit tests
+        run: |
+          Xvfb :1 &
+          python3 -m pytest tests/qgis/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2

.gitignore

@@ -33,6 +33,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
+junit/
 
 # Sphinx documentation
 docs/_build/

.vscode/settings.json

@@ -27,6 +27,10 @@
         "--verbose"
     ],
     "python.linting.pylintEnabled": false,
+    // Tests
+    "python.testing.pytestArgs": [],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
     // Git
     "git.enableCommitSigning": true,
     // Extensions

codecov.yml

@@ -0,0 +1,23 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+  status:
+    project: off
+    patch: off
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no

docs/development/testing.md

@@ -0,0 +1,50 @@
+# Tests
+
+Tests are written in 2 separate folders:
+
+- `tests/unit`: testing code which is independent of QGIS API
+- `tests/qgis`: testing code which depends on QGIS API
+
+## Requirements
+
+- QGIS {{ qgis_version_min }}+
+
+```bash
+python -m pip install -U pip
+python -m pip install -U -r requirements/testing.txt
+```
+
+## Running tests
+
+```bash
+# run all tests with PyTest and Coverage report
+python -m pytest
+
+# run only unit tests
+python -m pytest tests/unit
+
+# run only QGIS tests
+python -m pytest tests/qgis
+
+# run a specific test module using standard unittest
+python -m unittest tests.unit.test_plg_metadata
+
+# run a specific test function using standard unittest
+python -m unittest tests.unit.test_plg_metadata.TestPluginMetadata.test_version_semver
+```
+
+### Using Docker
+
+Build the image:
+
+```bash
+docker build --pull --rm -f "tests/tests_qgis.dockerfile" -t qgis_lts:plugin_tester .
+```
+
+Run tests:
+
+```bash
+docker run -v "$(pwd):/tmp/plugin" qgis_lts:plugin_tester python3 -m pytest
+```
+
+Please note that will use the root rights on some folders.

docs/index.md

@@ -65,6 +65,7 @@ maxdepth: 1
 ---
 development/contributing
 development/environment
+development/testing
 development/update_dependencies
 development/documentation
 development/packaging

qgis_resource_sharing/collection_manager.py

@@ -129,15 +129,15 @@ def get_installed_collections(self, repo_url=None):
         :rtype: dict
         """
         installed_collections = {}
-        for id, collection in config.COLLECTIONS.items():
+        for collection_id, collection in config.COLLECTIONS.items():
             if collection["status"] != COLLECTION_INSTALLED_STATUS:
                 continue
 
             if repo_url:
                 if collection["repository_url"] != repo_url:
                     continue
 
-            installed_collections[id] = collection
+            installed_collections[collection_id] = collection
 
         return installed_collections
 

qgis_resource_sharing/repository_handler/base.py

@@ -3,6 +3,7 @@
 import logging
 from configparser import ConfigParser
 from io import StringIO
+from typing import Dict, List
 from urllib.parse import urlparse
 
 from ext_libs.giturlparse import validate as git_validate
@@ -127,11 +128,11 @@ def fetch_metadata(self):
             self.metadata = bytes(network_manager.content).decode("utf8")
         return status, fetcherror
 
-    def parse_metadata(self):
+    def parse_metadata(self) -> List[Dict]:
         """Parse str metadata to collection dict.
 
         :return: collections
-        :rtype: (dict)
+        :rtype: List[Dict]
         """
         if not self.metadata:
             msg = "The metadata content is None"
@@ -227,20 +228,20 @@ def parse_metadata(self):
                 raise MetadataError("Error parsing metadata: %s" % e)
 
             collection_dict = {
-                "register_name": collection,
                 "author": author,
                 "author_email": email,
-                "repository_url": self.url,
-                "repository_name": "",
-                "status": COLLECTION_NOT_INSTALLED_STATUS,
-                "name": name,
-                "tags": tags,
                 "description": description,
-                "qgis_min_version": qgis_min_version,
-                "qgis_max_version": qgis_max_version,
-                "preview": preview_list,
                 "license": license_str,
                 "license_url": license_url,
+                "name": name,
+                "preview": preview_list,
+                "qgis_max_version": qgis_max_version,
+                "qgis_min_version": qgis_min_version,
+                "register_name": collection,
+                "repository_name": "",
+                "repository_url": self.url,
+                "status": COLLECTION_NOT_INSTALLED_STATUS,
+                "tags": tags,
             }
             collections.append(collection_dict)
 

qgis_resource_sharing/repository_handler/gogs_handler.py

@@ -1,3 +1,9 @@
+#! python3  # noqa E265
+
+# standard library
+from urllib.parse import ParseResult, urlparse
+
+# Plugin
 from qgis_resource_sharing.repository_handler.remote_git_handler import RemoteGitHandler
 
 
@@ -8,16 +14,32 @@ class GogsHandler(RemoteGitHandler):
 
     def __init__(self, url):
         RemoteGitHandler.__init__(self, url)
+        self.url = url
+
+    @property
+    def url_parsed(self) -> ParseResult:
+        return urlparse(self.url)
+
+    @property
+    def git_host(self):
+        return "git.osgeo.org"
+
+    @property
+    def git_owner(self):
+        return self.url_parsed.path.split("/")[2]
+
+    @property
+    def git_platform(self):
+        return "gogs"
+
+    @property
+    def git_service(self):
+        return "gitea"
 
     def can_handle(self):
         if self.git_platform == "gogs":
             return True
         return False
 
     def file_url(self, relative_path):
-        return "https://%s/%s/%s/raw/master/%s" % (
-            self.git_host,
-            self.git_owner,
-            self.git_repository,
-            relative_path,
-        )
+        return f"https://{self.git_host}/{self.git_service}/{self.git_owner}/{self.git_repository}/raw/branch/master/{relative_path}"

qgis_resource_sharing/repository_manager.py

@@ -150,9 +150,16 @@ def load_directories(self):
                     LOGGER.warning(nameWarn)
                     break
             if not repo_present:
-                self.add_directory(
-                    online_dir_name, self._online_directories[online_dir_name]
-                )
+                try:
+                    self.add_directory(
+                        online_dir_name, self._online_directories[online_dir_name]
+                    )
+                except Exception as exc:
+                    LOGGER.error(
+                        f"Error occured adding '{online_dir_name}' repository. Trace: {exc}"
+                    )
+                    continue
+
         for repo_name in settings.childGroups():
             self._directories[repo_name] = {}
             url = settings.value(repo_name + "/url", "", type=str)