Merge ~newell-jensen/maas:2.5-lp1814623 into maas:2.5

[Newell Jensen]

backport 225eed04a3b40bd2b2d2b777bf70030452ecf394 - LP: #1814623 -- Don't require node_id power parameter for Redfish. If not supplied by the user, search for the first available system's id.

[Newell Jensen (newell-jensen)]

Self approved backport.

review: Approve

diff --git a/src/provisioningserver/drivers/power/redfish.py b/src/provisioningserver/drivers/power/redfish.py
index 5b47e21..bca30b5 100644
--- a/src/provisioningserver/drivers/power/redfish.py
+++ b/src/provisioningserver/drivers/power/redfish.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2018-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Redfish Power Driver."""
@@ -11,7 +11,10 @@ from base64 import b64encode
 from http import HTTPStatus
 from io import BytesIO
 import json
-from os.path import join
+from os.path import (
+    basename,
+    join,
+)
 
 from provisioningserver.drivers import (
     make_ip_extractor,
@@ -42,7 +45,7 @@ from twisted.web.http_headers import Headers
 REDFISH_POWER_CONTROL_ENDPOINT = (
     b"redfish/v1/Systems/%s/Actions/ComputerSystem.Reset/")
 
-REDFISH_SYSTEMS_ENDPOINT = b"redfish/v1/Systems/%s/"
+REDFISH_SYSTEMS_ENDPOINT = b"redfish/v1/Systems/"
 
 
 class WebClientContextFactory(BrowserLikePolicyForHTTPS):
@@ -78,13 +81,6 @@ class RedfishPowerDriverBase(PowerDriver):
             }
         )
 
-    def process_redfish_context(self, context):
-        """Process Redfish power driver context."""
-        url = self.get_url(context)
-        node_id = context.get('node_id').encode('utf-8')
-        headers = self.make_auth_headers(**context)
-        return url, node_id, headers
-
     @asynchronous
     def redfish_request(self, method, uri, headers=None, bodyProducer=None):
         """Send the redfish request and return the response."""
@@ -144,8 +140,7 @@ class RedfishPowerDriver(RedfishPowerDriverBase):
             'power_pass', "Redfish password",
             field_type='password', required=True),
         make_setting_field(
-            'node_id', "Node ID",
-            scope=SETTING_SCOPE.NODE, required=True),
+            'node_id', "Node ID", scope=SETTING_SCOPE.NODE),
     ]
     ip_extractor = make_ip_extractor('power_address')
 
@@ -154,9 +149,38 @@ class RedfishPowerDriver(RedfishPowerDriverBase):
         return []
 
     @inlineCallbacks
+    def process_redfish_context(self, context):
+        """Process Redfish power driver context.
+
+        Returns the basename of the first member found
+        in the Redfish Systems:
+
+        "Members": [
+          {
+            "@odata.id": "/redfish/v1/Systems/1"
+          }
+        """
+        url = self.get_url(context)
+        headers = self.make_auth_headers(**context)
+        node_id = context.get('node_id')
+        if node_id:
+            node_id = node_id.encode('utf-8')
+        else:
+            node_id = yield self.get_node_id(url, headers)
+        return url, node_id, headers
+
+    @inlineCallbacks
+    def get_node_id(self, url, headers):
+        uri = join(url, REDFISH_SYSTEMS_ENDPOINT)
+        systems, _ = yield self.redfish_request(b"GET", uri, headers)
+        members = systems.get('Members')
+        member = members[0].get('@odata.id')
+        return basename(member).encode('utf-8')
+
+    @inlineCallbacks
     def set_pxe_boot(self, url, node_id, headers):
         """Set the machine with node_id to PXE boot."""
-        endpoint = REDFISH_SYSTEMS_ENDPOINT % node_id
+        endpoint = REDFISH_SYSTEMS_ENDPOINT + b'%s/' % node_id
         payload = FileBodyProducer(
             BytesIO(
                 json.dumps(
@@ -185,10 +209,10 @@ class RedfishPowerDriver(RedfishPowerDriverBase):
 
     @asynchronous
     @inlineCallbacks
-    def power_on(self, system_id, context):
+    def power_on(self, node_id, context):
         """Power on machine."""
-        url, node_id, headers = self.process_redfish_context(context)
-        power_state = yield self.power_query(system_id, context)
+        url, node_id, headers = yield self.process_redfish_context(context)
+        power_state = yield self.power_query(node_id, context)
         # Power off the machine if currently on.
         if power_state == 'on':
             yield self.power("ForceOff", url, node_id, headers)
@@ -199,9 +223,9 @@ class RedfishPowerDriver(RedfishPowerDriverBase):
 
     @asynchronous
     @inlineCallbacks
-    def power_off(self, system_id, context):
+    def power_off(self, node_id, context):
         """Power off machine."""
-        url, node_id, headers = self.process_redfish_context(context)
+        url, node_id, headers = yield self.process_redfish_context(context)
         # Set to PXE boot.
         yield self.set_pxe_boot(url, node_id, headers)
         # Power off the machine.
@@ -209,9 +233,9 @@ class RedfishPowerDriver(RedfishPowerDriverBase):
 
     @asynchronous
     @inlineCallbacks
-    def power_query(self, system_id, context):
+    def power_query(self, node_id, context):
         """Power query machine."""
-        url, node_id, headers = self.process_redfish_context(context)
-        uri = join(url, REDFISH_SYSTEMS_ENDPOINT % node_id)
+        url, node_id, headers = yield self.process_redfish_context(context)
+        uri = join(url, REDFISH_SYSTEMS_ENDPOINT + b'%s/' % node_id)
         node_data, _ = yield self.redfish_request(b"GET", uri, headers)
         return node_data.get('PowerState').lower()
diff --git a/src/provisioningserver/drivers/power/tests/test_redfish.py b/src/provisioningserver/drivers/power/tests/test_redfish.py
index f6db6e3..ca2a771 100644
--- a/src/provisioningserver/drivers/power/tests/test_redfish.py
+++ b/src/provisioningserver/drivers/power/tests/test_redfish.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2018-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Tests for `provisioningserver.drivers.power.redfish`."""
@@ -168,7 +168,6 @@ def make_context():
         'power_address': factory.make_ipv4_address(),
         'power_user': factory.make_name('power_user'),
         'power_pass': factory.make_name('power_pass'),
-        'node_id': factory.make_name('node_id'),
     }
 
 
@@ -332,7 +331,7 @@ class TestRedfishPowerDriver(MAASTestCase):
         power_change = factory.make_name('power_change')
         url = driver.get_url(context)
         headers = driver.make_auth_headers(**context)
-        node_id = context.get('node_id').encode('utf-8')
+        node_id = b'1'
         mock_file_body_producer = self.patch(
             redfish_module, 'FileBodyProducer')
         payload = FileBodyProducer(
@@ -354,7 +353,7 @@ class TestRedfishPowerDriver(MAASTestCase):
         driver = RedfishPowerDriver()
         context = make_context()
         url = driver.get_url(context)
-        node_id = context.get('node_id').encode('utf-8')
+        node_id = b'1'
         headers = driver.make_auth_headers(**context)
         mock_file_body_producer = self.patch(
             redfish_module, 'FileBodyProducer')
@@ -378,21 +377,23 @@ class TestRedfishPowerDriver(MAASTestCase):
     @inlineCallbacks
     def test__power_on(self):
         driver = RedfishPowerDriver()
-        system_id = factory.make_name('system_id')
         context = make_context()
         url = driver.get_url(context)
         headers = driver.make_auth_headers(**context)
-        node_id = context.get('node_id').encode('utf-8')
+        node_id = b'1'
+        mock_redfish_request = self.patch(driver, 'redfish_request')
+        mock_redfish_request.return_value = (
+            SAMPLE_JSON_SYSTEMS, None)
         mock_set_pxe_boot = self.patch(driver, 'set_pxe_boot')
         mock_power_query = self.patch(driver, 'power_query')
         mock_power_query.return_value = "on"
         mock_power = self.patch(driver, 'power')
 
-        yield driver.power_on(system_id, context)
+        yield driver.power_on(node_id, context)
         self.assertThat(mock_set_pxe_boot, MockCalledOnceWith(
             url, node_id, headers))
         self.assertThat(mock_power_query, MockCalledOnceWith(
-            system_id, context))
+            node_id, context))
         self.assertThat(mock_power, MockCallsMatch(
             call("ForceOff", url, node_id, headers),
             call("On", url, node_id, headers)))
@@ -400,15 +401,17 @@ class TestRedfishPowerDriver(MAASTestCase):
     @inlineCallbacks
     def test__power_off(self):
         driver = RedfishPowerDriver()
-        system_id = factory.make_name('system_id')
         context = make_context()
         url = driver.get_url(context)
         headers = driver.make_auth_headers(**context)
-        node_id = context.get('node_id').encode('utf-8')
+        node_id = b'1'
+        mock_redfish_request = self.patch(driver, 'redfish_request')
+        mock_redfish_request.return_value = (
+            SAMPLE_JSON_SYSTEMS, None)
         mock_set_pxe_boot = self.patch(driver, 'set_pxe_boot')
         mock_power = self.patch(driver, 'power')
 
-        yield driver.power_off(system_id, context)
+        yield driver.power_off(node_id, context)
         self.assertThat(mock_set_pxe_boot, MockCalledOnceWith(
             url, node_id, headers))
         self.assertThat(mock_power, MockCalledOnceWith(
@@ -423,7 +426,10 @@ class TestRedfishPowerDriver(MAASTestCase):
         mock_redfish_request = self.patch(driver, 'redfish_request')
         NODE_POWERED_ON = deepcopy(SAMPLE_JSON_SYSTEM)
         NODE_POWERED_ON['PowerState'] = "On"
-        mock_redfish_request.return_value = (NODE_POWERED_ON, None)
+        mock_redfish_request.side_effect = [
+            (SAMPLE_JSON_SYSTEMS, None),
+            (NODE_POWERED_ON, None),
+        ]
         power_state = yield driver.power_query(system_id, context)
         self.assertEquals(power_state, power_change.lower())
 
@@ -434,6 +440,9 @@ class TestRedfishPowerDriver(MAASTestCase):
         system_id = factory.make_name('system_id')
         context = make_context()
         mock_redfish_request = self.patch(driver, 'redfish_request')
-        mock_redfish_request.return_value = (SAMPLE_JSON_SYSTEM, None)
+        mock_redfish_request.side_effect = [
+            (SAMPLE_JSON_SYSTEMS, None),
+            (SAMPLE_JSON_SYSTEM, None),
+        ]
         power_state = yield driver.power_query(system_id, context)
         self.assertEquals(power_state, power_change.lower())