diff --git a/sardes/api/plugins.py b/sardes/api/plugins.py index df1625c1..72eee304 100644 --- a/sardes/api/plugins.py +++ b/sardes/api/plugins.py @@ -529,10 +529,11 @@ def show_plugin(self): This method is called by the mainwindow after it is shown. """ - is_visible = self.get_option('is_visible', False) - is_docked = self.get_option('is_docked', True) - if is_visible and not is_docked: - self.dockwindow.undock() + if self.dockwindow is not None: + is_visible = self.get_option('is_visible', False) + is_docked = self.get_option('is_docked', True) + if is_visible and not is_docked: + self.dockwindow.undock() def close_plugin(self): """ diff --git a/sardes/app/mainwindow.py b/sardes/app/mainwindow.py index ea6eafef..6bcaea2d 100644 --- a/sardes/app/mainwindow.py +++ b/sardes/app/mainwindow.py @@ -99,6 +99,10 @@ def __init__(self, splash=None, sys_capture_manager=None): self.db_connection_manager) print("Table models manager set up succesfully.") + # Setup the update manager. + from sardes.app.updates import UpdatesManager + self.updates_manager = UpdatesManager(parent=self) + self.setup() def set_splash(self, message): @@ -262,6 +266,15 @@ class Separator(object): triggered=self.confdialog.show ) + # Create show console action. + self.console_action = None + if self.console is not None: + self.console_action = create_action( + self, _('Sardes Console...'), icon='console', + shortcut='Ctrl+Shift+J', context=Qt.ApplicationShortcut, + triggered=self.console.show + ) + # Create the panes and toolbars menus and actions self.panes_menu = QMenu(_("Panes"), self) self.panes_menu.setIcon(get_icon('panes')) @@ -282,13 +295,6 @@ class Separator(object): triggered=self.reset_window_layout) # Create help related actions and menus. - self.console_action = None - if self.console is not None: - self.console_action = create_action( - self, _('Sardes Console...'), icon='console', - shortcut='Ctrl+Shift+J', context=Qt.ApplicationShortcut, - triggered=self.console.show - ) report_action = create_action( self, _('Report an issue...'), icon='bug', shortcut='Ctrl+Shift+R', context=Qt.ApplicationShortcut, @@ -299,6 +305,10 @@ class Separator(object): shortcut='Ctrl+Shift+I', context=Qt.ApplicationShortcut ) + update_action = create_action( + self, _('Check for updates...'), icon='update', + triggered=lambda: self.updates_manager.start_updates_check() + ) exit_action = create_action( self, _('Exit'), icon='exit', triggered=self.close, shortcut='Ctrl+Shift+Q', context=Qt.ApplicationShortcut @@ -306,11 +316,12 @@ class Separator(object): # Add the actions and menus to the options menu. options_menu_items = [ - self.lang_menu, preferences_action, Separator(), - self.panes_menu, self.toolbars_menu, + self.lang_menu, preferences_action, self.console_action, + Separator(), self.panes_menu, self.toolbars_menu, self.lock_dockwidgets_and_toolbars_action, self.reset_window_layout_action, Separator(), - self.console_action, report_action, about_action, exit_action + report_action, update_action, about_action, + Separator(), exit_action ] for item in options_menu_items: if isinstance(item, Separator): @@ -602,7 +613,8 @@ def setup_internal_plugins(self): def show(self): """ - Extend Qt method to call show_plugin on each installed plugin. + Extend base class method to perform specific actions of certain + plugins after the mainwindow has been shown. """ super().show() @@ -613,6 +625,8 @@ def show(self): if self.databases_plugin.get_option('auto_connect_to_database'): self.databases_plugin.connect_to_database() + self.updates_manager.start_updates_check(startup_check=True) + class ExceptHook(QObject): """ diff --git a/sardes/app/tests/test_updates.py b/sardes/app/tests/test_updates.py new file mode 100644 index 00000000..8c05f0de --- /dev/null +++ b/sardes/app/tests/test_updates.py @@ -0,0 +1,134 @@ +# -*- coding: utf-8 -*- +# ----------------------------------------------------------------------------- +# Copyright © GWHAT Project Contributors +# https://github.com/jnsebgosselin/gwhat +# +# This file is part of GWHAT (Ground-Water Hydrograph Analysis Toolbox). +# Licensed under the terms of the GNU General Public License. +# ----------------------------------------------------------------------------- + +# ---- Standard imports +import os +os.environ['SARDES_PYTEST'] = 'True' + +# ---- Third parties imports +import pytest +from qtpy.QtCore import QTimer + +# ---- Local imports +from sardes.app.updates import UpdatesManager +from sardes.config.main import CONF + + +# ============================================================================= +# ---- Fixtures +# ============================================================================= +@pytest.fixture +def updates_manager(qtbot): + CONF.reset_to_defaults() + updates_manager = UpdatesManager() + assert updates_manager.dialog.isVisible() is False + yield updates_manager + + # To avoid: Thread: Destroyed while thread is still running. + qtbot.wait(300) + + +# ============================================================================= +# ---- Tests +# ============================================================================= +def test_update_available(updates_manager, qtbot, mocker): + """ + Assert that the worker to check for updates on the GitHub API is + working as expected when an update is available. + + Note that since we are forcing the current version to a not stable version, + the '1.1.0rc2 update should be proposed to the user. + """ + mocker.patch('sardes.app.updates.__version__', '1.1.0rc1') + mocker.patch( + 'sardes.app.updates.fetch_available_releases', + return_value=(['0.9.0', '1.1.0rc2', '1.0.0'], None) + ) + + def handle_dialog(on_startup: bool): + assert updates_manager.dialog.isVisible() is True + assert updates_manager.dialog.chkbox.isVisible() == on_startup + assert 'Sardes 1.1.0rc2 is available!' in updates_manager.dialog.text() + updates_manager.dialog.close() + + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + QTimer.singleShot(300, lambda: handle_dialog(on_startup=False)) + updates_manager.start_updates_check() + + # Test that this is working also as expected during STARTUP and mute + # the message on next startups. + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + updates_manager.dialog.chkbox.setChecked(True) + QTimer.singleShot(300, lambda: handle_dialog(on_startup=True)) + updates_manager.start_updates_check(startup_check=True) + + # Assert the update is muted as expected. + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + updates_manager.start_updates_check(startup_check=True) + assert updates_manager.dialog.isVisible() is False + + +def test_no_update_available(updates_manager, qtbot, mocker): + """ + Assert that the worker to check for updates on the GitHub API is + working as expected when no update is available. + + Note that since we are forcing the current version to a stable version, + the '1.1.0rc2 update should be proposed to the user. + """ + mocker.patch('sardes.app.updates.__version__', '1.1.0') + mocker.patch( + 'sardes.app.updates.fetch_available_releases', + return_value=(['0.9.0', '1.1.0rc2', '1.0.0'], None) + ) + + def handle_dialog(on_startup: bool): + assert updates_manager.dialog.isVisible() is True + assert updates_manager.dialog.chkbox.isVisible() == on_startup + assert 'is up to date' in updates_manager.dialog.text() + updates_manager.dialog.close() + + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + QTimer.singleShot(300, lambda: handle_dialog(on_startup=False)) + updates_manager.start_updates_check() + + # Test that the 'up-to-date' message is not shown during STARTUP. + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + updates_manager.start_updates_check(startup_check=True) + assert updates_manager.dialog.isVisible() is False + + +def test_update_error(updates_manager, qtbot, mocker): + """ + Assert that the worker to check for updates on the GitHub API is + working as expected when there is an error. + """ + mocker.patch( + 'sardes.app.updates.fetch_available_releases', + return_value=(['0.9.0', '1.1.0rc2', '1.0.0'], 'some error') + ) + + def handle_dialog(on_startup: bool): + assert updates_manager.dialog.isVisible() is True + assert updates_manager.dialog.chkbox.isVisible() == on_startup + assert 'some error' in updates_manager.dialog.text() + updates_manager.dialog.close() + + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + QTimer.singleShot(300, lambda: handle_dialog(on_startup=False)) + updates_manager.start_updates_check() + + # Test that the error message is not shown during STARTUP. + with qtbot.waitSignal(updates_manager.worker.sig_releases_fetched): + updates_manager.start_updates_check(startup_check=True) + assert updates_manager.dialog.isVisible() is False + + +if __name__ == "__main__": + pytest.main(['-x', __file__, '-v', '-rw']) diff --git a/sardes/app/updates.py b/sardes/app/updates.py new file mode 100644 index 00000000..ee8c09e1 --- /dev/null +++ b/sardes/app/updates.py @@ -0,0 +1,265 @@ +# -*- coding: utf-8 -*- +# ----------------------------------------------------------------------------- +# Copyright © SARDES Project Contributors +# https://github.com/geo-stack/sardes +# +# This file is part of SARDES. +# Licensed under the terms of the GNU General Public License. +# +# Copyright (c) 2017 Spyder Project Contributors +# https://github.com/spyder-ide/spyder +# +# Some parts of this file is a derivative work of the Spyder project. +# Licensed under the terms of the MIT License. +# +# Copyright (C) 2013 The IPython Development Team +# https://github.com/ipython/ipython +# +# Some parts of this file is a derivative work of the IPython project. +# Licensed under the terms of the BSD License. +# ----------------------------------------------------------------------------- +from __future__ import annotations + +# ---- Standard imports +import re +from packaging.version import Version + +# ---- Third party imports +from qtpy.QtCore import QObject, Qt, QThread, Signal +from qtpy.QtWidgets import QApplication, QMessageBox, QCheckBox +import requests + +# ---- Local imports +from sardes import ( + __version__, __releases_url__, __releases_api__, + __namever__, __project_url__) +from sardes.config.icons import ( + get_icon, get_standard_iconsize, get_standard_icon) +from sardes.config.locale import _ +from sardes.config.main import CONF + + +class UpdatesManager(QObject): + """ + Self contained manager that checks if updates are available on GitHub + and displays the ressults in a message box. + """ + + def __init__(self, parent=None): + super().__init__() + + self._startup_check = False + self.dialog = UpdatesDialog(parent) + + self.thread = QThread() + + self.worker = WorkerUpdates() + self.worker.moveToThread(self.thread) + self.worker.sig_releases_fetched.connect( + self._receive_updates_check) + + self.thread.started.connect(self.worker.start) + + def start_updates_check(self, startup_check: bool = False): + """Check if updates are available.""" + self._startup_check = startup_check + self.thread.start() + + def _receive_updates_check(self, releases: list[str], error: str): + """Receive results from an update check.""" + self.thread.quit() + + update_available, latest_release = check_update_available( + __version__, releases) + muted_updates = CONF.get('main', 'muted_updates', []) + + if self._startup_check: + if update_available is False or error is not None: + return + for release in muted_updates: + if check_version(latest_release, release, '=='): + return + + if error is not None: + msg = error + icon = get_standard_icon('SP_MessageBoxWarning') + else: + if update_available: + icon = get_icon('update_blue') + msg = _( + "

Sardes {} is available!

" + "

This new version can be downloaded from our " + "Releases page.

" + ).format(latest_release, __releases_url__) + else: + icon = get_icon('commit_changes') + url_m = __project_url__ + "/milestones" + url_t = __project_url__ + "/issues" + msg = _( + "

{} is up to date

" + "

Further information about Sardes releases are " + "available on our Releases page.

" + "

The roadmap of the Sardes project can be consulted " + "on our Milestones page.

" + "

Please help Sardes by reporting bugs or proposing " + "new features on our Issues Tracker.

" + ).format(__namever__, __releases_url__, url_m, url_t) + + if self._startup_check: + # Add some space between text and checkbox. + msg += "
" + self.dialog.chkbox.setVisible(self._startup_check) + + self.dialog.setText(msg) + self.dialog.setIconPixmap( + icon.pixmap(get_standard_iconsize('messagebox'))) + self.dialog.exec_() + + if self.dialog.chkbox.isChecked(): + muted_updates.append(latest_release) + muted_updates = list(set(muted_updates)) + CONF.set('main', 'muted_updates', muted_updates) + + +class UpdatesDialog(QMessageBox): + """ + Dialog to display update checks. + """ + + def __init__(self, parent=None): + super().__init__(parent) + + self.setWindowTitle(_('Updates')) + self.setWindowIcon(get_icon('master')) + self.setMinimumSize(800, 700) + + self.setWindowFlags( + Qt.Window | Qt.CustomizeWindowHint | Qt.WindowCloseButtonHint) + + self.chkbox = QCheckBox(_("Do not show this message again.")) + self.setCheckBox(self.chkbox) + + self.setStandardButtons(QMessageBox.Ok) + self.setDefaultButton(QMessageBox.Ok) + + +class WorkerUpdates(QObject): + """ + Worker that fetch available releases using the Github API. + """ + sig_releases_fetched = Signal(object, object) + + def start(self): + """Main method of the WorkerUpdates worker.""" + releases, error = fetch_available_releases(__releases_api__) + self.sig_releases_fetched.emit(releases, error) + + +def fetch_available_releases(url: str) -> (list[str], str): + """Retrieve the list of released versions available on GitHub.""" + error = None + releases = [] + + try: + page = requests.get(__releases_api__) + data = page.json() + releases = [item['tag_name'][1:] for item in data] + except requests.exceptions.HTTPError: + error = _( + "Unable to retrieve information because of an http error.") + except requests.exceptions.ConnectionError: + error = _( + "Unable to connect to the internet. Make " + "sure that your connection is working properly.") + except requests.exceptions.Timeout: + error = _( + "Unable to retrieve information because the " + "connection timed out.") + except Exception: + error = _( + "Unable to check for updates because of " + "an unexpected error.") + + return releases, error + + +def check_update_available(version: str, releases: list[str]) -> (bool, str): + """ + Checks if there is an update available. + + It takes as parameters the current version of Sardes and a list of + valid cleaned releases in chronological order (what github api returns + by default). Example: ['2.3.4', '2.3.3' ...] + + Copyright (c) Spyder Project Contributors + Licensed under the terms of the MIT License + """ + if len(releases) == 0: + return False, None + + if is_stable_version(version): + # Remove non stable versions from the list. + releases = [r for r in releases if is_stable_version(r)] + + latest_release = str(max([Version(r) for r in releases])) + return check_version(version, latest_release, '<'), latest_release + + +def check_version(actver: str, version: str, cmp_op: str): + """ + Check version string of an active module against a required version. + + If dev/prerelease tags result in TypeError for string-number comparison, + it is assumed that the dependency is satisfied. Users on dev branches are + responsible for keeping their own packages up to date. + + Copyright (C) 2013 The IPython Development Team + Licensed under the terms of the BSD License + """ + if isinstance(version, tuple): + version = '.'.join([str(i) for i in version]) + + try: + if cmp_op == '>': + return Version(actver) > Version(version) + elif cmp_op == '>=': + return Version(actver) >= Version(version) + elif cmp_op == '==': + return Version(actver) == Version(version) + elif cmp_op == '<': + return Version(actver) < Version(version) + elif cmp_op == '<=': + return Version(actver) <= Version(version) + else: + return False + except TypeError: + return True + + +def is_stable_version(version): + """ + Returns wheter this is a stable version or not. A stable version has no + letters in the final component, but only numbers. + + Stable version example: 1.2, 1.3.4, 1.0.5 + Not stable version: 1.2alpha, 1.3.4beta, 0.1.0rc1, 3.0.0dev + + Copyright (c) 2017 Spyder Project Contributors + Licensed under the terms of the MIT License + """ + if not isinstance(version, tuple): + version = version.split('.') + last_part = version[-1] + + if not re.search('[a-zA-Z]', last_part): + return True + else: + return False + + +if __name__ == "__main__": + import sys + app = QApplication(sys.argv) + updates_manager = UpdatesManager() + updates_manager.start_updates_check(startup_check=False) + sys.exit(app.exec_()) diff --git a/sardes/config/icons.py b/sardes/config/icons.py index dc0b610a..69cd6fd4 100644 --- a/sardes/config/icons.py +++ b/sardes/config/icons.py @@ -1,12 +1,12 @@ # -*- coding: utf-8 -*- # ----------------------------------------------------------------------------- # Copyright © SARDES Project Contributors -# https://github.com/cgq-qgc/sardes +# https://github.com/geo-stack/sardes # # This file is part of SARDES. # Licensed under the terms of the GNU General Public License. # ---------------------------------------------------------------------------- - +from __future__ import annotations # ---- Standard imports import os @@ -272,6 +272,9 @@ 'undo': [ ('mdi.undo-variant',), {'color': ICON_COLOR}], + 'update': [ + ('mdi.update',), + {'color': ICON_COLOR, 'scale_factor': 1.3}], 'update_blue': [ ('mdi.update',), {'color': BLUE, 'scale_factor': 1.3}], @@ -316,7 +319,7 @@ def get_iconsize(size): return QSize(*ICON_SIZES[size]) -def get_standard_icon(constant): +def get_standard_icon(constant: str) -> QIcon: """ Return a QIcon of a standard pixmap. @@ -328,7 +331,7 @@ def get_standard_icon(constant): return style.standardIcon(constant) -def get_standard_iconsize(constant): +def get_standard_iconsize(constant: str) -> int: """ Return the standard size of various component of the gui. @@ -339,3 +342,8 @@ def get_standard_iconsize(constant): return style.pixelMetric(QStyle.PM_MessageBoxIconSize) elif constant == 'small': return style.pixelMetric(QStyle.PM_SmallIconSize) + else: + raise ValueError(( + "Valid values for the 'constant' parameter are " + "'messagebox' or 'small', but '{}' was provided" + ).format(constant))