fix: fix some async functions (#210)

* fix: fix some async functions

* version bump

* update tests

* formatting

* update test config

Author: firstof9

.github/workflows/test.yml

@@ -55,3 +55,5 @@ jobs:
           name: coverage-data
       - name: Upload coverage report
         uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

openevsehttp/__main__.py

@@ -194,7 +194,7 @@ async def test_and_get(self) -> dict:
         data = {"serial": serial, "model": model}
         return data
 
-    def ws_start(self):
+    def ws_start(self) -> None:
         """Start the websocket listener."""
         if self._ws_listening:
             raise AlreadyListening
@@ -218,7 +218,7 @@ def _start_listening(self):
             except RuntimeError:
                 _LOGGER.info(INFO_LOOP_RUNNING)
 
-    def _update_status(self, msgtype, data, error):
+    async def _update_status(self, msgtype, data, error):
         """Update data from websocket listener."""
         if msgtype == SIGNAL_CONNECTION_STATE:
             if data == STATE_CONNECTED:
@@ -247,16 +247,16 @@ def _update_status(self, msgtype, data, error):
                 data["watthour"] = data.pop("wh")
             # TODO: update specific endpoints based on _version prefix
             if any(key in keys for key in UPDATE_TRIGGERS):
-                self.update()
+                await self.update()
             self._status.update(data)
 
             if self.callback is not None:
                 self.callback()  # pylint: disable=not-callable
 
-    def ws_disconnect(self) -> None:
+    async def ws_disconnect(self) -> None:
         """Disconnect the websocket listener."""
         assert self.websocket
-        self.websocket.close()
+        await self.websocket.close()
         self._ws_listening = False
 
     @property

openevsehttp/websocket.py

@@ -45,11 +45,11 @@ def state(self):
         return self._state
 
     @state.setter
-    def state(self, value):
+    async def state(self, value):
         """Set the state."""
         self._state = value
         _LOGGER.debug("Websocket %s", value)
-        self.callback(SIGNAL_CONNECTION_STATE, value, self._error_reason)
+        await self.callback(SIGNAL_CONNECTION_STATE, value, self._error_reason)
         self._error_reason = None
 
     @staticmethod
@@ -59,7 +59,7 @@ def _get_uri(server):
 
     async def running(self):
         """Open a persistent websocket connection and act on events."""
-        self.state = STATE_STARTING
+        await OpenEVSEWebsocket.state.fset(self, STATE_STARTING)
         auth = None
 
         if self._user and self._password:
@@ -81,7 +81,7 @@ async def running(self):
                     if message.type == aiohttp.WSMsgType.TEXT:
                         msg = message.json()
                         msgtype = "data"
-                        self.callback(msgtype, msg, None)
+                        await self.callback(msgtype, msg, None)
 
                     elif message.type == aiohttp.WSMsgType.CLOSED:
                         _LOGGER.warning("Websocket connection closed")
@@ -98,7 +98,7 @@ async def running(self):
             else:
                 _LOGGER.error("Unexpected response received: %s", error)
                 self._error_reason = ERROR_UNKNOWN
-            self.state = STATE_STOPPED
+            await OpenEVSEWebsocket.state.fset(self, STATE_STOPPED)
         except (aiohttp.ClientConnectionError, asyncio.TimeoutError) as error:
             if self.failed_attempts >= MAX_FAILED_ATTEMPTS:
                 self._error_reason = ERROR_TOO_MANY_RETRIES
@@ -111,7 +111,7 @@ async def running(self):
                     retry_delay,
                     error,
                 )
-                self.state = STATE_DISCONNECTED
+                await OpenEVSEWebsocket.state.fset(self, STATE_DISCONNECTED)
                 await asyncio.sleep(retry_delay)
         except Exception as error:  # pylint: disable=broad-except
             if self.state != STATE_STOPPED:
@@ -129,6 +129,6 @@ async def listen(self):
         while self.state != STATE_STOPPED:
             await self.running()
 
-    def close(self):
+    async def close(self):
         """Close the listening websocket."""
-        self.state = STATE_STOPPED
+        await OpenEVSEWebsocket.state.fset(self, STATE_STOPPED)

setup.py

@@ -5,7 +5,7 @@
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.1.44"
+VERSION = "0.1.45"
 
 setup(
     name="python-openevse-http",

tests/fixtures/websocket.json

@@ -0,0 +1,68 @@
+{
+    "mode": "STA",
+    "wifi_client_connected": 1,
+    "eth_connected": 0,
+    "net_connected": 1,
+    "ipaddress": "192.168.21.10",
+    "emoncms_connected": 0,
+    "packets_sent": 0,
+    "packets_success": 0,
+    "mqtt_connected": 0,
+    "ocpp_connected": 0,
+    "rfid_failure": 0,
+    "ohm_hour": "NotConnected",
+    "free_heap": 195472,
+    "comm_sent": 287724,
+    "comm_success": 287720,
+    "rapi_connected": 1,
+    "evse_connected": 1,
+    "amp": 0,
+    "voltage": 240,
+    "pilot": 48,
+    "wh": 7875444,
+    "session_energy": 7950.783333,
+    "total_energy": 7875.444,
+    "temp": 529,
+    "temp_max": 576,
+    "temp1": false,
+    "temp2": 529,
+    "temp3": false,
+    "temp4": 555,
+    "state": 254,
+    "status": "disabled",
+    "flags": 512,
+    "vehicle": 0,
+    "colour": 5,
+    "manual_override": 0,
+    "freeram": 195472,
+    "divertmode": 1,
+    "srssi": -59,
+    "time": "2023-03-13T21:26:22Z",
+    "offset": "-0700",
+    "elapsed": 3685,
+    "wattsec": 2.862282e7,
+    "watthour": 7875444,
+    "gfcicount": 1,
+    "nogndcount": 0,
+    "stuckcount": 0,
+    "solar": 0,
+    "grid_ie": -5073,
+    "charge_rate": 4,
+    "divert_update": 6319,
+    "divert_active": false,
+    "shaper": 0,
+    "shaper_live_pwr": 0,
+    "shaper_cur": 0,
+    "shaper_updated": false,
+    "service_level": 2,
+    "ota_update": 0,
+    "config_version": 14,
+    "claims_version": 24,
+    "override_version": 4,
+    "schedule_version": 1,
+    "schedule_plan_version": 14,
+    "vehicle_state_update": 445687,
+    "tesla_vehicle_count": false,
+    "tesla_vehicle_id": false,
+    "tesla_vehicle_name": false
+}

tests/test_main.py

@@ -20,6 +20,7 @@
 TEST_URL_CONFIG = "http://openevse.test.tld/config"
 TEST_URL_DIVERT = "http://openevse.test.tld/divertmode"
 TEST_URL_RESTART = "http://openevse.test.tld/restart"
+TEST_URL_WS = "ws://openevse.test.tld/ws"
 TEST_URL_GITHUB_v4 = (
     "https://api.github.com/repos/OpenEVSE/ESP32_WiFi_V4.x/releases/latest"
 )
@@ -187,7 +188,7 @@ async def test_get_ammeter_offset(fixture, expected, request):
     """Test v4 Status reply."""
     charger = request.getfixturevalue(fixture)
     await charger.update()
-    charger.ws_disconnect()
+    await charger.ws_disconnect()
     status = charger.ammeter_offset
     assert status == expected
 
@@ -1389,3 +1390,15 @@ async def test_get_total_year(fixture, expected, request):
     await charger.update()
     status = charger.total_year
     assert status == expected
+
+
+async def test_websocket_functions(test_charger, mock_aioclient, caplog):
+    """Test v4 Status reply."""
+    mock_aioclient.get(
+        TEST_URL_WS,
+        status=200,
+        body=load_fixture("websocket.json"),
+    )
+    await test_charger.update()
+    test_charger.ws_start()
+    await test_charger.ws_disconnect()