1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
|
"""Test for tmuxp configuration import, inlining, expanding and export."""
from __future__ import annotations
import pathlib
import typing as t
import pytest
from tests.constants import EXAMPLE_PATH
from tmuxp import exc
from tmuxp._internal.config_reader import ConfigReader
from tmuxp.workspace import loader, validation
if t.TYPE_CHECKING:
from tests.fixtures.structures import WorkspaceTestData
def load_workspace(path: str | pathlib.Path) -> dict[str, t.Any]:
"""Load tmuxp workspace configuration from file."""
return ConfigReader._from_file(
pathlib.Path(path) if isinstance(path, str) else path,
)
def test_export_json(
tmp_path: pathlib.Path,
config_fixture: WorkspaceTestData,
) -> None:
"""Test exporting configuration dictionary to JSON."""
json_workspace_file = tmp_path / "config.json"
configparser = ConfigReader(config_fixture.sample_workspace.sample_workspace_dict)
json_workspace_data = configparser.dump("json", indent=2)
json_workspace_file.write_text(json_workspace_data, encoding="utf-8")
new_workspace_data = ConfigReader._from_file(path=json_workspace_file)
assert config_fixture.sample_workspace.sample_workspace_dict == new_workspace_data
def test_workspace_expand1(config_fixture: WorkspaceTestData) -> None:
"""Expand shell commands from string to list."""
test_workspace = loader.expand(config_fixture.expand1.before_workspace)
assert test_workspace == config_fixture.expand1.after_workspace()
def test_workspace_expand2(config_fixture: WorkspaceTestData) -> None:
"""Expand shell commands from string to list."""
unexpanded_dict = ConfigReader._load(
fmt="yaml",
content=config_fixture.expand2.unexpanded_yaml(),
)
expanded_dict = ConfigReader._load(
fmt="yaml",
content=config_fixture.expand2.expanded_yaml(),
)
assert loader.expand(unexpanded_dict) == expanded_dict
"""Test config inheritance for the nested 'start_command'."""
inheritance_workspace_before = {
"session_name": "sample workspace",
"start_directory": "/",
"windows": [
{
"window_name": "editor",
"start_directory": "~",
"panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
"layout": "main-vertical",
},
{
"window_name": "logging",
"panes": [{"shell_command": ["tail -F /var/log/syslog"]}],
},
{"window_name": "shufu", "panes": [{"shell_command": ["htop"]}]},
{"options": {"automatic-rename": True}, "panes": [{"shell_command": ["htop"]}]},
],
}
inheritance_workspace_after = {
"session_name": "sample workspace",
"start_directory": "/",
"windows": [
{
"window_name": "editor",
"start_directory": "~",
"panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
"layout": "main-vertical",
},
{
"window_name": "logging",
"panes": [{"shell_command": ["tail -F /var/log/syslog"]}],
},
{"window_name": "shufu", "panes": [{"shell_command": ["htop"]}]},
{"options": {"automatic-rename": True}, "panes": [{"shell_command": ["htop"]}]},
],
}
def test_inheritance_workspace() -> None:
"""TODO: Create a test to verify workspace config inheritance to object tree."""
workspace = inheritance_workspace_before
# TODO: Look at verifying window_start_directory
# if 'start_directory' in workspace:
# session_start_directory = workspace['start_directory']
# else:
# session_start_directory = None
# for windowconfitem in workspace['windows']:
# window_start_directory = None
#
# if 'start_directory' in windowconfitem:
# window_start_directory = windowconfitem['start_directory']
# elif session_start_directory:
# window_start_directory = session_start_directory
#
# for paneconfitem in windowconfitem['panes']:
# if 'start_directory' in paneconfitem:
# pane_start_directory = paneconfitem['start_directory']
# elif window_start_directory:
# paneconfitem['start_directory'] = window_start_directory
# elif session_start_directory:
# paneconfitem['start_directory'] = session_start_directory
assert workspace == inheritance_workspace_after
def test_shell_command_before(config_fixture: WorkspaceTestData) -> None:
"""Config inheritance for the nested 'start_command'."""
test_workspace = config_fixture.shell_command_before.config_unexpanded
test_workspace = loader.expand(test_workspace)
assert test_workspace == config_fixture.shell_command_before.config_expanded()
test_workspace = loader.trickle(test_workspace)
assert test_workspace == config_fixture.shell_command_before.config_after()
def test_in_session_scope(config_fixture: WorkspaceTestData) -> None:
"""Verify shell_command before_session is in session scope."""
sconfig = ConfigReader._load(
fmt="yaml",
content=config_fixture.shell_command_before_session.before,
)
validation.validate_schema(sconfig)
assert loader.expand(sconfig) == sconfig
assert loader.expand(loader.trickle(sconfig)) == ConfigReader._load(
fmt="yaml",
content=config_fixture.shell_command_before_session.expected,
)
def test_trickle_relative_start_directory(config_fixture: WorkspaceTestData) -> None:
"""Verify tmuxp config proliferates relative start directory to descendants."""
test_workspace = loader.trickle(config_fixture.trickle.before)
assert test_workspace == config_fixture.trickle.expected
def test_trickle_window_with_no_pane_workspace() -> None:
"""Verify tmuxp window config automatically infers a single pane."""
test_yaml = """
session_name: test_session
windows:
- window_name: test_1
panes:
- shell_command:
- ls -l
- window_name: test_no_panes
"""
sconfig = ConfigReader._load(fmt="yaml", content=test_yaml)
validation.validate_schema(sconfig)
assert loader.expand(loader.trickle(sconfig))["windows"][1]["panes"][0] == {
"shell_command": [],
}
def test_expands_blank_panes(config_fixture: WorkspaceTestData) -> None:
"""Expand blank config into full form.
Handle ``NoneType`` and 'blank'::
# nothing, None, 'blank'
'panes': [
None,
'blank'
]
# should be blank
'panes': [
'shell_command': []
]
Blank strings::
panes: [
''
]
# should output to:
panes:
'shell_command': ['']
"""
yaml_workspace_file = EXAMPLE_PATH / "blank-panes.yaml"
test_workspace = load_workspace(yaml_workspace_file)
assert loader.expand(test_workspace) == config_fixture.expand_blank.expected
def test_no_session_name() -> None:
"""Verify exception raised when tmuxp configuration has no session name."""
yaml_workspace = """
- window_name: editor
panes:
shell_command:
- tail -F /var/log/syslog
start_directory: /var/log
- window_name: logging
automatic-rename: true
panes:
- shell_command:
- htop
"""
sconfig = ConfigReader._load(fmt="yaml", content=yaml_workspace)
with pytest.raises(exc.WorkspaceError) as excinfo:
validation.validate_schema(sconfig)
assert excinfo.match(r'requires "session_name"')
def test_no_windows() -> None:
"""Verify exception raised when tmuxp configuration has no windows."""
yaml_workspace = """
session_name: test session
"""
sconfig = ConfigReader._load(fmt="yaml", content=yaml_workspace)
with pytest.raises(exc.WorkspaceError) as excinfo:
validation.validate_schema(sconfig)
assert excinfo.match(r'list of "windows"')
def test_no_window_name() -> None:
"""Verify exception raised when tmuxp config missing window name."""
yaml_workspace = """
session_name: test session
windows:
- window_name: editor
panes:
shell_command:
- tail -F /var/log/syslog
start_directory: /var/log
- automatic-rename: true
panes:
- shell_command:
- htop
"""
sconfig = ConfigReader._load(fmt="yaml", content=yaml_workspace)
with pytest.raises(exc.WorkspaceError) as excinfo:
validation.validate_schema(sconfig)
assert excinfo.match('missing "window_name"')
def test_replaces_env_variables(monkeypatch: pytest.MonkeyPatch) -> None:
"""Test loading configuration resolves environmental variables."""
env_key = "TESTHEY92"
env_val = "HEYO1"
yaml_workspace = """
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
panes:
- shell_command:
- htop
""".format(TEST_VAR=f"${{{env_key}}}")
sconfig = ConfigReader._load(fmt="yaml", content=yaml_workspace)
monkeypatch.setenv(str(env_key), str(env_val))
sconfig = loader.expand(sconfig)
assert f"{env_val}/test" == sconfig["start_directory"]
assert (
f"{env_val}/test2" in sconfig["shell_command_before"]["shell_command"][0]["cmd"]
)
assert f"{env_val}/test3" == sconfig["before_script"]
assert f"hi - {env_val}" == sconfig["session_name"]
assert f"{env_val}/moo" == sconfig["global_options"]["default-shell"]
assert f"{env_val}/lol" == sconfig["options"]["default-command"]
assert f"logging @ {env_val}" == sconfig["windows"][1]["window_name"]
def test_validate_plugins() -> None:
"""Test validation of plugins loading via tmuxp configuration file."""
yaml_workspace = """
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 = ConfigReader._load(fmt="yaml", content=yaml_workspace)
with pytest.raises(exc.WorkspaceError) as excinfo:
validation.validate_schema(sconfig)
assert excinfo.match("only supports list type")
|