Add test for plugin dependencies

Also made minor changes to the function and class names, to be more consistent with QGIS naming conventions.
qgis · Mar 18, 2019 · b85d5af · b85d5af
1 parent 1622d73
commit b85d5af
Show file tree

Hide file tree

Showing 7 changed files with 127 additions and 124 deletions.
diff --git a/python/pyplugin_installer/CMakeLists.txt b/python/pyplugin_installer/CMakeLists.txt
@@ -9,8 +9,8 @@ SET(PY_PLUGININSTALLER_FILES
     qgsplugininstallerpluginerrordialog.py
     qgsplugininstallerfetchingdialog.py
     qgsplugininstallerrepositorydialog.py
-    qgsplugindependencies.py
     qgsplugindependenciesdialog.py
+    plugindependencies.py
     unzip.py
     version_compare.py
 )

diff --git a/python/pyplugin_installer/installer.py b/python/pyplugin_installer/installer.py
@@ -43,7 +43,7 @@
 from .qgsplugininstallerfetchingdialog import QgsPluginInstallerFetchingDialog
 from .qgsplugininstallerrepositorydialog import QgsPluginInstallerRepositoryDialog
 from .unzip import unzip
-from .qgsplugindependencies import find_dependencies
+from .plugindependencies import find_dependencies
 from .qgsplugindependenciesdialog import QgsPluginDependenciesDialog
 
 

diff --git a/python/pyplugin_installer/qgsplugindependencies.py b/python/pyplugin_installer/qgsplugindependencies.py
diff --git a/python/utils.py b/python/utils.py
@@ -282,6 +282,7 @@ def updateAvailablePlugins():
     available_plugins = plugins
     global plugins_metadata_parser
     plugins_metadata_parser = metadata_parser
+    return metadata_parser
 
 
 def pluginMetadata(packageName, fct):

diff --git a/tests/src/python/CMakeLists.txt b/tests/src/python/CMakeLists.txt
@@ -243,6 +243,7 @@ ADD_PYTHON_TEST(PyQgsAuthSettingsWidget test_authsettingswidget.py)
 ADD_PYTHON_TEST(PyQgsAuxiliaryStorage test_qgsauxiliarystorage.py)
 ADD_PYTHON_TEST(PyQgsAuthManagerOgr test_authmanager_ogr.py)
 ADD_PYTHON_TEST(PyQgsFieldValidator test_qgsfieldvalidator.py)
+ADD_PYTHON_TEST(PyQgsPluginDependencies test_plugindependencies.py)
 
 IF (NOT WIN32)
   ADD_PYTHON_TEST(PyQgsLogger test_qgslogger.py)

diff --git a/tests/src/python/test_plugindependencies.py b/tests/src/python/test_plugindependencies.py
@@ -0,0 +1,122 @@
+# coding=utf-8
+"""QGIS Plugin dependencies test
+
+.. note:: This program is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published by
+     the Free Software Foundation; either version 2 of the License, or
+     (at your option) any later version.
+
+"""
+
+__author__ = 'elpaso@itopen.it'
+__date__ = '2018-09-19'
+__copyright__ = 'Copyright 2018, GISCE-TI S.L.'
+
+import uuid
+import os
+import re
+import json
+import unittest
+from qgis.PyQt.QtCore import QCoreApplication
+from pyplugin_installer.plugindependencies import find_dependencies
+
+
+from qgis.testing import (
+    start_app,
+    unittest,
+)
+
+from utilities import unitTestDataPath
+
+TESTDATA_PATH = unitTestDataPath()
+
+
+class PluginDependenciesTest(unittest.TestCase):
+    """Test plugin dependencies"""
+
+    @classmethod
+    def setUpClass(cls):
+        """Runs at start."""
+
+        QCoreApplication.setOrganizationName("QGIS")
+        QCoreApplication.setOrganizationDomain("qgis.org")
+        QCoreApplication.setApplicationName("QGIS-TEST-%s" % uuid.uuid1())
+        qgis_app = start_app()
+
+        # Installed plugins
+        cls.installed_plugins = {
+            'MetaSearch': '0.3.5',
+            'QuickWKT': '3.1',
+            'db_manager': '0.1.20',
+            'firstaid': '2.1.1',
+            'InaSAFE': '5.0.0',
+            'ipyconsole': '1.8',
+            'plugin_reloader': '0.7.4',
+            'processing': '2.12.99',
+            'qgis-geocoding': '2.18',
+            'qgisce': '0.9',
+            'redistrict': '0.1'
+        }
+
+        data_path = os.path.join(TESTDATA_PATH, 'plugindependencies_data.json')
+        with open(data_path) as f:
+            cls.plugin_data = json.loads(f.read())
+
+    def setUp(self):
+        """Runs before each test."""
+        pass
+
+    def tearDown(self):
+        """Runs after each test."""
+        pass
+
+    def test_find_dependencies(self):
+
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'InaSAFE': None}, installed_plugins=self.installed_plugins)
+        self.assertEqual(to_install, {})
+        self.assertEqual(to_upgrade, {})
+        self.assertEqual(not_found, {})
+
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'InaSAFE': '110.1'}, installed_plugins=self.installed_plugins)
+        self.assertEqual(to_install, {})
+        self.assertEqual(to_upgrade, {})
+        self.assertEqual(not_found['InaSAFE']['version_installed'], '5.0.0')
+
+        # QuickWkt is installed, version is not specified: ignore
+        installed_plugins = self.installed_plugins
+        installed_plugins['QuickWKT'] = '2.1'
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'QuickMapServices': '0.19.10.1', 'QuickWKT': None}, installed_plugins=self.installed_plugins)
+        self.assertEqual(to_install['QuickMapServices']['version_required'], '0.19.10.1')
+        self.assertEqual(to_upgrade, {})
+        self.assertEqual(not_found, {})
+
+        # QuickWkt is installed, version requires upgrade and it's in the repo: upgrade
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'QuickWKT': '3.1'}, installed_plugins=installed_plugins)
+        self.assertEqual(to_install, {})
+        self.assertEqual(to_upgrade['QuickWKT']['version_required'], '3.1')
+        self.assertEqual(not_found, {})
+
+        # QuickWkt is installed, version requires upgrade and it's NOT in the repo: not found
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'QuickWKT': '300.11234'}, installed_plugins=installed_plugins)
+        self.assertEqual(to_install, {})
+        self.assertEqual(to_upgrade, {})
+        self.assertEqual(not_found['QuickWKT']['version_required'], '300.11234')
+        self.assertEqual(not_found['QuickWKT']['version_installed'], '2.1')
+        self.assertEqual(not_found['QuickWKT']['version_available'], '3.1')
+
+        # Installed version is > than required: ignore (no downgrade is currently possible)
+        installed_plugins['QuickWKT'] = '300.1'
+        to_install, to_upgrade, not_found = find_dependencies('qgisce', self.plugin_data, plugin_deps={'QuickWKT': '1.2'}, installed_plugins=installed_plugins)
+        self.assertEqual(to_install, {})
+        self.assertEqual(to_upgrade, {})
+        self.assertEqual(not_found, {})
+
+
+def pluginSuite():
+    return unittest.makeSuite(PluginDependenciesTest, 'test')
+
+
+if __name__ == "__main__":
+    suite = unittest.makeSuite(PluginDependenciesTest)
+    runner = unittest.TextTestRunner(verbosity=2)
+    runner.run(suite)
diff --git a/tests/testdata/plugindependencies_data.json b/tests/testdata/plugindependencies_data.json