Class: Kitchen::Driver::Ec2

Inherits:
Base
  • Object
show all
Defined in:
lib/kitchen/driver/ec2.rb

Overview

Amazon EC2 driver for Test Kitchen.

Author:

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",
  "id" => "id",
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &block) ⇒ Ec2

Returns a new instance of Ec2.



97
98
99
 
# File 'lib/kitchen/driver/ec2.rb', line 97

def initialize(*args, &block)
  super
end

Class Method Details

.validation_error(driver, old_key, new_key) ⇒ Object 



106
107
108
109
110
 
# File 'lib/kitchen/driver/ec2.rb', line 106

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 



101
102
103
104
 
# File 'lib/kitchen/driver/ec2.rb', line 101

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



358
359
360
 
# File 'lib/kitchen/driver/ec2.rb', line 358

def actual_platform
  @actual_platform ||= Aws::StandardPlatform.from_image(self, image) if image
end

#config ⇒ Object 



423
424
425
426
 
# File 'lib/kitchen/driver/ec2.rb', line 423

def config
  return super unless @config
  @config
end

#create(state) ⇒ Object 



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
 
# File 'lib/kitchen/driver/ec2.rb', line 201

def create(state)
  return if state[:server_id]
  update_username(state)

  info(Kitchen::Util.outdent!("    If you are not using an account that qualifies under the AWS\n    free-tier, you may be charged to run these suites. The charge\n    should be minimal, but neither Test Kitchen nor its maintainers\n    are responsible for your incurred costs.\n  END\n\n  # If no security group IDs are specified, create one automatically.\n  unless config[:security_group_ids] || config[:security_group_filter]\n    create_security_group(state)\n    config[:security_group_ids] = [state[:auto_security_group_id]]\n  end\n\n  # If no SSH key pair name is specified, create one automatically.\n  # If `_disabled`, nullify the key ID to avoid associating the instance with\n  # an AWS-managed key pair.\n  case config[:aws_ssh_key_id]\n  when nil\n    create_key(state)\n    config[:aws_ssh_key_id] = state[:auto_key_id]\n  when \"_disable\"\n    info(\"Disabling AWS-managed SSH key pairs for this EC2 instance.\")\n    info(\"The key pairs for the kitchen transport config and the AMI must match.\")\n    config[:aws_ssh_key_id] = nil\n  end\n\n  if config[:spot_price]\n    # Spot instance when a price is set\n    server = with_request_limit_backoff(state) { submit_spots(state) }\n  else\n    # On-demand instance\n    server = with_request_limit_backoff(state) { submit_server }\n  end\n  info(\"Instance <\#{server.id}> requested.\")\n  with_request_limit_backoff(state) do\n    logging_proc = ->(attempts) { info(\"Polling AWS for existence, attempt \#{attempts}...\") }\n    server.wait_until_exists(before_attempt: logging_proc)\n  end\n\n  # See https://github.com/aws/aws-sdk-ruby/issues/859\n  # Tagging can fail with a NotFound error even though we waited until the server exists\n  # Waiting can also fail, so we have to also retry on that. If it means we re-tag the\n  # instance, so be it.\n  # Tagging an instance is possible before volumes are attached. Tagging the volumes after\n  # instance creation is consistent.\n  Retryable.retryable(\n    tries: 10,\n    sleep: lambda { |n| [2**n, 30].min },\n    on: ::Aws::EC2::Errors::InvalidInstanceIDNotFound\n  ) do |r, _|\n    info(\"Attempting to tag the instance, \#{r} retries\")\n    tag_server(server)\n\n    # Get information about the AMI (image) used to create the image.\n    image_data = ec2.client.describe_images({ image_ids: [server.image_id] })[0][0]\n\n    state[:server_id] = server.id\n    info(\"EC2 instance <\#{state[:server_id]}> created.\")\n\n    # instance-store backed images do not have attached volumes, so only\n    # wait for the volumes to be ready if the instance EBS-backed.\n    if image_data.root_device_type == \"ebs\"\n      wait_until_volumes_ready(server, state)\n      tag_volumes(server)\n    end\n    wait_until_ready(server, state)\n  end\n\n  if windows_os? &&\n      instance.transport[:username] =~ /administrator/i &&\n      instance.transport[:password].nil?\n    # If we're logging into the administrator user and a password isn't\n    # supplied, try to fetch it from the AWS instance\n    fetch_windows_admin_password(server, state)\n  end\n\n  info(\"EC2 instance <\#{state[:server_id]}> ready (hostname: \#{state[:hostname]}).\")\n  instance.transport.connection(state).wait_until_ready\n  create_ec2_json(state) if instance.provisioner.name =~ /chef/\n  debug(\"ec2:create '\#{state[:hostname]}'\")\nrescue Exception\n  # Clean up any auto-created security groups or keys on the way out.\n  delete_security_group(state)\n  delete_key(state)\n  raise\nend\n")) unless config[:skip_cost_warning]

#create_ec2_json(state) ⇒ Object 



679
680
681
682
683
684
685
686
687
 
# File 'lib/kitchen/driver/ec2.rb', line 679

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.

Parameters:

  • state (Hash) —

    Instance state hash.



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/kitchen/driver/ec2.rb', line 829

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.

Parameters:

  • state (Hash) —

    Instance state hash.



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
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/kitchen/driver/ec2.rb', line 780

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.authorize_security_group_ingress(
    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 



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/kitchen/driver/ec2.rb', line 492

def create_spot_request
  request_duration = config[:spot_wait]
  config_spot_price = config[:spot_price].to_s
  if ["ondemand", "on-demand"].include?(config_spot_price)
    spot_price = ""
  else
    spot_price = config_spot_price
  end
  request_data = {
    spot_price: spot_price,
    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 



373
374
375
376
377
378
379
380
 
# File 'lib/kitchen/driver/ec2.rb', line 373

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 



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/kitchen/driver/ec2.rb', line 343

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 



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/kitchen/driver/ec2.rb', line 689

def default_windows_user_data
  base_script = Kitchen::Util.outdent!("  $OSVersion = (get-itemproperty -Path \"HKLM:\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\" -Name ProductName).ProductName\n  If($OSVersion.contains('2016') -Or $OSVersion -eq 'Windows Server Datacenter') {\n    New-Item -ItemType Directory -Force -Path 'C:\\\\ProgramData\\\\Amazon\\\\EC2-Windows\\\\Launch\\\\Log'\n    $logfile='C:\\\\ProgramData\\\\Amazon\\\\EC2-Windows\\\\Launch\\\\Log\\\\kitchen-ec2.log'\n    # EC2Launch doesn't init extra disks by default\n    C:\\\\ProgramData\\\\Amazon\\\\EC2-Windows\\\\Launch\\\\Scripts\\\\InitializeDisks.ps1\n  } Else {\n     New-Item -ItemType Directory -Force -Path 'C:\\\\Program Files\\\\Amazon\\\\Ec2ConfigService\\\\Logs'\n     $logfile='C:\\\\Program Files\\\\Amazon\\\\Ec2ConfigService\\\\Logs\\\\kitchen-ec2.log'\n  }\n\n  # Logfile fail-safe in case the directory does not exist\n  New-Item $logfile -Type file -Force\n\n  # Allow script execution\n  Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Force\n  #PS Remoting and & winrm.cmd basic config\n  $enableArgs=@{Force=$true}\n  $command=Get-Command Enable-PSRemoting\n  if($command.Parameters.Keys -contains \"skipnetworkprofilecheck\"){\n      $enableArgs.skipnetworkprofilecheck=$true\n  }\n  Enable-PSRemoting @enableArgs\n  & winrm.cmd set winrm/config '@{MaxTimeoutms=\"1800000\"}' >> $logfile\n  & winrm.cmd set winrm/config/winrs '@{MaxMemoryPerShellMB=\"1024\"}' >> $logfile\n  & winrm.cmd set winrm/config/winrs '@{MaxShellsPerUser=\"50\"}' >> $logfile\n  & winrm.cmd set winrm/config/winrs '@{MaxMemoryPerShellMB=\"1024\"}' >> $logfile\n  #Firewall Config\n  & netsh advfirewall firewall set rule name=\"Windows Remote Management (HTTP-In)\" profile=public protocol=tcp localport=5985 remoteip=localsubnet new remoteip=any  >> $logfile\n  Set-ItemProperty -Name LocalAccountTokenFilterPolicy -Path HKLM:\\\\software\\\\Microsoft\\\\Windows\\\\CurrentVersion\\\\Policies\\\\system -Value 1\n  EOH\n\n  # Preparing custom static admin user if we defined something other than Administrator\n  custom_admin_script = \"\"\n  if !(instance.transport[:username] =~ /administrator/i) && instance.transport[:password]\n    custom_admin_script = Kitchen::Util.outdent!(<<-EOH)\n    \"Disabling Complex Passwords\" >> $logfile\n    $seccfg = [IO.Path]::GetTempFileName()\n    & secedit.exe /export /cfg $seccfg >> $logfile\n    (Get-Content $seccfg) | Foreach-Object {$_ -replace \"PasswordComplexity\\\\s*=\\\\s*1\", \"PasswordComplexity = 0\"} | Set-Content $seccfg\n    & secedit.exe /configure /db $env:windir\\\\security\\\\new.sdb /cfg $seccfg /areas SECURITYPOLICY >> $logfile\n    & cp $seccfg \"c:\\\\\"\n    & del $seccfg\n    $username=\"\#{instance.transport[:username]}\"\n    $password=\"\#{instance.transport[:password]}\"\n    \"Creating static user: $username\" >> $logfile\n    & net.exe user /y /add $username $password >> $logfile\n    \"Adding $username to Administrators\" >> $logfile\n    & net.exe localgroup Administrators /add $username >> $logfile\n    EOH\n  end\n\n  # Returning the fully constructed PowerShell script to user_data\n  Kitchen::Util.outdent!(<<-EOH)\n  <powershell>\n  \#{base_script}\n  \#{custom_admin_script}\n  </powershell>\n  EOH\nend\n")

#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.

Parameters:

  • state (Hash) —

    Instance state hash.



875
876
877
878
879
880
881
 
# File 'lib/kitchen/driver/ec2.rb', line 875

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.

Parameters:

  • state (Hash) —

    Instance state hash.



863
864
865
866
867
868
 
# File 'lib/kitchen/driver/ec2.rb', line 863

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 



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/kitchen/driver/ec2.rb', line 362

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 



292
293
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
 
# File 'lib/kitchen/driver/ec2.rb', line 292

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 



397
398
399
400
401
402
403
404
405
 
# File 'lib/kitchen/driver/ec2.rb', line 397

def ec2
  @ec2 ||= Aws::Client.new(
    config[:region],
    config[:shared_credentials_profile],
    config[:http_proxy],
    config[:retry_limit],
    config[:ssl_verify_peer]
  )
end

#expand_config(conf, key) ⇒ Object

Take one config and expand to multiple configs



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/kitchen/driver/ec2.rb', line 429

def expand_config(conf, key)
  configs = []

  if conf[key] && conf[key].kind_of?(Array)
    values = conf[key]
    values.each do |value|
      new_config = conf.clone
      new_config[key] = value
      configs.push new_config
    end
  else
    configs.push conf
  end

  configs
end

#fetch_windows_admin_password(server, state) ⇒ Object 



608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/kitchen/driver/ec2.rb', line 608

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.expand_path(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.



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/kitchen/driver/ec2.rb', line 655

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 



328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/kitchen/driver/ec2.rb', line 328

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 



764
765
766
767
768
769
770
771
772
773
 
# File 'lib/kitchen/driver/ec2.rb', line 764

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 



407
408
409
 
# File 'lib/kitchen/driver/ec2.rb', line 407

def instance_generator
  @instance_generator = Aws::InstanceGenerator.new(config, ec2, instance.logger)
end

#show_chosen_image ⇒ Object 



752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/kitchen/driver/ec2.rb', line 752

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



412
413
414
415
416
417
418
419
420
421
 
# File 'lib/kitchen/driver/ec2.rb', line 412

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 



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/kitchen/driver/ec2.rb', line 470

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[:spot_wait] / config[:retryable_sleep]
    w.delay = config[:retryable_sleep]
    w.before_attempt do |attempts|
      c = attempts * config[:retryable_sleep]
      t = config[:spot_wait]
      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

#submit_spots(state) ⇒ Object 



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/kitchen/driver/ec2.rb', line 446

def submit_spots(state)
  configs = [config]
  expanded = []
  keys = [:instance_type, :subnet_id]

  keys.each do |key|
    configs.each do |conf|
      expanded.push expand_config(conf, key)
    end
    configs = expanded.flatten
    expanded = []
  end

  configs.each do |conf|
    begin
      @config = conf
      return submit_spot(state)
    rescue
    end
  end

  raise "Could not create a spot"
end

#sudo_command ⇒ Object

Returns the sudo command to use or empty string if sudo is not configured



675
676
677
 
# File 'lib/kitchen/driver/ec2.rb', line 675

def sudo_command
  instance.provisioner[:sudo] ? instance.provisioner[:sudo_command].to_s : ""
end

#tag_server(server) ⇒ Object 



513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/kitchen/driver/ec2.rb', line 513

def tag_server(server)
  if config[:tags] && !config[:tags].empty?
    tags = 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.create_tags(tags: tags)
  end
end

#tag_volumes(server) ⇒ Object 



525
526
527
528
529
530
531
532
533
534
 
# File 'lib/kitchen/driver/ec2.rb', line 525

def tag_volumes(server)
  if config[:tags] && !config[:tags].empty?
    tags = config[:tags].map do |k, v|
      { key: k.to_s, value: v.to_s }
    end
    server.volumes.each do |volume|
      volume.create_tags(tags: tags)
    end
  end
end

#update_username(state) ⇒ Object 



382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/kitchen/driver/ec2.rb', line 382

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



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/kitchen/driver/ec2.rb', line 556

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.



540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/kitchen/driver/ec2.rb', line 540

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



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/kitchen/driver/ec2.rb', line 585

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 



623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/kitchen/driver/ec2.rb', line 623

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.message.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