vsphere-automation-sdk-python/samples/vsphere/vcenter/vm/main.py

"""
* *******************************************************
* Copyright (c) VMware, Inc. 2016. 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 2016 VMware, Inc. All rights reserved.'
__vcenter_version__ = '6.5+'

import samples.vsphere.vcenter.helper.network_helper
import samples.vsphere.vcenter.vm.hardware.main
import samples.vsphere.vcenter.vm.placement
import samples.vsphere.vcenter.vm.power
from samples.vsphere.common.sample_util import pp
from samples.vsphere.vcenter.setup import testbed_setup
from samples.vsphere.vcenter.setup import testbed
from samples.vsphere.vcenter.vm.create.create_default_vm import CreateDefaultVM
from samples.vsphere.vcenter.vm.create.create_basic_vm import CreateBasicVM
from samples.vsphere.vcenter.vm.create.create_exhaustive_vm import \
    CreateExhaustiveVM


class VMSetup(object):
    def __init__(self, context=None):
        self.context = context
        self.basic_vm = None
        self.default_vm = None
        self.exhaustive_vm = None

    def setup(self, context):
        print('Setup Samples Started')

        self.context = context

        ###########################################################################
        # Getting a PlacementSpec
        ###########################################################################
        placement_spec = samples.vsphere.vcenter.vm.placement.get_placement_spec_for_resource_pool(context)
        print('=' * 79)
        print('= Resource selection')
        print('=' * 79)
        print('placement_spec={}'.format(pp(placement_spec)))

        ###########################################################################
        # Getting a Network
        # Choose one of the following ways to get the PlacementSpec
        # 1. STANDARD_PORTGROUP on DATACENTER2
        # 2. DISTRIBUTED_PORTGROUP on DATACENTER2
        ###########################################################################
        standard_network = samples.vsphere.vcenter.helper \
            .network_helper.get_standard_network_backing(
            context.stub_config,
            context.testbed.config['STDPORTGROUP_NAME'],
            context.testbed.config['VM_DATACENTER_NAME'])
        print('standard_network={}'.format(standard_network))

        distributed_network = samples.vsphere.vcenter.helper \
            .network_helper.get_distributed_network_backing(
            context.stub_config,
            context.testbed.config['VDPORTGROUP1_NAME'],
            context.testbed.config['VM_DATACENTER_NAME'])
        print('distributed_network={}'.format(distributed_network))

        print('=' * 79)

        self.default_vm = CreateDefaultVM(context.stub_config,
                                          placement_spec)
        self.basic_vm = CreateBasicVM(context.stub_config, placement_spec)
        self.exhaustive_vm = CreateExhaustiveVM(context.stub_config,
                                                placement_spec,
                                                standard_network,
                                                distributed_network)

        print('Setup Samples Complete')

    def cleanup(self):

        print('Cleanup Samples Started')
        CreateDefaultVM(self.context.stub_config).cleanup()
        CreateBasicVM(self.context.stub_config).cleanup()
        CreateExhaustiveVM(self.context.stub_config).cleanup()
        print('Cleanup Samples Complete\n')

    def validate(self):
        print('Validating and Detecting Resources in vcenter.vm Samples')
        r = testbed_setup.validate(self.context)
        if r:
            print('==> Samples Setup validated')
            return True
        else:
            print('==> Samples Setup has errors')
            return False

    def run(self):
        # Clean up in case of past failures
        self.cleanup()

        # Check that sample is ready to run
        if self.context.option['DO_SAMPLES']:
            if not self.validate():
                exit(0)

        ###########################################################################
        # Create VM samples
        #
        # Choose one of the following ways to create the VM
        # 1. Default
        # 2. Basic (2 disks, 1 nic)
        # 3. Exhaustive (3 disks, 2 nics, 2 vcpu, 2 GB memory, boot=BIOS, 1 cdrom,
        #                1 serial port, 1 parallel port, 1 floppy,
        #                boot_devices= [CDROM, DISK, ETHERNET])
        ###########################################################################
        self.default_vm.run()
        self.basic_vm.run()
        self.exhaustive_vm.run()

        ###########################################################################
        # Incremental device CRUDE + connect/disconnect samples
        #
        ###########################################################################
        if self.context.option['DO_SAMPLES_INCREMENTAL']:
            samples.vsphere.vcenter.vm.hardware.main.setup(self.context)
            samples.vsphere.vcenter.vm.hardware.main.validate(self.context)
            samples.vsphere.vcenter.vm.hardware.main.run()
            if self.context.option['DO_SAMPLES_CLEANUP']:
                samples.vsphere.vcenter.vm.hardware.main.cleanup()

        # Sample cleanup
        if self.context.option['DO_SAMPLES_CLEANUP']:
            self.cleanup()