python-streamdeck-plugin-sdk/tests/test_command_sender.py at 710758dd1673816e495c91d4d9646ba020b97882 · strohganoff/python-streamdeck-plugin-sdk · GitHub

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
from __future__ import annotations

from unittest.mock import Mock

import pytest
from streamdeck.command_sender import StreamDeckCommandSender
from streamdeck.websocket import WebSocketClient


@pytest.fixture
def mock_client() -> Mock:
    """Fixture to mock the WebSocketClient."""
    return Mock(spec=WebSocketClient)


@pytest.fixture
def command_sender(mock_client: Mock, plugin_registration_uuid: str) -> StreamDeckCommandSender:
    """Fixture to provide an instance of StreamDeckCommandSender with a mocked client."""
    return StreamDeckCommandSender(client=mock_client, plugin_registration_uuid=plugin_registration_uuid)


@pytest.mark.parametrize(
    ("method_name", "context", "extra_args", "expected_event", "expected_payload"),
    [
        (
            "get_global_settings",
            None,  # get_global_settings uses the command_sender's own plugin_registration_uuid attribute as the context.
            {},
            "getGlobalSettings",
            {}
        ),
        (
            "get_settings",
            "fake_context",
            {},
            "getSettings",
            {}
        ),
        (
            "log_message",
            "fake_context",
            {"message": "fake log message..."},
            "logMessage",
            {"payload": {"message": "fake log message..."}}
        ),
        (
            "open_url",
            "fake_context",
            {"url": "http://example.com"},
            "openUrl",
            {"payload": {"url": "http://example.com"}}
        ),
        (
            "show_alert",
            "fake_context",
            {},
            "showAlert",
            {}
        ),
        (
            "show_ok",
            "fake_context",
            {},
            "showOk",
            {}
        ),
        (
            "send_to_plugin",
            "fake_context",
            {"action": "fake_action", "payload": {"key": "value"}},
            "sendToPlugin",
            {"action": "fake_action", "payload": {"key": "value"}},
        ),
        (
            "send_to_property_inspector",
            "fake_context",
            {"payload": {"key": "value"}},
            "sendToPropertyInspector",
            {"payload": {"key": "value"}},
        ),
        (
            "set_feedback",
            "fake_context",
            {"payload": {"key": "value"}},
            "setFeedback",
            {"payload": {"key": "value"}},
        ),
        (
            "set_feedback_layout",
            "fake_context",
            {"layout": "fake layout"},
            "setFeedbackLayout",
            {"payload": {"layout": "fake layout"}},
        ),
        (
            "set_image",
            "fake_context",
            {"state": "fake_state", "image": "fake-base64encodedstring", "target": "hardware"},
            "setImage",
            {"payload": {"state": "fake_state", "image": "fake-base64encodedstring", "target": 1}},
        ),
        (
            "set_title",
            "fake_context",
            {"state": "fake_state", "target": "fake_title", "title": "fake_title"},
            "setTitle",
            {"payload": {"state": "fake_state", "target": "fake_title", "title": "fake_title"}},
        ),
        (
            "set_trigger_description",
            "fake_context",
            {"rotate": "fake rotate description", "push": "fake push description", "touch": "fake touch description", "long_touch": "fake long touch description"},
            "setTriggerDescription",
            {"payload": {"rotate": "fake rotate description", "push": "fake push description", "touch": "fake touch description", "longTouch": "fake long touch description"}},
        ),
        (
            "set_global_settings",
            None,  # set_global_settings uses the command_sender's own plugin_registration_uuid attribute as the context.
            {"payload": {"key": "value"}},
            "setGlobalSettings",
            {"payload": {"key": "value"}},
        ),
        (
            "set_settings",
            "fake_context",
            {"payload": {"key": "value"}},
            "setSettings",
            {"payload": {"key": "value"}},
        ),
        (
            "set_state",
            "fake_context",
            {"state": 1},
            "setState",
            {"payload": {"state": 1}},
        ),
        (
            "switch_to_profile",
            "fake_context",
            {"device": "fake device", "profile": "fake profile", "page": 4},
            "switchToProfile",
            {"device": "fake device", "payload": {"profile": "fake profile", "page": 4}},
        ),
    ]
)
def test_command_sender_methods(
    command_sender: StreamDeckCommandSender,
    mock_client: Mock,
    method_name: str,
    context: str | None,
    extra_args: dict,
    expected_event: str,
    expected_payload: dict,
):
    """Parameterized test for StreamDeckCommandSender methods that send events."""
    # First, assert the command_sender object has the provided method name (i.e. "set_settings")
    assert hasattr(command_sender, method_name)

    method = getattr(command_sender, method_name)
    if context is not None:
        method(context, **extra_args)
    else:
        method(**extra_args)

    # Build the expected data structure to send through the WebSocket
    expected_data = {
        "context": context or command_sender._plugin_registration_uuid,
        "event": expected_event,
        **expected_payload,
    }

    # Assert that the client's send_event method was called with the expected data
    mock_client.send_event.assert_called_once_with(expected_data)