Working on version contraints for the plugin system. Moved the load_plugin function and corresponding tests. Add a way to skip loading a plugin if it failed to load

Author: joseph-flinn

docs/plugin_system.rst

@@ -39,20 +39,44 @@ tmuxp expects all plugins to be class within a python submodule named
 python environment. A plugin interface is provided by tmuxp to inherit. 
 
 `poetry`_ is the chosen python package manager for tmuxp. It is highly 
-suggested to use it when developing tmuxp plugins; however, ``pip`` will work 
-just as well. Only one of the configuration files is needed for the packaging tool that the
-package developer desides to use. 
+suggested to use it when developing plugins; however, ``pip`` will work 
+just as well. Only one of the configuration files is needed for the packaging 
+tool that the package developer desides to use. 
 
 .. code-block:: bash
 
     python_module
-    ├── my_plugin_module
+    ├── tmuxp_plugin_my_plugin_module
     │   ├── __init__.py
     │   └── plugin.py
     ├── pyproject.toml  # Poetry's module configuration file
     └── setup.py        # pip's module configuration file
 
 
+When publishing plugins to pypi, tmuxp advocates for standardized naming: 
+``tmuxp-plugin-{your-plugin-name}`` to allow for easier searching. To create a 
+module configuration file with poetry, run ``poetry init`` in the module 
+directory. The resulting file looks something like this:
+
+.. code-block:: toml
+
+    [tool.poetry]
+    name = "tmuxp-plugin-my-tmuxp-plugin"
+    version = "0.0.2"
+    description = "An example tmuxp plugin."
+    authors = ["Author Name <author.name@<domain>.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"
+
+
 The `plugin.py` file could contain something like the following:
 
 .. code-block:: python
@@ -63,13 +87,18 @@ The `plugin.py` file could contain something like the following:
     class MyTmuxpPlugin(TmuxpPluginInterface):
         def __init__(self):
             """
-            Currently optional.
-
-            In the current version of the plugin interface, the __init__
-            isn't being utilized. However, it does provide a space for 
-            later additions to the interface.
+            Initialize my custom plugin.
             """
-            super.__init__(self)
+            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']
 
         def before_workspace_builder(self, session):
             session.rename_session('my-new-session-name')
@@ -78,6 +107,7 @@ The `plugin.py` file could contain something like the following:
             now = datetime.datetime.now().strftime('%Y-%m-%d')
             session.rename_session('session_{}'.format(now))
 
+
 Once this plugin is installed in the local python environment, it can be used
 in a configuration file like the following:
 

pyproject.toml

@@ -3,7 +3,7 @@ skip-string-normalization = true
 
 [tool.poetry]
 name = "tmuxp"
-version = "1.5.6"
+version = "1.6.0"
 description = "tmux session manager"
 license = "MIT"
 authors = ["Tony Narlock <tony@git-pull.com>"]

tests/fixtures/pluginsystem/__init__.py

@@ -0,0 +1,17 @@
+from .test_plugin_helpers import TestTmuxpPluginInterface
+
+
+class AllVersionPassPlugin(TestTmuxpPluginInterface):
+    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'],
+            '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)

tests/fixtures/pluginsystem/partials/__init__.py

@@ -0,0 +1,16 @@
+from tmuxp.plugin import TmuxpPluginInterface
+
+class TestTmuxpPluginInterface(TmuxpPluginInterface):
+    def __init__(self, config):
+        tmux_version = config.pop('tmux_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 tmuxp_version:
+            self.version_constraints['tmuxp']['version'] = tmuxp_version
+
+        self._version_check()

tests/fixtures/pluginsystem/partials/all_pass.py

@@ -0,0 +1,32 @@
+from .test_plugin_helpers import TestTmuxpPluginInterface
+
+
+class TmuxVersionFailMinPlugin(TestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'tmux-min-version-fail',
+            'tmux_min_version': '1.8',
+            'tmux_version': '1.7'
+        }
+        TestTmuxpPluginInterface.__init__(self, config)
+
+
+class TmuxVersionFailMaxPlugin(TestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'tmux-max-version-fail',
+            'tmux_min_version': '3.0',
+            'tmux_version': '3.5'
+        }
+        TestTmuxpPluginInterface.__init__(self, config)
+
+
+class TmuxVersionFailIncompatiblePlugin(TestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'tmux-incompatible-version-fail',
+            'tmux_version_incompatible': ['2.3'],
+            'tmux_version': '2.3'
+        }
+
+        TestTmuxpPluginInterface.__init__(self, config)

tests/fixtures/pluginsystem/partials/test_plugin_helpers.py

@@ -0,0 +1,31 @@
+from .test_plugin_helpers import TestTmuxpPluginInterface
+
+
+class TmuxpVersionFailMinPlugin(TestTmuxpPluginInterface):
+    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)
+
+
+class TmuxpVersionFailMaxPlugin(TestTmuxpPluginInterface):
+    def __init__(self):
+        config = {
+            'plugin_name': 'tmuxp-max-verion-fail',
+            'tmuxp_min_version': '2.0.0',
+            'tmuxp_version': '2.5'
+        }
+        TestTmuxpPluginInterface.__init__(self, config)
+
+
+class TmuxpVersionFailIncompatiblePlugin(TestTmuxpPluginInterface):
+    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)

tests/fixtures/pluginsystem/partials/tmux_version_fail.py

@@ -6,7 +6,7 @@ authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.5"
-tmuxp = "^1.5.6"
+tmuxp = "^1.6.0"
 
 [tool.poetry.dev-dependencies]
 

tests/fixtures/pluginsystem/partials/tmuxp_version_fail.py

@@ -6,7 +6,7 @@ authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.5"
-tmuxp = "^1.5.6"
+tmuxp = "^1.6.0."
 
 [tool.poetry.dev-dependencies]
 

tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.5"
-tmuxp = "^1.5.6"
+tmuxp = "^1.6.0"
 
 [tool.poetry.dev-dependencies]
 

tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.5"
-tmuxp = "^1.5.6"
+tmuxp = "^1.6.0"
 
 [tool.poetry.dev-dependencies]
 

tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Joseph Flinn <joseph.s.flinn@gmail.com>"]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.5"
-tmuxp = "^1.5.6"
+tmuxp = "^1.6.0"
 
 [tool.poetry.dev-dependencies]
 

tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/pyproject.toml

@@ -22,8 +22,10 @@
     load_workspace,
     scan_config,
     _reattach,
+    load_plugins,
 )
 from tmuxp.workspacebuilder import WorkspaceBuilder
+from tmuxp_test_plugin_bwb.plugin import PluginBeforeWorkspaceBuilder
 
 from .fixtures._util import curjoin, loadfixture
 
@@ -681,6 +683,24 @@ def test_ls_cli(monkeypatch, tmpdir):
     assert cli_output == '\n'.join(stems) + '\n'
 
 
+def test_load_plugins():
+    plugins_config = loadfixture("workspacebuilder/plugin_bwb.yaml")
+
+    sconfig = kaptan.Kaptan(handler='yaml')
+    sconfig = sconfig.import_config(plugins_config).get()
+    sconfig = config.expand(sconfig)
+
+    plugins = load_plugins(sconfig)
+
+    assert len(plugins) == 1
+
+    test_plugin_class_types = [
+        PluginBeforeWorkspaceBuilder().__class__,
+    ]
+    for plugin in plugins:
+        assert plugin.__class__ in test_plugin_class_types
+
+
 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
@@ -705,7 +725,11 @@ def test_reattach_plugins(server):
     sconfig = config.expand(sconfig)
 
     # open it detached
-    builder = WorkspaceBuilder(sconf=sconfig, server=server)
+    builder = WorkspaceBuilder(
+        sconf=sconfig, 
+        plugins=load_plugins(sconfig), 
+        server=server
+    )
     builder.build()
 
     try:

tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/pyproject.toml

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+"""Test for tmuxp plugin api."""
+from __future__ import absolute_import
+
+import json
+import os
+
+import pytest
+
+import libtmux
+from libtmux.common import has_lt_version
+from tmuxp.plugin import TmuxpPluginInterface
+from tmuxp.exc import TmuxpPluginException
+
+from .fixtures.pluginsystem.partials.all_pass import AllVersionPassPlugin
+from .fixtures.pluginsystem.partials.tmux_version_fail import (
+    TmuxVersionFailMinPlugin,
+    TmuxVersionFailMaxPlugin,
+    TmuxVersionFailIncompatiblePlugin
+)
+from .fixtures.pluginsystem.partials.tmuxp_version_fail import (
+    TmuxpVersionFailMinPlugin,
+    TmuxpVersionFailMaxPlugin,
+    TmuxpVersionFailIncompatiblePlugin 
+)
+
+
+def test_all_pass():
+    try:
+        plugin = AllVersionPassPlugin()
+        assert(True)
+    except TmuxpPluginException as error:
+        assert(False)
+
+
+def test_tmux_version_fail_min():
+    try:
+        plugin = TmuxVersionFailMinPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_tmux_version_fail_max():
+    try:
+        plugin = TmuxVersionFailMaxPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_tmux_version_fail_incompatible():
+    try:
+        plugin = TmuxVersionFailIncompatiblePlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_tmuxp_version_fail_min():
+    try:
+        plugin = TmuxpVersionFailMinPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_tmux_version_fail_max():
+    try:
+        plugin = TmuxpVersionFailMaxPlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())
+
+
+def test_tmux_version_fail_incompatible():
+    try:
+        plugin = TmuxpVersionFailIncompatiblePlugin()
+        assert(False)
+    except TmuxpPluginException as error:
+        assert('Incompatible' in error.__str__())