Merge lp:~newell-jensen/maas/fix-1553841 into lp:~maas-committers/maas/trunk

[Newell Jensen]

Update AMT error messages to instruct the user if they have entered an incorrect BMC configuration (power parameters).

[Mike Pontillo (mpontillo)]

Code looks fine to me. Just a couple things I'm wondering:

 * Can you update the commit message so that it is more accurate? (it makes it sound like error propagation in general, but the branch seems to just fix up the AMT exceptions so that they are thrown correctly.)

 * Are we confident the AMT utilities will always print these particular strings? (I assume we're using a consistent locale, so that the strings don't show up translated into another language and surprise us. And I was wondering if using just the HTTP status code for matching might be more future-proof... assuming the output isn't too large, and we could match the number in multiple places in the string...?)

review: Needs Information

[Newell Jensen (newell-jensen)]

> Code looks fine to me. Just a couple things I'm wondering:
>
> * Can you update the commit message so that it is more accurate? (it makes it
> sound like error propagation in general, but the branch seems to just fix up
> the AMT exceptions so that they are thrown correctly.)
>
> * Are we confident the AMT utilities will always print these particular
> strings? (I assume we're using a consistent locale, so that the strings don't
> show up translated into another language and surprise us.

The subprocesses are executed using select_c_utf8_locale() to set the environment.

 And I was wondering
> if using just the HTTP status code for matching might be more future-proof...
> assuming the output isn't too large, and we could match the number in multiple
> places in the string...?)

I am on the fence about changing what we are matching on. Here are the two errors that amttool gives back:

401 Unauthorized at /usr/bin/amttool line 126.

and

500 Can't connect to 172.24.124.257:16992 at /usr/bin/amttool line 126.

If you think we should match just on the error status code and don't think it will cause any future issues, that is fine with me. These messages are coming back from amttool, so how I have it now seems fine to me.

[Mike Pontillo (mpontillo)]

Yeah. I suppose the other option would be to just match the beginning of the string, if it's always the first thing in the output.

OK, I'll approve this branch, but please update the commit message to be more accurate before you land it.

review: Approve

[MAAS Lander (maas-lander)]

The attempt to merge lp:~newell-jensen/maas/fix-1553841 into lp:maas failed. Below is the output from the failed tests.

Hit:1 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial InRelease
Get:2 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial-updates InRelease [93.3 kB]
Hit:3 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial-backports InRelease
Get:4 http://security.ubuntu.com/ubuntu xenial-security InRelease [92.2 kB]
Fetched 185 kB in 0s (389 kB/s)
Reading package lists...
sudo DEBIAN_FRONTEND=noninteractive apt-get -y \
    --no-install-recommends install apache2 archdetect-deb authbind bash bind9 bind9utils build-essential bzr bzr-builddeb chromium-browser chromium-chromedriver curl daemontools debhelper dh-apport dh-systemd distro-info dnsutils firefox freeipmi-tools git gjs ipython isc-dhcp-common libjs-angularjs libjs-jquery libjs-jquery-hotkeys libjs-yui3-full libjs-yui3-min libpq-dev make nodejs-legacy npm postgresql pxelinux python3-all python3-apt python3-bson python3-convoy python3-coverage python3-crochet python3-cssselect python3-curtin python3-dev python3-distro-info python3-django python3-django-nose python3-django-piston3 python3-dnspython python3-docutils python3-formencode python3-hivex python3-httplib2 python3-jinja2 python3-jsonschema python3-lxml python3-mock python3-netaddr python3-netifaces python3-oauth python3-oauthlib python3-openssl python3-paramiko python3-petname python3-pexpect python3-psycopg2 python3-pyinotify python3-pyparsing python3-pyvmomi python3-requests python3-seamicroclient python3-setuptools python3-simplestreams python3-sphinx python3-tempita python3-twisted python3-txtftp python3-tz python3-yaml python3-zope.interface python-bson python-crochet python-django python-django-piston python-djorm-ext-pgarray python-formencode python-lxml python-netaddr python-netifaces python-pocket-lint python-psycopg2 python-simplejson python-tempita python-twisted python-yaml socat syslinux-common tgt ubuntu-cloudimage-keyring wget xvfb
Reading package lists...
Building dependency tree...
Reading state information...
apache2 is already the newest version (2.4.18-2ubuntu3).
archdetect-deb is already the newest version (1.117ubuntu2).
authbind is already the newest version (2.1.1+nmu1).
bash is already the newest version (4.3-14ubuntu1).
build-essential is already the newest version (12.1ubuntu2).
bzr is already the newest version (2.7.0-2ubuntu1).
curl is already the newest version (7.47.0-1ubuntu2).
debhelper is already the newest version (9.20160115ubuntu3).
distro-info is already the newest version (0.14build1).
freeipmi-tools is already the newest version (1.4.11-1ubuntu1).
git is already the newest version (1:2.7.4-0ubuntu1).
isc-dhcp-common is already the newest version (4.3.3-5ubuntu12).
libjs-angularjs is already the newest version (1.2.28-1ubuntu2).
libjs-jquery is already the newest version (1.11.3+dfsg-4).
libjs-yui3-full is already the newest version (3.5.1-1ubuntu3).
libjs-yui3-min is already the newest version (3.5.1-1ubuntu3).
libpq-dev is already the newest version (9.5.2-1).
make is already the newest version (4.1-6).
postgresql is already the newest version (...

[Mike Pontillo (mpontillo)]

Looks like you need to "make format".

FAIL: maastesting.tests.test_lint.TestLint.test_that_imports_are_formatted

=(

=== modified file 'src/provisioningserver/drivers/power/amt.py'
--- src/provisioningserver/drivers/power/amt.py	2016-04-15 14:54:37 +0000
+++ src/provisioningserver/drivers/power/amt.py	2016-05-05 20:22:05 +0000
@@ -21,9 +21,10 @@
 from provisioningserver.drivers.power import (
     is_power_parameter_set,
     PowerActionError,
+    PowerAuthError,
     PowerConnError,
     PowerDriver,
-    PowerFatalError,
+    PowerSettingError,
 )
 from provisioningserver.utils import (
     shell,
@@ -31,6 +32,20 @@
 )
 
 
+AMT_ERRORS = {
+    '401 Unauthorized': {
+        'message': (
+            "Incorrect password.  Check BMC configuration and try again."),
+        'exception': PowerAuthError
+    },
+    "500 Can't connect": {
+        'message': (
+            "Could not connect to BMC.  "
+            "Check BMC configuration and try again."),
+        'exception': PowerConnError
+    },
+}
+
 REQUIRED_PACKAGES = [["amttool", "amtterm"], ["wsman", "wsmancli"]]
 
 
@@ -176,7 +191,7 @@
             sleep(1)
 
         if output is None:
-            raise PowerFatalError("amttool power querying FAILED.")
+            raise PowerActionError("amttool power querying failed.")
 
         # Ensure that from this point forward that output is a str.
         output = output.decode("utf-8")
@@ -228,7 +243,7 @@
             elif state in ('6', '8', '12', '13'):
                 return 'off'
             else:
-                raise PowerFatalError(
+                raise PowerActionError(
                     "Got unknown power state from node: %s" % state)
 
     def amttool_restart(self, ip_address, power_pass, amttool_boot_mode):
@@ -306,12 +321,16 @@
         stdout = stdout.decode("utf-8")
         stderr = stderr.decode("utf-8")
         if stdout == "" or stdout.isspace():
+            for error, error_info in AMT_ERRORS.items():
+                if error in stderr:
+                    raise error_info.get(
+                        'exception')(error_info.get('message'))
             raise PowerConnError(
                 "Unable to retrieve AMT version: %s" % stderr)
         else:
             match = re.search("AMT version:\s*([0-9]+)", stdout)
             if match is None:
-                raise PowerFatalError(
+                raise PowerActionError(
                     "Unable to extract AMT version from "
                     "amttool output: %s" % stdout)
             else:
@@ -341,7 +360,9 @@
         elif is_power_parameter_set(ip_address):
             return ip_address
         else:
-            raise PowerFatalError('No host provided')
+            raise PowerSettingError(
+                "No IP address provided.  "
+                "Please update BMC configuration and try again.")
 
     def power_on(self, system_id, context):
         """Power on AMT node."""

=== modified file 'src/provisioningserver/drivers/power/tests/test_amt.py'
--- src/provisioningserver/drivers/power/tests/test_amt.py	2016-04-15 14:54:37 +0000
+++ src/provisioningserver/drivers/power/tests/test_amt.py	2016-05-05 20:22:05 +0000
@@ -26,7 +26,10 @@
     PowerConnError,
     PowerFatalError,
 )
-from provisioningserver.drivers.power.amt import AMTPowerDriver
+from provisioningserver.drivers.power.amt import (
+    AMT_ERRORS,
+    AMTPowerDriver,
+)
 from provisioningserver.utils.shell import has_command_available
 from testtools.matchers import Equals
 
@@ -58,7 +61,7 @@
 """).encode('utf-8')
 
 
-def make_parameters():
+def make_context():
     return {
         'system_id': factory.make_name('system_id'),
         'power_address': factory.make_name('power_address'),
@@ -304,7 +307,7 @@
         _issue_amttool_command_mock.return_value = None
 
         self.assertRaises(
-            PowerFatalError, amt_power_driver.amttool_query_state,
+            PowerActionError, amt_power_driver.amttool_query_state,
             ip_address, power_pass)
 
     def test_amttool_restart_power_cycles(self):
@@ -431,7 +434,7 @@
         _issue_wsman_command_mock.return_value = WSMAN_OUTPUT % b'error'
 
         self.assertRaises(
-            PowerFatalError, amt_power_driver.wsman_query_state,
+            PowerActionError, amt_power_driver.wsman_query_state,
             ip_address, power_pass)
         self.assertThat(
             _issue_wsman_command_mock, MockCalledOnceWith(
@@ -571,9 +574,21 @@
         amt_power_driver = AMTPowerDriver()
         self.patch_popen(return_value=(b'No match here', b''))
         self.assertRaises(
-            PowerFatalError, amt_power_driver._get_amt_command,
+            PowerActionError, amt_power_driver._get_amt_command,
             sentinel.ip_address, sentinel.power_pass)
 
+    def test__get_amt_command_raises_power_error(self):
+        amt_power_driver = AMTPowerDriver()
+        for error, error_info in AMT_ERRORS.items():
+            popen_mock = self.patch(amt_module, 'Popen')
+            process = popen_mock.return_value
+            process.communicate.return_value = (b'', error.encode('utf-8'))
+            self.assertRaises(
+                error_info.get('exception'),
+                amt_power_driver._get_amt_command,
+                factory.make_ipv4_address(),
+                factory.make_name('power_pass'))
+
     def test__get_amttool_boot_mode_local_boot(self):
         amt_power_driver = AMTPowerDriver()
         result = amt_power_driver._get_amttool_boot_mode('local')
@@ -605,7 +620,7 @@
 
     def test_power_on_powers_on_with_amttool_when_already_on(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'amttool'
@@ -630,7 +645,7 @@
 
     def test_power_on_powers_on_with_amttool_when_already_off(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'amttool'
@@ -655,7 +670,7 @@
 
     def test_power_on_powers_on_with_wsman_when_already_on(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'wsman'
@@ -679,7 +694,7 @@
 
     def test_power_on_powers_on_with_wsman_when_already_off(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'wsman'
@@ -703,7 +718,7 @@
 
     def test_power_off_powers_off_with_amttool(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'amttool'
@@ -726,7 +741,7 @@
 
     def test_power_off_powers_off_with_wsman(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'wsman'
@@ -749,7 +764,7 @@
 
     def test_power_query_queries_with_amttool(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'amttool'
@@ -769,7 +784,7 @@
 
     def test_power_query_queries_with_wsman(self):
         amt_power_driver = AMTPowerDriver()
-        context = make_parameters()
+        context = make_context()
         _get_amt_command_mock = self.patch(
             amt_power_driver, '_get_amt_command')
         _get_amt_command_mock.return_value = 'wsman'