gpvcmupdate.py

#!/usr/bin/env python
"""
NAME: gpvmcupdate
AUTOR: Carlos Gimeno
EMAIL: cgimeno@bifi.es
DESCPRTION: Used by vmcatcher as a hook for images updates from vmcatcher
            Inform glancepush for image updates.

            This program will write files on different locations, so run as root
            (not recommended) or be careful with permissions!
"""
import os
import sys
import tarfile
import stat
import argparse

__author__ = "Carlos Gimeno"
__license__ = "MIT"
__maintainer__ = "Carlos Gimeno"
__email__ = "cgimeno@bifi.es"
__status__ = "Development"


def main():
    # Directories
    spooldir = "/var/spool/glancepush/"
    metadata_dir = "/etc/glancepush/meta/"
    transform_dir = "/etc/glancepush/transform/"
    test_dir = "/etc/glancepush/test/"
    temp_dir = "/tmp/"
    image_metadata = { 'VMCATCHER_EVENT_TYPE' : 'VMCATCHER_EVENT_TYPE', 'VMCATCHER_EVENT_DC_DESCRIPTION' : 'VMCATCHER_EVENT_DC_DESCRIPTION', 'VMCATCHER_EVENT_DC_IDENTIFIER' : 'VMCATCHER_EVENT_DC_IDENTIFIER', 'VMCATCHER_EVENT_DC_TITLE' : 'VMCATCHER_EVENT_DC_TITLE', 'VMCATCHER_EVENT_HV_HYPERVISOR': 'VMCATCHER_EVENT_HV_HYPERVISOR', 'VMCATCHER_EVENT_HV_SIZE' : 'VMCATCHER_EVENT_HV_SIZE', 'VMCATCHER_EVENT_HV_URI' : 'VMCATCHER_EVENT_HV_URI', 'VMCATCHER_EVENT_HV_FORMAT' : 'VMCATCHER_EVENT_HV_FORMAT', 'VMCATCHER_EVENT_HV_VERSION' : 'VMCATCHER_EVENT_HV_VERSION', 'VMCATCHER_EVENT_SL_ARCH' : 'VMCATCHER_EVENT_SL_ARCH', 'VMCATCHER_EVENT_SL_CHECKSUM_SHA512' : 'VMCATCHER_EVENT_SL_CHECKSUM_SHA512', 'VMCATCHER_EVENT_SL_COMMENTS' : 'VMCATCHER_EVENT_SL_COMMENTS', 'VMCATCHER_EVENT_SL_OS' : 'VMCATCHER_EVENT_SL_OS', 'VMCATCHER_EVENT_SL_OSVERSION' : 'VMCATCHER_EVENT_SL_OSVERSION', 'VMCATCHER_EVENT_TYPE' : 'VMCATCHER_EVENT_TYPE', 'VMCATCHER_EVENT_IL_DC_IDENTIFIER' : 'VMCATCHER_EVENT_IL_DC_IDENTIFIER', 'VMCATCHER_EVENT_AD_MPURI' : 'VMCATCHER_EVENT_AD_MPURI', 'VMCATCHER_EVENT_VO' : 'VMCATCHER_EVENT_VO', 'VMCATCHER_EVENT_FILENAME' : 'VMCATCHER_EVENT_FILENAME' }

    # Option Parser
    parser = argparse.ArgumentParser(description="Used by vmcatcher as a hook for images updates from vmcatcher.\n"
                                                 "It will create all neccesary files to upload downloaded images from"
                                                 " vmcatcher to Glance, using glancepush")
    parser.add_argument("-p", "--protected", action="store_true",
                        dest="protected", default=False, help="Set protected flag in glance to true")
    parser.add_argument("-D", "--delete", action="store_true", dest="delete", default="false", help="Delete expired "
                                                                                                    "images")
    parser.add_argument("--version", action="version", version="0.0.5")
    args = parser.parse_args()

    dir_cache = os.getenv('VMCATCHER_CACHE_DIR_CACHE', 0)
    event_dc_title = os.getenv('VMCATCHER_EVENT_DC_TITLE', 0)
    identifier = os.getenv('VMCATCHER_EVENT_DC_IDENTIFIER')
    if (os.getenv('VMCATCHER_EVENT_TYPE') == 'ProcessPrefix') or (os.getenv('VMCATCHER_EVENT_TYPE') == 'ProcessPostfix') or (os.getenv('VMCATCHER_EVENT_TYPE') == 'ExpirePrefix'):
        sys.stderr.write("Ignoring " + os.getenv('VMCATCHER_EVENT_TYPE') + " event.")
        os._exit(0)
    if (dir_cache == 0) or (event_dc_title == 0) or (identifier == 0):
        sys.stderr.write("Some Variables are not set")
        os._exit(1)

    # I'm going to replace backslashes and spaces to avoid problems
    image = spooldir + os.getenv('VMCATCHER_EVENT_DC_TITLE').replace(" ", "_").replace("/", "_")
    sys.stdout.write(os.getenv('VMCATCHER_EVENT_TYPE'))
    metadata = metadata_dir + os.getenv('VMCATCHER_EVENT_DC_TITLE').replace(" ", "_").replace("/", "_")
    transform = transform_dir + os.getenv('VMCATCHER_EVENT_DC_TITLE').replace(" ", "_").replace("/", "_")
    test = test_dir + os.getenv('VMCATCHER_EVENT_DC_TITLE').replace(" ", "_").replace("/", "_")

    with open(image, "w") as outfile:
        if os.getenv('VMCATCHER_EVENT_HV_FORMAT').lower() == "ova":
            to_file = "file=" + temp_dir + os.getenv('VMCATCHER_EVENT_DC_IDENTIFIER')
        else:
            to_file = "file=" + os.getenv('VMCATCHER_CACHE_DIR_CACHE') + '/' + os.getenv(
                'VMCATCHER_EVENT_DC_IDENTIFIER')
        outfile.write(to_file)
        outfile.close()

    if os.getenv('VMCATCHER_EVENT_TYPE') == 'ExpirePostfix':
        # We need to check if image is expired
        if os.path.isfile(os.getenv('VMCATCHER_CACHE_DIR_EXPIRE') + '/' + os.getenv('VMCATCHER_EVENT_FILENAME')):
            sys.stdout.write(" Removing " + image)
            os.remove(transform)
            os.remove(test)
            # Tell vmcatcher to remove expired images 
            if args.delete:
                with open(image, "w") as outfile:
                    outfile.write("file='#DELETE#'")
                    outfile.close()
            else:
                os.remove(image)
                os.remove(metadata)
    elif os.getenv('VMCATCHER_EVENT_TYPE') == 'AvailablePostfix':
        # Wait! Is an OVA Image?
        if os.getenv('VMCATCHER_EVENT_HV_FORMAT').lower() == "ova":
            # Ova File. We must extract VMDK and VDF, discard VDF and upload VMDK
            # Also, we must convert it to qcow2 to provide compatibility with old qemu versions
            downloaded_image = os.getenv('VMCATCHER_CACHE_DIR_CACHE') + '/' + os.getenv('VMCATCHER_EVENT_DC_IDENTIFIER')
            tfile = tarfile.open(downloaded_image)
            if tarfile.is_tarfile(downloaded_image):
                tfile.extractall(temp_dir)

            for file in os.listdir(temp_dir):
                if file.endswith(".ovf"):  # Delete OVF File
                    os.remove(temp_dir + file)
                elif file.endswith(".vmdk"):
                    command = "qemu-img convert -f vmdk -O qcow2 " + temp_dir + file + " " + temp_dir + file + ".qcow2"
                    os.system(command)  # Convert image to qcow2
                    os.remove(temp_dir + file)  # Delete old VMDK file
                    os.rename(temp_dir + file + ".qcow2", temp_dir + os.getenv('VMCATCHER_EVENT_DC_IDENTIFIER'))

        sys.stdout.write("Creating Metadata Files")
        with open(metadata, "w") as outfile:
            # Sometimes, comments are not defined by the endorser
            try:
               os.environ['VMCATCHER_EVENT_SL_COMMENTS']
            except KeyError:
               os.environ['VMCATCHER_EVENT_SL_COMMENTS'] = "undefined"
            outfile.write("comment=\"" + os.getenv('VMCATCHER_EVENT_SL_COMMENTS') + "\"\n")
            # Try to get VMCATCHER_EVENT_VO. If exception is not raised, then VO is defined
            # and image shouldn't be public. If is raised, then VO is not defined, and the
            # image should be public
            try:
                os.environ['VMCATCHER_EVENT_VO']
                outfile.write("is_public=\"no\"\n")
            except KeyError:
                outfile.write("is_public=\"yes\"\n")

            if args.protected:
                outfile.write("is_protected=\"yes\"\n")
            else:
                outfile.write("is_protected=\"no\"\n")
            if os.getenv('VMCATCHER_EVENT_HV_FORMAT').lower() == "ova":
                outfile.write("disk_format=\"qcow2" + "\"\n")
            else:
                outfile.write("disk_format=\"" + os.getenv('VMCATCHER_EVENT_HV_FORMAT') + "\"\n")
            outfile.write("container_format=\"bare\"\n")
            #write additional metadata
            i=0
            for metaname in image_metadata:
                metavalue=os.getenv(image_metadata[metaname])
                try:
                   outfile.write("properties["+str(i)+"]='"+metaname+"="+metavalue+"'\n");
                except TypeError:
                   # Sometimes, not all metadata is filled by the endorser
                   metavalue = "undefined"
                   outfile.write("properties["+str(i)+"]='"+metaname+"="+metavalue+"'\n");
                i=i+1
            outfile.close()
        # TODO: Load custom test script
        with open(transform, "w") as outfile:
            outfile.write("#!/bin/sh\n")
            outfile.write("cat")
            outfile.close()
        # TODO: Load Custom Transform Script
        with open(test, "w+") as outfile:
            outfile.write("#!/bin/sh\n")
            outfile.write("cat")
            outfile.close()
        #Grant execution access to owner
        st = os.stat(transform)
        os.chmod(transform, st.st_mode | stat.S_IEXEC)
    pass


if __name__ == "__main__":
    main()