kitchen-vcair 1.0.0

data/examples/VIDEOS.md

@@ -0,0 +1,57 @@
+# kitchen-vcair demonstration videos
+
+Below are videos created by the original plugin author that demonstrate
+kitchen-vcair and how to use it.  Some configuration parameters have changed
+since the initial development of this plugin to keep is consistent with other
+VMware-based plugins, so be sure to check the README.md in this repo for the
+latest instructions.
+
+## Linux
+
+* [github.com/vulk/kitchen-vcair](https://www.youtube.com/watch?v=5srDko69XJ0&t=03)
+* [vchs.vmware.com](https://www.youtube.com/watch?v=5srDko69XJ0&t=15)
+* [Walkthrough steps for cloning, building gem](https://www.youtube.com/watch?v=5srDko69XJ0&t=30)
+* [git clone git@github.com:/vulk/kitchen-vcair.git](https://www.youtube.com/watch?v=5srDko69XJ0&t=68)
+* [cd kitchen-vcair](https://www.youtube.com/watch?v=5srDko69XJ0&t=94)
+* [gem build kitchen-vcair.gemspec](https://www.youtube.com/watch?v=5srDko69XJ0&t=100)
+* [gem install ./kitchen-vcair-0.1.0.gem](https://www.youtube.com/watch?v=5srDko69XJ0&t=120)
+* [quick look through code  ](https://www.youtube.com/watch?v=5srDko69XJ0&t=126)
+* [git clone git@github.com:chef-cookbooks/httpd.git ](https://www.youtube.com/watch?v=5srDko69XJ0&t=173)
+* [walkthrough of .kitchen.vcair.yml](https://www.youtube.com/watch?v=5srDko69XJ0&t=199)
+* [walkthrough of environment variables](https://www.youtube.com/watch?v=5srDko69XJ0&t=247)
+* [kitchen test](https://www.youtube.com/watch?v=5srDko69XJ0&t=282)
+* [vchs.vmware.com virtualmachine list, showing creation of helloworldtest VM](https://www.youtube.com/watch?v=5srDko69XJ0&t=296)
+* [knife vcair server list showing creation of helloworld test VM](https://www.youtube.com/watch?v=5srDko69XJ0&t=326)
+* [instance provisionied, waiting for ssh](https://www.youtube.com/watch?v=5srDko69XJ0&t=355)
+* [ssh available, installing chef-client](https://www.youtube.com/watch?v=5srDko69XJ0&t=400)
+* [chef-client starting](https://www.youtube.com/watch?v=5srDko69XJ0&t=499)
+* [chef-client finished, apache install completed](https://www.youtube.com/watch?v=5srDko69XJ0&t=515)
+* [Kitchen Setup and Verify](https://www.youtube.com/watch?v=5srDko69XJ0&t=516)
+* [Kitichen Destroy](https://www.youtube.com/watch?v=5srDko69XJ0&t=517)
+* [Kitchen is finished](https://www.youtube.com/watch?v=5srDko69XJ0&t=525)
+* [vchs.vmware.com and knife vcair shows vm destroyed](https://www.youtube.com/watch?v=5srDko69XJ0&t=530)
+
+## Windows
+
+* [vmwair-vcair.env.example](https://www.youtube.com/watch?v=k8OZII4UGZs&t=09)
+* [.kitchen.vcair.yml](https://www.youtube.com/watch?v=k8OZII4UGZs&t=20)
+* [.yml / platforms:customization_script note](https://www.youtube.com/watch?v=k8OZII4UGZs&t=30)
+* [customization_script install-winrm-vcair.bat](https://www.youtube.com/watch?v=k8OZII4UGZs&t=37)
+* [git clone opscode-cookbooks/iis](https://www.youtube.com/watch?v=k8OZII4UGZs&t=54)
+* [start coping files into iis cookbooks](https://www.youtube.com/watch?v=k8OZII4UGZs&t=60)
+* [Add kitchen-vcair and kitchen-pester to the Gemfile](https://www.youtube.com/watch?v=k8OZII4UGZs&t=98)
+* [bundle install kitchen vcair and pester](https://www.youtube.com/watch?v=k8OZII4UGZs&t=120)
+* [KITCHEN_YAML=.kitchen.vcair.yml bundle exec kitchen verify](https://www.youtube.com/watch?v=k8OZII4UGZs&t=150)
+* [Server is allocated.](https://www.youtube.com/watch?v=k8OZII4UGZs&t=270)
+* ['pre'/'post' customization script ](https://www.youtube.com/watch?v=k8OZII4UGZs&t=300)
+* ['pre' customization reboot ](https://www.youtube.com/watch?v=k8OZII4UGZs&t=412)
+* ['post' customization boot ](https://www.youtube.com/watch?v=k8OZII4UGZs&t=440)
+* [winrm is online](https://www.youtube.com/watch?v=k8OZII4UGZs&t=555)
+* [installing chef omnibus](https://www.youtube.com/watch?v=k8OZII4UGZs&t=560)
+* [chef-client starts](https://www.youtube.com/watch?v=k8OZII4UGZs&t=600)
+* [iis:default recipe runs](https://www.youtube.com/watch?v=k8OZII4UGZs&t=630)
+* [verification via kitche-pester](https://www.youtube.com/watch?v=k8OZII4UGZs&t=647)
+* [kitchen verify complete!](https://www.youtube.com/watch?v=k8OZII4UGZs&t=660)
+* [iis default web page via links](https://www.youtube.com/watch?v=k8OZII4UGZs&t=695)
+* [kitchen verify again](https://www.youtube.com/watch?v=k8OZII4UGZs&t=710)
+* [kitchen destroy](https://www.youtube.com/watch?v=k8OZII4UGZs&t=735)

data/examples/windows_customization.bat

@@ -0,0 +1,53 @@
+@echo off
+
+@rem First Boot...
+if “%1%” == “precustomization” (
+
+echo Do precustomization tasks
+@rem during this boot the hostname is set, which requires a reboot
+
+@rem we also enable winrm over http, plaintext, long timeout, more memory etc
+
+cmd.exe /c winrm quickconfig -q
+cmd.exe /c winrm quickconfig -transport:http
+cmd.exe /c winrm set winrm/config @{MaxTimeoutms="1800000"}
+cmd.exe /c winrm set winrm/config/winrs @{MaxMemoryPerShellMB="300"}
+cmd.exe /c winrm set winrm/config/service @{AllowUnencrypted="true"}
+cmd.exe /c winrm set winrm/config/service/auth @{Basic="true"}
+cmd.exe /c winrm set winrm/config/client/auth @{Basic="true"}
+cmd.exe /c winrm set winrm/config/listener?Address=*+Transport=HTTP @{Port="5985"}
+
+@rem Make sure winrm is off for this boot, but enabled on next
+@rem as we don't want a tcp connection available until we are
+@rem past postcustomization
+
+cmd.exe /c net stop winrm
+cmd.exe /c sc config winrm start= auto
+
+@rem make sure the default on password age is unlimited
+@rem this ensures we don't have a password change forced on us
+cmd.exe /c net accounts /maxpwage:unlimited
+
+@rem write out a timestamp for this first boot / customization completes
+echo %DATE% %TIME% > C:\vm-is-customized
+
+) else if “%1%” == “postcustomization” (
+
+@rem Second Boot / start winrm, just incase, and fix firewall
+
+cmd.exe /c net start winrm
+cmd.exe /c netsh advfirewall firewall set rule group="remote administration" new enable=yes
+cmd.exe /c netsh firewall add portopening TCP 5985 "Port 5985 for WinRM"
+
+@rem Password Setting and Autologin currently seem broken
+@rem when done via the API, so we MUST set it in the postcustomization phase
+cmd.exe /c net user administrator Password1
+
+@rem in some environments we found the need to specify a DNS address
+@rem cmd.exe /c netsh interface ipv4 add dnsserver "Ethernet" address=8.8.8.8
+@rem cmd.exe /c netsh interface ipv4 add dnsserver "Ethernet0" address=8.8.8.8
+
+@rem this is our 'ready' boot, password and winrm should be up
+echo %DATE% %TIME% > C:\vm-is-ready
+
+)

data/kitchen-vcair.gemspec

@@ -0,0 +1,32 @@
+# Encoding: UTF-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/vcair_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-vcair'
+  spec.version       = Kitchen::Driver::VCAIR_VERSION
+  spec.authors       = ['Chef Partner Engineering', 'Taylor Carpenter', 'Chris McClimans']
+  spec.email         = %w(partnereng@chef.io wolfpack+c+t@vulk.co)
+  spec.description   = 'A Test Kitchen vCloud Air driver'
+  spec.summary       = 'A Test Kitchen vCloud Air driver built on Fog'
+  spec.homepage      = 'https://github.com/chef-partners/kitchen-vcair'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'test-kitchen', '~> 1.4', '>= 1.4.1'
+  spec.add_dependency 'fog',          '~> 1.33'
+
+  spec.add_development_dependency 'bundler',   '~> 1.7'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.2'
+  spec.add_development_dependency 'rubocop',   '~> 0.33'
+  spec.add_development_dependency 'pry',       '~> 0.10'
+end

data/lib/kitchen/driver/vcair.rb

@@ -0,0 +1,359 @@
+# Encoding: UTF-8
+#
+# Authors:: Chris McClimans (<c@vulk.co>)
+# Authors:: Taylor Carpenter (<t@vulk.co>)
+# Authors:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fog'
+require 'kitchen'
+require 'securerandom'
+
+module Kitchen
+  module Driver
+    class Vcair < Kitchen::Driver::Base
+      attr_accessor :vapp_id
+
+      default_config :wait_for, 600
+      default_config :vcair_api_path, '/api'
+      default_config :catalog_id, nil
+      default_config :catalog_name, nil
+      default_config :image_id, nil
+      default_config :image_name, nil
+      default_config :vdc_id, nil
+      default_config :vdc_name, nil
+      default_config :network_id, nil
+      default_config :network_name, nil
+      default_config :cpus, 1
+      default_config :memory, 1024
+      default_config :vm_password
+
+      required_config :vcair_username
+      required_config :vcair_password
+      required_config :vcair_api_host
+      required_config :vcair_org
+
+      def initialize(config)
+        super
+        Fog.timeout = config[:wait_for].to_i
+      end
+
+      def name
+        'vCloudAir'
+      end
+
+      def create(state)
+        return unless state[:vapp_id].nil?
+
+        validate!
+
+        create_server(state)
+        vm.wait_for { ready? }
+        state[:hostname] = vm.ip_address
+
+        info("Server #{state[:hostname]} is powered on. Waiting for it to be ready...")
+        wait_for_server(state)
+      end
+
+      def destroy(state)
+        return if state[:vapp_id].nil?
+
+        validate!
+
+        self.vapp_id = state[:vapp_id]
+
+        info("Destroying vApp #{vapp_id}...")
+        begin
+          vapp
+        rescue Fog::Compute::VcloudDirector::Forbidden
+          warn("Unable to locate vApp <#{state[:vapp_id]}> - assuming it is already destroyed.")
+          return
+        end
+
+        info('Powering off the vApp...')
+        vapp.power_off
+
+        info('Undeploying the vApp...')
+        vapp.undeploy
+
+        info('Deleting the vApp...')
+        vapp.destroy
+
+        info("vApp <#{state[:vapp_id]}> destroyed.")
+      end
+
+      def vcloud_client
+        @vcloud_client ||= Fog::Compute.new(fog_server_def)
+      rescue Excon::Errors::Unauthorized => e
+        raise "Connection failure, please check your username and password. -- #{e.message}"
+      end
+
+      def org
+        @org ||= vcloud_client.organizations.get_by_name(config[:vcair_org])
+      end
+
+      def create_server(state)
+        self.vapp_id = instantiate
+        state[:vapp_id] = vapp_id
+
+        info("vApp ID #{vapp_id} created.")
+
+        info('Validating the vApp...')
+        unless validate_vapp
+          destroy(state)
+          return
+        end
+
+        info('Updating the VM customization...')
+        update_customization
+
+        info('Adjusting VM hardware...')
+        adjust_hardware
+
+        info('Attaching it to the network...')
+        attach_network
+
+        info('Tagging the VM...')
+        tag_vm
+
+        info('Powering on the VM...')
+        power_on
+      end
+
+      def adjust_hardware
+        vm.cpu    = config[:cpus] if config[:cpus]
+        vm.memory = config[:memory] if config[:memory]
+      end
+
+      def attach_network_payload
+        {
+          PrimaryNetworkConnectionIndex: 0,
+          NetworkConnection: [
+            {
+              network: network.name,
+              needsCustomization: true,
+              NetworkConnectionIndex: 0,
+              IsConnected: true,
+              IpAddressAllocationMode: 'POOL'
+            }
+          ]
+        }
+      end
+
+      def attach_network
+        task = vcloud_client.put_network_connection_system_section_vapp(vm.id, attach_network_payload)
+        vcloud_client.process_task(task.body)
+      end
+
+      def tag_vm
+        vm.tags.create('created-by', 'test-kitchen')
+      end
+
+      def power_on
+        vapp.power_on
+      end
+
+      def wait_for_server(state)
+        instance.transport.connection(state).wait_until_ready
+      rescue
+        error("Server #{vapp.id} (#{vm.name}) not reachable. Destroying server...")
+        destroy(state)
+        raise
+      end
+
+      def vcloud_username
+        [ config[:vcair_username], config[:vcair_org] ].join('@')
+      end
+
+      def fog_server_def
+        {
+          provider: 'vclouddirector',
+          vcloud_director_username:      vcloud_username,
+          vcloud_director_password:      config[:vcair_password],
+          vcloud_director_host:          config[:vcair_api_host],
+          vcloud_director_api_version:   config[:vcair_api_version],
+          vcloud_director_show_progress: false,
+          path:                          config[:vcair_api_path]
+        }
+      end
+
+      def image
+        if config[:image_id]
+          catalog.catalog_items.get(config[:image_id])
+        else
+          catalog.catalog_items.get_by_name(config[:image_name])
+        end
+      end
+
+      def catalog
+        if config[:catalog_id]
+          org.catalogs.get(config[:catalog_id])
+        else
+          org.catalogs.get_by_name(config[:catalog_name])
+        end
+      end
+
+      def vdc
+        if config[:vdc_id]
+          org.vdcs.get(config[:vdc_id])
+        else
+          org.vdcs.get_by_name(config[:vdc_name])
+        end
+      end
+
+      def network
+        if config[:network_id]
+          org.networks.get(config[:network_id])
+        else
+          org.networks.get_by_name(config[:network_name])
+        end
+      end
+
+      def node_description
+        config[:node_description] || "Test Kitchen: #{node_name}"
+      end
+
+      def node_name
+        config[:node_name] || generate_node_name
+      end
+
+      def generate_node_name
+        # SecureRandom.hex generates a string 2x the argument.
+        # We need the name to be 15 chars or less to play nicely
+        # with windows, so we're generating a 12-char random
+        # string prefixed with "tk-"
+        'tk-' + SecureRandom.hex(6)
+      end
+
+      def instantiate_config
+        {
+          vdc_id: vdc.id,
+          network_id: network.id,
+          description: node_description
+        }
+      end
+
+      def print_error_and_exit(message)
+        error(message)
+        fail message
+      end
+
+      def validate!
+        %w(vdc catalog image network).each do |param|
+          validate_parameter_pair!(param)
+        end
+
+        [ :org, :vdc, :catalog, :image, :network].each do |method|
+          validate_method!(method)
+        end
+
+        validate_customization_script!
+        validate_computer_name!
+      end
+
+      def validate_parameter_pair!(param)
+        id_key   = param + '_id'
+        name_key = param + '_name'
+
+        print_error_and_exit("No #{param} found. You must specify #{id_key} or #{name_key}.") if
+          config[id_key.to_sym].nil? && config[name_key.to_sym].nil?
+      end
+
+      def validate_method!(method)
+        send(method)
+      rescue => e
+        raise "Unable to validate #{method} - check your configuration and try again. #{e.class} -- #{e.message}"
+      end
+
+      def validate_computer_name!
+        # regex proudly modified after stealing from:
+        # http://stackoverflow.com/questions/2063213/regular-expression-for-validating-dns-label-host-name
+        print_error_and_exit('Node name is not valid - must be 15 characters or less, and be a valid Windows node name') unless
+          node_name =~ /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{,15}(?<!-)$/
+      end
+
+      def validate_customization_script!
+        return unless config[:customization_script]
+
+        print_error_and_exit("Customization script #{config[:customization_script]} is not found or not readable.") unless
+          ::File.readable?(config[:customization_script])
+      end
+
+      def instantiate
+        image.instantiate(node_name, instantiate_config)
+      end
+
+      def vapp
+        @vapp ||= vdc.vapps.get(vapp_id)
+      end
+
+      def vm
+        @vm ||= vapp.vms.first
+      end
+
+      def validate_vapp
+        vms = vapp.vms
+        if vms.empty?
+          error('vApp created, but did not contain any VMs')
+          return false
+        end
+
+        if vms.size > 1
+          error('vApp created, but contained more than one VM')
+          return false
+        end
+
+        true
+      end
+
+      def customization
+        @customization ||= vm.customization
+      end
+
+      def update_customization
+        set_customization_script if config[:customization_script]
+        set_customization_password
+        set_customization_computer_name
+        save_customization
+      end
+
+      def set_customization_script
+        customization.script = ::File.read(config[:customization_script])
+      end
+
+      def set_customization_password
+        if config[:vm_password]
+          customization.admin_password          = config[:vm_password]
+          customization.admin_password_auto     = false
+          customization.reset_password_required = false
+        else
+          customization.admin_password          = nil
+          customization.admin_password_auto     = true
+          customization.reset_password_required = false
+        end
+      end
+
+      def set_customization_computer_name
+        customization.computer_name = node_name
+      end
+
+      def save_customization
+        customization.enabled = true
+        customization.save
+      end
+    end
+  end
+end