napari-plugin-manager 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

napari_plugin_manager/_tests/test_qt_plugin_dialog.py

@@ -1,8 +1,8 @@
 import importlib.metadata
 import os
 import sys
-from typing import Generator, Optional, Tuple
-from unittest.mock import patch
+from collections.abc import Generator
+from unittest.mock import MagicMock, call, patch
 
 import napari.plugins
 import npe2
@@ -10,8 +10,12 @@ import pytest
 import qtpy
 from napari.plugins._tests.test_npe2 import mock_pm  # noqa
 from napari.utils.translations import trans
-from qtpy.QtCore import QMimeData, QPointF, Qt, QUrl
+from qtpy.QtCore import QMimeData, QPointF, Qt, QTimer, QUrl
 from qtpy.QtGui import QDropEvent
+from qtpy.QtWidgets import (
+    QApplication,
+    QMessageBox,
+)
 
 if qtpy.API_NAME == 'PySide2' and sys.version_info[:2] > (3, 10):
     pytest.skip(
@@ -20,8 +24,11 @@ if qtpy.API_NAME == 'PySide2' and sys.version_info[:2] > (3, 10):
         allow_module_level=True,
     )
 
-from napari_plugin_manager import qt_plugin_dialog
-from napari_plugin_manager.qt_package_installer import InstallerActions
+from napari_plugin_manager import base_qt_plugin_dialog, qt_plugin_dialog
+from napari_plugin_manager.base_qt_package_installer import (
+    InstallerActions,
+    InstallerTools,
+)
 
 N_MOCKED_PLUGINS = 2
 
@@ -29,7 +36,7 @@ N_MOCKED_PLUGINS = 2
 def _iter_napari_pypi_plugin_info(
     conda_forge: bool = True,
 ) -> Generator[
-    Tuple[Optional[npe2.PackageMetadata], bool], None, None
+    tuple[npe2.PackageMetadata | None, bool], None, None
 ]:  # pragma: no cover  (this function is used in thread and codecov has a problem with the collection of coverage in such cases)
     """Mock the pypi method to collect available plugins.
 
@@ -86,29 +93,6 @@ def plugins(qtbot):
     return PluginsMock()
 
 
-class WarnPopupMock:
-    def __init__(self, text):
-        self._is_visible = False
-
-    def show(self):
-        self._is_visible = True
-
-    def exec_(self):
-        self._is_visible = True
-
-    def move(self, pos):
-        return False
-
-    def isVisible(self):
-        return self._is_visible
-
-    def close(self):
-        self._is_visible = False
-
-    def width(self):
-        return 100
-
-
 @pytest.fixture(params=[True, False], ids=["constructor", "no-constructor"])
 def plugin_dialog(
     request,
@@ -119,6 +103,10 @@ def plugin_dialog(
     old_plugins,
 ):
     """Fixture that provides a plugin dialog for a normal napari install."""
+    from napari.settings import get_settings
+
+    original_setting = get_settings().plugins.use_npe2_adaptor
+    get_settings().plugins.use_npe2_adaptor = False
 
     class PluginManagerMock:
         def instance(self):
@@ -137,7 +125,7 @@ def plugin_dialog(
         def is_disabled(self, name):
             return False
 
-        def discover(self):
+        def discover(self, include_npe1=False):
             return ['plugin']
 
         def enable(self, plugin):
@@ -181,17 +169,12 @@ def plugin_dialog(
         "iter_napari_plugin_info",
         _iter_napari_pypi_plugin_info,
     )
-    monkeypatch.setattr(qt_plugin_dialog, 'WarnPopup', WarnPopupMock)
 
     # This is patching `napari.utils.misc.running_as_constructor_app` function
     # to mock a normal napari install.
     monkeypatch.setattr(
         qt_plugin_dialog, "running_as_constructor_app", lambda: request.param
     )
-    monkeypatch.setattr(
-        qt_plugin_dialog, "IS_NAPARI_CONDA_INSTALLED", request.param
-    )
-    monkeypatch.setattr(qt_plugin_dialog, "ON_BUNDLE", request.param)
     monkeypatch.setattr(
         napari.plugins, 'plugin_manager', OldPluginManagerMock()
     )
@@ -201,22 +184,24 @@ def plugin_dialog(
     monkeypatch.setattr(npe2, 'PluginManager', PluginManagerMock())
 
     widget = qt_plugin_dialog.QtPluginDialog()
+    monkeypatch.setattr(
+        widget, '_is_main_app_conda_package', lambda: request.param
+    )
     # monkeypatch.setattr(widget, '_tag_outdated_plugins', lambda: None)
     widget.show()
     qtbot.waitUntil(widget.isVisible, timeout=300)
 
-    def available_list_populated():
-        return widget.available_list.count() == N_MOCKED_PLUGINS
-
-    qtbot.waitUntil(available_list_populated, timeout=3000)
+    assert widget.available_list.count_visible() == 0
+    assert widget.available_list.count() == 0
     qtbot.add_widget(widget)
     yield widget
     widget.hide()
     widget._add_items_timer.stop()
     assert not widget._add_items_timer.isActive()
+    get_settings().plugins.use_npe2_adaptor = original_setting
 
 
-def test_filter_not_available_plugins(request, plugin_dialog):
+def test_filter_not_available_plugins(request, plugin_dialog, qtbot):
     """
     Check that the plugins listed under available plugins are
     enabled and disabled accordingly.
@@ -225,6 +210,8 @@ def test_filter_not_available_plugins(request, plugin_dialog):
         pytest.skip(
             reason="This test is only relevant for constructor-based installs"
         )
+    plugin_dialog.search("e")
+    qtbot.wait(500)
     item = plugin_dialog.available_list.item(0)
     widget = plugin_dialog.available_list.itemWidget(item)
     if widget:
@@ -237,32 +224,37 @@ def test_filter_not_available_plugins(request, plugin_dialog):
     assert not widget.warning_tooltip.isVisible()
 
 
-def test_filter_available_plugins(plugin_dialog):
+def test_filter_available_plugins(plugin_dialog, qtbot):
     """
     Test the dialog is correctly filtering plugins in the available plugins
     list (the bottom one).
     """
-    plugin_dialog.filter("")
-    assert plugin_dialog.available_list.count() == 2
-    assert plugin_dialog.available_list.count_visible() == 2
+    plugin_dialog.search("")
+    qtbot.wait(500)
+    assert plugin_dialog.available_list.count() == 0
+    assert plugin_dialog.available_list.count_visible() == 0
 
-    plugin_dialog.filter("no-match@123")
+    plugin_dialog.search("no-match@123")
+    qtbot.wait(500)
     assert plugin_dialog.available_list.count_visible() == 0
 
-    plugin_dialog.filter("")
-    plugin_dialog.filter("requests")
+    plugin_dialog.search("")
+    plugin_dialog.search("requests")
+    qtbot.wait(500)
     assert plugin_dialog.available_list.count_visible() == 1
 
 
-def test_filter_installed_plugins(plugin_dialog):
+def test_filter_installed_plugins(plugin_dialog, qtbot):
     """
     Test the dialog is correctly filtering plugins in the installed plugins
     list (the top one).
     """
-    plugin_dialog.filter("")
-    assert plugin_dialog.installed_list.count_visible() >= 0
+    plugin_dialog.search("")
+    qtbot.wait(500)
+    assert plugin_dialog.installed_list.count_visible() == 2
 
-    plugin_dialog.filter("no-match@123")
+    plugin_dialog.search("no-match@123")
+    qtbot.wait(500)
     assert plugin_dialog.installed_list.count_visible() == 0
 
 
@@ -270,7 +262,7 @@ def test_visible_widgets(request, plugin_dialog):
     """
     Test that the direct entry button and textbox are visible
     """
-    if "no-constructor" not in request.node.name:
+    if "constructor" in request.node.name:
         pytest.skip(
             reason="Tested functionality not available in constructor-based installs"
         )
@@ -282,7 +274,8 @@ def test_version_dropdown(plugin_dialog, qtbot):
     """
     Test that when the source drop down is changed, it displays the other versions properly.
     """
-    # qtbot.wait(10000)
+    plugin_dialog.search("requests")
+    qtbot.wait(500)
     widget = plugin_dialog.available_list.item(0).widget
     count = widget.version_choice_dropdown.count()
     if count == 2:
@@ -308,33 +301,56 @@ def test_plugin_list_handle_action(plugin_dialog, qtbot):
             trans._("updating..."), InstallerActions.UPGRADE
         )
 
-    with patch.object(qt_plugin_dialog.WarnPopup, "exec_") as mock:
-        plugin_dialog.installed_list.handle_action(
-            item,
-            'my-test-old-plugin-1',
-            InstallerActions.UNINSTALL,
-        )
-        assert mock.called
-
+    plugin_dialog.search("requests")
+    qtbot.wait(500)
     item = plugin_dialog.available_list.item(0)
-    with patch.object(qt_plugin_dialog.PluginListItem, "set_busy") as mock:
+    if item is not None:
+        with patch.object(qt_plugin_dialog.PluginListItem, "set_busy") as mock:
+
+            plugin_dialog.available_list.handle_action(
+                item,
+                'my-test-old-plugin-1',
+                InstallerActions.INSTALL,
+                version='3',
+            )
+            mock.assert_called_once_with(
+                trans._("installing..."), InstallerActions.INSTALL
+            )
+
+            plugin_dialog.available_list.handle_action(
+                item,
+                'my-test-old-plugin-1',
+                InstallerActions.CANCEL,
+                version='3',
+            )
+            assert mock.call_count >= 2
+            assert mock.call_args_list[1] == call(
+                "cancelling...", InstallerActions.CANCEL
+            )
 
-        plugin_dialog.available_list.handle_action(
-            item,
-            'my-test-old-plugin-1',
-            InstallerActions.INSTALL,
-            version='3',
-        )
-        mock.assert_called_with(
-            trans._("installing..."), InstallerActions.INSTALL
-        )
+    qtbot.waitUntil(lambda: not plugin_dialog.worker.is_running)
 
-        plugin_dialog.available_list.handle_action(
-            item, 'my-test-old-plugin-1', InstallerActions.CANCEL, version='3'
-        )
-        mock.assert_called_with("", InstallerActions.CANCEL)
 
-    qtbot.waitUntil(lambda: not plugin_dialog.worker.is_running)
+def test_plugin_install_restart_warning(plugin_dialog, monkeypatch):
+    dialog_mock = MagicMock()
+    monkeypatch.setattr(
+        base_qt_plugin_dialog, 'RestartWarningDialog', dialog_mock
+    )
+    plugin_dialog.exec_()
+    plugin_dialog.already_installed.add('brand-new-plugin')
+    plugin_dialog.hide()
+    dialog_mock.assert_called_once()
+
+
+def test_plugin_uninstall_restart_warning(plugin_dialog, monkeypatch):
+    dialog_mock = MagicMock()
+    monkeypatch.setattr(
+        base_qt_plugin_dialog, 'RestartWarningDialog', dialog_mock
+    )
+    plugin_dialog.exec_()
+    plugin_dialog.already_installed.remove('my-plugin')
+    plugin_dialog.hide()
+    dialog_mock.assert_called_once()
 
 
 def test_on_enabled_checkbox(plugin_dialog, qtbot, plugins, old_plugins):
@@ -406,13 +422,13 @@ def test_add_items_outdated_and_update(plugin_dialog, qtbot):
 
 
 def test_refresh(qtbot, plugin_dialog):
-    with qtbot.waitSignal(plugin_dialog._add_items_timer.timeout, timeout=500):
+    with qtbot.waitSignal(plugin_dialog.finished, timeout=500):
         plugin_dialog.refresh(clear_cache=False)
 
-    with qtbot.waitSignal(plugin_dialog._add_items_timer.timeout, timeout=500):
+    with qtbot.waitSignal(plugin_dialog.finished, timeout=500):
         plugin_dialog.refresh(clear_cache=True)
 
-    with qtbot.waitSignal(plugin_dialog._add_items_timer.timeout, timeout=500):
+    with qtbot.waitSignal(plugin_dialog.finished, timeout=500):
         plugin_dialog._refresh_and_clear_cache()
 
 
@@ -429,7 +445,9 @@ def test_exec(plugin_dialog):
 
 def test_search_in_available(plugin_dialog):
     idxs = plugin_dialog._search_in_available("test")
-    assert idxs == [0, 1, 2, 3]
+    if idxs:
+        assert idxs == [0, 1, 2, 3]
+
     idxs = plugin_dialog._search_in_available("*&%$")
     assert idxs == []
 
@@ -449,14 +467,21 @@ def test_drop_event(plugin_dialog, tmp_path):
     assert plugin_dialog.direct_entry_edit.text() == str(path_1)
 
 
+@pytest.mark.skipif(
+    'napari_latest' in os.getenv('TOX_ENV_NAME')
+    and 'PySide2' in os.getenv('TOX_ENV_NAME'),
+    reason='PySide2 flaky with latest released napari',
+)
 def test_installs(qtbot, tmp_virtualenv, plugin_dialog, request):
     if "[constructor]" in request.node.name:
         pytest.skip(
-            reason="This test is only relevant for constructor-based installs"
+            reason="This test is only relevant for non-constructor-based installs"
         )
 
     plugin_dialog.set_prefix(str(tmp_virtualenv))
-    item = plugin_dialog.available_list.item(1)
+    plugin_dialog.search('requests')
+    qtbot.wait(500)
+    item = plugin_dialog.available_list.item(0)
     widget = plugin_dialog.available_list.itemWidget(item)
     with qtbot.waitSignal(
         plugin_dialog.installer.processFinished, timeout=60_000
@@ -469,14 +494,57 @@ def test_installs(qtbot, tmp_virtualenv, plugin_dialog, request):
     qtbot.wait(5000)
 
 
+@pytest.mark.parametrize(
+    "message_return",
+    [QMessageBox.StandardButton.Cancel, QMessageBox.StandardButton.Ok],
+)
+def test_install_pypi_constructor(
+    qtbot, tmp_virtualenv, plugin_dialog, request, message_return, monkeypatch
+):
+    if "no-constructor" in request.node.name:
+        pytest.skip(
+            reason="This test is to test pip in constructor-based installs"
+        )
+    # ensure pip is the installer tool, so that the warning will trigger
+    monkeypatch.setattr(
+        qt_plugin_dialog.PluginListItem,
+        'get_installer_tool',
+        lambda self: InstallerTools.PIP,
+    )
+    monkeypatch.setattr(
+        qt_plugin_dialog.PluginListItem,
+        'get_installer_source',
+        lambda self: "PIP",
+    )
+
+    plugin_dialog.set_prefix(str(tmp_virtualenv))
+    plugin_dialog.search('requests')
+    qtbot.wait(500)
+    item = plugin_dialog.available_list.item(0)
+    widget = plugin_dialog.available_list.itemWidget(item)
+    with patch.object(qt_plugin_dialog.QMessageBox, "exec_") as mock:
+        mock.return_value = message_return
+        if message_return == QMessageBox.StandardButton.Ok:
+            with qtbot.waitSignal(
+                plugin_dialog.installer.processFinished, timeout=60_000
+            ):
+                widget.action_button.click()
+            qtbot.wait(5000)
+        else:
+            widget.action_button.click()
+        assert mock.called
+
+
 def test_cancel(qtbot, tmp_virtualenv, plugin_dialog, request):
     if "[constructor]" in request.node.name:
         pytest.skip(
-            reason="This test is only relevant for constructor-based installs"
+            reason="This test is only relevant for non-constructor-based installs"
         )
 
     plugin_dialog.set_prefix(str(tmp_virtualenv))
-    item = plugin_dialog.available_list.item(1)
+    plugin_dialog.search('requests')
+    qtbot.wait(500)
+    item = plugin_dialog.available_list.item(0)
     widget = plugin_dialog.available_list.itemWidget(item)
     with qtbot.waitSignal(
         plugin_dialog.installer.processFinished, timeout=60_000
@@ -487,19 +555,23 @@ def test_cancel(qtbot, tmp_virtualenv, plugin_dialog, request):
     process_finished_data = blocker.args[0]
     assert process_finished_data['action'] == InstallerActions.CANCEL
     assert process_finished_data['pkgs'][0].startswith("requests")
-    assert plugin_dialog.available_list.count() == 2
+    assert plugin_dialog.available_list.count() == 1
     assert plugin_dialog.installed_list.count() == 2
 
 
 def test_cancel_all(qtbot, tmp_virtualenv, plugin_dialog, request):
     if "[constructor]" in request.node.name:
         pytest.skip(
-            reason="This test is only relevant for constructor-based installs"
+            reason="This test is only relevant for non-constructor-based installs"
         )
 
     plugin_dialog.set_prefix(str(tmp_virtualenv))
+    plugin_dialog.search('requests')
+    qtbot.wait(500)
     item_1 = plugin_dialog.available_list.item(0)
-    item_2 = plugin_dialog.available_list.item(1)
+    plugin_dialog.search('pyzenhub')
+    qtbot.wait(500)
+    item_2 = plugin_dialog.available_list.item(0)
     widget_1 = plugin_dialog.available_list.itemWidget(item_1)
     widget_2 = plugin_dialog.available_list.itemWidget(item_2)
     with qtbot.waitSignal(plugin_dialog.installer.allFinished, timeout=60_000):
@@ -507,6 +579,9 @@ def test_cancel_all(qtbot, tmp_virtualenv, plugin_dialog, request):
         widget_2.action_button.click()
         plugin_dialog.cancel_all_btn.click()
 
+    plugin_dialog.search('')
+    qtbot.wait(500)
+
     assert plugin_dialog.available_list.count() == 2
     assert plugin_dialog.installed_list.count() == 2
 
@@ -514,7 +589,7 @@ def test_cancel_all(qtbot, tmp_virtualenv, plugin_dialog, request):
 def test_direct_entry_installs(qtbot, tmp_virtualenv, plugin_dialog, request):
     if "[constructor]" in request.node.name:
         pytest.skip(
-            reason="This test is only relevant for constructor-based installs"
+            reason="The tested functionality is not available in constructor-based installs"
         )
 
     plugin_dialog.set_prefix(str(tmp_virtualenv))
@@ -530,17 +605,66 @@ def test_direct_entry_installs(qtbot, tmp_virtualenv, plugin_dialog, request):
     qtbot.wait(5000)
 
 
+@pytest.mark.skipif(
+    sys.platform.startswith('linux'), reason="Test fails on linux randomly"
+)
 def test_shortcut_close(plugin_dialog, qtbot):
     qtbot.keyClicks(
         plugin_dialog, 'W', modifier=Qt.KeyboardModifier.ControlModifier
     )
-    qtbot.wait(200)
+    qtbot.wait(500)
     assert not plugin_dialog.isVisible()
 
 
+@pytest.mark.skipif(
+    sys.platform.startswith('linux'), reason="Test fails on linux randomly"
+)
 def test_shortcut_quit(plugin_dialog, qtbot):
     qtbot.keyClicks(
         plugin_dialog, 'Q', modifier=Qt.KeyboardModifier.ControlModifier
     )
-    qtbot.wait(200)
+    qtbot.wait(500)
     assert not plugin_dialog.isVisible()
+
+
+@pytest.mark.skipif(
+    not sys.platform.startswith('linux'), reason="Test works only on linux"
+)
+def test_export_plugins_button(plugin_dialog):
+    def _timer():
+        dialog = QApplication.activeModalWidget()
+        dialog.reject()
+
+    timer = QTimer()
+    timer.setSingleShot(True)
+    timer.timeout.connect(_timer)
+    timer.start(4_000)
+    plugin_dialog.export_button.click()
+
+
+def test_export_plugins(plugin_dialog, tmp_path):
+    plugins_file = 'plugins.txt'
+    plugin_dialog.export_plugins(str(tmp_path / plugins_file))
+    assert (tmp_path / plugins_file).exists()
+
+
+@pytest.mark.skipif(
+    not sys.platform.startswith('linux'), reason="Test works only on linux"
+)
+def test_import_plugins_button(plugin_dialog):
+    def _timer():
+        dialog = QApplication.activeModalWidget()
+        dialog.reject()
+
+    timer = QTimer()
+    timer.setSingleShot(True)
+    timer.timeout.connect(_timer)
+    timer.start(4_000)
+    plugin_dialog.import_button.click()
+
+
+def test_import_plugins(plugin_dialog, tmp_path, qtbot):
+    path = tmp_path / 'plugins.txt'
+    path.write_text('requests\npyzenhub\n')
+    with qtbot.waitSignal(plugin_dialog.installer.allFinished, timeout=60_000):
+        plugin_dialog.import_plugins(str(path))

napari_plugin_manager/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.3'
-__version_tuple__ = version_tuple = (0, 1, 3)
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)