Added vagrant vm spawning provider

Ticket: ENT-5725
Signed-off-by: Victor Moene <victor.moene@northern.tech>

Author: victormlg

cf_remote/Vagrantfile

@@ -0,0 +1,65 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+require 'json'
+
+config_path = File.expand_path("../config.json", __FILE__)
+if !File.file?(config_path)
+  abort "Need a config file for this host at " + config_path
+end
+config = JSON.parse(File.read(config_path))
+
+VM_BOX = config['box']
+VM_COUNT = config['count']
+VM_MEMORY = config['memory']
+VM_CPUS = config['cpus']
+VM_PROVISION = File.expand_path(config['provision'], __FILE__)
+VM_NAME = config['name']
+SYNC_FOLDER = config['sync_folder']
+
+Vagrant.configure("2") do |config|
+
+  (1..VM_COUNT).each do |i|
+
+    config.vm.define "#{VM_NAME}-#{i}" do |node|
+      node.vm.hostname = "#{VM_NAME}-#{i}"
+      node.vm.network "private_network", ip: "192.168.56.#{9 + i}"
+      node.vm.box = VM_BOX
+
+      node.vm.provision "shell" do |s|
+        ssh_pub_key = File.readlines("#{Dir.home}/.ssh/id_rsa.pub").first.strip
+        s.inline = <<-SHELL
+        echo #{ssh_pub_key} >> /home/vagrant/.ssh/authorized_keys
+        echo #{ssh_pub_key} >> /root/.ssh/authorized_keys
+        SHELL
+      end
+      node.vm.provision "bootstrap", type: "shell", path: VM_PROVISION
+      node.vm.synced_folder  ".", "/vagrant",
+                  rsync__args: ["--verbose", "--archive", "--delete", "-z", "--links"]
+      node.vm.synced_folder "#{SYNC_FOLDER}", "/northern.tech",
+                  rsync__args: ["--verbose", "--archive", "--delete", "-z", "--links"]
+
+      # https://bugs.launchpad.net/cloud-images/+bug/1874453
+      NOW = Time.now.strftime("%d.%m.%Y.%H:%M:%S")
+      FILENAME = "serial-debug-%s.log" % NOW
+      node.vm.provider "virtualbox" do |vb|
+          vb.memory = VM_MEMORY
+          vb.cpus = VM_CPUS
+          vb.customize [ "guestproperty", "set", :id, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-threshold", 1000 ]
+          vb.customize [ "modifyvm", :id, "--uart1", "0x3F8", "4" ]
+          vb.customize [ "modifyvm", :id, "--uartmode1", "file",
+          File.join(Dir.pwd, FILENAME) ]
+      end
+  
+      node.vm.provider :libvirt do |v, override|
+        v.memory = VM_MEMORY
+        v.cpus = VM_CPUS
+        # Fedora 30+ uses QEMU sessions by default, breaking pretty much all
+        # previously working Vagrantfiles:
+        # https://fedoraproject.org/wiki/Changes/Vagrant_2.2_with_QEMU_Session#Upgrade.2Fcompatibility_impact
+        v.qemu_use_session = false
+        override.vm.synced_folder "./", "/vagrant", type: :rsync
+        override.vm.synced_folder "#{SYNC_FOLDER}", "/northern.tech", type: :rsync
+      end
+    end
+  end
+end

cf_remote/commands.py

@@ -37,7 +37,14 @@
     CFRChecksumError,
     CFRUserError,
 )
-from cf_remote.spawn import VM, VMRequest, Providers, AWSCredentials, GCPCredentials
+from cf_remote.spawn import (
+    VM,
+    VMRequest,
+    Providers,
+    AWSCredentials,
+    GCPCredentials,
+    VagrantVM,
+)
 from cf_remote.spawn import spawn_vms, destroy_vms, dump_vms_info, get_cloud_driver
 from cf_remote import log
 from cf_remote import cloud_data
@@ -393,6 +400,9 @@ def spawn(
     network=None,
     public_ip=True,
     extend_group=False,
+    vagrant_cpus=None,
+    vagrant_sync=None,
+    vagrant_provision=None,
 ):
     creds_data = None
     if os.path.exists(CLOUD_CONFIG_FPATH):
@@ -469,13 +479,20 @@ def spawn(
             network=network,
             role=role,
             spawned_cb=print_progress_dot,
+            vagrant_cpus=vagrant_cpus,
+            vagrant_sync=vagrant_sync,
+            vagrant_provision=vagrant_provision,
         )
     except ValueError as e:
         print("\nError: Failed to spawn VMs - " + str(e))
         return 1
     print("DONE")
 
-    if public_ip and (not all(vm.public_ips for vm in vms)):
+    if (
+        provider != Providers.VAGRANT
+        and public_ip
+        and (not all(vm.public_ips for vm in vms))
+    ):
         print("Waiting for VMs to get IP addresses...", end="")
         sys.stdout.flush()  # STDOUT is line-buffered
         while not all(vm.public_ips for vm in vms):
@@ -565,35 +582,47 @@ def destroy(group_name=None):
 
         region = vms_info[group_name]["meta"]["region"]
         provider = vms_info[group_name]["meta"]["provider"]
-        if provider not in ["aws", "gcp"]:
+        if provider not in ["aws", "gcp", "vagrant"]:
             raise CFRUserError(
-                "Unsupported provider '{}' encountered in '{}', only aws / gcp is supported".format(
+                "Unsupported provider '{}' encountered in '{}', only aws, gcp or vagrant are supported".format(
                     provider, CLOUD_STATE_FPATH
                 )
             )
 
         driver = None
-        if provider == "aws":
-            if aws_creds is None:
-                raise CFRExitError("Missing/incomplete AWS credentials")
-            driver = get_cloud_driver(Providers.AWS, aws_creds, region)
-        if provider == "gcp":
-            if gcp_creds is None:
-                raise CFRExitError("Missing/incomplete GCP credentials")
-            driver = get_cloud_driver(Providers.GCP, gcp_creds, region)
-        assert driver is not None
-
-        nodes = driver.list_nodes()
-        for name, vm_info in vms_info[group_name].items():
-            if name == "meta":
-                continue
-            vm_uuid = vm_info["uuid"]
-            vm = VM.get_by_uuid(vm_uuid, nodes=nodes)
-            if vm is not None:
-                to_destroy.append(vm)
-            else:
-                print("VM '%s' not found in the clouds" % vm_uuid)
-        del vms_info[group_name]
+        if not provider == "vagrant":
+            if provider == "aws":
+                if aws_creds is None:
+                    raise CFRExitError("Missing/incomplete AWS credentials")
+                driver = get_cloud_driver(Providers.AWS, aws_creds, region)
+            if provider == "gcp":
+                if gcp_creds is None:
+                    raise CFRExitError("Missing/incomplete GCP credentials")
+                driver = get_cloud_driver(Providers.GCP, gcp_creds, region)
+
+            assert driver is not None
+
+            nodes = driver.list_nodes()
+            for name, vm_info in vms_info[group_name].items():
+                if name == "meta":
+                    continue
+                vm_uuid = vm_info["uuid"]
+                vm = VM.get_by_uuid(vm_uuid, nodes=nodes)
+                if vm is not None:
+                    to_destroy.append(vm)
+                else:
+                    print("VM '%s' not found in the clouds" % vm_uuid)
+            del vms_info[group_name]
+        else:
+            for name, vm_info in vms_info[group_name].items():
+                if name == "meta":
+                    continue
+                vm = VagrantVM.get_by_info(name, vm_info)
+                if vm is not None:
+                    to_destroy.append(vm)
+                else:
+                    print("VM '%s' not found in the clouds" % name)
+            del vms_info[group_name]
     else:
         print("Destroying all hosts")
         for group_name in [key for key in vms_info.keys() if key.startswith("@")]:
@@ -603,7 +632,7 @@ def destroy(group_name=None):
 
             region = vms_info[group_name]["meta"]["region"]
             provider = vms_info[group_name]["meta"]["provider"]
-            if provider not in ["aws", "gcp"]:
+            if provider not in ["aws", "gcp", "vagrant"]:
                 raise CFRUserError(
                     "Unsupported provider '{}' encountered in '{}', only aws / gcp is supported".format(
                         provider, CLOUD_STATE_FPATH
@@ -655,6 +684,10 @@ def list_platforms():
     return 0
 
 
+def list_boxes():
+    return 0
+
+
 def init_cloud_config():
     if os.path.exists(CLOUD_CONFIG_FPATH):
         print("File %s already exists" % CLOUD_CONFIG_FPATH)

cf_remote/main.py

@@ -224,6 +224,7 @@ def _get_arg_parser():
     sp.add_argument(
         "--list-platforms", help="List supported platforms", action="store_true"
     )
+    sp.add_argument("--list-boxes", help="List installed boxes", action="store_true")
     sp.add_argument(
         "--init-config",
         help="Initialize configuration file for spawn functionality",
@@ -242,8 +243,22 @@ def _get_arg_parser():
         help="Append the new VMs to a pre-existing group",
         action="store_true",
     )
-    sp.add_argument("--aws", help="Spawn VMs in AWS (default)", action="store_true")
-    sp.add_argument("--gcp", help="Spawn VMs in GCP", action="store_true")
+    sp.add_argument(
+        "--provider",
+        help="VM provider",
+        type=str,
+        default="aws",
+        choices=["aws", "gcp", "vagrant"],
+    )
+    sp.add_argument("--cpus", help="Number of cpus of the vagrant instances", type=str)
+    sp.add_argument(
+        "--sync-root",
+        help="Root folder of synchronized folders of vagrant instance",
+        type=str,
+    )
+    sp.add_argument(
+        "--provision", help="full path to provision shell script for Vagrant VM", type=str
+    )
     sp.add_argument("--size", help="Size/type of the instances", type=str)
     sp.add_argument(
         "--network", help="network/subnet to assign the VMs to (GCP only)", type=str
@@ -360,24 +375,38 @@ def run_command_with_args(command, args) -> int:
     elif command == "spawn":
         if args.list_platforms:
             return commands.list_platforms()
+        if args.list_boxes:
+            return commands.list_boxes()
         if args.init_config:
             return commands.init_cloud_config()
         if args.name and "," in args.name:
             raise CFRExitError("Group --name may not contain commas")
-        if args.aws and args.gcp:
-            raise CFRExitError("--aws and --gcp cannot be used at the same time")
         if args.role.endswith("s"):
             # role should be singular
             args.role = args.role[:-1]
-        if args.gcp:
+        if args.provider == "gcp":
             provider = Providers.GCP
-        else:
-            # AWS is currently also the default
+        elif args.provider == "aws":
             provider = Providers.AWS
             if args.network:
                 raise CFRExitError("--network not supported for AWS")
             if args.no_public_ip:
                 raise CFRExitError("--no-public-ip not supported for AWS")
+        else:
+            provider = Providers.VAGRANT
+
+        if provider != Providers.VAGRANT:
+            if args.cpus:
+                raise CFRExitError("--cpus not supported for {}".format(args.provider))
+            if args.sync_root:
+                raise CFRExitError(
+                    "--sync-root not supported for {}".format(args.provider)
+                )
+            if args.provision:
+                raise CFRExitError(
+                    "--provision not supported for {}".format(args.provider)
+                )
+
         if args.network and (args.network.count("/") != 1):
             raise CFRExitError(
                 "Invalid network specified, needs to be in the network/subnet format"
@@ -393,6 +422,9 @@ def run_command_with_args(command, args) -> int:
             network=args.network,
             public_ip=not args.no_public_ip,
             extend_group=args.append,
+            vagrant_cpus=args.cpus,
+            vagrant_sync=args.sync_root,
+            vagrant_provision=args.provision,
         )
     elif command == "show":
         return commands.show(args.ansible_inventory)