Merge pull request #235 from sebastianst/feat-options_after

Implement `options_after` window option

Author: tony

doc/examples.rst

@@ -301,6 +301,25 @@ JSON
 .. literalinclude:: ../examples/options.json
     :language: json
 
+Set window options after pane creation
+--------------------------------------
+
+Apply window options after panes have been created. Useful for
+``synchronize-panes`` option after executing individual commands in each
+pane during creation.
+
+YAML
+~~~~
+
+.. literalinclude:: ../examples/2-pane-synchronized.yaml
+    :language: yaml
+
+JSON
+~~~~
+
+.. literalinclude:: ../examples/2-pane-synchronized.json
+    :language: json
+
 Main pane height
 ----------------
 

examples/2-pane-synchronized.json

@@ -0,0 +1,15 @@
+{
+  "session_name": "2-pane-synchronized",
+  "windows": [
+    {
+      "window_name": "Two synchronized panes",
+      "panes": [
+        "ssh server1",
+        "ssh server2"
+      ],
+      "options_after": {
+        "synchronize-panes": true
+      }
+    }
+  ]
+}

examples/2-pane-synchronized.yaml

@@ -0,0 +1,8 @@
+session_name: 2-pane-synchronized
+windows:
+  - window_name: Two synchronized panes
+    panes:
+    - ssh server1
+    - ssh server2
+    options_after:
+      synchronize-panes: on

tests/fixtures/workspacebuilder/window_options_after.yaml

@@ -0,0 +1,11 @@
+session_name: tmuxp test window_options_after
+options:
+  default-shell: /bin/bash
+windows:
+  - window_name: test
+    suppress_history: false
+    panes:
+    - echo 0
+    - echo 1
+    options_after:
+      synchronize-panes: on

tests/test_workspacebuilder.py

@@ -259,6 +259,51 @@ def test_window_options(session):
         w.select_layout(wconf['layout'])
 
 
+@pytest.mark.flaky(reruns=5)
+def test_window_options_after(session):
+    yaml_config = loadfixture("workspacebuilder/window_options_after.yaml")
+    s = session
+    sconfig = kaptan.Kaptan(handler='yaml')
+    sconfig = sconfig.import_config(yaml_config).get()
+    sconfig = config.expand(sconfig)
+
+    builder = WorkspaceBuilder(sconf=sconfig)
+    builder.build(session=session)
+
+    def assert_last_line(p, s):
+        correct = False
+        for _ in range(10):
+            pane_out = p.cmd('capture-pane', '-p', '-J').stdout
+            # delete trailing empty lines for tmux 1.8...
+            while not pane_out[-1].strip(): pane_out.pop()
+            if len(pane_out) > 1 and pane_out[-2].strip() == s:
+                correct = True
+                break
+
+            time.sleep(0.1)
+
+        # Print output for easier debugging if assertion fails
+        if not correct:
+            print('\n'.join(pane_out))
+
+        return correct
+
+    for i, pane in enumerate(session.attached_window.panes):
+        assert assert_last_line(pane, str(i)), \
+                "Initial command did not execute properly/" + str(i)
+        pane.cmd('send-keys', 'Up') # Will repeat echo
+        pane.enter()                # in each iteration
+        assert assert_last_line(pane, str(i)), \
+                "Repeated command did not execute properly/" + str(i)
+
+    session.cmd('send-keys', ' echo moo')
+    session.cmd('send-keys', 'Enter')
+
+    for pane in session.attached_window.panes:
+        assert assert_last_line(pane, 'moo'), \
+                "Synchronized command did not execute properly"
+
+
 def test_window_shell(session):
     yaml_config = loadfixture("workspacebuilder/window_shell.yaml")
     s = session

tmuxp/workspacebuilder.py

@@ -188,6 +188,8 @@ def build(self, session=None):
             if 'focus' in wconf and wconf['focus']:
                 focus = w
 
+            self.config_after_window(w, wconf)
+
             if focus_pane:
                 focus_pane.select_pane()
 
@@ -308,6 +310,14 @@ def get_pane_start_directory():
 
             yield p, pconf
 
+    """
+    Applies window configurations relevant after window and pane creation.
+    """
+    def config_after_window(self, w, wconf):
+        if 'options_after' in wconf and isinstance(wconf['options_after'], dict):
+            for key, val in wconf['options_after'].items():
+                w.set_window_option(key, val)
+
 
 def freeze(session):
     """Freeze live tmux session and Return session config :py:obj:`dict`.