Add ability to specify session/global options

tony · tony · commit 035973190392 · 2016-06-15T22:53:02.000-05:00
Ability to specify ``options`` and ``global_options`` via configuration. Also you can specify environment variables via that. Add tests for it. Update libtmux to v0.5 See also: #65
diff --git a/CHANGES b/CHANGES
@@ -4,6 +4,11 @@ Changelog
 
 Here you can find the recent changes to tmuxp
 
+- :feature:`65` Ability to specify ``options`` and ``global_options`` via
+  configuration. Also you can specify environment variables via that.
+
+  Include tests.
+
 - :release:`1.1.1 <2016-06-02>`
 - :bug:`167 backported` fix attaching multiple sessions
 - :bug:`165 backported` fix typo in error output, thanks @fpietka
diff --git a/examples/env-variables.json b/examples/env-variables.json
@@ -1,5 +1,5 @@
 {
-  "before_script": "${MY_ENV_VAR}/test3.sh",
+  "before_script": "${MY_ENV_VAR}/test3.sh", 
   "windows": [
     {
       "panes": [
@@ -8,24 +8,26 @@
             "tail -F /var/log/syslog"
           ]
         }
-      ],
-      "start_directory": "/var/log",
+      ], 
+      "start_directory": "/var/log", 
       "window_name": "editor"
-    },
+    }, 
     {
       "panes": [
         {
           "shell_command": [
-            "htop",
+            "htop", 
             "ls $PWD"
           ]
         }
       ], 
-      "window_name": "logging for {USER}",
-      "automatic_rename": true
+      "window_name": "logging for ${USER}", 
+      "options": {
+        "automatic-rename": true
+      }
     }
-  ],
-  "shell_command_before": "echo ${PWD}",
-  "start_directory": "${PWD}/test",
+  ], 
+  "shell_command_before": "echo ${PWD}", 
+  "start_directory": "${PWD}/test", 
   "session_name": "session - ${USER} (${MY_ENV_VAR})"
-}
+}
diff --git a/examples/env-variables.yaml b/examples/env-variables.yaml
@@ -9,7 +9,8 @@ windows:
     - tail -F /var/log/syslog
   start_directory: /var/log
 - window_name: logging for ${USER}
-  automatic_rename: true
+  options:
+    automatic-rename: true
   panes:
   - shell_command:
     - htop
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -1,4 +1,4 @@
 kaptan>=0.5.7
-libtmux==0.4.1
+libtmux==0.5
 click==6.6
 colorama
diff --git a/tests/fixtures/config/expand1.py b/tests/fixtures/config/expand1.py
@@ -32,7 +32,7 @@
         },
         {
             'start_directory': '/var/log',
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': 'htop'
@@ -95,7 +95,7 @@
         },
         {
             'start_directory': '/var/log',
-            'options': {'automatic_rename': True},
+            'options': {'automatic-rename': True},
             'panes': [
                 {'shell_command': ['htop']},
                 {'shell_command': ['vim']}
diff --git a/tests/fixtures/config/shell_command_before.py b/tests/fixtures/config/shell_command_before.py
@@ -40,7 +40,7 @@
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -92,7 +92,7 @@
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -155,7 +155,7 @@
         },
         {
             'start_directory': '/',
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': ['htop']
diff --git a/tests/fixtures/workspacebuilder/env_var_options.yaml b/tests/fixtures/workspacebuilder/env_var_options.yaml
@@ -0,0 +1,13 @@
+session_name: test env vars for options
+start_directory: '~'
+global_options:
+  visual-silence: ${VISUAL_SILENCE}
+options:
+  repeat-time: 738
+windows:
+- window_name: moo
+  layout: main-horizontal
+  options:
+    main-pane-height: ${MAIN_PANE_HEIGHT}
+  panes:
+  - pane
diff --git a/tests/fixtures/workspacebuilder/global_options.yaml b/tests/fixtures/workspacebuilder/global_options.yaml
@@ -0,0 +1,12 @@
+session_name: test global options
+start_directory: '~'
+global_options:
+  repeat-time: 493
+  status-position: 'top'
+windows:
+- layout: main-horizontal
+  panes:
+  - pane
+  - pane
+  - pane
+  window_name: moo
diff --git a/tests/fixtures/workspacebuilder/pane_ordering.yaml b/tests/fixtures/workspacebuilder/pane_ordering.yaml
@@ -2,7 +2,7 @@ session_name: sampleconfig
 start_directory: {HOME}
 windows:
 - options:
-  - automatic_rename: on
+    automatic-rename: on
   layout: tiled
   panes:
   - cd /usr/bin
diff --git a/tests/fixtures/workspacebuilder/session_options.yaml b/tests/fixtures/workspacebuilder/session_options.yaml
@@ -0,0 +1,12 @@
+session_name: test session options
+start_directory: '~'
+options:
+  default-shell: /bin/sh
+  default-command: /bin/sh
+windows:
+- layout: main-horizontal
+  panes:
+  - pane
+  - pane
+  - pane
+  window_name: moo
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -9,7 +9,6 @@
 import kaptan
 import pytest
 
-from libtmux.test import EnvironmentVarGuard
 from tmuxp import config, exc
 
 from . import example_dir
@@ -129,7 +128,7 @@ def test_config_expand2():
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -158,7 +157,7 @@ def test_config_expand2():
         },
         {
             'options': {
-                'automatic_rename': True,
+                'automatic-rename': True,
             },
             'panes': [
                 'htop'
@@ -213,7 +212,7 @@ def test_inline_config():
         },
         {
             'options': {
-                'automatic_rename': True,
+                'automatic-rename': True,
             },
             'panes': [
                 {
@@ -257,7 +256,7 @@ def test_inline_config():
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': ['htop'],
@@ -363,7 +362,7 @@ def test_no_session_name():
       - tail -F /var/log/syslog
       start_directory: /var/log
     - window_name: logging
-      automatic_rename: true
+      automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -399,7 +398,7 @@ def test_no_window_name():
       shell_command:
       - tail -F /var/log/syslog
       start_directory: /var/log
-    - automatic_rename: true
+    - automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -413,22 +412,26 @@ def test_no_window_name():
         assert excinfo.matches('missing "window_name"')
 
 
-def test_replaces_start_directory():
+def test_replaces_env_variables(monkeypatch):
     env_key = "TESTHEY92"
-    env_value = "HEYO1"
+    env_val = "HEYO1"
     yaml_config = """
     start_directory: {TEST_VAR}/test
     shell_command_before: {TEST_VAR}/test2
     before_script: {TEST_VAR}/test3
     session_name: hi - {TEST_VAR}
+    options:
+        default-command: {TEST_VAR}/lol
+    global_options:
+        default-shell: {TEST_VAR}/moo
     windows:
     - window_name: editor
       panes:
       - shell_command:
       - tail -F /var/log/syslog
       start_directory: /var/log
     - window_name: logging @ {TEST_VAR}
-      automatic_rename: true
+      automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -438,12 +441,12 @@ def test_replaces_start_directory():
 
     sconfig = load_yaml(yaml_config)
 
-    with EnvironmentVarGuard() as env:
-        env.set(env_key, env_value)
-        sconfig = config.expand(sconfig)
-        assert "%s/test" % env_value == sconfig['start_directory']
-        assert "%s/test2" % env_value in sconfig['shell_command_before']
-        assert "%s/test3" % env_value == sconfig['before_script']
-        assert "hi - %s" % env_value == sconfig['session_name']
-        assert "logging @ %s" % env_value == \
-            sconfig['windows'][1]['window_name']
+    monkeypatch.setenv(env_key, env_val)
+    sconfig = config.expand(sconfig)
+    assert "%s/test" % env_val == sconfig['start_directory']
+    assert "%s/test2" % env_val in sconfig['shell_command_before']
+    assert "%s/test3" % env_val == sconfig['before_script']
+    assert "hi - %s" % env_val == sconfig['session_name']
+    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']
diff --git a/tests/test_workspacebuilder.py b/tests/test_workspacebuilder.py
diff --git a/tmuxp/config.py b/tmuxp/config.py
diff --git a/tmuxp/workspacebuilder.py b/tmuxp/workspacebuilder.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "before_script": "${MY_ENV_VAR}/test3.sh",`
	`2`	`+ "before_script": "${MY_ENV_VAR}/test3.sh",`
`3`	`3`	`"windows": [`
`4`	`4`	`{`
`5`	`5`	`"panes": [`
`@@ -8,24 +8,26 @@`
`8`	`8`	`"tail -F /var/log/syslog"`
`9`	`9`	`]`
`10`	`10`	`}`
`11`		`- ],`
`12`		`- "start_directory": "/var/log",`
	`11`	`+ ],`
	`12`	`+ "start_directory": "/var/log",`
`13`	`13`	`"window_name": "editor"`
`14`		`- },`
	`14`	`+ },`
`15`	`15`	`{`
`16`	`16`	`"panes": [`
`17`	`17`	`{`
`18`	`18`	`"shell_command": [`
`19`		`- "htop",`
	`19`	`+ "htop",`
`20`	`20`	`"ls $PWD"`
`21`	`21`	`]`
`22`	`22`	`}`
`23`	`23`	`],`
`24`		`- "window_name": "logging for {USER}",`
`25`		`- "automatic_rename": true`
	`24`	`+ "window_name": "logging for ${USER}",`
	`25`	`+ "options": {`
	`26`	`+ "automatic-rename": true`
	`27`	`+ }`
`26`	`28`	`}`
`27`		`- ],`
`28`		`- "shell_command_before": "echo ${PWD}",`
`29`		`- "start_directory": "${PWD}/test",`
	`29`	`+ ],`
	`30`	`+ "shell_command_before": "echo ${PWD}",`
	`31`	`+ "start_directory": "${PWD}/test",`
`30`	`32`	`"session_name": "session - ${USER} (${MY_ENV_VAR})"`
`31`		`-}`
	`33`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`},`
`33`	`33`	`{`
`34`	`34`	`'start_directory': '/var/log',`
`35`		`- 'options': {'automatic_rename': True, },`
	`35`	`+ 'options': {'automatic-rename': True, },`
`36`	`36`	`'panes': [`
`37`	`37`	`{`
`38`	`38`	`'shell_command': 'htop'`
`@@ -95,7 +95,7 @@`
`95`	`95`	`},`
`96`	`96`	`{`
`97`	`97`	`'start_directory': '/var/log',`
`98`		`- 'options': {'automatic_rename': True},`
	`98`	`+ 'options': {'automatic-rename': True},`
`99`	`99`	`'panes': [`
`100`	`100`	`{'shell_command': ['htop']},`
`101`	`101`	`{'shell_command': ['vim']}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`]`
`41`	`41`	`},`
`42`	`42`	`{`
`43`		`- 'options': {'automatic_rename': True, },`
	`43`	`+ 'options': {'automatic-rename': True, },`
`44`	`44`	`'panes': [`
`45`	`45`	`{'shell_command': ['htop']}`
`46`	`46`	`]`
`@@ -92,7 +92,7 @@`
`92`	`92`	`]`
`93`	`93`	`},`
`94`	`94`	`{`
`95`		`- 'options': {'automatic_rename': True, },`
	`95`	`+ 'options': {'automatic-rename': True, },`
`96`	`96`	`'panes': [`
`97`	`97`	`{'shell_command': ['htop']}`
`98`	`98`	`]`
`@@ -155,7 +155,7 @@`
`155`	`155`	`},`
`156`	`156`	`{`
`157`	`157`	`'start_directory': '/',`
`158`		`- 'options': {'automatic_rename': True, },`
	`158`	`+ 'options': {'automatic-rename': True, },`
`159`	`159`	`'panes': [`
`160`	`160`	`{`
`161`	`161`	`'shell_command': ['htop']`