Class: Kitchen::Driver::Ec2
- Inherits:
-
Base
- Object
- Base
- Kitchen::Driver::Ec2
- Defined in:
- lib/kitchen/driver/ec2.rb
Overview
Amazon EC2 driver for Test Kitchen.
Constant Summary collapse
- INTERFACE_TYPES =
Ordered mapping from config name to Fog name. Ordered by preference when looking up hostname.
{ "dns" => "public_dns_name", "public" => "public_ip_address", "private" => "private_ip_address", "private_dns" => "private_dns_name", }.freeze
Class Method Summary collapse
- .validation_error(driver, old_key, new_key) ⇒ Object
- .validation_warn(driver, old_key, new_key) ⇒ Object
Instance Method Summary collapse
-
#actual_platform ⇒ Object
The actual platform is the platform detected from the image.
- #create(state) ⇒ Object
- #create_ec2_json(state) ⇒ Object
-
#create_key(state) ⇒ void
private
Create a temporary SSH key pair for this instance.
-
#create_security_group(state) ⇒ void
private
Create a temporary security group for this instance.
- #create_spot_request ⇒ Object
- #default_ami ⇒ Object
- #default_instance_type ⇒ Object
- #default_windows_user_data ⇒ Object
-
#delete_key(state) ⇒ void
private
Clean up a temporary SSH key pair for this instance.
-
#delete_security_group(state) ⇒ void
private
Clean up a temporary security group for this instance.
- #desired_platform ⇒ Object
- #destroy(state) ⇒ Object
- #ec2 ⇒ Object
- #fetch_windows_admin_password(server, state) ⇒ Object
-
#hostname(server, interface_type = nil) ⇒ Object
Lookup hostname of provided server.
- #image ⇒ Object
- #image_info(image) ⇒ Object
-
#initialize(*args, &block) ⇒ Ec2
constructor
A new instance of Ec2.
- #instance_generator ⇒ Object
- #show_chosen_image ⇒ Object
-
#submit_server ⇒ Object
Fog AWS helper for creating the instance.
- #submit_spot(state) ⇒ Object
-
#sudo_command ⇒ Object
Returns the sudo command to use or empty string if sudo is not configured.
- #tag_server(server) ⇒ Object
- #tag_volumes(server) ⇒ Object
- #update_username(state) ⇒ Object
-
#wait_until_ready(server, state) ⇒ Object
Normally we could use ‘server.wait_until_running` but we actually need to check more than just the instance state.
-
#wait_until_volumes_ready(server, state) ⇒ Object
Compares the requested volume count vs what has actually been set to be attached to the instance.
-
#wait_with_destroy(server, state, status_msg, &block) ⇒ Object
Poll a block, waiting for it to return true.
- #with_request_limit_backoff(state) ⇒ Object
Constructor Details
#initialize(*args, &block) ⇒ Ec2
Returns a new instance of Ec2.
96 97 98 |
# File 'lib/kitchen/driver/ec2.rb', line 96 def initialize(*args, &block) super end |
Class Method Details
.validation_error(driver, old_key, new_key) ⇒ Object
105 106 107 108 109 |
# File 'lib/kitchen/driver/ec2.rb', line 105 def self.validation_error(driver, old_key, new_key) warn "ERROR: The driver[#{driver.class.name}] config key `#{old_key}` " \ "has been removed, please use `#{new_key}`" exit! end |
.validation_warn(driver, old_key, new_key) ⇒ Object
100 101 102 103 |
# File 'lib/kitchen/driver/ec2.rb', line 100 def self.validation_warn(driver, old_key, new_key) driver.warn "WARN: The driver[#{driver.class.name}] config key `#{old_key}` " \ "is deprecated, please use `#{new_key}`" end |
Instance Method Details
#actual_platform ⇒ Object
The actual platform is the platform detected from the image
360 361 362 |
# File 'lib/kitchen/driver/ec2.rb', line 360 def actual_platform @actual_platform ||= Aws::StandardPlatform.from_image(self, image) if image end |
#create(state) ⇒ Object
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/kitchen/driver/ec2.rb', line 200 def create(state) return if state[:server_id] update_username(state) info(Kitchen::Util.outdent!(<<-END)) unless config[:skip_cost_warning] If you are not using an account that qualifies under the AWS free-tier, you may be charged to run these suites. The charge should be minimal, but neither Test Kitchen nor its maintainers are responsible for your incurred costs. END # If no security group IDs are specified, create one automatically. unless config[:security_group_ids] || config[:security_group_filter] create_security_group(state) config[:security_group_ids] = [state[:auto_security_group_id]] end # If no SSH key pair name is specified, create one automatically. # If `_disabled`, nullify the key ID to avoid associating the instance with # an AWS-managed key pair. case config[:aws_ssh_key_id] when nil create_key(state) config[:aws_ssh_key_id] = state[:auto_key_id] when "_disable" info("Disabling AWS-managed SSH key pairs for this EC2 instance.") info("The key pairs for the kitchen transport config and the AMI must match.") config[:aws_ssh_key_id] = nil end if config[:spot_price] # Spot instance when a price is set server = with_request_limit_backoff(state) { submit_spot(state) } else # On-demand instance server = with_request_limit_backoff(state) { submit_server } end info("Instance <#{server.id}> requested.") with_request_limit_backoff(state) do server.wait_until_exists do |w| w.before_attempt do |attempts| info("Polling AWS for existence, attempt #{attempts}...") end end end # See https://github.com/aws/aws-sdk-ruby/issues/859 # Tagging can fail with a NotFound error even though we waited until the server exists # Waiting can also fail, so we have to also retry on that. If it means we re-tag the # instance, so be it. # Tagging an instance is possible before volumes are attached. Tagging the volumes after # instance creation is consistent. Retryable.retryable( tries: 10, sleep: lambda { |n| [2**n, 30].min }, on: ::Aws::EC2::Errors::InvalidInstanceIDNotFound ) do |r, _| info("Attempting to tag the instance, #{r} retries") tag_server(server) # Get information about the AMI (image) used to create the image. image_data = ec2.client.describe_images({ image_ids: [server.image_id] })[0][0] state[:server_id] = server.id info("EC2 instance <#{state[:server_id]}> created.") # instance-store backed images do not have attached volumes, so only # wait for the volumes to be ready if the instance EBS-backed. if image_data.root_device_type == "ebs" wait_until_volumes_ready(server, state) tag_volumes(server) end wait_until_ready(server, state) end if windows_os? && instance.transport[:username] =~ /administrator/i && instance.transport[:password].nil? # If we're logging into the administrator user and a password isn't # supplied, try to fetch it from the AWS instance fetch_windows_admin_password(server, state) end info("EC2 instance <#{state[:server_id]}> ready (hostname: #{state[:hostname]}).") instance.transport.connection(state).wait_until_ready create_ec2_json(state) if instance.provisioner.name =~ /chef/ debug("ec2:create '#{state[:hostname]}'") rescue Exception # Clean up any auto-created security groups or keys on the way out. delete_security_group(state) delete_key(state) raise end |
#create_ec2_json(state) ⇒ Object
627 628 629 630 631 632 633 634 635 |
# File 'lib/kitchen/driver/ec2.rb', line 627 def create_ec2_json(state) if windows_os? cmd = "New-Item -Force C:\\chef\\ohai\\hints\\ec2.json -ItemType File" else debug "Using sudo_command='#{sudo_command}' for ohai hints" cmd = "#{sudo_command} mkdir -p /etc/chef/ohai/hints; #{sudo_command} touch /etc/chef/ohai/hints/ec2.json" end instance.transport.connection(state).execute(cmd) end |
#create_key(state) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Create a temporary SSH key pair for this instance.
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 |
# File 'lib/kitchen/driver/ec2.rb', line 777 def create_key(state) return if state[:auto_key_id] # Encode a bunch of metadata into the name because that's all we can # set for a key pair. name_parts = [ instance.name.gsub(/\W/, ""), (Etc.getlogin || "nologin").gsub(/\W/, ""), Socket.gethostname.gsub(/\W/, "")[0..20], Time.now.utc.iso8601, Array.new(8) { rand(36).to_s(36) }.join(""), ] # In a perfect world this would generate the key locally and use ImportKey # instead for better security, but given the use case that is very likely # to rapidly exhaust local entropy by creating a lot of keys. So this is # probably fine. If you want very high security, probably don't use this # feature anyway. resp = ec2.client.create_key_pair(key_name: "kitchen-#{name_parts.join('-')}") state[:auto_key_id] = resp.key_name info("Created automatic key pair #{state[:auto_key_id]}") # Write the key out with safe permissions key_path = "#{config[:kitchen_root]}/.kitchen/#{instance.name}.pem" File.open(key_path, File::WRONLY | File::CREAT | File::EXCL, 00600) do |f| f.write(resp.key_material) end # Inject the key into the state to be used by the SSH transport, or for # the Windows password decrypt above in {#fetch_windows_admin_password}. state[:ssh_key] = key_path end |
#create_security_group(state) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Create a temporary security group for this instance.
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 |
# File 'lib/kitchen/driver/ec2.rb', line 728 def create_security_group(state) return if state[:auto_security_group_id] # Work out which VPC, if any, we are creating in. vpc_id = if config[:subnet_id] # Get the VPC ID for the subnet. subnets = ec2.client.describe_subnets(filters: [{ name: "subnet-id", values: [config[:subnet_id]] }]).subnets raise "Subnet #{config[:subnet_id]} not found during security group creation" if subnets.empty? subnets.first.vpc_id else # Try to check for a default VPC. vpcs = ec2.client.describe_vpcs(filters: [{ name: "isDefault", values: ["true"] }]).vpcs if vpcs.empty? # No default VPC so assume EC2-Classic ¯\_(ツ)_/¯ nil else # I don't actually know if you can have more than one default VPC? vpcs.first.vpc_id end end # Create the SG. params = { group_name: "kitchen-#{Array.new(8) { rand(36).to_s(36) }.join}", description: "Test Kitchen for #{instance.name} by #{Etc.getlogin || 'nologin'} on #{Socket.gethostname}", } params[:vpc_id] = vpc_id if vpc_id resp = ec2.client.create_security_group(params) state[:auto_security_group_id] = resp.group_id info("Created automatic security group #{state[:auto_security_group_id]}") debug(" in VPC #{vpc_id || 'none'}") # Set up SG rules. ec2.client.( group_id: state[:auto_security_group_id], # Allow SSH and WinRM (both plain and TLS). ip_permissions: [22, 3389, 5985, 5986].map do |port| { ip_protocol: "tcp", from_port: port, to_port: port, ip_ranges: [{ cidr_ip: config[:security_group_cidr_ip] }], } end ) end |
#create_spot_request ⇒ Object
447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
# File 'lib/kitchen/driver/ec2.rb', line 447 def create_spot_request request_duration = config[:retryable_tries] * config[:retryable_sleep] request_data = { spot_price: config[:spot_price].to_s, launch_specification: instance_generator.ec2_instance_data, valid_until: Time.now + request_duration, } if config[:block_duration_minutes] request_data[:block_duration_minutes] = config[:block_duration_minutes] end response = ec2.client.request_spot_instances(request_data) response[:spot_instance_requests][0][:spot_instance_request_id] end |
#default_ami ⇒ Object
375 376 377 378 379 380 381 382 |
# File 'lib/kitchen/driver/ec2.rb', line 375 def default_ami @default_ami ||= begin search_platform = desired_platform || Aws::StandardPlatform.from_platform_string(self, "ubuntu") image_search = config[:image_search] || search_platform.image_search search_platform.find_image(image_search) end end |
#default_instance_type ⇒ Object
345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/kitchen/driver/ec2.rb', line 345 def default_instance_type @instance_type ||= begin # We default to the free tier (t2.micro for hvm, t1.micro for paravirtual) if image && image.virtualization_type == "hvm" info("instance_type not specified. Using free tier t2.micro instance ...") "t2.micro" else info("instance_type not specified. Using free tier t1.micro instance since" \ " image is paravirtual (pick an hvm image to use the superior t2.micro!) ...") "t1.micro" end end end |
#default_windows_user_data ⇒ Object
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'lib/kitchen/driver/ec2.rb', line 637 def default_windows_user_data base_script = Kitchen::Util.outdent!(<<-EOH) $OSVersion = (get-itemproperty -Path "HKLM:\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion" -Name ProductName).ProductName If($OSVersion.contains('2016') -Or $OSVersion -eq 'Windows Server Datacenter') { New-Item -ItemType Directory -Force -Path 'C:\\ProgramData\\Amazon\\EC2-Windows\\Launch\\Log' $logfile='C:\\ProgramData\\Amazon\\EC2-Windows\\Launch\\Log\\kitchen-ec2.log' # EC2Launch doesn't init extra disks by default C:\\ProgramData\\Amazon\\EC2-Windows\\Launch\\Scripts\\InitializeDisks.ps1 } Else { New-Item -ItemType Directory -Force -Path 'C:\\Program Files\\Amazon\\Ec2ConfigService\\Logs' $logfile='C:\\Program Files\\Amazon\\Ec2ConfigService\\Logs\\kitchen-ec2.log' } # Logfile fail-safe in case the directory does not exist New-Item $logfile -Type file -Force # Allow script execution Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Force #PS Remoting and & winrm.cmd basic config $enableArgs=@{Force=$true} $command=Get-Command Enable-PSRemoting if($command.Parameters.Keys -contains "skipnetworkprofilecheck"){ $enableArgs.skipnetworkprofilecheck=$true } Enable-PSRemoting @enableArgs & winrm.cmd set winrm/config '@{MaxTimeoutms="1800000"}' >> $logfile & winrm.cmd set winrm/config/winrs '@{MaxMemoryPerShellMB="1024"}' >> $logfile & winrm.cmd set winrm/config/winrs '@{MaxShellsPerUser="50"}' >> $logfile & winrm.cmd set winrm/config/winrs '@{MaxMemoryPerShellMB="1024"}' >> $logfile #Firewall Config & netsh advfirewall firewall set rule name="Windows Remote Management (HTTP-In)" profile=public protocol=tcp localport=5985 remoteip=localsubnet new remoteip=any >> $logfile Set-ItemProperty -Name LocalAccountTokenFilterPolicy -Path HKLM:\\software\\Microsoft\\Windows\\CurrentVersion\\Policies\\system -Value 1 EOH # Preparing custom static admin user if we defined something other than Administrator custom_admin_script = "" if !(instance.transport[:username] =~ /administrator/i) && instance.transport[:password] custom_admin_script = Kitchen::Util.outdent!(<<-EOH) "Disabling Complex Passwords" >> $logfile $seccfg = [IO.Path]::GetTempFileName() & secedit.exe /export /cfg $seccfg >> $logfile (Get-Content $seccfg) | Foreach-Object {$_ -replace "PasswordComplexity\\s*=\\s*1", "PasswordComplexity = 0"} | Set-Content $seccfg & secedit.exe /configure /db $env:windir\\security\\new.sdb /cfg $seccfg /areas SECURITYPOLICY >> $logfile & cp $seccfg "c:\\" & del $seccfg $username="#{instance.transport[:username]}" $password="#{instance.transport[:password]}" "Creating static user: $username" >> $logfile & net.exe user /y /add $username $password >> $logfile "Adding $username to Administrators" >> $logfile & net.exe localgroup Administrators /add $username >> $logfile EOH end # Returning the fully constructed PowerShell script to user_data Kitchen::Util.outdent!(<<-EOH) <powershell> #{base_script} #{custom_admin_script} </powershell> EOH end |
#delete_key(state) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Clean up a temporary SSH key pair for this instance.
823 824 825 826 827 828 829 |
# File 'lib/kitchen/driver/ec2.rb', line 823 def delete_key(state) return unless state[:auto_key_id] info("Removing automatic key pair #{state[:auto_key_id]}") ec2.client.delete_key_pair(key_name: state[:auto_key_id]) state.delete(:auto_key_id) File.unlink("#{config[:kitchen_root]}/.kitchen/#{instance.name}.pem") end |
#delete_security_group(state) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Clean up a temporary security group for this instance.
811 812 813 814 815 816 |
# File 'lib/kitchen/driver/ec2.rb', line 811 def delete_security_group(state) return unless state[:auto_security_group_id] info("Removing automatic security group #{state[:auto_security_group_id]}") ec2.client.delete_security_group(group_id: state[:auto_security_group_id]) state.delete(:auto_security_group_id) end |
#desired_platform ⇒ Object
364 365 366 367 368 369 370 371 372 373 |
# File 'lib/kitchen/driver/ec2.rb', line 364 def desired_platform @desired_platform ||= begin platform = Aws::StandardPlatform.from_platform_string(self, instance.platform.name) if platform debug("platform name #{instance.platform.name} appears to be a standard platform." \ " Searching for #{platform} ...") end platform end end |
#destroy(state) ⇒ Object
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/kitchen/driver/ec2.rb', line 294 def destroy(state) if state[:server_id] server = ec2.get_instance(state[:server_id]) unless server.nil? instance.transport.connection(state).close server.terminate end if state[:spot_request_id] debug("Deleting spot request <#{state[:server_id]}>") ec2.client.cancel_spot_instance_requests( spot_instance_request_ids: [state[:spot_request_id]] ) state.delete(:spot_request_id) end # If we are going to clean up an automatic security group, we need # to wait for the instance to shut down. This slightly breaks the # subsystem encapsulation, sorry not sorry. if state[:auto_security_group_id] && server server.wait_until_terminated do |waiter| waiter.max_attempts = config[:retryable_tries] waiter.delay = config[:retryable_sleep] waiter.before_attempt do |attempts| info "Waited #{attempts * waiter.delay}/#{waiter.delay * waiter.max_attempts}s for instance <#{server.id}> to terminate." end end end info("EC2 instance <#{state[:server_id]}> destroyed.") state.delete(:server_id) state.delete(:hostname) end # Clean up any auto-created security groups or keys. delete_security_group(state) delete_key(state) end |
#ec2 ⇒ Object
399 400 401 402 403 404 405 406 407 |
# File 'lib/kitchen/driver/ec2.rb', line 399 def ec2 @ec2 ||= Aws::Client.new( config[:region], config[:shared_credentials_profile], config[:http_proxy], config[:retry_limit], config[:ssl_verify_peer] ) end |
#fetch_windows_admin_password(server, state) ⇒ Object
557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/kitchen/driver/ec2.rb', line 557 def fetch_windows_admin_password(server, state) wait_with_destroy(server, state, "to fetch windows admin password") do |aws_instance| enc = server.client.get_password_data( instance_id: state[:server_id] ).password_data # Password data is blank until password is available !enc.nil? && !enc.empty? end pass = with_request_limit_backoff(state) do server.decrypt_windows_password(File.(state[:ssh_key] || instance.transport[:ssh_key])) end state[:password] = pass info("Retrieved Windows password for instance <#{state[:server_id]}>.") end |
#hostname(server, interface_type = nil) ⇒ Object
Lookup hostname of provided server. If interface_type is provided use that interface to lookup hostname. Otherwise, try ordered list of options.
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'lib/kitchen/driver/ec2.rb', line 603 def hostname(server, interface_type = nil) if interface_type interface_type = INTERFACE_TYPES.fetch(interface_type) do raise Kitchen::UserError, "Invalid interface [#{interface_type}]" end server.send(interface_type) else potential_hostname = nil INTERFACE_TYPES.values.each do |type| potential_hostname ||= server.send(type) # AWS returns an empty string if the dns name isn't populated yet potential_hostname = nil if potential_hostname == "" end potential_hostname end end |
#image ⇒ Object
330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/kitchen/driver/ec2.rb', line 330 def image return @image if defined?(@image) if config[:image_id] @image = ec2.resource.image(config[:image_id]) show_chosen_image else raise "Neither image_id nor an image_search specified for instance #{instance.name}!" \ " Please specify one or the other." end @image end |
#image_info(image) ⇒ Object
712 713 714 715 716 717 718 719 720 721 |
# File 'lib/kitchen/driver/ec2.rb', line 712 def image_info(image) root_device = image.block_device_mappings .find { |b| b.device_name == image.root_device_name } volume_type = " #{root_device.ebs.volume_type}" if root_device && root_device.ebs " Architecture: #{image.architecture}," \ " Virtualization: #{image.virtualization_type}," \ " Storage: #{image.root_device_type}#{volume_type}," \ " Created: #{image.creation_date}" end |
#instance_generator ⇒ Object
409 410 411 |
# File 'lib/kitchen/driver/ec2.rb', line 409 def instance_generator @instance_generator ||= Aws::InstanceGenerator.new(config, ec2, instance.logger) end |
#show_chosen_image ⇒ Object
700 701 702 703 704 705 706 707 708 709 710 |
# File 'lib/kitchen/driver/ec2.rb', line 700 def show_chosen_image # Print some debug stuff debug("Image for #{instance.name}: #{image.name}. #{image_info(image)}") if actual_platform info("Detected platform: #{actual_platform.name} version #{actual_platform.version}" \ " on #{actual_platform.architecture}. Instance Type: #{config[:instance_type]}." \ " Default username: #{actual_platform.username} (default).") else debug("No platform detected for #{image.name}.") end end |
#submit_server ⇒ Object
Fog AWS helper for creating the instance
414 415 416 417 418 419 420 421 422 423 |
# File 'lib/kitchen/driver/ec2.rb', line 414 def submit_server instance_data = instance_generator.ec2_instance_data debug("Creating EC2 instance in region #{config[:region]} with properties:") instance_data.each do |key, value| debug("- #{key} = #{value.inspect}") end instance_data[:min_count] = 1 instance_data[:max_count] = 1 ec2.create_instance(instance_data) end |
#submit_spot(state) ⇒ Object
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/kitchen/driver/ec2.rb', line 425 def submit_spot(state) debug("Creating EC2 Spot Instance..") spot_request_id = create_spot_request # deleting the instance cancels the request, but deleting the request # does not affect the instance state[:spot_request_id] = spot_request_id ec2.client.wait_until( :spot_instance_request_fulfilled, spot_instance_request_ids: [spot_request_id] ) do |w| w.max_attempts = config[:retryable_tries] w.delay = config[:retryable_sleep] w.before_attempt do |attempts| c = attempts * config[:retryable_sleep] t = config[:retryable_tries] * config[:retryable_sleep] info "Waited #{c}/#{t}s for spot request <#{spot_request_id}> to become fulfilled." end end ec2.get_instance_from_spot_request(spot_request_id) end |
#sudo_command ⇒ Object
Returns the sudo command to use or empty string if sudo is not configured
623 624 625 |
# File 'lib/kitchen/driver/ec2.rb', line 623 def sudo_command instance.provisioner[:sudo] ? instance.provisioner[:sudo_command].to_s : "" end |
#tag_server(server) ⇒ Object
462 463 464 465 466 467 468 469 470 471 472 |
# File 'lib/kitchen/driver/ec2.rb', line 462 def tag_server(server) if config[:tags] && !config[:tags].empty? = config[:tags].map do |k, v| # we convert the value to a string because # nils should be passed as an empty String # and Integers need to be represented as Strings { key: k.to_s, value: v.to_s } end server.(tags: ) end end |
#tag_volumes(server) ⇒ Object
474 475 476 477 478 479 480 481 482 483 |
# File 'lib/kitchen/driver/ec2.rb', line 474 def tag_volumes(server) if config[:tags] && !config[:tags].empty? = config[:tags].map do |k, v| { key: k.to_s, value: v.to_s } end server.volumes.each do |volume| volume.(tags: ) end end end |
#update_username(state) ⇒ Object
384 385 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'lib/kitchen/driver/ec2.rb', line 384 def update_username(state) # BUG: With the following equality condition on username, if the user specifies 'root' # as the transport's username then we will overwrite that value with one from the standard # platform definitions. This seems difficult to handle here as the default username is # provided by the underlying transport classes, and is often non-nil (eg; 'root'), leaving # us no way to distinguish a user-set value from the transport's default. # See https://github.com/test-kitchen/kitchen-ec2/pull/273 if actual_platform && instance.transport[:username] == instance.transport.class.defaults[:username] debug("No SSH username specified: using default username #{actual_platform.username} " \ " for image #{config[:image_id]}, which we detected as #{actual_platform}.") state[:username] = actual_platform.username end end |
#wait_until_ready(server, state) ⇒ Object
Normally we could use ‘server.wait_until_running` but we actually need to check more than just the instance state
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/kitchen/driver/ec2.rb', line 505 def wait_until_ready(server, state) wait_with_destroy(server, state, "to become ready") do |aws_instance| hostname = hostname(aws_instance, config[:interface]) # We aggressively store the hostname so if the process fails here # we still have it, even if it will change later state[:hostname] = hostname # Euca instances often report ready before they have an IP ready = aws_instance.exists? && aws_instance.state.name == "running" && hostname != "0.0.0.0" if ready && ( hostname.nil? || hostname == "" ) debug("Unable to detect hostname using interface_type #{config[:interface]}. Fallback to ordered mapping") state[:hostname] = hostname(aws_instance, nil) end if ready && windows_os? output = server.console_output.output unless output.nil? output = Base64.decode64(output) debug "Console output: --- \n#{output}" end ready = !!(output =~ /Windows is Ready to use/) end ready end end |
#wait_until_volumes_ready(server, state) ⇒ Object
Compares the requested volume count vs what has actually been set to be attached to the instance. The information requested through ec2.client.described_volumes is updated before the instance volume information.
489 490 491 492 493 494 495 496 497 498 499 500 501 |
# File 'lib/kitchen/driver/ec2.rb', line 489 def wait_until_volumes_ready(server, state) wait_with_destroy(server, state, "volumes to be ready") do |aws_instance| described_volume_count = 0 ready_volume_count = 0 if aws_instance.exists? described_volume_count = ec2.client.describe_volumes(filters: [ { name: "attachment.instance-id", values: ["#{state[:server_id]}"] }] ).volumes.length aws_instance.volumes.each { ready_volume_count += 1 } end (described_volume_count > 0) && (described_volume_count == ready_volume_count) end end |
#wait_with_destroy(server, state, status_msg, &block) ⇒ Object
Poll a block, waiting for it to return true. If it does not succeed within the configured time we destroy the instance to save people money
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'lib/kitchen/driver/ec2.rb', line 534 def wait_with_destroy(server, state, status_msg, &block) wait_log = proc do |attempts| c = attempts * config[:retryable_sleep] t = config[:retryable_tries] * config[:retryable_sleep] info "Waited #{c}/#{t}s for instance <#{state[:server_id]}> #{status_msg}." end begin with_request_limit_backoff(state) do server.wait_until( max_attempts: config[:retryable_tries], delay: config[:retryable_sleep], before_attempt: wait_log, &block ) end rescue ::Aws::Waiters::Errors::WaiterFailed error("Ran out of time waiting for the server with id [#{state[:server_id]}]" \ " #{status_msg}, attempting to destroy it") destroy(state) raise end end |
#with_request_limit_backoff(state) ⇒ Object
572 573 574 575 576 577 578 579 580 581 582 583 584 |
# File 'lib/kitchen/driver/ec2.rb', line 572 def with_request_limit_backoff(state) retries = 0 begin yield rescue ::Aws::EC2::Errors::RequestLimitExceeded, ::Aws::Waiters::Errors::UnexpectedError => e raise unless retries < 5 && e..include?("Request limit exceeded") retries += 1 info("Request limit exceeded for instance <#{state[:server_id]}>." \ " Trying again in #{retries**2} seconds.") sleep(retries**2) retry end end |