Merge pull request #14 from connorgallopo/hass-actions

Lint code and add HACS workflow

.github/workflows/validate.yml

@@ -0,0 +1,18 @@
+name: Validate
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+  validate-hacs:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+      - name: HACS validation
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

.pre-commit-config.yaml

@@ -11,9 +11,10 @@ repos:
       - id: black
         name: black
         entry: black
-        language: system
+        language: python
         types: [python]
         require_serial: true
+        additional_dependencies: [black==22.3.0, click==8.0.4]
       - id: flake8
         name: flake8
         entry: flake8

README.md

@@ -18,11 +18,12 @@
 
 **This component will set up the following platforms.**
 
-| Platform        | Description                                                               |
-| --------------- | ------------------------------------------------------------------------- |
-| `sensor`        | Show info from leslies_pool API.                                          |
+| Platform | Description                      |
+| -------- | -------------------------------- |
+| `sensor` | Show info from leslies_pool API. |
 
 **The component will set up the following sensors:**
+
 - Free Chlorine - PPM
 - Total Chlorine - PPM
 - PH - pH
@@ -34,7 +35,6 @@
 - Phosphates - PPB
 - Salt - PPM
 
-
 ## Installation - Automatic (REQUIRES HACS)
 
 1. Add this repository URL to HACS custom repositories as an Integration
@@ -53,6 +53,7 @@
 7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "leslies_pool"
 
 ## Setup
+
 1. Provide the Username and Password for your leslie's account. These are used to auth and refresh cookies
 2. Input the Water Test URL. This can be found by navigating [here](https://lesliespool.com/on/demandware.store/Sites-lpm_site-Site/en_US/PoolProfile-Landing) once logged in, and then by clicking on "Water Tests" for the pool you want to integrate. The water test URL can be copied from the URL bar once you have navigated there. This URL contains the Pool ID and Pool Name which are needed to make the API calls to fetch the data.
 3. Set a polling rate (Seconds).

custom_components/leslies_pool/__init__.py

@@ -1,5 +1,4 @@
 """Initialize Leslie's Pool Water Tests integration."""
-
 from __future__ import annotations
 
 from homeassistant.config_entries import ConfigEntry

custom_components/leslies_pool/api.py

@@ -1,7 +1,7 @@
 """API client for Leslie's Pool Water Tests."""
-
-from bs4 import BeautifulSoup, Tag
 import requests
+from bs4 import BeautifulSoup
+from bs4 import Tag
 
 
 class LesliesPoolApi:

custom_components/leslies_pool/config_flow.py

@@ -1,15 +1,15 @@
 """Config flow for Leslie's Pool Water Tests integration."""
-
 from __future__ import annotations
 
 import logging
 import re
 from typing import Any
 
 import voluptuous as vol
-
 from homeassistant import config_entries
-from homeassistant.const import CONF_PASSWORD, CONF_SCAN_INTERVAL, CONF_USERNAME
+from homeassistant.const import CONF_PASSWORD
+from homeassistant.const import CONF_SCAN_INTERVAL
+from homeassistant.const import CONF_USERNAME
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
 

custom_components/leslies_pool/manifest.json

@@ -1,11 +1,12 @@
 {
   "domain": "leslies_pool",
   "name": "Leslie's Pool Water Tests",
+  "codeowners": ["@connorgallopo"],
+  "config_flow": true,
+  "dependencies": [],
   "documentation": "https://github.com/connorgallopo/leslies-pool",
+  "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/connorgallopo/leslies-pool/issues",
-  "dependencies": [],
-  "config_flow": true,
-  "codeowners": ["@connorgallopo"],
   "requirements": ["beautifulsoup4==4.12.3", "requests==2.31.0"],
   "version": "1.0.0"
 }

custom_components/leslies_pool/requirements.txt

@@ -1,2 +1,2 @@
 beautifulsoup4==4.12.3
-requests==2.31.0
+requests==2.31.0

custom_components/leslies_pool/sensor.py

@@ -1,16 +1,16 @@
 """Sensor platform for Leslie's Pool Water Tests."""
-
-from datetime import timedelta
 import logging
+from datetime import timedelta
 
 import requests
-
 from homeassistant.components.sensor import SensorEntity
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.helpers.device_registry import DeviceEntryType
+from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+from homeassistant.helpers.update_coordinator import UpdateFailed
 
 from .const import DOMAIN
 

custom_components/leslies_pool/translations/en.json

@@ -1,27 +1,21 @@
 {
   "config": {
-      "error": {
-          "invalid_auth": "Authentication failed.",
-          "invalid_url": "The provided URL is invalid.",
-          "unknown": "An unknown error occurred."
-      },
-      "step": {
-          "user": {
-              "data": {
-                  "password": "Password",
-                  "scan_interval": "Polling Interval (seconds)",
-                  "username": "Username",
-                  "water_test_url": "Water Test URL"
-              },
-              "description": "Set up your Leslie's Pool integration.",
-              "description_placeholders": {
-                  "password": "Enter your password",
-                  "scan_interval": "300",
-                  "username": "Enter your username",
-                  "water_test_url": "https://lesliespool.com/on/demandware.store/Sites-lpm_site-Site/en_US/WaterTest-Landing?poolProfileId=XXXX&poolName=XXXX"
-              },
-              "title": "Leslie's Pool Water Tests"
-          }
+    "error": {
+      "invalid_auth": "Authentication failed.",
+      "invalid_url": "The provided URL is invalid.",
+      "unknown": "An unknown error occurred."
+    },
+    "step": {
+      "user": {
+        "data": {
+          "password": "Password",
+          "scan_interval": "Polling Interval (seconds)",
+          "username": "Username",
+          "water_test_url": "Water Test URL"
+        },
+        "description": "Set up your Leslie's Pool integration.",
+        "title": "Leslie's Pool Water Tests"
       }
+    }
   }
-}
+}

custom_components/leslies_pool/translations/fr.json

@@ -13,13 +13,6 @@
           "username": "Nom d'utilisateur",
           "water_test_url": "URL du test de l'eau"
         },
-        "description": "Configurez votre intégration Leslie's Pool.",
-        "description_placeholders": {
-          "password": "Entrez votre mot de passe",
-          "scan_interval": "300",
-          "username": "Entrez votre nom d'utilisateur",
-          "water_test_url": "https://lesliespool.com/on/demandware.store/Sites-lpm_site-Site/en_US/WaterTest-Landing?poolProfileId=XXXX&poolName=XXXX"
-        },
         "title": "Tests de l'eau de Leslie's Pool"
       }
     }

custom_components/leslies_pool/translations/nb.json

@@ -13,13 +13,6 @@
           "username": "Brukernavn",
           "water_test_url": "Vanntest-URL"
         },
-        "description": "Konfigurer din Leslie's Pool-integrasjon.",
-        "description_placeholders": {
-          "password": "Skriv inn ditt passord",
-          "scan_interval": "300",
-          "username": "Skriv inn ditt brukernavn",
-          "water_test_url": "https://lesliespool.com/on/demandware.store/Sites-lpm_site-Site/en_US/WaterTest-Landing?poolProfileId=XXXX&poolName=XXXX"
-        },
         "title": "Leslie's Pool Vanntester"
       }
     }

hacs.json

@@ -1,7 +1,5 @@
 {
   "name": "Leslie's Pool Water Tests",
   "hacs": "1.6.0",
-  "domains": ["sensor"],
-  "iot_class": "Cloud Polling",
   "homeassistant": "0.118.0"
 }

requirements.txt

@@ -1,2 +1,4 @@
 beautifulsoup4==4.12.3
-requests==2.31.0
+requests==2.31.0
+black==22.3.0
+click==8.0.4

tests/__init__.py

@@ -1 +1 @@
-"""Tests for leslies_pool integration."""
+"""Tests for the Leslie's Pool Water Tests integration."""

tests/conftest.py

@@ -1,39 +1,15 @@
-"""Global fixtures for leslies_pool integration."""
+"""Common fixtures for the Leslie's Pool Water Tests tests."""
+from collections.abc import Generator
+from unittest.mock import AsyncMock
 from unittest.mock import patch
 
 import pytest
 
-pytest_plugins = "pytest_homeassistant_custom_component"
 
-
-# This fixture is used to prevent HomeAssistant from attempting to create and dismiss persistent
-# notifications. These calls would fail without this fixture since the persistent_notification
-# integration is never loaded during a test.
-@pytest.fixture(name="skip_notifications", autouse=True)
-def skip_notifications_fixture():
-    """Skip notification calls."""
-    with patch("homeassistant.components.persistent_notification.async_create"), patch(
-        "homeassistant.components.persistent_notification.async_dismiss"
-    ):
-        yield
-
-
-# This fixture, when used, will result in calls to async_get_data to return None. To have the call
-# return a value, we would add the `return_value=<VALUE_TO_RETURN>` parameter to the patch call.
-@pytest.fixture(name="bypass_get_data")
-def bypass_get_data_fixture():
-    """Skip calls to get data from API."""
-    with patch("custom_components.leslies_pool.LesliesPoolApiClient.async_get_data"):
-        yield
-
-
-# In this fixture, we are forcing calls to async_get_data to raise an Exception. This is useful
-# for exception handling.
-@pytest.fixture(name="error_on_get_data")
-def error_get_data_fixture():
-    """Simulate error when retrieving data from API."""
+@pytest.fixture
+def mock_setup_entry() -> Generator[AsyncMock, None, None]:
+    """Override async_setup_entry."""
     with patch(
-        "custom_components.leslies_pool.LesliesPoolApiClient.async_get_data",
-        side_effect=Exception,
-    ):
-        yield
+        "homeassistant.components.leslies_pool.async_setup_entry", return_value=True
+    ) as mock_setup_entry:
+        yield mock_setup_entry

tests/const.py

@@ -1,9 +1,5 @@
 """Constants for leslies_pool tests."""
-from custom_components.leslies_pool.const import (
-    CONF_PASSWORD,
-)
-from custom_components.leslies_pool.const import (
-    CONF_USERNAME,
-)
+from custom_components.leslies_pool.const import CONF_PASSWORD
+from custom_components.leslies_pool.const import CONF_USERNAME
 
 MOCK_CONFIG = {CONF_USERNAME: "test_username", CONF_PASSWORD: "test_password"}