Add platform and sensors for Vultr VPS #9928

GenericStudent · 2017-10-17T19:19:29Z

Description:

Allows the Vultr VPS provider to be used as a hub, binary sensor (representing currently running or not of each subscription (vps), attributes being everything static about the vps), sensor (two types for the moment representing current bandwidth usage this period in GB and the current pending charges in US$), switch (allow the VPS to be started or stopped, also contains all the attributes the binary sensor does)

This is my first platform / sensor creation so I would love any feedback. It was stitched together with reference code from the DigitalOcean platform and various other components.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#3663

Example entry for `configuration.yaml` (if applicable):

vultr:
  api_key: ABCDEF123456

binary_sensor:
  - platform: vultr
    name: My Amazing Server
    subscription: 123456

sensor:
  - platform: vultr
    subscription: 123456
    monitored_conditions:
      - current_bandwidth_used
      - pending_charges

switch:
  - platform: vultr
    name: Web Server 17
    subscription: 123456

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.

houndci-bot · 2017-10-20T17:02:47Z

tests/components/sensor/test_vultr.py

+
+        self.assertFalse(setup)
+
+        with pytest.raises(vol.Invalid):


undefined name 'pytest'
undefined name 'vol'

houndci-bot · 2017-10-20T17:02:47Z

tests/components/sensor/test_vultr.py

+    def test_invalid_sensor(self, mock):
+        """Test the Vultr sensor class and methods."""
+        mock.get('https://api.vultr.com/v1/account/info',
+            text="{}")


continuation line under-indented for visual indent

houndci-bot · 2017-10-20T17:02:47Z

tests/components/sensor/test_vultr.py

+
+        self.assertFalse(setup)
+
+        with pytest.raises(vol.Invalid):


undefined name 'pytest'
undefined name 'vol'

houndci-bot · 2017-10-20T17:02:47Z

tests/components/sensor/test_vultr.py

+    def test_invalid_sensor(self, mock):
+        """Test the Vultr sensor class and methods."""
+        mock.get('https://api.vultr.com/v1/account/info',
+            text="{}")


continuation line under-indented for visual indent

houndci-bot · 2017-10-20T17:56:06Z

tests/components/binary_sensor/test_vultr.py

+                                 device_attrs[ATTR_CREATED_AT])
+                self.assertEqual('123456',
+                                 device_attrs[ATTR_SUBSCRIPTION_ID])
+


blank line at end of file

fabaff · 2017-11-02T11:25:02Z

homeassistant/components/binary_sensor/vultr.py

+        add_devices([VultrBinarySensor(vultr, subscription, name)], True)
+    else:
+        _LOGGER.error(
+            "Subscription %s not found. Perhaps API key issue?",


Leave Perhaps API key issue? out because I could also be that the subscription doesn't exist.

fabaff · 2017-11-02T11:26:21Z

homeassistant/components/sensor/vultr.py

+    sensors = []
+
+    for condition in monitored_conditions:
+        if condition not in MONITORED_CONDITIONS:


This will never happen as the schema validation only allows entries in MONITORED_CONDITIONS.

fabaff · 2017-11-02T11:26:46Z

homeassistant/components/sensor/vultr.py

+                                       name))
+        else:
+            _LOGGER.error(
+                "Subscription %s not found. Perhaps API key issue?",


fabaff · 2017-11-02T11:27:52Z

homeassistant/components/sensor/vultr.py

+        self._vultr = vultr
+        self._subscription = subscription
+        self._var_id = variable
+        self.data = self._vultr.data[subscription]


Set it to None and let Home Assistant update set the state.

fabaff · 2017-11-02T11:30:55Z

homeassistant/components/binary_sensor/vultr.py

+    subscription = config.get(CONF_SUBSCRIPTION)
+    name = config.get(CONF_NAME)
+
+    if subscription in vultr.data:


Go for not in and log the error and return false as a guard clause. Now the else: can be avoided.

fabaff · 2017-11-02T11:41:02Z

homeassistant/components/switch/vultr.py

+    subscription = config.get(CONF_SUBSCRIPTION)
+    name = config.get(CONF_NAME)
+
+    if subscription in vultr.data:


fabaff · 2017-11-02T11:41:05Z

homeassistant/components/switch/vultr.py

+        self._vultr = vultr
+        self._subscription = subscription
+        self.data = self._vultr.data[subscription]
+        self._state = None


fabaff · 2017-11-02T11:41:15Z

homeassistant/components/switch/vultr.py

+        """Initialize a new Vultr switch."""
+        self._vultr = vultr
+        self._subscription = subscription
+        self.data = self._vultr.data[subscription]


With the switch component, I use this self.data immediately to format the name, allowing the default name of Vultr {} to be populated with the subscription's label. How do you think I should handle this? I could not use the label at all and default to Vultr subscription or something. Could move the name setting into update method. Could set data to None, but access the self._vultr.data[subscription]['label'] directly in this init method.

Thanks for you assistance with my PRs, it's always much appreciated and makes me proud to contribute to such a cool project.

Now I see the idea. As far as I can tell, is it required that the user provide the right string at the moment. Only something like MyName {} will work. If MyName is set then there will be an IndexError. My guess is that something like this could work:

[...] self._name = name @property def name(self): """Return the name of the switch.""" try: return self._name.format(self.data['label']) except IndexError: return self._name

fabaff · 2017-11-02T11:41:26Z

homeassistant/components/switch/vultr.py

+
+
+class VultrSwitch(SwitchDevice):
+    """Representation of a Vultr subsciption switch."""


fabaff · 2017-11-02T11:43:32Z

homeassistant/components/binary_sensor/vultr.py

+        return self._name
+
+    @property
+    def icon(self):


Use def device_class() for binary sensors.

Looking through the device_class types, the only one that jumps out to me is power, I notice the digitalocean binary sensor has moving. What would you suggest to pin it as?

If you prefer power then go with that. User can always overwrite it.

Have a working Vultr hub and binary sensor which pulls down the following attributes of your VPS: - Date created - Subscription id (server id) - Cost per month (in US$) - Operating System installed - IPv4 address - label (human readable name) - region - number of vcpus - which storage package chosen - IPV6 address (if applicable) - RAM amount Working next on sensor and then testing / coverage.

…red binary_sensor and hub too

…r alerting

- Refactored sensor, binary_sensor, and switch to reference one subscription - Renamed CURRENT_BANDWIDTH_GB monitored condition to CURRENT_BANDWIDTH_USED - Improved test coverage

fabaff

Thanks 🐦

GenericStudent requested a review from andrey-git as a code owner October 17, 2017 19:19

homeassistant added cla-signed new-platform platform: binary_sensor.vultr integration: vultr labels Oct 17, 2017

GenericStudent mentioned this pull request Oct 17, 2017

Adding in docs for Vultr platform and sensors home-assistant/home-assistant.io#3663

Merged

fabaff added the Hacktoberfest label Oct 18, 2017

homeassistant added the cla-signed label Oct 20, 2017

houndci-bot reviewed Oct 20, 2017

View reviewed changes

balloobbot added component platform requirement labels Oct 23, 2017

homeassistant added cla-signed labels Oct 25, 2017

fabaff removed the Hacktoberfest label Nov 2, 2017

fabaff reviewed Nov 2, 2017

View reviewed changes

homeassistant added the cla-signed label Nov 4, 2017

GenericStudent added 10 commits November 4, 2017 18:11

Added Vultr sensor for pending charges and current bandwidth. Refacto…

57a58dc

…red binary_sensor and hub too

Corrected is_on bases

1e8fc43

Added basic tests for Vultr binary & platform

4514f63

Updated require files

d195f75

Changing test fixture to highlight different cases

d362cc2

Written basic test for sensor.vultr

f1431f2

Resolved linting errors and broken test

cd69189

Increase test coverage and corrected docs

31b8f3c

Resolved hound issues

02c8e32

GenericStudent added 22 commits November 4, 2017 18:11

Revert back negative binary test

ce32532

Another hound resolve

1795f35

Refactoring and adding is switch, moving over to vultr branch

ac88b47

Made Vultr components more resiliant to invalid configs

565415b

Added negetive test for vultr binary sensor

a32b39d

Added better testing of vultr sensor

6e6bac3

Resolved vultr platform test affecting subsequent vultr tests

d99cb93

Moving VULTR components to single use design

370be57

Added in sensor name config

9655875

Added missing sensors var

d74dae5

Resolved init data setting of sensors, added in name conf to switch

5c66e1b

Made the Vultr component more resiliant to startup failure with bette…

25763d2

…r alerting

Various Vultr component changes

0197782

- Refactored sensor, binary_sensor, and switch to reference one subscription - Renamed CURRENT_BANDWIDTH_GB monitored condition to CURRENT_BANDWIDTH_USED - Improved test coverage

Resolved local tox linting issue

c2b90f7

Added more testing for Vultr switch

e664d10

Improved test coverage for Vultr components

a3c208f

Made PR comment changes to vultr binary sensor

4a2fda4

Made PR comment changes to Vultr sensor

c401be8

resolved PR comments for Vultr Switch

9fefdf0

Resolved vultr sensor name and improved tests

608067f

Improved Vultr switch testing (default name formatting)

a43ba9c

Removed vultr hub failure checking

e6424a5

homeassistant added the cla-signed label Nov 4, 2017

fabaff approved these changes Nov 5, 2017

View reviewed changes

fabaff merged commit 72ce9ec into home-assistant:dev Nov 5, 2017

balloob mentioned this pull request Nov 17, 2017

0.58 #10630

Merged

home-assistant locked and limited conversation to collaborators Mar 2, 2018

ghost removed platform: binary_sensor.vultr labels Mar 21, 2019



		class VultrSwitch(SwitchDevice):
		"""Representation of a Vultr subsciption switch."""

Uh oh!

Add platform and sensors for Vultr VPS #9928

Add platform and sensors for Vultr VPS #9928

Uh oh!

Conversation

GenericStudent commented Oct 17, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff Nov 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff Nov 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GenericStudent commented Oct 17, 2017 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

fabaff Nov 2, 2017 •

edited

Loading

fabaff Nov 2, 2017 •

edited

Loading