Merge pull request #114 from tianhao64/master

signed ova import sample

samples/vsphere/contentlibrary/README.md

@@ -4,6 +4,7 @@ This directory contains samples for Content Library APIs:
     * Updating content of a content library item                                                                            - contentupdate/content_update.py
     * Workflow to deploy an OVF library item to a resource pool                                                             - ovfdeploy/deploy_ovf_template.py
     * Workflows to import an OVF package into a content library, and download of an OVF template from a content library     - ovfimport/ovf_import_export.py
+    * Basic workflow to import an OVA package into a content library as an OVF library item                                 - ovaimport/signed_ova_import.py
     * Basic workflow to publish and subscribe content libraries                                                             - publishsubscribe/library_publish_subscribe.py
     * Workflow to capture a virtual machine into a content library                                                          - vmcapture/vm_template_capture.py
     * Content library ISO item mount and unmount workflow                                                                   - isomount/iso_mount.py
@@ -20,11 +21,12 @@ The additional sample parameters are as follows (all parameters can be displayed
     * content_update.py             --datastorename <datastore-name>
     * deploy_ovf_template.py        --clustername <cluster-name>  --libitemname <ovf-item-name>
     * ovf_import_export.py          --datastorename <datastore-name>
+    * signed_ova_import.py          --datastorename <datastore-name>
     * library_publish_subscribe.py  --datastorename <datastore-name>
     * vm_template_capture.py        --datastorename <datastore-name> --vmname <vm-name>
     * iso_mount.py                  --datastorename <datastore-name> --vmname <vm-name>
     * create_vm_template.py         --datacentername <datacenter-name> --resourcepoolname <resource-pool-name> --datastorename <datastore-name> --vmname <vm-name>
-    * deploy_vm_template.py         --itemname <item-name> --datacentername <datacenter-name> --foldername <folder-name>  --resourcepoolname <resource-pool-name> --datastorename <datastore-name>    
+    * deploy_vm_template.py         --itemname <item-name> --datacentername <datacenter-name> --foldername <folder-name>  --resourcepoolname <resource-pool-name> --datastorename <datastore-name>
 
 * Testbed Requirement:
     - 1 vCenter Server

samples/vsphere/contentlibrary/lib/cls_api_helper.py

@@ -119,7 +119,8 @@ class ClsApiHelper(object):
         print('Library item created id: {0}'.format(library_item_id))
 
         # Upload an iso file to above library item, use the filename as the item_filename
-        iso_files_map = self.get_iso_file_map(item_filename=iso_filename, disk_filename=iso_filename)
+        iso_files_map = self.get_iso_file_map(item_filename=iso_filename,
+                                              disk_filename=iso_filename)
         self.upload_files(library_item_id=library_item_id, files_map=iso_files_map)
         print('Uploaded iso file to library item {0}'.format(library_item_id))
         return library_item_id
@@ -131,6 +132,21 @@ class ClsApiHelper(object):
         iso_files_map[item_filename] = iso_file_path
         return iso_files_map
 
+    def get_ova_file_map(self, relative_path, local_filename):
+        """
+        Get OVA file paths to be used during uploads.
+
+        :param relative_path: directory path under contentlibrary/resources for ova file
+        :param local_filename: name of the file on local disk under resources directory
+        :return: mapping of item's filename to full path for the file on local disk
+        """
+        ova_file_map = {}
+        item_filename = os.path.basename(local_filename)
+        ova_file_path = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)),
+                                                     relative_path, local_filename))
+        ova_file_map[item_filename] = ova_file_path
+        return ova_file_map
+
     def get_libraryitem_spec(self, client_token, name, description, library_id, library_item_type):
         """
         Create library item spec

samples/vsphere/contentlibrary/ovaimport/signed_ova_import.py

@@ -0,0 +1,163 @@
+#!/usr/bin/env python
+
+"""
+* *******************************************************
+* Copyright VMware, Inc. 2018. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+
+__author__ = 'VMware, Inc.'
+__copyright__ = 'Copyright 2018 VMware, Inc.  All rights reserved.'
+__vcenter_version__ = '6.7u1+'
+
+import time
+try:
+    import urllib2
+except ImportError:
+    import urllib.request as urllib2
+
+from com.vmware.content.library.item_client import UpdateSessionModel
+from com.vmware.content.library.item.updatesession_client import (
+    File as UpdateSessionFile, PreviewInfo, WarningType, WarningBehavior)
+from samples.vsphere.common.id_generator import generate_random_uuid
+from samples.vsphere.common.sample_base import SampleBase
+from samples.vsphere.contentlibrary.lib.cls_api_client import ClsApiClient
+from samples.vsphere.contentlibrary.lib.cls_api_helper import ClsApiHelper
+
+AVAILABLE = PreviewInfo.State.AVAILABLE
+NOT_APPLICABLE = PreviewInfo.State.NOT_APPLICABLE
+
+
+class SignedOvaImport(SampleBase):
+    """
+    Demonstrates the workflow to import an OVA file into the content library,
+    as an OVF library item.
+
+    Note: the workflow needs an existing VC DS with available storage.
+    """
+
+    SIGNED_OVA_FILENAME = 'nostalgia-signed.ova'
+    SIGNED_OVA_RELATIVE_DIR = '../resources/signedOvaWithCertWarning'
+
+    def __init__(self):
+        SampleBase.__init__(self, self.__doc__)
+        self.servicemanager = None
+        self.client = None
+        self.helper = None
+        self.datastore_name = None
+        self.lib_name = 'ova-demo-lib'
+        self.local_lib_id = None
+        self.lib_item_name = 'signedOvaImport'
+        self.lib_item_id = None
+
+    def _options(self):
+        self.argparser.add_argument('-datastorename',
+                                    '--datastorename',
+                                    required=True,
+                                    help='The name of the datastore.')
+
+    def _setup(self):
+        self.servicemanager = self.get_service_manager()
+
+        self.client = ClsApiClient(self.servicemanager)
+        self.helper = ClsApiHelper(self.client, self.skip_verification)
+
+    def _execute(self):
+        # Build the storage backing for the library to be created using given datastore name
+        self.datastore_name = self.args.datastorename
+        storage_backings = self.helper.create_storage_backings(service_manager=self.servicemanager,
+                                                               datastore_name=self.datastore_name)
+
+        # Create a local content library backed by the VC datastore using vAPIs
+        self.local_lib_id = self.helper.create_local_library(storage_backings, self.lib_name)
+
+        # Create a new library item in the content library for uploading the files
+        self.lib_item_id = self.helper.create_library_item(library_id=self.local_lib_id,
+                                                           item_name=self.lib_item_name,
+                                                           item_description='Sample template from ova file',
+                                                           item_type='ovf')
+        print('Library item created. ID: {0}'.format(self.lib_item_id))
+
+        ova_file_map = self.helper.get_ova_file_map(self.SIGNED_OVA_RELATIVE_DIR,
+                                                    local_filename=self.SIGNED_OVA_FILENAME)
+        # Create a new upload session for uploading the files
+        # To ignore expected warnings and skip preview info check,
+        # you can set create_spec.warning_behavior during session creation
+        session_id = self.client.upload_service.create(
+            create_spec=UpdateSessionModel(library_item_id=self.lib_item_id),
+            client_token=generate_random_uuid())
+        self.helper.upload_files_in_session(ova_file_map, session_id)
+
+        # Wait for terminal preview state and obtain preview warnings if any
+        self.wait_for_terminal_preview_state(session_id, AVAILABLE)
+        session = self.client.upload_service.get(session_id)
+        preview_info = session.preview_info
+
+        # Collect generated preview warning types
+        preview_warning_types = []
+        print('Preview warnings for the session are the following:')
+        for preview_warning in preview_info.warnings:
+            print(preview_warning.message.default_message)
+            preview_warning_types.append(preview_warning.type)
+
+        # Ignore preview warnings on session
+        ignore_warning_behaviors = []
+        for warning_type in preview_warning_types:
+            warning_behavior = WarningBehavior(type=warning_type, ignored=True)
+            ignore_warning_behaviors.append(warning_behavior)
+        self.client.upload_service.update(session_id, update_spec=UpdateSessionModel(
+            warning_behavior=ignore_warning_behaviors))
+        print('All preview warnings are ignored, proceeding to complete the session')
+
+        self.client.upload_service.complete(session_id)
+        self.client.upload_service.delete(session_id)
+        print('Uploaded ova file as an ovf template to library item {0}'.format(self.lib_item_id))
+
+    def wait_for_terminal_preview_state(self, session_id, expected_terminal_preview_state,
+                                        timeout_sec=300):
+        """
+        Periodically checks update session for preview state to reach a terminal state.
+
+        :param session_id: ID of update session for which preview state is checked
+        :param expected_terminal_preview_state: expected terminal preview state
+        :param timeout_sec: number of seconds to wait before timing out
+        """
+        preview_state = None
+        start_time = time.time()
+        terminal_preview_state_list = [NOT_APPLICABLE, AVAILABLE]
+        while (time.time() - start_time) < timeout_sec:
+            session = self.client.upload_service.get(session_id)
+            if session.state == 'ERROR':
+                raise Exception('Session is in error state, error message: {}'.format(
+                    session.error_message))
+            preview_state = session.preview_info.state
+            # check if preview state is in one of the terminal states
+            if preview_state not in terminal_preview_state_list:
+                time.sleep(1)
+            else:
+                break
+
+        if preview_state != expected_terminal_preview_state:
+            raise Exception('Preview state did not reach expected {} state, actual preview state: '
+                            '{}'.format(expected_terminal_preview_state, preview_state))
+
+    def _cleanup(self):
+        if self.local_lib_id:
+            self.client.local_library_service.delete(library_id=self.local_lib_id)
+            print('Deleted library ID: {0}'.format(self.local_lib_id))
+
+
+def main():
+    sample = SignedOvaImport()
+    sample.main()
+
+
+if __name__ == '__main__':
+    main()