Merge maas:s390x-power-driver into maas:master

[Björn Tillenius]

Add a power driver for IBM Z LPARs. The power driver can connect to the HMC and turn on and off the LPARs.

Mostly complete, but might need another test or two.

Also, it currently depends on the Python zhmcclient library being used. For local testing I pip installed it, but it needs to be packaged before this branch can land.

26fa215... by Lee Trager on 2018-12-06

Define chassis = False

Unmerged commits

26fa215... by Lee Trager on 2018-12-06

Define chassis = False

80cca4d... by Björn Tillenius on 2018-06-26

Add a S390X power driver that can turn on an off LPARs.

diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index c7b9ac3..1ee698a 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -92,6 +92,8 @@ parts:
       - squid
       - tcpdump
       - ubuntu-keyring
+    python-packages:
+      - zhmcclient
     organize:
         lib/python3.*/site-packages/etc/*: etc
         lib/python3.*/site-packages/usr/bin/*: usr/bin
diff --git a/src/provisioningserver/drivers/hardware/s390x.py b/src/provisioningserver/drivers/hardware/s390x.py
new file mode 100644
index 0000000..3f7b13a
--- /dev/null
+++ b/src/provisioningserver/drivers/hardware/s390x.py
@@ -0,0 +1,48 @@
+# Copyright 2018 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+from zhmcclient import (
+    Client,
+    Session,
+)
+
+from provisioningserver.logger import get_maas_logger
+
+
+maaslog = get_maas_logger('drivers.s390x')
+
+
+class S390XHMCClient:
+
+    def __init__(self, host, user, password):
+        maaslog.info('Creating session')
+        self.session = Session(host, user, password)
+        maaslog.info('Creating client')
+        self.client = Client(self.session)
+
+    def get_power_state(self, uuid):
+        maaslog.info('Checking power state for {}'.format(uuid))
+        partition = self._get_partition(uuid)
+        return partition.properties['status']
+
+    def start_partition(self, uuid):
+        partition = self._get_partition(uuid)
+        partition.start(wait_for_completion=False)
+
+    def stop_partition(self, uuid):
+        partition = self._get_partition(uuid)
+        partition.stop(wait_for_completion=False)
+
+    def _get_partition(self, uuid):
+        maaslog.info('Finding partition {}'.format(uuid))
+        for cpc in self.client.cpcs.list():
+            maaslog.info('Found a CPC')
+            if not cpc.dpm_enabled:
+                maaslog.info('DPM is not enabled')
+                continue
+            maaslog.info('Listing partitions')
+            partitions = cpc.partitions.list(
+                full_properties=True, filter_args={'object-id': uuid})
+            if partitions:
+                maaslog.info('Found partition')
+                return partitions[0]
diff --git a/src/provisioningserver/drivers/hardware/tests/test_s390x.py b/src/provisioningserver/drivers/hardware/tests/test_s390x.py
new file mode 100644
index 0000000..58d16b5
--- /dev/null
+++ b/src/provisioningserver/drivers/hardware/tests/test_s390x.py
@@ -0,0 +1,44 @@
+# Copyright 2018 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for `provisioningserver.drivers.hardware.s390x`.
+"""
+
+__all__ = []
+
+import zhmcclient
+from zhmcclient_mock import FakedSession
+
+from maastesting.testcase import (
+    MAASTestCase,
+)
+from provisioningserver.drivers.hardware import s390x
+
+
+class TestS390XHMCClient(MAASTestCase):
+    """Tests for `S390XHMCClient`."""
+
+    def setUp(self):
+        super().setUp()
+        self.session_mock = self.patch(s390x, 'Session')
+        self.faked_session = FakedSession(
+            'example.com', 'hmc-test', '2.13.1', '1.8')
+        self.session_mock.return_value = self.faked_session
+        self.faked_session.hmc.cpcs.add(
+            {'name': 'cpc-test',
+             'dpm-enabled': True,
+             })
+        client = zhmcclient.Client(self.faked_session)
+        [cpc] = client.cpcs.list()
+        self.part = cpc.partitions.create(
+            {'name': 'test',
+             'status': 'active',
+             'object-id': 'some-uuid',
+             'initial-memory': 1024,
+             'maximum-memory': 2048})
+
+    def test_foo(self):
+        client = s390x.S390XHMCClient('foo', 'bar', 'baz')
+        self.assertEqual(
+            'active',
+            client.get_power_state(self.part.properties['object-id']))
diff --git a/src/provisioningserver/drivers/power/registry.py b/src/provisioningserver/drivers/power/registry.py
index 14a1136..a37692c 100644
--- a/src/provisioningserver/drivers/power/registry.py
+++ b/src/provisioningserver/drivers/power/registry.py
@@ -22,6 +22,7 @@ from provisioningserver.drivers.power.mscm import MSCMPowerDriver
 from provisioningserver.drivers.power.msftocs import MicrosoftOCSPowerDriver
 from provisioningserver.drivers.power.nova import NovaPowerDriver
 from provisioningserver.drivers.power.recs import RECSPowerDriver
+from provisioningserver.drivers.power.s390x import S390XPowerDriver
 from provisioningserver.drivers.power.seamicro import SeaMicroPowerDriver
 from provisioningserver.drivers.power.ucsm import UCSMPowerDriver
 from provisioningserver.drivers.power.virsh import VirshPowerDriver
@@ -61,6 +62,8 @@ power_drivers = [
     MicrosoftOCSPowerDriver(),
     NovaPowerDriver(),
     RECSPowerDriver(),
+    S390XPowerDriver(),
+    SeaMicroPowerDriver(),
     SeaMicroPowerDriver(),
     UCSMPowerDriver(),
     VirshPowerDriver(),
diff --git a/src/provisioningserver/drivers/power/s390x.py b/src/provisioningserver/drivers/power/s390x.py
new file mode 100644
index 0000000..3da60ea
--- /dev/null
+++ b/src/provisioningserver/drivers/power/s390x.py
@@ -0,0 +1,67 @@
+# Copyright 2018 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""s390x Power Driver."""
+
+__all__ = []
+
+from provisioningserver.drivers import (
+    make_ip_extractor,
+    make_setting_field,
+    SETTING_SCOPE,
+)
+from provisioningserver.drivers.hardware.s390x import S390XHMCClient
+from provisioningserver.drivers.power import PowerDriver
+from provisioningserver.logger import get_maas_logger
+
+
+maaslog = get_maas_logger('drivers.s390x')
+
+
+def get_client(context):
+    return S390XHMCClient(
+        host=context['power_address'], user=context['power_user'],
+        password=context['power_pass'])
+
+
+class S390XPowerDriver(PowerDriver):
+
+    name = 's390x'
+    chassis = False
+    description = "IBM Z (s390x)"
+    settings = [
+        make_setting_field('power_address', "HMC host", required=True),
+        make_setting_field('power_user', "HMC user", required=True),
+        make_setting_field(
+            'power_pass', "HMC password",
+            required=True, field_type='password'),
+        make_setting_field(
+            'power_uuid', "Partition UUID", scope=SETTING_SCOPE.NODE,
+            required=True),
+    ]
+
+    ip_extractor = make_ip_extractor('power_address')
+
+    def detect_missing_packages(self):
+        return []
+
+    def power_on(self, system_id, context):
+        """Power on S390X partition."""
+        client = get_client(context)
+        client.start_partition(context['power_uuid'])
+
+    def power_off(self, system_id, context):
+        """Power off Virsh node."""
+        client = get_client(context)
+        client.stop_partition(context['power_uuid'])
+
+    def power_query(self, system_id, context):
+        """Power query Virsh node."""
+        maaslog.info('Getting client')
+        client = get_client(context)
+        maaslog.info('Querying power state')
+        state = client.get_power_state(context['power_uuid'])
+        if state in ['starting', 'active', 'stopping', 'degraded']:
+            return 'on'
+        else:
+            return 'off'