Merge ~andreserl/maas:ipmi_boot_type_2 into maas:master

[Andres Rodriguez]

Change the IPMI_BOOT_TYPE options to be more user friendly.

This allows to specify the boot type with generalized options instead of forcing the user of freeipmi-tools terminology.

[Newell Jensen (newell-jensen)]

Looks good. One inline comment.

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b ipmi_boot_type_2 lp:~andreserl/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci-jenkins.internal:8080/job/maas/job/branch-tester/2081/console
COMMIT: 7d9a04fb65d162db82df511cd70fdd1064911a08

review: Needs Fixing

[MAAS Lander (maas-lander)]

LANDING
-b ipmi_boot_type_2 lp:~andreserl/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED BUILD
LOG: http://maas-ci-jenkins.internal:8080/job/maas/job/branch-tester/2083/consoleText

Unmerged commits

7d9a04f... by Andres Rodriguez on 2018-03-26

Change the options for power_boot_type so that API users can specify them by using auto|legacy|efi instead of freeipmi-tools specific <null>|EFI|PC-COMPATIBLE

f5180d0... by Andres Rodriguez on 2018-03-21

Fix lint

87fc9dd... by Andres Rodriguez on 2018-03-21

Add missing tests

8a1cb40... by Andres Rodriguez on 2018-03-21

Fix tests

e9ffd06... by Andres Rodriguez on 2018-03-20

Fix tests

bf35c2f... by Andres Rodriguez on 2018-03-20

LP: #1750622 - Add ability to force the BIOS boot method, and auto discover it during enlistment/commissioning

2b2a439... by Andres Rodriguez on 2018-03-20

Fix lint

07d5287... by Andres Rodriguez on 2018-03-20

Fix review comments

36cdc4b... by Andres Rodriguez on 2018-03-20

Fix test

9e45488... by Andres Rodriguez on 2018-03-20

Add/fix tests

diff --git a/src/maasserver/api/tests/test_enlistment.py b/src/maasserver/api/tests/test_enlistment.py
index 5b636fb..2f03848 100644
--- a/src/maasserver/api/tests/test_enlistment.py
+++ b/src/maasserver/api/tests/test_enlistment.py
@@ -115,7 +115,7 @@ class EnlistmentAPITest(APITestCase.ForAnonymousAndUserAndAdmin):
         # Add the default values.
         power_parameters['power_driver'] = 'LAN_2_0'
         power_parameters['mac_address'] = ''
-        power_parameters['power_boot_type'] = ''
+        power_parameters['power_boot_type'] = 'auto'
         self.assertEqual(http.client.OK, response.status_code)
         [machine] = Machine.objects.filter(hostname=hostname)
         self.assertEqual(power_parameters, machine.power_parameters)
diff --git a/src/metadataserver/user_data/templates/snippets/maas_ipmi_autodetect.py b/src/metadataserver/user_data/templates/snippets/maas_ipmi_autodetect.py
index a2caa8e..72e2496 100644
--- a/src/metadataserver/user_data/templates/snippets/maas_ipmi_autodetect.py
+++ b/src/metadataserver/user_data/templates/snippets/maas_ipmi_autodetect.py
@@ -321,8 +321,8 @@ def bmc_supports_lan2_0():
 def get_system_boot_type():
     """Detect if the system has boot EFI."""
     if os.path.isdir('/sys/firmware/efi'):
-        return 'EFI'
-    return ''
+        return 'efi'
+    return 'auto'
 
 
 def main():
diff --git a/src/metadataserver/user_data/templates/snippets/tests/test_maas_ipmi_autodetect.py b/src/metadataserver/user_data/templates/snippets/tests/test_maas_ipmi_autodetect.py
index 37f52b6..86803eb 100644
--- a/src/metadataserver/user_data/templates/snippets/tests/test_maas_ipmi_autodetect.py
+++ b/src/metadataserver/user_data/templates/snippets/tests/test_maas_ipmi_autodetect.py
@@ -726,7 +726,7 @@ class TestGetSystemBootType(MAASTestCase):
 
     def test_get_system_boot_type_efi(self):
         """Test that returns ."""
-        boot_type = 'EFI'
+        boot_type = 'efi'
         # path os.path.isdir to return True to simulate
         # that /sys/firmware/efi exists.
         self.patch(os.path, "isdir").return_value = True
@@ -735,7 +735,7 @@ class TestGetSystemBootType(MAASTestCase):
 
     def test_get_system_boot_type_non_efi(self):
         """Test """
-        boot_type = ''
+        boot_type = 'auto'
         # path os.path.isdir to return False to simulate
         # that /sys/firmware/efi doesn't exist.
         self.patch(os.path, "isdir").return_value = False
diff --git a/src/provisioningserver/drivers/power/ipmi.py b/src/provisioningserver/drivers/power/ipmi.py
index 84835e1..ee5b413 100644
--- a/src/provisioningserver/drivers/power/ipmi.py
+++ b/src/provisioningserver/drivers/power/ipmi.py
@@ -169,9 +169,9 @@ IPMI_DRIVER_CHOICES = [
 
 class IPMI_BOOT_TYPE:
     # DEFAULT used to provide backwards compatibility
-    DEFAULT = ''
-    LEGACY = 'PC-COMPATIBLE'
-    EFI = 'EFI'
+    DEFAULT = 'auto'
+    LEGACY = 'legacy'
+    EFI = 'efi'
 
 
 IPMI_BOOT_TYPE_CHOICES = [
@@ -180,6 +180,11 @@ IPMI_BOOT_TYPE_CHOICES = [
     [IPMI_BOOT_TYPE.EFI, "EFI boot"]
     ]
 
+IPMI_BOOT_TYPE_MAPPING = {
+    IPMI_BOOT_TYPE.EFI: 'EFI',
+    IPMI_BOOT_TYPE.LEGACY: 'PC-COMPATIBLE',
+    }
+
 
 class IPMIPowerDriver(PowerDriver):
 
@@ -216,10 +221,13 @@ class IPMIPowerDriver(PowerDriver):
         env = shell.get_env_with_locale()
         with NamedTemporaryFile("w+", encoding="utf-8") as tmp_config:
             # Write out the chassis configuration.
-            if power_boot_type is None or power_boot_type == '':
+            if (power_boot_type is None
+                    or power_boot_type == IPMI_BOOT_TYPE.DEFAULT):
                 tmp_config.write(IPMI_CONFIG)
             else:
-                tmp_config.write(IPMI_CONFIG_WITH_BOOT_TYPE % power_boot_type)
+                tmp_config.write(
+                    IPMI_CONFIG_WITH_BOOT_TYPE %
+                    IPMI_BOOT_TYPE_MAPPING[power_boot_type])
             tmp_config.flush()
             # Use it when running the chassis config command.
             # XXX: Not using call_and_check here because we
diff --git a/src/provisioningserver/drivers/power/tests/test_ipmi.py b/src/provisioningserver/drivers/power/tests/test_ipmi.py
index 6e7a4b9..548846e 100644
--- a/src/provisioningserver/drivers/power/tests/test_ipmi.py
+++ b/src/provisioningserver/drivers/power/tests/test_ipmi.py
@@ -26,6 +26,7 @@ from provisioningserver.drivers.power import (
 )
 from provisioningserver.drivers.power.ipmi import (
     IPMI_BOOT_TYPE,
+    IPMI_BOOT_TYPE_MAPPING,
     IPMI_CONFIG,
     IPMI_CONFIG_WITH_BOOT_TYPE,
     IPMI_ERRORS,
@@ -379,6 +380,7 @@ class TestIPMIPowerDriver(MAASTestCase):
         self.assertThat(
             tmpfile.write,
             MockCalledOnceWith(
-                IPMI_CONFIG_WITH_BOOT_TYPE % IPMI_BOOT_TYPE.EFI))
+                IPMI_CONFIG_WITH_BOOT_TYPE % IPMI_BOOT_TYPE_MAPPING[
+                    IPMI_BOOT_TYPE.EFI]))
         self.assertThat(tmpfile.flush, MockCalledOnceWith())
         self.assertThat(tmpfile.__exit__, MockCalledOnceWith(None, None, None))