refactor utils.provision

mech/mech.py

@@ -338,8 +338,7 @@ def up(self, arguments):  # pylint: disable=invalid-name
                         print(colored.yellow("VM ({}) was already started on an "
                                              "unknown IP address".format(instance)))
                 if not disable_provisioning:
-                    utils.provision(instance, inst.vmx, inst.user, inst.password,
-                                    inst.provision, show=False)
+                    utils.provision(inst, show=False)
 
     # allows "mech start" to alias to "mech up"
     start = up
@@ -823,7 +822,7 @@ def provision(self, arguments):
             inst = MechInstance(instance)
 
             if inst.created:
-                utils.provision(instance, inst.vmx, inst.user, inst.password, inst.provision, show)
+                utils.provision(inst, show)
             else:
                 print("VM not created.")
 

mech/test_utils.py

@@ -404,25 +404,24 @@ def test_build_mechfile_entry_file_location_external_bad_location():
 def test_provision_no_instance():
     """Test provisioning."""
     with raises(SystemExit, match=r"Need to provide an instance to provision"):
-        mech.utils.provision(instance=None, vmx=None, user=None, password=None,
-                             provision_config=None, show=None)
+        mech.utils.provision(instance=None, show=None)
 
 
 def test_provision_no_vmx():
     """Test provisioning."""
+    mock_inst = MagicMock()
+    mock_inst.vmx = None
     with raises(SystemExit, match=r"Need to provide vmx.*"):
-        mech.utils.provision(instance='first', vmx=None, user=None, password=None,
-                             provision_config=None, show=None)
+        mech.utils.provision(instance=mock_inst, show=None)
 
 
 @patch('mech.vmrun.VMrun.installed_tools')
 def test_provision_no_vmare_tools(mock_installed_tools):
     """Test provisioning."""
+    mock_inst = MagicMock()
     mock_installed_tools.return_value = None
     with raises(SystemExit, match=r"Cannot provision if VMware Tools are not installed"):
-        mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                             user='vagrant', password='vagrant', provision_config=None,
-                             show=None)
+        mech.utils.provision(instance=mock_inst, show=None)
 
 
 @patch('mech.utils.provision_file')
@@ -431,8 +430,9 @@ def test_provision_file_no_provisioning(mock_installed_tools, mock_provision_fil
     """Test provisioning."""
     mock_installed_tools.return_value = "running"
     mock_provision_file.return_value = None
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx', user='vagrant',
-                         password='vagrant', provision_config=[], show=None)
+    mock_inst = MagicMock()
+    mock_inst.provision = []
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     assert re.search(r'Nothing to provision', out, re.MULTILINE)
 
@@ -450,8 +450,11 @@ def test_provision_file(mock_installed_tools, mock_copy_file, capfd):
             "destination": "/tmp/file1.txt",
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx', user='vagrant',
-                         password='vagrant', provision_config=config, show=None)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     assert re.search(r'Copying ', out, re.MULTILINE)
 
@@ -470,8 +473,11 @@ def test_provision_file_could_not_copy_file_to_guest(mock_installed_tools,
             "destination": "/tmp/file1.txt",
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx', user='vagrant',
-                         password='vagrant', provision_config=config, show=None)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     assert re.search(r'Not Provisioned', out, re.MULTILINE)
 
@@ -487,9 +493,11 @@ def test_provision_file_show(mock_installed_tools, capfd):
             "destination": "/tmp/file1.txt",
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                         user='vagrant', password='vagrant',
-                         provision_config=config, show=True)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=True)
     out, _ = capfd.readouterr()
     assert re.search(r'instance:', out, re.MULTILINE)
 
@@ -520,9 +528,11 @@ def test_provision_shell(mock_installed_tools, mock_copy_file,
             "inline": "echo hello from inline"
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                         user='vagrant', password='vagrant',
-                         provision_config=config, show=None)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     mock_installed_tools.assert_called()
     mock_copy_file.assert_called()
@@ -550,9 +560,11 @@ def test_provision_shell_show_only(mock_installed_tools, capfd):
             ],
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                         user='vagrant', password='vagrant',
-                         provision_config=config, show=True)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=True)
     out, _ = capfd.readouterr()
     mock_installed_tools.assert_called()
     assert re.search(r' instance:', out, re.MULTILINE)
@@ -573,9 +585,11 @@ def test_provision_shell_with_issue(mock_installed_tools, mock_provision_shell,
             ],
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                         user='vagrant', password='vagrant',
-                         provision_config=config, show=None)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     mock_installed_tools.assert_called()
     mock_provision_shell.assert_called()
@@ -590,9 +604,11 @@ def test_provision_with_unknown_type(mock_installed_tools, capfd):
             "type": "foo",
         },
     ]
-    mech.utils.provision(instance='first', vmx='/tmp/first/some.vmx',
-                         user='vagrant', password='vagrant',
-                         provision_config=config, show=None)
+    mock_inst = MagicMock()
+    mock_inst.name = 'first'
+    mock_inst.vmx = '/tmp/first/some.vmx'
+    mock_inst.provision = config
+    mech.utils.provision(instance=mock_inst, show=None)
     out, _ = capfd.readouterr()
     mock_installed_tools.assert_called()
     assert re.search(r'Not Provisioned', out, re.MULTILINE)

mech/utils.py

@@ -193,7 +193,7 @@ def update_vmx(path, numvcpus=None, memsize=None, no_nat=False):
 
 
 def load_mechfile(should_exist=True):
-    """Load the Mechfile from disk and return the object."""
+    """Load the Mechfile from disk and return the mechfile as a dictionary."""
     mechfile_fullpath = os.path.join(main_dir(), 'Mechfile')
     LOGGER.debug("mechfile_fullpath:%s", mechfile_fullpath)
     if os.path.isfile(mechfile_fullpath):
@@ -206,14 +206,12 @@ def load_mechfile(should_exist=True):
                 print(colored.red("Invalid Mechfile." + os.linesep))
     else:
         if should_exist:
-            print(colored.red(textwrap.fill(
-                "Could not find a Mechfile in the current directory. "
-                "A Mech environment is required to run this command. Run `mech init` "
-                "to create a new Mech environment. Or specify the name of the VM you would "
-                "like to start with `mech up <name>`. A final option is to change to a "
-                "directory with a Mechfile and to try again."
-            )))
-            sys.exit(1)
+            sys.exit(colored.red(textwrap.fill(
+                     "Could not find a Mechfile in the current directory. "
+                     "A Mech environment is required to run this command. Run `mech init` "
+                     "to create a new Mech environment. Or specify the name of the VM you would "
+                     "like to start with `mech up <name>`. A final option is to change to a "
+                     "directory with a Mechfile and to try again.")))
         else:
             return {}
 
@@ -356,8 +354,7 @@ def init_box(name, box=None, box_version=None, location=None, force=False, save=
             save=save,
             requests_kwargs=requests_kwargs)
         if not name_version_box:
-            print(colored.red("Cannot find a valid box with a VMX file in it"))
-            sys.exit(1)
+            sys.exit(colored.red("Cannot find a valid box with a VMX file in it"))
 
         box_parts = box.split('/')
         box_dir = os.path.join(*filter(None, (mech_dir(), 'boxes',
@@ -377,8 +374,7 @@ def init_box(name, box=None, box_version=None, location=None, force=False, save=
                 startupinfo.dwFlags |= subprocess.SW_HIDE | subprocess.STARTF_USESHOWWINDOW
             proc = subprocess.Popen(cmd, cwd=instance_path, startupinfo=startupinfo)
             if proc.wait():
-                print(colored.red("Cannot extract box"))
-                sys.exit(1)
+                sys.exit(colored.red("Cannot extract box"))
         else:
             tar = tarfile.open(box_file, 'r')
             tar.extractall(instance_path)
@@ -388,8 +384,7 @@ def init_box(name, box=None, box_version=None, location=None, force=False, save=
 
     vmx = locate(instance_path, '*.vmx')
     if not vmx:
-        print(colored.red("Cannot locate a VMX file"))
-        sys.exit(1)
+        sys.exit(colored.red("Cannot locate a VMX file"))
 
     update_vmx(vmx, numvcpus=numvcpus, memsize=memsize, no_nat=no_nat)
     return vmx
@@ -506,11 +501,9 @@ def add_box_url(name, box, box_version, url, force=False, save=True, requests_kw
             finally:
                 os.unlink(the_file.name)
         except requests.HTTPError as exc:
-            print(colored.red("Bad response: %s" % exc))
-            sys.exit(1)
+            sys.exit(colored.red("Bad response: %s" % exc))
         except requests.ConnectionError:
-            print(colored.red("Couldn't connect to '%s'" % url))
-            sys.exit(1)
+            sys.exit(colored.red("Couldn't connect to '%s'" % url))
     return name, box_version, box
 
 
@@ -538,11 +531,9 @@ def add_box_file(box=None, box_version=None, filename=None, url=None, force=Fals
                 valid_tar = True
                 break
             if i.startswith('/') or i.startswith('..'):
-                print(colored.red(textwrap.fill(
-                    "This box is comprised of filenames starting with '/' or '..' "
-                    "Exiting for the safety of your files."
-                )))
-                sys.exit(1)
+                sys.exit(colored.red(textwrap.fill(
+                         "This box is comprised of filenames starting with '/' or '..' "
+                         "Exiting for the safety of your files.")))
 
     if valid_tar:
         if save:
@@ -601,31 +592,36 @@ def get_requests_kwargs(arguments):
     return requests_kwargs
 
 
-def provision(instance, vmx, user, password, provision_config, show):
+def provision(instance, show=False):
     """Provision an instance.
 
-       provision types:
+    Args:
+        instance (MechInstance): an instance
+        show (bool): just print the provisioning
+
+    Notes:
+        Valid provision types are:
            file: copies files to instances
            shell: executes scripts
 
     """
 
-    if not instance or instance == '':
+    if not instance:
         sys.exit(colored.red("Need to provide an instance to provision()."))
 
-    if not vmx or not user or not password:
+    if instance.vmx is None or instance.user is None or instance.password is None:
         sys.exit(colored.red("Need to provide vmx/user/password to provision()."))
 
     print(colored.green('Provisioning instance:{}'.format(instance)))
 
-    vmrun = VMrun(vmx, user, password)
+    vmrun = VMrun(instance.vmx, instance.user, instance.password)
     # cannot run provisioning if vmware tools are not installed
     if not vmrun.installed_tools():
         sys.exit(colored.red("Cannot provision if VMware Tools are not installed."))
 
     provisioned = 0
-    if provision_config:
-        for i, pro in enumerate(provision_config):
+    if instance.provision:
+        for i, pro in enumerate(instance.provision):
             provision_type = pro.get('type')
             if provision_type == 'file':
                 source = pro.get('source')