Adding in test plugins. Got these plugins to programmitcally install with python for testing purposes. Started rudimentary config testing. Started working on the cli.load_plugins test.

joseph-flinn · joseph-flinn · commit 03bf7e22c102 · 2020-11-07T11:21:24.000-08:00
diff --git a/requirements/test.txt b/requirements/test.txt
@@ -3,3 +3,4 @@ pytest-rerunfailures<9
 pytest-cov
 coverage
 codecov
+wheel
diff --git a/tests/fixtures/pluginsystem/install_plugins.py b/tests/fixtures/pluginsystem/install_plugins.py
@@ -0,0 +1,21 @@
+import subprocess
+import sys
+
+
+plugin_paths = [
+    "plugins/tmuxp_plugin_one",
+    "plugins/tmuxp_plugin_two"
+]
+
+
+def install(package):
+    subprocess.check_call([sys.executable, "-m", "pip", "install", package])
+
+
+def install_plugins():
+    for plugin in plugin_paths:
+        install(plugin)
+
+
+if __name__ == "__main__":
+    install_plugins()
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/setup.py
@@ -0,0 +1,10 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp-plugin-one',
+    version='0.0.1',
+    author='Joseph Flinn',
+    author_email='joseph.s.flinn@gmail.com',
+    packages=setuptools.find_packages(),
+    description='A tmuxp plugin to test the plugin system',
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/tmuxp_plugin_one/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/tmuxp_plugin_one/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/tmuxp_plugin_one/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_one/tmuxp_plugin_one/plugin.py
@@ -0,0 +1,19 @@
+class TestPluginOne:
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def before_workspace_builder(self, session):
+        pass
+
+    def before_script(self, session):
+        pass
+
+    def reattach(self, session):
+        pass
+
+    def on_window_create(self, window):
+        if window.name == 'editor': 
+            pass
+
+    def after_window_finished(self, window):  
+        pass
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/setup.py
@@ -0,0 +1,10 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp-plugin-two',
+    version='0.0.1',
+    author='Joseph Flinn',
+    author_email='joseph.s.flinn@gmail.com',
+    packages=setuptools.find_packages(),
+    description='A tmuxp plugin to test the plugin system',
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/tmuxp_plugin_two/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/tmuxp_plugin_two/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/tmuxp_plugin_two/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_two/tmuxp_plugin_two/plugin.py
@@ -0,0 +1,19 @@
+class TestPluginTwo:
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def before_workspace_builder(self, session):
+        pass
+
+    def before_script(self, session):
+        pass
+
+    def reattach(self, session):
+        pass
+
+    def on_window_create(self, window):
+        if window.name == 'editor': 
+            pass
+
+    def after_window_finished(self, window):  
+        pass
diff --git a/tests/fixtures/workspacebuilder/plugins_one.yaml b/tests/fixtures/workspacebuilder/plugins_one.yaml
@@ -0,0 +1,15 @@
+session_name: plugin-test
+plugins:
+- 'tmuxp_plugin_one.plugin.TestPluginOne'
+windows:
+- window_name: editor
+  layout: tiled
+  shell_command_before:
+    - cd ~/
+  panes:
+    - shell_command:
+        - cd /var/log
+        - ls -al | grep \.log
+    - echo hello
+    - echo hello
+    - echo hello
diff --git a/tests/fixtures/workspacebuilder/plugins_two.yaml b/tests/fixtures/workspacebuilder/plugins_two.yaml
@@ -0,0 +1,16 @@
+session_name: plugin-test
+plugins:
+- 'tmuxp_plugin_one.plugin.TestPluginOne'
+- 'tmuxp_plugin_two.plugin.TestPluginTwo'
+windows:
+- window_name: editor
+  layout: tiled
+  shell_command_before:
+    - cd ~/
+  panes:
+    - shell_command:
+        - cd /var/log
+        - ls -al | grep \.log
+    - echo hello
+    - echo hello
+    - echo hello
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -20,10 +20,12 @@
     is_pure_name,
     load_workspace,
     scan_config,
+    load_plugins,
 )
 
 from .fixtures._util import curjoin, loadfixture
-
+from tmuxp_plugin_one.plugin import TestPluginOne
+from tmuxp_plugin_two.plugin import TestPluginTwo
 
 def test_creates_config_dir_not_exists(tmpdir):
     """cli.startup() creates config dir if not exists."""
@@ -267,6 +269,19 @@ def check_cmd(config_arg):
         assert 'config not found in config dir' in check_cmd('moo')
 
 
+def test_load_plugins():
+    session_config = curjoin("workspacebuildter/plugins_two.yaml")
+    plugins = load_plugins(session_config)
+    assert len(plugins) == 2
+
+    test_plugin_class_types = [
+        TestPluginOne().__class__, 
+        TestPluginTwo().__class__
+    ]
+    for plugin in plugins: 
+        assert plugin.__class__ in test_plugin_class_types
+
+
 def test_load_workspace(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_config.py b/tests/test_config.py
@@ -383,3 +383,23 @@ def test_replaces_env_variables(monkeypatch):
     assert "%s/moo" % env_val == sconfig['global_options']['default-shell']
     assert "%s/lol" % env_val == sconfig['options']['default-command']
     assert "logging @ %s" % env_val == sconfig['windows'][1]['window_name']
+
+
+def test_plugins():
+    yaml_config = """
+    session_name: test session
+    plugins: tmuxp-plugin-one.plugin.TestPluginOne
+    windows:
+    - window_name: editor
+      panes:
+      shell_command:
+      - tail -F /var/log/syslog
+      start_directory: /var/log
+    """
+
+    sconfig = kaptan.Kaptan(handler='yaml')
+    sconfig = sconfig.import_config(yaml_config).get()
+
+    with pytest.raises(exc.ConfigError) as excinfo:
+        config.validate_schema(sconfig)
+        assert excinfo.matches('only supports list type')
diff --git a/tmuxp/cli.py b/tmuxp/cli.py
@@ -193,34 +193,6 @@ def set_layout_hook(session, hook_name):
     session.cmd(*cmd)
 
 
-def load_plugins(sconfig):
-    plugins = []
-    if 'plugins' in sconfig:
-        for plugin in sconfig['plugins']:
-            try:
-                """
-                click.echo(
-                    click.style('[Loading] ', fg='green')
-                    + click.style(f'Plugin: {plugin}', fg='blue', bold=True)
-                )
-                """
-                module_name = plugin.split('.')
-                module_name = '.'.join(module_name[:-1])
-                plugin_name = plugin.split('.')[-1]
-                plugin = getattr(importlib.import_module(module_name), plugin_name)
-                plugins.append(plugin())
-            except Exception as error:
-                click.echo(
-                    click.wrap_text(
-                        f'Error in loading {plugin}. Please make '
-                        f'sure {plugin} is installed.\n\n'
-                        f'{error}'
-                    )
-                )
-
-    return plugins
-
-
 def is_pure_name(path):
     """
     Return True if path is a name and not a file path.
@@ -401,6 +373,34 @@ def scan_config(config, config_dir=None):
     return config
 
 
+def load_plugins(config):
+    plugins = []
+    if 'plugins' in config:
+        for plugin in config['plugins']:
+            try:
+                """
+                click.echo(
+                    click.style('[Loading] ', fg='green')
+                    + click.style(f'Plugin: {plugin}', fg='blue', bold=True)
+                )
+                """
+                module_name = plugin.split('.')
+                module_name = '.'.join(module_name[:-1])
+                plugin_name = plugin.split('.')[-1]
+                plugin = getattr(importlib.import_module(module_name), plugin_name)
+                plugins.append(plugin())
+            except Exception as error:
+                click.echo(
+                    click.wrap_text(
+                        f'Error in loading {plugin}. Please make ' \
+                        f'sure {plugin} is installed.\n\n' \
+                        f'{error}' \
+                    )
+                )
+
+    return plugins
+
+
 def _reattach(session, plugins):
     """
     Reattach session (depending on env being inside tmux already or not)
