Added ability to add url for write_files section.

Some systems have to have a strict control, even in system state
information. Prefixed with "sudo" to command to gather information how
cloud init is doing.

README.rst

@@ -2,8 +2,8 @@
 box.py
 ======
 
-Box.py is a simple automation tool meant to run Ubuntu or Fedora cloud images
-on top of VirtualBox.
+Box.py is a simple automation tool meant to run Ubuntu, Fedora or Centos Stream
+cloud images on top of VirtualBox.
 
 What it does is simply download official cloud image, set up VM, tweak it up
 and do the initial pre-configuration using generated config drive.
@@ -19,6 +19,7 @@ Requirements
 - Python 3.x
 
   - `pyyaml`_
+  - `requests`_
 
 - Virtualbox (obviously)
 - ``mkisofs`` or ``genisoimage`` command for generating iso image
@@ -140,11 +141,20 @@ pass filenames to the custom config, instead of filling up
        permissions: '0644'
        filename: /path/to/local/file.txt
 
-during processing this file, boxpy will look for ``filename`` key in the yaml
-file for the ``write_files`` sections, and it will remove that key, read the
-file and put its contents under ``content`` key. What is more important, that
-will be done after template processing, so there will be no interference for
-possible ``$`` characters.
+or
+
+.. code:: yaml
+
+   write_files:
+     - path: /opt/somefile.txt
+       permissions: '0644'
+       url: https://some.url/content
+
+during processing this file, boxpy will look for ``filename`` or ``url`` keys
+in the yaml file for the ``write_files`` sections, and it will remove that key,
+read the file and put its contents under ``content`` key. What is more
+important, that will be done after template processing, so there will be no
+interference for possible ``$`` characters.
 
 What is more interesting is the fact, that you could use whatever cloud-init
 accepts, and a special section, for keeping configuration, so that you don't
@@ -202,3 +212,4 @@ This work is licensed under GPL-3.
 
 .. _pyyaml: https://github.com/yaml/pyyaml
 .. _cloud-init: https://cloudinit.readthedocs.io
+.. _requests: https://docs.python-requests.org

box.py

@@ -4,6 +4,7 @@ import argparse
 import collections.abc
 import os
 import random
+import re
 import shutil
 import string
 import subprocess
@@ -13,16 +14,18 @@ import time
 import uuid
 import xml.dom.minidom
 
+import requests
 import yaml
 
 
-__version__ = "1.0"
+__version__ = "1.2"
 
 CACHE_DIR = os.environ.get('XDG_CACHE_HOME', os.path.expanduser('~/.cache'))
 CLOUD_IMAGE = "ci.iso"
 FEDORA_RELEASE_MAP = {'32': '1.6', '33': '1.2', '34': '1.2'}
 TYPE_MAP = {'HardDisk': 'disk', 'DVD': 'dvd', 'Floppy': 'floppy'}
-DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora'}
+DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora',
+              'centos': 'Centos Stream'}
 META_DATA_TPL = string.Template('''\
 instance-id: $instance_id
 local-hostname: $vmhostname
@@ -136,7 +139,7 @@ _boxpy() {
             ;;
         create|rebuild)
             items=(--cpus --disable-nested --disk-size --distro --forwarding
-                --key --memory --hostname --port --config --version)
+                --key --memory --hostname --port --config --version --type)
             if [[ ${prev} == ${cmd} ]]; then
                 if [[ ${cmd} = "rebuild" ]]; then
                     _vms_comp vms
@@ -156,7 +159,12 @@ _boxpy() {
                         _ssh_identityfile
                         ;;
                     --distro)
-                        COMPREPLY=( $(compgen -W "ubuntu fedora" -- ${cur}) )
+                        COMPREPLY=( $(compgen -W "ubuntu fedora centos" \
+                                -- ${cur}) )
+                        ;;
+                    --type)
+                        COMPREPLY=( $(compgen -W "gui headless sdl separate" \
+                            -- ${cur}) )
                         ;;
                     --*)
                         COMPREPLY=( )
@@ -416,27 +424,52 @@ class Config:
         if conf.get('write_files'):
             new_list = []
             for file_data in conf['write_files']:
+                content = None
                 fname = file_data.get('filename')
-                if not fname:
+                url = file_data.get('url')
+                if not any((fname, url)):
                     new_list.append(file_data)
                     continue
 
-                fname = os.path.expanduser(os.path.expandvars(fname))
-                if not os.path.exists(fname):
-                    LOG.warning("File '%s' doesn't exists",
-                                file_data['filename'])
-                    continue
+                if fname:
+                    key = 'filename'
+                    content = self._read_filename(fname)
+                    if content is None:
+                        LOG.warning("File '%s' doesn't exists", fname)
+                        continue
 
-                with open(fname) as fobj:
-                    file_data['content'] = fobj.read()
-                del file_data['filename']
-                new_list.append(file_data)
+                if url:
+                    key = 'url'
+                    code, content = self._get_url(url)
+                    if content is None:
+                        LOG.warning("Getting url '%s' returns %s code",
+                                    url, code)
+                        continue
+
+                if content:
+                    file_data['content'] = content
+                    del file_data[key]
+                    new_list.append(file_data)
 
             conf['write_files'] = new_list
 
         # 3. finally dump it again.
         return "#cloud-config\n" + yaml.safe_dump(conf)
 
+    def _get_url(self, url):
+        response = requests.get(url)
+        if response.status_code != 200:
+            return response.status_code, None
+        return response.status_code, response.text
+
+    def _read_filename(self, fname):
+        fullpath = os.path.expanduser(os.path.expandvars(fname))
+        if not os.path.exists(fullpath):
+            return
+
+        with open(fname) as fobj:
+            return fobj.read()
+
     def _set_ssh_key_path(self):
         self.ssh_key_path = self.key
 
@@ -630,7 +663,7 @@ class VBoxManage:
                     continue
             if long_list:
                 info = "\n".join(Run(['vboxmanage', 'showvminfo',
-                                      info]).stdout.split('\n'))
+                                      name]).stdout.split('\n'))
             machines[name] = info
         return machines
 
@@ -751,9 +784,9 @@ class VBoxManage:
             return False
         return True
 
-    def poweron(self):
+    def poweron(self, type_='headless'):
         if Run(['vboxmanage', 'startvm', self.name_or_uuid, '--type',
-                'headless']).returncode != 0:
+                type_]).returncode != 0:
             LOG.fatal('Failed to start: %s', self.name_or_uuid)
             raise BoxVBoxFailure()
 
@@ -861,21 +894,6 @@ class Image:
             return False
         return True
 
-    def _download_image(self):
-        raise NotImplementedError()
-
-
-class Ubuntu(Image):
-    URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s"
-    IMG = "ubuntu-%s-server-cloudimg-%s.img"
-
-    def __init__(self, vbox, version, arch, release):
-        super().__init__(vbox, version, arch, release)
-        self._img_fname = self.IMG % (version, arch)
-        self._img_url = self.URL % (version, self._img_fname)
-        self._checksum_file = 'SHA256SUMS'
-        self._checksum_url = self.URL % (version, self._checksum_file)
-
     def _checksum(self):
         """
         Get and check checkusm for downloaded image. Return True if the
@@ -886,15 +904,8 @@ class Ubuntu(Image):
             return False
 
         LOG.info('Calculating checksum for "%s"', self._img_fname)
-        expected_sum = None
         fname = os.path.join(self._tmp, self._checksum_file)
-        Run(['wget', self._checksum_url, '-q', '-O', fname])
-
-        with open(fname) as fobj:
-            for line in fobj.readlines():
-                if self._img_fname in line:
-                    expected_sum = line.split(' ')[0]
-                    break
+        expected_sum = self._get_checksum(fname)
 
         if not expected_sum:
             LOG.fatal('Cannot find checksum for provided cloud image')
@@ -926,6 +937,32 @@ class Ubuntu(Image):
         LOG.header('Downloaded image %s', self._img_fname)
         return True
 
+    def _get_checksum(self, fname):
+        raise NotImplementedError()
+
+
+class Ubuntu(Image):
+    URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s"
+    IMG = "ubuntu-%s-server-cloudimg-%s.img"
+
+    def __init__(self, vbox, version, arch, release):
+        super().__init__(vbox, version, arch, release)
+        self._img_fname = self.IMG % (version, arch)
+        self._img_url = self.URL % (version, self._img_fname)
+        self._checksum_file = 'SHA256SUMS'
+        self._checksum_url = self.URL % (version, self._checksum_file)
+
+    def _get_checksum(self, fname):
+        expected_sum = None
+        Run(['wget', self._checksum_url, '-q', '-O', fname])
+        with open(fname) as fobj:
+            for line in fobj.readlines():
+                if self._img_fname in line:
+                    expected_sum = line.split(' ')[0]
+                    break
+
+        return expected_sum
+
 
 class Fedora(Image):
     URL = ("https://download.fedoraproject.org/pub/fedora/linux/releases/%s/"
@@ -940,18 +977,8 @@ class Fedora(Image):
         self._checksum_file = self.CHKS % (version, release, arch)
         self._checksum_url = self.URL % (version, arch, self._checksum_file)
 
-    def _checksum(self):
-        """
-        Get and check checkusm for downloaded image. Return True if the
-        checksum is correct, False otherwise.
-        """
-        if not os.path.exists(os.path.join(CACHE_DIR, self._img_fname)):
-            LOG.debug('Image %s not downloaded yet', self._img_fname)
-            return False
-
-        LOG.info('Calculating checksum for "%s"', self._img_fname)
+    def _get_checksum(self, fname):
         expected_sum = None
-        fname = os.path.join(self._tmp, self._checksum_file)
         Run(['wget', self._checksum_url, '-q', '-O', fname])
 
         with open(fname) as fobj:
@@ -961,35 +988,55 @@ class Fedora(Image):
                 if self._img_fname in line:
                     expected_sum = line.split('=')[1].strip()
                     break
+        return expected_sum
 
-        if not expected_sum:
-            LOG.fatal('Cannot find checksum for provided cloud image')
-            return False
 
-        if os.path.exists(os.path.join(CACHE_DIR, self._img_fname)):
-            cmd = ['sha256sum', os.path.join(CACHE_DIR, self._img_fname)]
-            calulated_sum = Run(cmd).stdout.split(' ')[0]
-            LOG.details('Checksum for image: %s, expected: %s', calulated_sum,
-                        expected_sum)
-            return calulated_sum == expected_sum
+class CentosStream(Image):
+    URL = "https://cloud.centos.org/centos/%s-stream/%s/images/%s"
+    IMG = '.*(CentOS-Stream-GenericCloud-%s-[0-9]+\.[0-9].%s.qcow2).*'
+    CHKS = "CHECKSUM"
 
-        return False
+    def __init__(self, vbox, version, arch, release):
+        super().__init__(vbox, version, arch, release)
+        self._checksum_file = '%s-centos-stream-%s-%s' % (self.CHKS, version,
+                                                          arch)
+        self._checksum_url = self.URL % (version, arch, self.CHKS)
+        # there is assumption, that we always need latest relese for specific
+        # version and architecture.
+        self._img_fname = self._get_image_name(version, arch)
+        self._img_url = self.URL % (version, arch, self._img_fname)
 
-    def _download_image(self):
-        if self._checksum():
-            LOG.details('Image already downloaded: %s', self._img_fname)
-            return True
+    def _get_image_name(self, version, arch):
+        Run(['wget', self._checksum_url, '-q', '-O', self._checksum_file])
 
-        fname = os.path.join(CACHE_DIR, self._img_fname)
-        Run(['wget', '-q', self._img_url, '-O', fname])
+        pat = re.compile(self.IMG % (version, arch))
 
-        if not self._checksum():
-            # TODO: make some retry mechanism?
-            LOG.fatal('Checksum for downloaded image differ from expected')
-            return False
+        images = []
+        with open(self._checksum_file) as fobj:
+            for line in fobj.read().strip().split('\n'):
+                line = line.strip()
+                if line.startswith('#'):
+                    continue
+                match = pat.match(line)
+                if match and match.groups():
+                    images.append(match.groups()[0])
 
-        LOG.header('Downloaded image %s', self._img_fname)
-        return True
+        images.reverse()
+        if images:
+            return images[0]
+
+    def _get_checksum(self, fname):
+        expected_sum = None
+        Run(['wget', self._checksum_url, '-q', '-O', fname])
+
+        with open(fname) as fobj:
+            for line in fobj.readlines():
+                if line.startswith('#'):
+                    continue
+                if self._img_fname in line:
+                    expected_sum = line.split('=')[1].strip()
+                    break
+        return expected_sum
 
 
 DISTROS = {'ubuntu': {'username': 'ubuntu',
@@ -1001,7 +1048,12 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
                       'realname': 'fedora',
                       'img_class': Fedora,
                       'amd64': 'x86_64',
-                      'default_version': '34'}}
+                      'default_version': '34'},
+           'centos': {'username': 'centos',
+                      'realname': 'centos',
+                      'img_class': CentosStream,
+                      'amd64': 'x86_64',
+                      'default_version': '8'}}
 
 
 def get_image_object(vbox, version, image='ubuntu', arch='amd64'):
@@ -1062,6 +1114,10 @@ def vmcreate(args, conf=None):
             conf = Config(args)
         except BoxNotFound:
             return 7
+        except yaml.YAMLError:
+            LOG.fatal(f'Cannot read or parse file `{args.config}` as YAML '
+                      f'file')
+            return 14
     LOG.header('Creating VM: %s', conf.name)
 
     vbox = VBoxManage(conf.name)
@@ -1109,7 +1165,7 @@ def vmcreate(args, conf=None):
                 vbox.add_nic(key, val)
 
     # start the VM and wait for cloud-init to finish
-    vbox.poweron()
+    vbox.poweron(args.type)
     # give VBox some time to actually change the state of the VM before query
     time.sleep(3)
 
@@ -1120,7 +1176,7 @@ def vmcreate(args, conf=None):
            '-o', 'ConnectTimeout=2',
            '-i', conf.ssh_key_path[:-4],
            f'ssh://{DISTROS[conf.distro]["username"]}'
-           f'@localhost:{vbox.vm_info["port"]}', 'cloud-init status']
+           f'@localhost:{vbox.vm_info["port"]}', 'sudo cloud-init status']
     try:
         while True:
             out = Run(cmd).stdout
@@ -1163,7 +1219,12 @@ def vmcreate(args, conf=None):
 
 
 def vmdestroy(args):
-    LOG.header('Removing VM: %s', args.name)
+    vbox = VBoxManage(args.name)
+    if not vbox.get_vm_info():
+        LOG.fatal(f'Cannot remove VM "{args.name}" - it doesn\'t exists.')
+        return 18
+    else:
+        LOG.header('Removing VM: %s', args.name)
     return VBoxManage(args.name).destroy()
 
 
@@ -1182,6 +1243,8 @@ def vmlist(args):
             LOG.header('All VMs:')
 
     for key in sorted(vms):
+        if args.long:
+            LOG.header(f"\n{key}")
         LOG.info(vms[key])
 
     return 0
@@ -1190,6 +1253,10 @@ def vmlist(args):
 def vminfo(args):
     vbox = VBoxManage(args.name)
     info = vbox.get_vm_info()
+    if not info:
+        LOG.fatal(f'Cannot show details of VM "{args.name}" - '
+                  f'it doesn\'t exists.')
+        return 19
 
     LOG.header('Details for VM: %s', args.name)
     LOG.info('Creator:\t\t%s', info.get('creator', 'unknown/manual'))
@@ -1245,12 +1312,21 @@ def vminfo(args):
 
 
 def vmrebuild(args):
-    LOG.header('Rebuilding VM: %s', args.name)
     vbox = VBoxManage(args.name)
+    if not vbox.get_vm_info():
+        LOG.fatal(f'Cannot rebuild VM "{args.name}" - it doesn\'t exists.')
+        return 20
+    else:
+        LOG.header('Rebuilding VM: %s', args.name)
+
     try:
         conf = Config(args, vbox)
     except BoxNotFound:
         return 8
+    except yaml.YAMLError:
+        LOG.fatal(f'Cannot read or parse file `{args.config}` as YAML '
+                  f'file')
+        return 15
 
     vbox.poweroff()
 
@@ -1280,10 +1356,18 @@ def shell_completion(args):
 
 def connect(args):
     vbox = VBoxManage(args.name)
+    if not vbox.get_vm_info():
+        LOG.fatal(f'No machine has been found with a name `{args.name}`.')
+        return 17
+
     try:
         conf = Config(args, vbox)
     except BoxNotFound:
         return 11
+    except yaml.YAMLError:
+        LOG.fatal(f'Cannot read or parse file `{args.config}` as YAML '
+                  f'file.')
+        return 16
 
     return Run(['ssh', '-o', 'StrictHostKeyChecking=no',
                 '-o', 'UserKnownHostsFile=/dev/null',
@@ -1335,6 +1419,9 @@ def main():
                         help="disable nested virtualization")
     create.add_argument('-s', '--disk-size', help="disk size to be expanded "
                         "to. By default to 10GB")
+    create.add_argument('-t', '--type', default='headless',
+                        help="VM run type, headless by default.",
+                        choices=['gui', 'headless', 'sdl', 'separate'])
     create.add_argument('-u', '--cpus', type=int, help="amount of CPUs to be "
                         "configured. Default 1.")
     create.add_argument('-v', '--version', help=f"distribution version. "
@@ -1375,6 +1462,9 @@ def main():
                          help="disable nested virtualization")
     rebuild.add_argument('-s', '--disk-size',
                          help='disk size to be expanded to')
+    rebuild.add_argument('-t', '--type', default='headless',
+                         help="VM run type, headless by default.",
+                         choices=['gui', 'headless', 'sdl', 'separate'])
     rebuild.add_argument('-u', '--cpus', type=int,
                          help='amount of CPUs to be configured')
     rebuild.add_argument('-v', '--version', help='distribution version')
@@ -1398,7 +1488,7 @@ def main():
 
     LOG.set_verbose(args.verbose, args.quiet)
 
-    if args.version:
+    if 'func' not in args and args.version:
         LOG.info(f'boxpy {__version__}')
         parser.exit()
 

examples/devstack-fedora34.yaml

@@ -1,3 +1,5 @@
+# Note, that cloud init will fail, due to old cloudinit package, which module
+# cc_keys_to_console doesn't recognize skipping option. Just ignore this error.
 package_update: true
 packages:
   - bash-completion
@@ -12,7 +14,6 @@ packages:
 write_files:
   - path: /tmp/local.conf
     permissions: '0644'
-    owner: fedora:fedora
     content: |
       [[local|localrc]]
       ADMIN_PASSWORD=pass
@@ -33,4 +34,4 @@ boxpy_data:
   memory: 4GB
   disk_size: 10GB
   distro: fedora
-  version: 32
+  version: 34

examples/devstack-ubuntu-20.04.yaml

@@ -19,7 +19,6 @@ packages:
 write_files:
   - path: /tmp/local.conf
     permissions: '0644'
-    owner: ubuntu:ubuntu
     content: |
       [[local|localrc]]
       ADMIN_PASSWORD=pass
@@ -27,6 +26,8 @@ write_files:
       RABBIT_PASSWORD=$$ADMIN_PASSWORD
       SERVICE_PASSWORD=$$ADMIN_PASSWORD
 runcmd:
+  - [apt, purge, '-y', python3-pyasn1-modules]
+  - [apt, purge, '-y', python3-simplejson]
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/vmstrap"]
   - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh"]
   - [rm, -fr, /home/ubuntu/vmstrap]

examples/kuryr_multinode_master.yaml

@@ -31,7 +31,6 @@ write_files:
               - 192.168.10.10/24
   - path: /tmp/local.conf
     permissions: '0644'
-    owner: ubuntu:ubuntu
     content: |
       [[local|localrc]]
       disable_all_services

examples/kuryr_multinode_worker.yaml

@@ -31,7 +31,6 @@ write_files:
               - 192.168.10.11/24
   - path: /tmp/local.conf
     permissions: '0644'
-    owner: ubuntu:ubuntu
     content: |
       [[local|localrc]]
       disable_all_services

requirements.txt

@@ -1 +1,2 @@
 pyyaml>=5.4.1
+requests>=2.26.0