Merge ~adacre/maas:eaton_driver into maas:master

[Alex Dacre]

Adds support for Eaton branded switched PDUs. Based heavily off of the APC driver.

[MAAS Lander (maas-lander)]

UNIT TESTS
-b eaton_driver lp:~adacre/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci-jenkins.internal:8080/job/maas/job/branch-tester/7045/console
COMMIT: 2d27119ed35b95072331ffdd3aa802e0406e651f

review: Needs Fixing

[Alex Dacre (adacre)]

Not sure which tests are failing - the tests added as part of this power driver are passing:

adacre@adacre-ubuntu:~/maas$ bin/test.parallel src/provisioningserver/drivers/power/tests/test_eaton.py
WARNING: bin/test.region.legacy will _never_ be selected when using
selectors at the command-line. Run bin/test.region.legacy directly.
Tests running...
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_missing_packages (0.03s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_no_missing_packages (0.01s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_power_query_returns_power_state_off (0.01s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_power_query_returns_power_state_on (0.00s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_run_process_crashes_on_external_process_error (0.01s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_run_process_crashes_on_no_power_state_match_found (0.01s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_power_off_calls_run_process (0.01s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_power_on_calls_run_process (0.00s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_power_query_crashes_for_uknown_power_state (0.00s)
SUCCESS: provisioningserver.drivers.power.tests.test_eaton.TestEatonPowerDriver.test_run_process_calls_command_and_returns_output (0.00s)

Ran 10 tests in 2.121s
OK

[Adam Collard (adam-collard)]

> UNIT TESTS
> -b eaton_driver lp:~adacre/maas/+git/maas into -b master lp:~maas-
> committers/maas
>
> STATUS: FAILED
> LOG: http://maas-ci-jenkins.internal:8080/job/maas/job/branch-
> tester/7045/console
> COMMIT: 2d27119ed35b95072331ffdd3aa802e0406e651f

The test failure here is a lint issue, can you please use `make format-py` to reformat your modules, and ensure that `make lint` passes?

Unmerged commits

de4a88f... by Alex Dacre on 2019-12-30

Add eaton power driver

address linter issue

diff --git a/src/provisioningserver/drivers/power/eaton.py b/src/provisioningserver/drivers/power/eaton.py
new file mode 100644
index 0000000..21c5843
--- /dev/null
+++ b/src/provisioningserver/drivers/power/eaton.py
@@ -0,0 +1,131 @@
+"""Eaton Power Driver.
+
+Support for managing Eaton PDU outlets via SNMP.
+"""
+
+__all__ = []
+
+import re
+from time import sleep
+
+from provisioningserver.drivers import (
+    make_ip_extractor,
+    make_setting_field,
+    SETTING_SCOPE,
+)
+from provisioningserver.drivers.power import PowerActionError, PowerDriver
+from provisioningserver.utils import shell
+
+
+class EatonState:
+    OFF = "0"
+    ON = "1"
+
+
+class EatonFunction:
+    QUERY = "2"
+    OFF = "3"
+    ON = "4"
+
+
+class EatonPowerDriver(PowerDriver):
+
+    name = "eaton"
+    chassis = True
+    description = "Eaton PDU"
+    settings = [
+        make_setting_field("power_address", "IP for Eaton PDU", required=True),
+        make_setting_field(
+            "node_outlet",
+            "Eaton PDU node outlet number (1-24)",
+            scope=SETTING_SCOPE.NODE,
+            required=True,
+        ),
+        make_setting_field(
+            "power_on_delay", "Power ON outlet delay (seconds)", default="5"
+        ),
+    ]
+    ip_extractor = make_ip_extractor("power_address")
+    queryable = False
+
+    def detect_missing_packages(self):
+        binary, package = ["snmpset", "snmp"]
+        if not shell.has_command_available(binary):
+            return [package]
+        return []
+
+    def run_process(self, *command):
+        """Run SNMP command in subprocess."""
+        result = shell.run_command(*command)
+        if result.returncode != 0:
+            raise PowerActionError(
+                "Eaton Power Driver external process error for command %s: %s"
+                % ("".join(command), result.stderr)
+            )
+        match = re.search(r"INTEGER:\s*([0-1])", result.stdout)
+        if match is None:
+            raise PowerActionError(
+                "Eaton Power Driver unable to extract outlet power state"
+                " from: %s" % result.stdout
+            )
+        else:
+            return match.group(1)
+
+    def power_on(self, system_id, context):
+        """Power on Eaton outlet."""
+        if self.power_query(system_id, context) == "on":
+            self.power_off(system_id, context)
+        sleep(float(context["power_on_delay"]))
+        self.run_process(
+            "snmpset",
+            *_get_common_args(
+                context["power_address"],
+                EatonFunction.ON,
+                context["node_outlet"],
+            ),
+            "i",
+            "0",
+        )
+
+    def power_off(self, system_id, context):
+        """Power off Eaton outlet."""
+        self.run_process(
+            "snmpset",
+            *_get_common_args(
+                context["power_address"],
+                EatonFunction.OFF,
+                context["node_outlet"],
+            ),
+            "i",
+            "0",
+        )
+
+    def power_query(self, system_id, context):
+        """Power query for Eaton outlet."""
+        power_state = self.run_process(
+            "snmpget",
+            *_get_common_args(
+                context["power_address"],
+                EatonFunction.QUERY,
+                context["node_outlet"],
+            ),
+        )
+        if power_state == EatonState.OFF:
+            return "off"
+        elif power_state == EatonState.ON:
+            return "on"
+        else:
+            raise PowerActionError(
+                "Eaton Power Driver retrieved unknown power state: %r"
+                % power_state
+            )
+
+
+def _get_common_args(address, function, outlet):
+    return [
+        "-c",
+        "private",
+        "-v1",
+        address,
+        f"1.3.6.1.4.1.534.6.6.7.6.6.1.{function}.0.{outlet}",
+    ]
diff --git a/src/provisioningserver/drivers/power/registry.py b/src/provisioningserver/drivers/power/registry.py
index 8ea5b27..a5e9a7d 100644
--- a/src/provisioningserver/drivers/power/registry.py
+++ b/src/provisioningserver/drivers/power/registry.py
@@ -12,6 +12,7 @@ from provisioningserver.drivers.power import JSON_POWER_DRIVERS_SCHEMA
 from provisioningserver.drivers.power.amt import AMTPowerDriver
 from provisioningserver.drivers.power.apc import APCPowerDriver
 from provisioningserver.drivers.power.dli import DLIPowerDriver
+from provisioningserver.drivers.power.eaton import EatonPowerDriver
 from provisioningserver.drivers.power.hmc import HMCPowerDriver
 from provisioningserver.drivers.power.ipmi import IPMIPowerDriver
 from provisioningserver.drivers.power.manual import ManualPowerDriver
@@ -52,6 +53,7 @@ power_drivers = [
     AMTPowerDriver(),
     APCPowerDriver(),
     DLIPowerDriver(),
+    EatonPowerDriver(),
     HMCPowerDriver(),
     IPMIPowerDriver(),
     ManualPowerDriver(),
diff --git a/src/provisioningserver/drivers/power/tests/test_eaton.py b/src/provisioningserver/drivers/power/tests/test_eaton.py
new file mode 100644
index 0000000..9550827
--- /dev/null
+++ b/src/provisioningserver/drivers/power/tests/test_eaton.py
@@ -0,0 +1,161 @@
+"""Tests for `provisioningserver.drivers.power.eaton`."""
+
+__all__ = []
+
+from testtools.matchers import Equals
+
+from maastesting.factory import factory
+from maastesting.matchers import MockCalledOnceWith
+from maastesting.testcase import MAASTestCase
+from provisioningserver.drivers.power import eaton as eaton_module
+from provisioningserver.drivers.power import PowerActionError
+from provisioningserver.utils.shell import has_command_available, ProcessResult
+
+COMMON_ARGS = "-c private -v1 {} 1.3.6.1.4.1.534.6.6.7.6.6.1.{}.0.{}"
+COMMON_OUTPUT = "iso.3.6.1.4.1.534.6.6.7.6.6.1.%s.0.%s = INTEGER: 0\n"
+
+
+class TestEatonPowerDriver(MAASTestCase):
+    def make_context(self):
+        return {
+            "power_address": factory.make_name("power_address"),
+            "node_outlet": factory.make_name("node_outlet"),
+            "power_on_delay": "5",
+        }
+
+    def test_missing_packages(self):
+        mock = self.patch(has_command_available)
+        mock.return_value = False
+        driver = eaton_module.EatonPowerDriver()
+        missing = driver.detect_missing_packages()
+        self.assertItemsEqual(["snmp"], missing)
+
+    def test_no_missing_packages(self):
+        mock = self.patch(has_command_available)
+        mock.return_value = True
+        driver = eaton_module.EatonPowerDriver()
+        missing = driver.detect_missing_packages()
+        self.assertItemsEqual([], missing)
+
+    def patch_run_command(self, stdout="", stderr="", returncode=0):
+        mock_run_command = self.patch(eaton_module.shell, "run_command")
+        mock_run_command.return_value = ProcessResult(
+            stdout=stdout, stderr=stderr, returncode=returncode
+        )
+        return mock_run_command
+
+    def test_run_process_calls_command_and_returns_output(self):
+        driver = eaton_module.EatonPowerDriver()
+        context = self.make_context()
+        command = ["snmpget"] + COMMON_ARGS.format(
+            context["power_address"],
+            eaton_module.EatonFunction.QUERY,
+            context["node_outlet"],
+        ).split()
+        mock_run_command = self.patch_run_command(
+            stdout=COMMON_OUTPUT
+            % (eaton_module.EatonFunction.QUERY, context["node_outlet"]),
+            stderr="error_output",
+        )
+        output = driver.run_process(*command)
+        mock_run_command.assert_called_once_with(*command)
+        self.expectThat(output, Equals(eaton_module.EatonState.OFF))
+
+    def test_run_process_crashes_on_external_process_error(self):
+        driver = eaton_module.EatonPowerDriver()
+        self.patch_run_command(returncode=1)
+        self.assertRaises(
+            PowerActionError, driver.run_process, factory.make_name("command")
+        )
+
+    def test_run_process_crashes_on_no_power_state_match_found(self):
+        driver = eaton_module.EatonPowerDriver()
+        self.patch_run_command(stdout="Error")
+        self.assertRaises(
+            PowerActionError, driver.run_process, factory.make_name("command")
+        )
+
+    def test_power_on_calls_run_process(self):
+        driver = eaton_module.EatonPowerDriver()
+        system_id = factory.make_name("system_id")
+        context = self.make_context()
+        mock_power_query = self.patch(driver, "power_query")
+        mock_power_query.return_value = "on"
+        self.patch(driver, "power_off")
+        mock_sleep = self.patch(eaton_module, "sleep")
+        mock_run_process = self.patch(driver, "run_process")
+        driver.power_on(system_id, context)
+
+        self.expectThat(
+            mock_power_query, MockCalledOnceWith(system_id, context)
+        )
+        self.expectThat(
+            mock_sleep, MockCalledOnceWith(float(context["power_on_delay"]))
+        )
+        command = (
+            ["snmpset"]
+            + COMMON_ARGS.format(
+                context["power_address"],
+                eaton_module.EatonFunction.ON,
+                context["node_outlet"],
+            ).split()
+            + ["i", "0"]
+        )
+        mock_run_process.assert_called_once_with(*command)
+
+    def test_power_off_calls_run_process(self):
+        driver = eaton_module.EatonPowerDriver()
+        system_id = factory.make_name("system_id")
+        context = self.make_context()
+        mock_run_process = self.patch(driver, "run_process")
+        driver.power_off(system_id, context)
+        command = (
+            ["snmpset"]
+            + COMMON_ARGS.format(
+                context["power_address"],
+                eaton_module.EatonFunction.OFF,
+                context["node_outlet"],
+            ).split()
+            + ["i", "0"]
+        )
+        mock_run_process.assert_called_once_with(*command)
+
+    def test_power_query_returns_power_state_on(self):
+        driver = eaton_module.EatonPowerDriver()
+        system_id = factory.make_name("system_id")
+        context = self.make_context()
+        mock_run_process = self.patch(driver, "run_process")
+        mock_run_process.return_value = eaton_module.EatonState.ON
+        result = driver.power_query(system_id, context)
+        command = ["snmpget"] + COMMON_ARGS.format(
+            context["power_address"],
+            eaton_module.EatonFunction.QUERY,
+            context["node_outlet"],
+        ).split()
+        mock_run_process.assert_called_once_with(*command)
+        self.expectThat(result, Equals("on"))
+
+    def test_power_query_returns_power_state_off(self):
+        driver = eaton_module.EatonPowerDriver()
+        system_id = factory.make_name("system_id")
+        context = self.make_context()
+        mock_run_process = self.patch(driver, "run_process")
+        mock_run_process.return_value = eaton_module.EatonState.OFF
+        result = driver.power_query(system_id, context)
+        command = ["snmpget"] + COMMON_ARGS.format(
+            context["power_address"],
+            eaton_module.EatonFunction.QUERY,
+            context["node_outlet"],
+        ).split()
+        mock_run_process.assert_called_once_with(*command)
+        self.expectThat(result, Equals("off"))
+
+    def test_power_query_crashes_for_uknown_power_state(self):
+        driver = eaton_module.EatonPowerDriver()
+        system_id = factory.make_name("system_id")
+        context = self.make_context()
+        mock_run_process = self.patch(driver, "run_process")
+        mock_run_process.return_value = "Error"
+        self.assertRaises(
+            PowerActionError, driver.power_query, system_id, context
+        )