Finishing up the version contraints of the plugin system as well as skipping plugin load if the fail

joseph-flinn · joseph-flinn · commit 274238177568 · 2020-11-07T11:23:49.000-08:00
diff --git a/docs/plugin_system.rst b/docs/plugin_system.rst
@@ -89,16 +89,17 @@ The `plugin.py` file could contain something like the following:
             """
             Initialize my custom plugin.
             """
-            super().__init__()
-
-            # Optional version dependency configurations:
-            self.plugin_name = 'tmuxp-plugin-my-tmuxp-plugin'
-            self.tmux_min_version = '1.8'
-            self.tmux_max_version = '2.4'
-            self.tmux_version_incompatible = ['2.3']
-            self.tmuxp_min_version = '1.6.0'
-            self.tmuxp_max_version = '1.6.2'
-            self.tmuxp_version_incompatible = ['1.6.1']
+            # Optional version dependency configuration. See Plugin API docs 
+            # for all supported config parameters
+            config = {
+                'tmuxp_min_version' = '1.6.2'
+            }
+
+            TmuxpPluginInterface.__init__(
+                self,
+                plugin_name='tmuxp-plugin-my-tmuxp-plugin',
+                **config
+            )
 
         def before_workspace_builder(self, session):
             session.rename_session('my-new-session-name')
diff --git a/pyproject.toml b/pyproject.toml
@@ -74,6 +74,7 @@ tmuxp-test-plugin-bs = { path = "tests/fixtures/pluginsystem/plugins/tmuxp_test_
 tmuxp-test-plugin-r = { path = "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/"}
 tmuxp-test-plugin-owc = { path = "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/"}
 tmuxp-test-plugin-awf = { path = "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/"}
+tmuxp-test-plugin-fail = { path = "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/"}
 
 ### Coverage ###
 codecov = "*"
diff --git a/tests/fixtures/pluginsystem/partials/all_pass.py b/tests/fixtures/pluginsystem/partials/all_pass.py
@@ -1,17 +1,20 @@
-from .test_plugin_helpers import TestTmuxpPluginInterface
+from .test_plugin_helpers import MyTestTmuxpPluginInterface
 
 
-class AllVersionPassPlugin(TestTmuxpPluginInterface):
+class AllVersionPassPlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmuxp-plugin-my-tmuxp-plugin',
             'tmux_min_version': '1.8',
             'tmux_max_version': '100.0',
             'tmux_version_incompatible': ['2.3'],
+            'libtmux_min_version': '0.8.3',
+            'libtmux_max_version': '100.0',
+            'libtmux_version_incompatible': ['0.7.1'],
             'tmuxp_min_version': '1.6.0',
             'tmuxp_max_version': '100.0.0',
             'tmuxp_version_incompatible': ['1.5.6'],
             'tmux_version': '3.0',
             'tmuxp_version': '1.6.0',
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
diff --git a/tests/fixtures/pluginsystem/partials/libtmux_version_fail.py b/tests/fixtures/pluginsystem/partials/libtmux_version_fail.py
@@ -0,0 +1,31 @@
+from .test_plugin_helpers import MyTestTmuxpPluginInterface
+
+
+class LibtmuxVersionFailMinPlugin(MyTestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'libtmux-min-version-fail',
+            'libtmux_min_version': '0.8.3',
+            'libtmux_version': '0.7.0'
+        }
+        MyTestTmuxpPluginInterface.__init__(self, config)
+
+
+class LibtmuxVersionFailMaxPlugin(MyTestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'libtmux-max-version-fail',
+            'libtmux_max_version': '3.0',
+            'libtmux_version': '3.5'
+        }
+        MyTestTmuxpPluginInterface.__init__(self, config)
+
+
+class LibtmuxVersionFailIncompatiblePlugin(MyTestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'libtmux-incompatible-version-fail',
+            'libtmux_version_incompatible': ['0.7.1'],
+            'libtmux_version': '0.7.1'
+        }
+        MyTestTmuxpPluginInterface.__init__(self, config)
diff --git a/tests/fixtures/pluginsystem/partials/test_plugin_helpers.py b/tests/fixtures/pluginsystem/partials/test_plugin_helpers.py
@@ -1,15 +1,18 @@
 from tmuxp.plugin import TmuxpPluginInterface
 
-class TestTmuxpPluginInterface(TmuxpPluginInterface):
+class MyTestTmuxpPluginInterface(TmuxpPluginInterface):
     def __init__(self, config):
         tmux_version = config.pop('tmux_version', None)
+        libtmux_version = config.pop('libtmux_version', None)
         tmuxp_version = config.pop('tmuxp_version', None)
 
         TmuxpPluginInterface.__init__(self, **config)
 
         # WARNING! This should not be done in anything but a test
         if tmux_version:
             self.version_constraints['tmux']['version'] = tmux_version
+        if libtmux_version:
+            self.version_constraints['libtmux']['version'] = libtmux_version
         if tmuxp_version:
             self.version_constraints['tmuxp']['version'] = tmuxp_version
 
diff --git a/tests/fixtures/pluginsystem/partials/tmux_version_fail.py b/tests/fixtures/pluginsystem/partials/tmux_version_fail.py
@@ -1,32 +1,32 @@
-from .test_plugin_helpers import TestTmuxpPluginInterface
+from .test_plugin_helpers import MyTestTmuxpPluginInterface
 
 
-class TmuxVersionFailMinPlugin(TestTmuxpPluginInterface):
+class TmuxVersionFailMinPlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmux-min-version-fail',
             'tmux_min_version': '1.8',
             'tmux_version': '1.7'
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
 
 
-class TmuxVersionFailMaxPlugin(TestTmuxpPluginInterface):
+class TmuxVersionFailMaxPlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmux-max-version-fail',
-            'tmux_min_version': '3.0',
+            'tmux_max_version': '3.0',
             'tmux_version': '3.5'
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
 
 
-class TmuxVersionFailIncompatiblePlugin(TestTmuxpPluginInterface):
+class TmuxVersionFailIncompatiblePlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmux-incompatible-version-fail',
             'tmux_version_incompatible': ['2.3'],
             'tmux_version': '2.3'
         }
 
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
diff --git a/tests/fixtures/pluginsystem/partials/tmuxp_version_fail.py b/tests/fixtures/pluginsystem/partials/tmuxp_version_fail.py
@@ -1,31 +1,31 @@
-from .test_plugin_helpers import TestTmuxpPluginInterface
+from .test_plugin_helpers import MyTestTmuxpPluginInterface
 
 
-class TmuxpVersionFailMinPlugin(TestTmuxpPluginInterface):
+class TmuxpVersionFailMinPlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmuxp-min-verion-fail',
             'tmuxp_min_version': '1.6.0',
             'tmuxp_version': '1.5.6'
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
 
 
-class TmuxpVersionFailMaxPlugin(TestTmuxpPluginInterface):
+class TmuxpVersionFailMaxPlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmuxp-max-verion-fail',
-            'tmuxp_min_version': '2.0.0',
+            'tmuxp_max_version': '2.0.0',
             'tmuxp_version': '2.5'
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
 
 
-class TmuxpVersionFailIncompatiblePlugin(TestTmuxpPluginInterface):
+class TmuxpVersionFailIncompatiblePlugin(MyTestTmuxpPluginInterface):
     def __init__(self):
         config = {
             'plugin_name': 'tmuxp-incompatible-verion-fail',
             'tmuxp_version_incompatible': ['1.5.0'],
             'tmuxp_version': '1.5.0'
         }
-        TestTmuxpPluginInterface.__init__(self, config)
+        MyTestTmuxpPluginInterface.__init__(self, config)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/pyproject.toml b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/pyproject.toml
@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "tmuxp_test_plugin_fail"
+version = "0.1.0"
+description = "A test plugin designed to fail to test the cli"
+authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
+
+[tool.poetry.dependencies]
+python = "~2.7 || ^3.5"
+tmuxp = "^1.6.0"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/tmuxp_test_plugin_fail/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/tmuxp_test_plugin_fail/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/tmuxp_test_plugin_fail/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/tmuxp_test_plugin_fail/plugin.py
@@ -0,0 +1,10 @@
+from tmuxp.plugin import TmuxpPluginInterface
+
+
+class PluginFailVersion(TmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'tmuxp-plugin-fail-version',
+            'tmuxp_max_version': '0.0.0',
+        }
+        TmuxpPluginInterface.__init__(self, **config)
diff --git a/tests/fixtures/workspacebuilder/plugin_missing_fail.yaml b/tests/fixtures/workspacebuilder/plugin_missing_fail.yaml
@@ -0,0 +1,6 @@
+session_name: plugin-test-missing-fail
+plugins:
+- 'tmuxp_test_plugin_fail.plugin.PluginFailMissing'
+windows:
+- panes:
+    - echo "hey"
diff --git a/tests/fixtures/workspacebuilder/plugin_versions_fail.yaml b/tests/fixtures/workspacebuilder/plugin_versions_fail.yaml
@@ -0,0 +1,6 @@
+session_name: plugin-test-version-fail
+plugins:
+- 'tmuxp_test_plugin_fail.plugin.PluginFailVersion'
+windows:
+- panes:
+    - echo "hey"
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -979,6 +979,45 @@ def test_load_plugins():
         assert plugin.__class__ in test_plugin_class_types
 
 
+@pytest.mark.skip('Not sure how to clean up the tmux session this makes')
+@pytest.mark.parametrize(
+    "cli_args,inputs",
+    [(
+        ['load', 'tests/fixtures/workspacebuilder/plugin_versions_fail.yaml'],
+        ['y\n'],
+    )],
+)
+def test_load_plugins_version_fail_skip(cli_args, inputs):
+    runner = CliRunner()
+
+    results = runner.invoke(cli.cli, cli_args, input=''.join(inputs)) 
+    assert '[Loading]' in results.output
+
+
+@pytest.mark.parametrize(
+    "cli_args,inputs",
+    [(
+        ['load', 'tests/fixtures/workspacebuilder/plugin_versions_fail.yaml'],
+        ['n\n'],
+    )],
+)
+def test_load_plugins_version_fail_no_skip(cli_args, inputs):
+    runner = CliRunner()
+
+    results = runner.invoke(cli.cli, cli_args, input=''.join(inputs)) 
+    assert '[Not Skipping]' in results.output
+
+
+@pytest.mark.parametrize("cli_args", [
+    (['load', 'tests/fixtures/workspacebuilder/plugin_missing_fail.yaml'])
+])
+def test_load_plugins_plugin_missing(cli_args):
+    runner = CliRunner()
+
+    results = runner.invoke(cli.cli, cli_args) 
+    assert '[Plugin Error]' in results.output
+
+
 def test_plugin_system_before_script(server, monkeypatch):
     # this is an implementation test. Since this testsuite may be ran within
     # a tmux session by the developer himself, delete the TMUX variable
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -18,6 +18,11 @@
     TmuxVersionFailMaxPlugin,
     TmuxVersionFailIncompatiblePlugin
 )
+from .fixtures.pluginsystem.partials.libtmux_version_fail import (
+    LibtmuxVersionFailMinPlugin,
+    LibtmuxVersionFailMaxPlugin,
+    LibtmuxVersionFailIncompatiblePlugin
+)
 from .fixtures.pluginsystem.partials.tmuxp_version_fail import (
     TmuxpVersionFailMinPlugin,
     TmuxpVersionFailMaxPlugin,
@@ -65,17 +70,40 @@ def test_tmuxp_version_fail_min():
         assert('Incompatible' in error.__str__())
 
 
-def test_tmux_version_fail_max():
+def test_tmuxp_version_fail_max():
     try:
         plugin = TmuxpVersionFailMaxPlugin()
         assert(False)
     except TmuxpPluginException as error:
         assert('Incompatible' in error.__str__())
 
 
-def test_tmux_version_fail_incompatible():
+def test_tmuxp_version_fail_incompatible():
     try:
         plugin = TmuxpVersionFailIncompatiblePlugin()
         assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+def test_libtmux_version_fail_min():
+    try:
+        plugin = LibtmuxVersionFailMinPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_libtmux_version_fail_max():
+    try:
+        plugin = LibtmuxVersionFailMaxPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_libtmux_version_fail_incompatible():
+    try:
+        plugin = LibtmuxVersionFailIncompatiblePlugin()
+        assert(False)
     except TmuxpPluginException as error:
         assert('Incompatible' in error.__str__())
diff --git a/tmuxp/cli.py b/tmuxp/cli.py
@@ -387,25 +387,23 @@ def load_plugins(sconf):
                 plugin = getattr(importlib.import_module(module_name), plugin_name)
                 plugins.append(plugin())
             except exc.TmuxpPluginException as error:
-                if (click.confirm(
-                    '%s Skip?' % click.style(error, fg='orange'), default=True
+                if (not click.confirm(
+                    '%sSkip loading %s?' 
+                    % (click.style(str(error), fg='yellow'), plugin_name), 
+                    default=True
                 )):
-                    pass
+                    click.echo(
+                        click.style('[Not Skipping] ', fg='yellow') 
+                        + 'Plugin verions constraint not met. Exiting...'
+                    )
+                    sys.exit(1)
             except Exception as error:
-                raise exc.TmuxpException(
-                    'Error in loading {0}. Please make sure {0} is '
-                    'installed.\n\n{1}'.format(plugin, error)
+                click.echo(
+                    click.style('[Plugin Error] ', fg='red')
+                    + "Couldn\'t load {0}\n".format(plugin)
+                    + click.style('{0}'.format(error), fg='yellow')
                 )
-
-        if not detached and (
-            answer_yes
-            or click.confirm(
-                '%s is already running. Attach?'
-                % click.style(session_name, fg='green'),
-                default=True,
-            )
-        ):
-            pass
+                sys.exit(1)
 
     return plugins
 
diff --git a/tmuxp/plugin.py b/tmuxp/plugin.py
