# -*- encoding: utf-8 -*- # # Author:: Jeff Moody () # # Copyright (C) 2013, Jeff Moody # # 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 'benchmark' require 'kitchen' require 'fog' require 'socket' require 'openssl' # require 'pry' module Kitchen module Driver # Cloudstack driver for Kitchen. # # @author Jeff Moody class Cloudstack < Kitchen::Driver::SSHBase default_config :name, nil default_config :username, 'root' default_config :port, '22' default_config :password, nil def compute cloudstack_uri = URI.parse(config[:cloudstack_api_url]) connection = Fog::Compute.new( :provider => :cloudstack, :cloudstack_api_key => config[:cloudstack_api_key], :cloudstack_secret_access_key => config[:cloudstack_secret_key], :cloudstack_host => cloudstack_uri.host, :cloudstack_port => cloudstack_uri.port, :cloudstack_path => cloudstack_uri.path, :cloudstack_scheme => cloudstack_uri.scheme ) end def create_server options = {} config[:server_name] ||= generate_name(instance.name) options['displayname'] = config[:server_name] if (!config[:cloudstack_network_id].nil?) options['networkids'] = config[:cloudstack_network_id] end if (!config[:cloudstack_security_group_id].nil?) options['securitygroupids'] = config[:cloudstack_security_group_id] end if (!config[:cloudstack_ssh_keypair_name].nil?) options['keypair'] = config[:cloudstack_ssh_keypair_name] end options[:templateid] = config[:cloudstack_template_id] options[:serviceofferingid] = config[:cloudstack_serviceoffering_id] options[:zoneid] = config[:cloudstack_zone_id] debug(options) # binding.pry compute.deploy_virtual_machine(options) end def create(state) if not config[:name] # Generate what should be a unique server name config[:name] = "#{instance.name}-#{Etc.getlogin}-" + "#{Socket.gethostname}-#{Array.new(8){rand(36).to_s(36)}.join}" end if config[:disable_ssl_validation] require 'excon' Excon.defaults[:ssl_verify_peer] = false end server = create_server debug(server) state[:server_id] = server['deployvirtualmachineresponse'].fetch('id') start_jobid = {'jobid' => server['deployvirtualmachineresponse'].fetch('jobid')} info("CloudStack instance <#{state[:server_id]}> created.") debug("Job ID #{start_jobid}") # Cloning the original job id hash because running the query_async_job_result updates the hash to include # more than just the job id (which I could work around, but I'm lazy). jobid = start_jobid.clone server_start = compute.query_async_job_result(jobid) # jobstatus of zero is a running job while server_start['queryasyncjobresultresponse'].fetch('jobstatus').to_i == 0 debug("Job status: #{server_start}") print ". " sleep(10) debug("Running Job ID #{jobid}") debug("Start Job ID #{start_jobid}") # We have to reclone on each iteration, as the hash keeps getting updated. jobid = start_jobid.clone server_start = compute.query_async_job_result(jobid) end debug("Server_Start: #{server_start} \n") # jobstatus of 2 is an error response if server_start['queryasyncjobresultresponse'].fetch('jobstatus').to_i == 2 errortext = server_start['queryasyncjobresultresponse'].fetch('jobresult').fetch('errortext') error("ERROR! Job failed with #{errortext}") raise ActionFailed, "Could not create server #{errortext}" end # jobstatus of 1 is a succesfully completed async job if server_start['queryasyncjobresultresponse'].fetch('jobstatus').to_i == 1 server_info = server_start['queryasyncjobresultresponse']['jobresult']['virtualmachine'] debug(server_info) print "(server ready)" keypair = nil if ((!config[:keypair_search_directory].nil?) and (File.exist?("#{config[:keypair_search_directory]}/#{config[:cloudstack_ssh_keypair_name]}.pem"))) keypair = "#{config[:keypair_search_directory]}/#{config[:cloudstack_ssh_keypair_name]}.pem" debug("Keypair being used is #{keypair}") elsif File.exist?("./#{config[:cloudstack_ssh_keypair_name]}.pem") keypair = "./#{config[:cloudstack_ssh_keypair_name]}.pem" debug("Keypair being used is #{keypair}") elsif File.exist?("#{ENV["HOME"]}/#{config[:cloudstack_ssh_keypair_name]}.pem") keypair = "#{ENV["HOME"]}/#{config[:cloudstack_ssh_keypair_name]}.pem" debug("Keypair being used is #{keypair}") elsif File.exist?("#{ENV["HOME"]}/.ssh/#{config[:cloudstack_ssh_keypair_name]}.pem") keypair = "#{ENV["HOME"]}/.ssh/#{config[:cloudstack_ssh_keypair_name]}.pem" debug("Keypair being used is #{keypair}") elsif (!config[:cloudstack_ssh_keypair_name].nil?) info("Keypair specified but not found. Using password if enabled.") end # binding.pry # debug("Keypair is #{keypair}") state[:hostname] = config[:cloudstack_vm_public_ip] || server_info.fetch('nic').first.fetch('ipaddress') if (!keypair.nil?) debug("Using keypair: #{keypair}") info("SSH for #{state[:hostname]} with keypair #{config[:cloudstack_ssh_keypair_name]}.") ssh_key = File.read(keypair) if ssh_key.split[0] == "ssh-rsa" or ssh_key.split[0] == "ssh-dsa" error("SSH key #{keypair} is not a Private Key. Please modify your .kitchen.yml") end wait_for_sshd(state[:hostname], config[:username], {:keys => keypair}) debug("SSH connectivity validated with keypair.") ssh = Fog::SSH.new(state[:hostname], config[:username], {:keys => keypair}) debug("Connecting to : #{state[:hostname]} as #{config[:username]} using keypair #{keypair}.") elsif (server_info.fetch('passwordenabled') == true) password = server_info.fetch('password') # Print out IP and password so you can record it if you want. info("Password for #{config[:username]} at #{state[:hostname]} is #{password}") wait_for_sshd(state[:hostname], config[:username], {:password => password}) debug("SSH connectivity validated with cloudstack-set password.") ssh = Fog::SSH.new(state[:hostname], config[:username], {:password => password}) debug("Connecting to : #{state[:hostname]} as #{config[:username]} using password #{password}.") elsif (!config[:password].nil?) info("Connecting with user #{config[:username]} with password #{config[:password]}") wait_for_sshd(state[:hostname], config[:username], {:password => config[:password]}) debug("SSH connectivity validated with fixed password.") ssh = Fog::SSH.new(state[:hostname], config[:username], {:password => config[:password]}) else info("No keypair specified (or file not found) nor is this a password enabled template. You will have to manually copy your SSH public key to #{state[:hostname]} to use this Kitchen.") end # binding.pry validate_ssh_connectivity(ssh) deploy_private_key(ssh) end end def destroy(state) return if state[:server_id].nil? debug("Destroying #{state[:server_id]}") server = compute.servers.get(state[:server_id]) if not server.nil? compute.destroy_virtual_machine({'id' => state[:server_id]}) end info("CloudStack instance <#{state[:server_id]}> destroyed.") state.delete(:server_id) state.delete(:hostname) end def validate_ssh_connectivity(ssh) rescue Errno::ETIMEDOUT debug("SSH connection timed out. Retrying.") sleep 2 false rescue Errno::EPERM debug("SSH connection returned error. Retrying.") false rescue Errno::ECONNREFUSED debug("SSH connection returned connection refused. Retrying.") sleep 2 false rescue Errno::EHOSTUNREACH debug("SSH connection returned host unreachable. Retrying.") sleep 2 false rescue Errno::ENETUNREACH debug("SSH connection returned network unreachable. Retrying.") sleep 30 false rescue Net::SSH::Disconnect debug("SSH connection has been disconnected. Retrying.") sleep 15 false rescue Net::SSH::AuthenticationFailed debug("SSH authentication has failed. Password or Keys may not be in place yet. Retrying.") sleep 15 false ensure sync_time = 0 if (config[:cloudstack_sync_time]) sync_time = config[:cloudstack_sync_time] end sleep(sync_time) debug("Connecting to host and running ls") ssh.run('ls') end def deploy_private_key(ssh) debug("Deploying user private key to server using connection #{ssh} to guarantee connectivity.") if File.exist?("#{ENV["HOME"]}/.ssh/id_rsa.pub") user_public_key = File.read("#{ENV["HOME"]}/.ssh/id_rsa.pub") elsif File.exist?("#{ENV["HOME"]}/.ssh/id_dsa.pub") user_public_key = File.read("#{ENV["HOME"]}/.ssh/id_dsa.pub") else debug("No public SSH key for user. Skipping.") end if user_public_key ssh.run([ %{mkdir .ssh}, %{echo "#{user_public_key}" >> ~/.ssh/authorized_keys} ]) end end def generate_name(base) # Generate what should be a unique server name sep = '-' pieces = [ base, Etc.getlogin, Socket.gethostname, Array.new(8) { rand(36).to_s(36) }.join ] until pieces.join(sep).length <= 64 do if pieces[2].length > 24 pieces[2] = pieces[2][0..-2] elsif pieces[1].length > 16 pieces[1] = pieces[1][0..-2] elsif pieces[0].length > 16 pieces[0] = pieces[0][0..-2] end end pieces.join sep end end end end