Snapshot management should be the same as Virtualbox

[simono74]

The snapshot management in the Vagrant VMWare plugin is different than the Virtualbox implementation.
In the Virtualbox implementation, doing "vagrant snapshot list" returns the list of snapshots as follows:

$ vagrant snapshot list
==> vm1:
snapshot1
snapshot2
snapshot3
==> vm2:
snapshot2
snapshot3

You can then restore the snapshots based on the unique name for the complete lab or per VM.
In the Vagrant VMWare plugin, the "vagrant snapshot list" returns a tree like list instead:

$ vagrant snapshot list
==> vm1:
snapshot1
snapshot1/snapshot2
snapshot1/snapshot2/snapshot3
==> vm2:
snapshot2
snapshot2/snapshot3

You must then pass the "path" in the vagrant snapshot restore command instead of only passing the snapshot name.
Trying to restore "snapshot2" for example would result in this error:

The snapshot name `snapshot2` was not found for the
virtual machine `vm1`.

To restore the snapshot, you need to pass the full path like "vagrant snapshot restore snapshot1/snapshot2".
However, this doesn't work in the example above since the path to "snapshot2" is different on both VMs. So it is not possible to restore this snapshot in one command.

The fix would be to handle the snapshots without the tree like structure like it is done in Virtualbox.

Expected behavior

Doing a 'vagrant snapshot list' should return the list of snapshots without the tree structure.

$ vagrant snapshot list
==> vm1:
snapshot1
snapshot2
snapshot3
==> vm2:
snapshot2
snapshot3

Restoring a snapshot should only take the snapshot name only even if we have nested snapshots.

Actual behavior

vagrant snapshot list returns a tree like output:

$ vagrant snapshot list
==> vm1:
snapshot1
snapshot1/snapshot2
snapshot1/snapshot2/snapshot3
==> vm2:
snapshot2
snapshot2/snapshot3

vagrant snapshot restore requires the full path to the snapshot instead of only the snapshot name:

vagrant snapshot restore snapshot1/snapshot2/snapshot3

Reproduction information

Vagrant version

2.4.7

Host operating system

Windows

Guest operating system

Oracle Linux 8

Steps to reproduce

See description above

[McAndersDK]

Funny, I actually want it to be like the vmware plugin, as we dont see the tree structure information with virtualbox.
so we can see if the snapshot are taken from another snapshot.
I guess, the list should have an option to define which format you want.
flat or path (tree)

[simono74]

I added an environment variable VAGRANT_VMWARE_USE_SNAPSHOT_TREE to toggle between the old behavior and the new in my PR (default behavior is the same as the Virtualbox behavior). Note that using the tree structure also breaks the checks that ensure we don't try to create a duplicate snapshot.
For example, if we have this snapshot structure:
VM snapshots:
test/test1

and we call: vagrant snapshot save test1

Due to the snapshot tree structure returned by the snapshot_list command, Vagrant tries to do the snapshot even if there is a duplicate one (because it compares 'test1' with 'test/test1' and doesn't find the clash):

vagrant snapshot save test1
==> as1: Snapshotting VM as 'test1'...
An error occurred while executing `vmrun`, a utility for controlling
VMware machines. The command and output are below:

Command: ["-T", "ws", "snapshot", "D:\\VM\\VMWare\\23372c17-9568-4d32-a2ad-9916f63942b3\\OracleLinux8.10_BroadWorks.vmx", "test1", {:notify=>[:stdout, :stderr]}]

Stdout: Error: A snapshot with the name already exists

Stderr:

while the correct behavior would be this (behaves correctly with the fix):

$ vagrant snapshot save test1
Ansible controller: as1
You must include the `--force` option to replace an existing snapshot.

So the snapshot management is clearly meant to be the same as what is done for Virtualbox. Still I understand that some users my be used to the previous behavior, so the environment variable allows going back to it if they want.