Redoing the plugin fixtures for testing

joseph-flinn · joseph-flinn · commit 53f672be28a1 · 2020-11-07T11:21:24.000-08:00
diff --git a/tests/fixtures/pluginsystem/install_plugins.py b/tests/fixtures/pluginsystem/install_plugins.py
@@ -3,14 +3,18 @@
 
 
 plugin_paths = [
-    "plugins/tmuxp_plugin_one",
-    "plugins/tmuxp_plugin_two"
+    "plugins/tmuxp_plugin_interface",
+    "plugins/tmuxp_test_plugin_bwb",
+    "plugins/tmuxp_test_plugin_bs",
+    "plugins/tmuxp_test_plugin_r",
+    "plugins/tmuxp_test_plugin_owc",
+    "plugins/tmuxp_test_plugin_awf",
 ]
 
 
 def install(package):
     subprocess.check_call([sys.executable, "-m", "pip", "install", package])
-
+    
 
 def install_plugins():
     for plugin in plugin_paths:
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/setup.py
@@ -1,10 +1,10 @@
 from setuptools import setup
 
 setup(
-    name='tmuxp-plugin-one',
+    name='tmuxp_plugin_interface',
     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',
+    description='A tmuxp plugin class interface',
 )
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/tmuxp_plugin_interface/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/tmuxp_plugin_interface/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/tmuxp_plugin_interface/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_plugin_interface/tmuxp_plugin_interface/plugin.py
@@ -1,6 +1,6 @@
-class TestPluginTwo:
+class TmuxpPluginInterface:
     def __init__(self):
-        self.message = f'[+] This is the Tmuxp Test Plugin'
+        pass
 
     def before_workspace_builder(self, session):
         pass
@@ -12,8 +12,7 @@ def reattach(self, session):
         pass
 
     def on_window_create(self, window):
-        if window.name == 'editor': 
-            pass
+        pass
 
     def after_window_finished(self, window):  
-        pass
+        pass
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
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/setup.py
@@ -0,0 +1,13 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp_test_plugin_awf',
+    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 after_window_finished part of the '
+        'plugin system'
+    ),
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/tmuxp_test_plugin_awf/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/tmuxp_test_plugin_awf/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/tmuxp_test_plugin_awf/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_awf/tmuxp_test_plugin_awf/plugin.py
@@ -0,0 +1,8 @@
+from tmuxp_plugin_interface.plugin import TmuxpPluginInterface
+
+class PluginAfterWindowFinished(TmuxpPluginInterface):
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def after_window_finished(self, window):  
+        pass
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/setup.py
@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp_test_plugin_bs',
+    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 before_script part of the plugin system'
+    ),
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/tmuxp_test_plugin_bs/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/tmuxp_test_plugin_bs/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/tmuxp_test_plugin_bs/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/tmuxp_test_plugin_bs/plugin.py
@@ -0,0 +1,8 @@
+from tmuxp_plugin_interface.plugin import TmuxpPluginInterface
+
+class PluginBeforeScript(TmuxpPluginInterface):
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def before_script(self, session):
+        pass
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/setup.py
@@ -0,0 +1,13 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp_test_plugin_bwb',
+    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 before_workspace_builder part of the '
+        'plugin system'
+    ),
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/tmuxp_test_plugin_bwb/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/tmuxp_test_plugin_bwb/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/tmuxp_test_plugin_bwb/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/tmuxp_test_plugin_bwb/plugin.py
@@ -0,0 +1,9 @@
+from tmuxp_plugin_interface.plugin import TmuxpPluginInterface
+
+class PluginBeforeWorkspaceBuilder(TmuxpPluginInterface):
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def before_workspace_builder(self, session):
+        session.rename_session('plugin_test_bwb')
+
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/setup.py
@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(
+    name='tmuxp_test_plugin_owc',
+    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 on_window_create part of the plugin system'
+    ),
+)
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/tmuxp_test_plugin_owc/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/tmuxp_test_plugin_owc/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/tmuxp_test_plugin_owc/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_owc/tmuxp_test_plugin_owc/plugin.py
@@ -0,0 +1,9 @@
+from tmuxp_plugin_interface.plugin import TmuxpPluginInterface
+
+class PluginOnWindowCreate(TmuxpPluginInterface):
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def on_window_create(self, window):
+        if window.name == 'editor': 
+            pass
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/setup.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/setup.py
@@ -1,10 +1,12 @@
 from setuptools import setup
 
 setup(
-    name='tmuxp-plugin-two',
+    name='tmuxp_test_plugin_r',
     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',
+    description=(
+        'A tmuxp plugin to test the reattach part of the plugin system'
+    ),
 )
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/tmuxp_test_plugin_r/__init__.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/tmuxp_test_plugin_r/__init__.py
diff --git a/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/tmuxp_test_plugin_r/plugin.py b/tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_r/tmuxp_test_plugin_r/plugin.py
@@ -0,0 +1,8 @@
+from tmuxp_plugin_interface.plugin import TmuxpPluginInterface
+
+class PluginReattach(TmuxpPluginInterface):
+    def __init__(self):
+        self.message = f'[+] This is the Tmuxp Test Plugin'
+
+    def reattach(self, session):
+        pass
diff --git a/tests/fixtures/workspacebuilder/plugin_awf.yaml b/tests/fixtures/workspacebuilder/plugin_awf.yaml
@@ -1,7 +1,6 @@
-session_name: plugin-test
+session_name: plugin-test-awf
 plugins:
-- 'tmuxp_plugin_one.plugin.TestPluginOne'
-- 'tmuxp_plugin_two.plugin.TestPluginTwo'
+- 'tmuxp_test_plugin_awf.plugin.TestPluginAfterWindowFinished'
 windows:
 - window_name: editor
   layout: tiled
diff --git a/tests/fixtures/workspacebuilder/plugin_bs.yaml b/tests/fixtures/workspacebuilder/plugin_bs.yaml
@@ -0,0 +1,15 @@
+session_name: plugin-test-bs
+plugins:
+- 'tmuxp_test_plugin_bs.plugin.TestPluginBeforeScript'
+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/plugin_bwb.yaml b/tests/fixtures/workspacebuilder/plugin_bwb.yaml
@@ -0,0 +1,15 @@
+session_name: plugin-test-bwb
+plugins:
+- 'tmuxp_test_plugin_bwb.plugin.TestPluginBeforeWorkspaceBuild'
+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/plugin_owc.yaml b/tests/fixtures/workspacebuilder/plugin_owc.yaml
@@ -0,0 +1,15 @@
+session_name: plugin-test-owc
+plugins:
+- 'tmuxp_test_plugin_owc.plugin.TestPluginOnWindowCreate'
+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/plugin_r.yaml b/tests/fixtures/workspacebuilder/plugin_r.yaml
@@ -1,6 +1,6 @@
-session_name: plugin-test
+session_name: plugin-test-r
 plugins:
-- 'tmuxp_plugin_one.plugin.TestPluginOne'
+- 'tmuxp_test_plugin_r.plugin.TestPluginReattach'
 windows:
 - window_name: editor
   layout: tiled
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -24,8 +24,7 @@
 )
 
 from .fixtures._util import curjoin, loadfixture
-from tmuxp_plugin_one.plugin import TestPluginOne
-from tmuxp_plugin_two.plugin import TestPluginTwo
+from tmuxp_test_plugin_bwb.plugin import PluginBeforeWorkspaceBuilder
 
 def test_creates_config_dir_not_exists(tmpdir):
     """cli.startup() creates config dir if not exists."""
@@ -270,13 +269,12 @@ def check_cmd(config_arg):
 
 
 def test_load_plugins():
-    session_config = curjoin("workspacebuildter/plugins_two.yaml")
+    session_config = curjoin("workspacebuildter/plugin_bwb.yaml")
     plugins = load_plugins(session_config)
-    assert len(plugins) == 2
+    assert len(plugins) == 1
 
     test_plugin_class_types = [
-        TestPluginOne().__class__, 
-        TestPluginTwo().__class__
+        PluginBeforeWorkspaceBuilder().__class__, 
     ]
     for plugin in plugins: 
         assert plugin.__class__ in test_plugin_class_types
diff --git a/tests/test_workspacebuilder.py b/tests/test_workspacebuilder.py
@@ -673,3 +673,20 @@ def test_before_load_true_if_test_passes_with_args(server):
 
     with temp_session(server) as session:
         builder.build(session=session)
+
+
+def test_plugin_system_before_workspace_builder(session):
+    config_plugins = loadfixture("workspacebuilder/plugin_bwb.yaml")
+
+    sconfig = kaptan.Kaptan(handler='yaml')
+    sconfig = sconfig.import_config(config_plugins).get()
+    sconfig = config.expand(sconfig)
+
+    builder = WorkspaceBuilder(sconf=sconfig)
+    assert len(builder.plugins) > 0
+
+    builder.build(session)
+    assert session.cmd('display-message', '-p', "'#S'") == 'plugin_test_bwb'
+
+
+
