Skip to content

Commit

Permalink
support --no-destroy-on-error in up(), closes #122
Browse files Browse the repository at this point in the history
  • Loading branch information
eighthave committed Jul 14, 2022
1 parent 3576c0e commit fe28810
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/vagrant/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,14 +307,15 @@ def init(self, box_name=None, box_url=None):
"""
self._call_vagrant_command(["init", box_name, box_url])

def up(
def up( # pylint: disable-msg=too-many-locals
self,
vm_name=None,
no_provision=False,
provider=None,
provision=None,
provision_with=None,
stream_output=False,
destroy_on_error=True,
):
"""
Invoke `vagrant up` to start a box or boxes, possibly streaming the
Expand All @@ -330,6 +331,8 @@ def up(
subprocess might hang. if False, None is returned and the command
is run to completion without streaming the output. Defaults to
False.
destroy_on_error: if True, the newly created will be destroyed if there
was any error in the provisioning.
Note: If provision and no_provision are not None, no_provision will be
ignored.
returns: None or a generator yielding lines of output.
Expand All @@ -350,7 +353,10 @@ def up(
if provision
else "--no-provision"
)

if destroy_on_error:
destroy_on_error_arg = "--destroy-on-error"
else:
destroy_on_error_arg = "--no-destroy-on-error"
args = [
"up",
vm_name,
Expand All @@ -359,6 +365,7 @@ def up(
provider_arg,
prov_with_arg,
providers_arg,
destroy_on_error_arg,
]
if stream_output:
generator = self._stream_vagrant_command(args)
Expand Down
18 changes: 18 additions & 0 deletions tests/test_vagrant.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ def get_provider() -> str:
"vagrantfiles",
"shell_provision_Vagrantfile",
)
SHELL_PROVISION_FAIL_VAGRANTFILE = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
"vagrantfiles",
"shell_provision_fail_Vagrantfile",
)
# the names of the vms from the multi-vm Vagrantfile.
VM_1 = "web"
VM_2 = "db"
Expand Down Expand Up @@ -603,6 +608,19 @@ def test_provisioning(vm_dir):
assert test_file_contents == "foo", "The test file should contain 'foo'"


@pytest.mark.parametrize("vm_dir", (SHELL_PROVISION_FAIL_VAGRANTFILE,), indirect=True)
def test_provisioning_no_destory_on_error(vm_dir):
"""
Test support for 'vagrant up --no-destroy-on-error'.
"""
v = vagrant.Vagrant(vm_dir)
v.up(destroy_on_error=True)
assert v.status()[0].state == v.NOT_CREATED

v.up(destroy_on_error=False)
assert v.status()[0].state == v.RUNNING


@pytest.mark.parametrize("vm_dir", (MULTIVM_VAGRANTFILE,), indirect=True)
def test_multivm_lifecycle(vm_dir):
v = vagrant.Vagrant(vm_dir)
Expand Down
5 changes: 5 additions & 0 deletions tests/vagrantfiles/shell_provision_fail_Vagrantfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Vagrant.configure("2") do |config|
config.vbguest.auto_update = false if Vagrant.has_plugin?("vagrant-vbguest")
config.vm.box = "generic/alpine315"
config.vm.provision :shell, :inline => "exit 1"
end

0 comments on commit fe28810

Please sign in to comment.