Merge ~ltrager/maas:lp1707562 into maas:master

[Lee Trager]

LP: #1707562 - When an admin creates a machine start commissioning using form.

When an administrator uses the API to create a machine start commissioning
using the CommissionForm. This allows the administrator to set all
commissioning options.

[MAAS Lander (maas-lander)]

UNIT TESTS
-b lp1707562 lp:~ltrager/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci-jenkins.internal:8080/job/maas/job/branch-tester/5064/console
COMMIT: 3be9f76033c4c718f774a289294a050dab0b4628

review: Needs Fixing

[Mike Pontillo (mpontillo)]

Looks good!

review: Approve

diff --git a/src/maasserver/api/machines.py b/src/maasserver/api/machines.py
index ee7c7b3..b706767 100644
--- a/src/maasserver/api/machines.py
+++ b/src/maasserver/api/machines.py
@@ -1,4 +1,4 @@
-# Copyright 2015-2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2015-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 __all__ = [
@@ -1760,6 +1760,34 @@ class MachinesHandler(NodesHandler, PowersMixin):
         COMMISSIONING. Machines will wait for COMMISSIONING results and not
         time out.
 
+        @param (int) "enable_ssh" [required=false]  Whether to enable SSH for
+        the commissioning environment using the user's SSH key(s). '1' == True,
+        '0' == False.
+
+        @param (int) "skip_bmc_config" [required=false] Whether to skip
+        re-configuration of the BMC for IPMI based machines. '1' == True, '0'
+        == False.
+
+        @param (int) "skip_networking" [required=false] Whether to skip
+        re-configuring the networking on the machine after the commissioning
+        has completed. '1' == True, '0' == False.
+
+        @param (int) "skip_storage" [required=false] Whether to skip
+        re-configuring the storage on the machine after the commissioning has
+        completed. '1' == True, '0' == False.
+
+        @param (string) "commissioning_scripts" [required=false] A comma
+        seperated list of commissioning script names and tags to be run. By
+        default all custom commissioning scripts are run. Built-in
+        commissioning scripts always run. Selecting 'update_firmware' or
+        'configure_hba' will run firmware updates or configure HBA's on
+        matching machines.
+
+        @param (string) "testing_scripts" [required=false] A comma seperated
+        list of testing script names and tags to be run. By default all tests
+        tagged 'commissioning' will be run. Set to 'none' to disable running
+        tests.
+
         @success (http-status-code) "200" 200
         @success (json) "success-json" A JSON object containing the machine
         information.
@@ -1768,10 +1796,12 @@ class MachinesHandler(NodesHandler, PowersMixin):
         """
         machine = create_machine(request)
         if request.user.is_superuser:
-            d = machine.start_commissioning(request.user)
+            form = CommissionForm(
+                instance=machine, user=request.user, data=request.data)
             # Silently ignore errors to prevent 500 errors. The commissioning
             # callbacks have their own logging. This fixes LP1600328.
-            d.addErrback(lambda _: None)
+            if form.is_valid():
+                machine = form.save()
         return machine
 
     def _check_system_ids_exist(self, system_ids):
diff --git a/src/maasserver/api/tests/test_machines.py b/src/maasserver/api/tests/test_machines.py
index 8b6bbed..efdc420 100644
--- a/src/maasserver/api/tests/test_machines.py
+++ b/src/maasserver/api/tests/test_machines.py
@@ -1,4 +1,4 @@
-# Copyright 2015-2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2015-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Tests for the machines API."""
@@ -74,6 +74,8 @@ from maastesting.matchers import (
 )
 from maastesting.testcase import MAASTestCase
 from maastesting.twisted import always_succeed_with
+from metadataserver.enum import SCRIPT_TYPE
+from metadataserver.models import ScriptSet
 from provisioningserver.rpc import cluster as cluster_module
 from provisioningserver.utils.enum import map_enum
 from testtools.matchers import (
@@ -268,6 +270,7 @@ class TestMachinesAPI(APITestCase.ForUser):
 
     def test_POST_handles_error_when_unable_to_access_bmc(self):
         # Regression test for LP1600328
+        self.patch(Machine, "_start").return_value = None
         make_usable_osystem(self)
         self.become_admin()
         power_address = factory.make_ip_address()
@@ -289,6 +292,32 @@ class TestMachinesAPI(APITestCase.ForUser):
             power_address, machine.power_parameters['power_address'])
         self.assertEqual(power_id, machine.power_parameters['power_id'])
 
+    def test_POST_starts_commissioning_with_selected_test_scripts(self):
+        # Regression test for LP1707562
+        self.become_admin()
+        self.patch(Machine, "_start").return_value = None
+        make_usable_osystem(self)
+        power_address = factory.make_ip_address()
+        power_id = factory.make_name('power_id')
+        test_script = factory.make_Script(script_type=SCRIPT_TYPE.TESTING)
+        response = self.client.post(
+            reverse('machines_handler'),
+            {
+                'architecture': make_usable_architecture(self),
+                'mac_addresses': ['aa:bb:cc:dd:ee:ff'],
+                'power_type': 'virsh',
+                'power_parameters_power_address': power_address,
+                'power_parameters_power_id': power_id,
+                'testing_scripts': test_script.name,
+            })
+        parsed_result = json.loads(response.content.decode())
+        self.assertEquals(NODE_STATUS.COMMISSIONING, parsed_result['status'])
+        script_set = ScriptSet.objects.get(
+            id=parsed_result['current_testing_result_id'])
+        self.assertItemsEqual(
+            [test_script.name],
+            [script_result.name for script_result in script_set])
+
     def test_GET_lists_machines(self):
         # The api allows for fetching the list of Machines.
         machine1 = factory.make_Node()