feat(plugin): hass-cli raw ws for websocket apis

Why:

 * testing out websocket apis before there are commands for it
   are tedious. would be nice to have ability like `raw get` to
   access websocket api.

This change addreses the need by:

 * introduce `hass-cli raw ws <method> --json <optional data>` command.
   Example:
   ```
   hass-cli raw ws config/area_registry/delete --json='{ "area_id":"2c8bf93c8082492f99c989896962f207" }'
   ```

 * Fixed a few mypy / static check errors.

Resolves #271

Author: maxandersen

homeassistant_cli/autocompletion.py

@@ -168,7 +168,25 @@ def api_methods(
     completions = []
     for name, value in getmembers(hassconst):
         if name.startswith('URL_API_'):
-            completions.append((value, name[len('URL_API_'):]))
+            completions.append((value, name[len('URL_API_') :]))
+
+    completions.sort()
+
+    return [c for c in completions if incomplete in c[0]]
+
+
+def wsapi_methods(
+    ctx: Configuration, args: List, incomplete: str
+) -> List[Tuple[str, str]]:
+    """Auto completion for websocket methods."""
+    _init_ctx(ctx)
+
+    from inspect import getmembers
+
+    completions = []
+    for name, value in getmembers(hassconst):
+        if name.startswith('WS_TYPE_'):
+            completions.append((value, name[len('WS_TYPE_') :]))
 
     completions.sort()
 

homeassistant_cli/config.py

@@ -170,7 +170,8 @@ def auto_output(self, auto_output: str) -> str:
     def yaml(self) -> YAML:
         """Create default yaml parser."""
         if self:
-            return yaml.yaml()
+            yaml.yaml()
+        return yaml.yaml()
 
     def yamlload(self, source: str) -> Any:
         """Load YAML from source."""

homeassistant_cli/plugins/raw.py

@@ -1,6 +1,7 @@
 """Raw plugin for Home Assistant CLI (hass-cli)."""
 import json as json_
 import logging
+from typing import Any, Dict, List, cast  # noqa: F401
 
 import click
 
@@ -67,3 +68,31 @@ def post(ctx: Configuration, method, json):
     response = api.restapi(ctx, 'post', method, data)
 
     _report(ctx, "GET", method, response)
+
+
+@cli.command("ws")
+@click.argument(  # type: ignore
+    'wstype', autocompletion=autocompletion.wsapi_methods
+)
+@click.option('--json')
+@pass_context
+def websocket(ctx: Configuration, wstype, json):  # noqa: D301
+    """Send a websocket request against /api/websocket.
+
+    WSTYPE is name of websocket methods.
+
+    \b
+    --json is dictionary to pass in addition to the type.
+           Example: --json='{ "area_id":"2c8bf93c8082492f99c989896962f207" }'
+    """
+    if json:
+        data = json_.loads(json)
+    else:
+        data = {}
+
+    frame = {'type': wstype}
+    frame = {**frame, **data}  # merging data into frame
+
+    response = cast(List[Dict[str, Any]], api.wsapi(ctx, frame))
+
+    ctx.echo(format_output(ctx, response))

homeassistant_cli/yaml.py

@@ -9,7 +9,7 @@
 def yaml() -> YAML:
     """Return default YAML parser."""
     yamlp = YAML(typ='safe', pure=True)
-    yamlp.preserve_quotes = True
+    yamlp.preserve_quotes = cast(None, True)
     yamlp.default_flow_style = False
     return yamlp
 

tests/test_raw.py

@@ -1,5 +1,7 @@
 """Tests file for Home Assistant CLI (hass-cli)."""
 import json
+import unittest.mock as mocker
+from unittest.mock import ANY
 
 from click.testing import CliRunner
 import requests_mock
@@ -59,3 +61,67 @@ def test_apimethod_completion(default_services) -> None:
     resultdict = dict(result)
 
     assert "/api/discovery_info" in resultdict
+
+
+def test_wsapimethod_completion(default_services) -> None:
+    """Test completion for raw ws API methods."""
+    cfg = Configuration()
+
+    result = autocompletion.wsapi_methods(
+        cfg, ["raw", "get"], "config/device_registry/l"
+    )
+    assert len(result) == 1
+
+    resultdict = dict(result)
+
+    assert "config/device_registry/list" in resultdict
+
+
+def test_raw_ws() -> None:
+    """Test websocket."""
+    with mocker.patch(
+        'homeassistant_cli.remote.wsapi', return_value={"result": "worked"}
+    ) as mockmethod:
+
+        runner = CliRunner()
+        result = runner.invoke(
+            cli.cli,
+            ["--output=json", "raw", "ws", "config/wsmethod"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0
+
+        mockmethod.assert_called_once()
+        mockmethod.assert_called_with(ANY, {"type": "config/wsmethod"})
+
+        data = json.loads(result.output)
+        assert len(data) == 1
+
+
+def test_raw_ws_data() -> None:
+    """Test websocket with data."""
+    with mocker.patch(
+        'homeassistant_cli.remote.wsapi', return_value={"result": "worked"}
+    ) as mockmethod:
+
+        runner = CliRunner()
+        result = runner.invoke(
+            cli.cli,
+            [
+                "--output=json",
+                "raw",
+                "ws",
+                "config/wsmethod",
+                "--json",
+                '{ "id":"secret"}',
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0
+
+        mockmethod.assert_called_with(
+            ANY, {"type": "config/wsmethod", "id": "secret"}
+        )
+
+        data = json.loads(result.output)
+        assert len(data) == 1