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",
}

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &block) ⇒ Ec2

Returns a new instance of Ec2.



89
90
91
92
93
94
 
# File 'lib/kitchen/driver/ec2.rb', line 89

def initialize(*args, &block)
  super
  # AWS Ruby SDK loading isn't thread safe, so as soon as we know we're
  # going to use EC2, autoload it. Seems to have been fixed in Ruby 2.3+
  ::Aws.eager_autoload! unless RUBY_VERSION.to_f >= 2.3
end

Class Method Details

.validation_error(driver, old_key, new_key) ⇒ Object 



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

def self.validation_error(driver, old_key, new_key)
  raise "ERROR: The driver[#{driver.class.name}] config key `#{old_key}` " \
    "has been removed, please use `#{new_key}`"
end

.validation_warn(driver, old_key, new_key) ⇒ Object 



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

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



289
290
291
 
# File 'lib/kitchen/driver/ec2.rb', line 289

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

#create(state) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/MethodLength



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
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
 
# File 'lib/kitchen/driver/ec2.rb', line 171

def create(state) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  return if state[:server_id]
  update_username(state)

  info(Kitchen::Util.outdent!(<<-END))
    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 config[:spot_price]
    # Spot instance when a price is set
    server = submit_spot(state)
  else
    # On-demand instance
    server = submit_server
  end
  info("Instance <#{server.id}> requested.")
  server.wait_until_exists do |w|
    w.before_attempt do |attempts|
      info("Polling AWS for existence, attempt #{attempts}...")
    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)
  debug("ec2:create '#{state[:hostname]}'")
end

#create_ec2_json(state) ⇒ Object

rubocop:disable Metrics/MethodLength, Metrics/LineLength



536
537
538
539
540
541
542
543
544
 
# File 'lib/kitchen/driver/ec2.rb', line 536

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_spot_request ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/kitchen/driver/ec2.rb', line 379

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 



304
305
306
307
308
309
310
311
 
# File 'lib/kitchen/driver/ec2.rb', line 304

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 



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/kitchen/driver/ec2.rb', line 274

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 



546
547
548
549
550
551
552
553
554
555
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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/kitchen/driver/ec2.rb', line 546

def default_windows_user_data
  # 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

  if actual_platform.version =~ /2016/
    logfile_name = 'C:\\ProgramData\\Amazon\\EC2-Windows\\Launch\\Log\\kitchen-ec2.log'
    disk_init = 'C:\\ProgramData\\Amazon\\EC2-Windows\\Launch\\Scripts\\InitializeDisks.ps1'
  else
    logfile_name = 'C:\\Program Files\\Amazon\\Ec2ConfigService\\Logs\\kitchen-ec2.log'
    disk_init = ""
  end
  # Returning the fully constructed PowerShell script to user_data
  Kitchen::Util.outdent!(<<-EOH)
  <powershell>
  $logfile="#{logfile_name}"
  # EC2Launch doesn't init extra disks by default
  #{disk_init}
  # 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
  #{custom_admin_script}
  </powershell>
  EOH
end

#desired_platform ⇒ Object 



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/kitchen/driver/ec2.rb', line 293

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 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/kitchen/driver/ec2.rb', line 239

def destroy(state)
  return if state[:server_id].nil?

  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
  info("EC2 instance <#{state[:server_id]}> destroyed.")
  state.delete(:server_id)
  state.delete(:hostname)
end

#ec2 ⇒ Object 



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

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

#fetch_windows_admin_password(server, state) ⇒ Object

rubocop:disable Lint/UnusedBlockArgument



480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/kitchen/driver/ec2.rb', line 480

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 = server.decrypt_windows_password(File.expand_path(instance.transport[:ssh_key]))
  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.



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

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 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/kitchen/driver/ec2.rb', line 259

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 



614
615
616
617
618
619
620
621
622
623
 
# File 'lib/kitchen/driver/ec2.rb', line 614

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 



341
342
343
 
# File 'lib/kitchen/driver/ec2.rb', line 341

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

#show_chosen_image ⇒ Object

rubocop:enable Metrics/MethodLength, Metrics/LineLength



602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/kitchen/driver/ec2.rb', line 602

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



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

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

rubocop:disable Metrics/AbcSize



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/kitchen/driver/ec2.rb', line 357

def submit_spot(state) # rubocop:disable Metrics/AbcSize
  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



531
532
533
 
# File 'lib/kitchen/driver/ec2.rb', line 531

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

#tag_server(server) ⇒ Object 



394
395
396
397
398
399
400
401
 
# File 'lib/kitchen/driver/ec2.rb', line 394

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

#tag_volumes(server) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/kitchen/driver/ec2.rb', line 403

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

#update_username(state) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/kitchen/driver/ec2.rb', line 313

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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/kitchen/driver/ec2.rb', line 434

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/kitchen/driver/ec2.rb', line 418

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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/kitchen/driver/ec2.rb', line 458

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
    server.wait_until(
      :max_attempts => config[:retryable_tries],
      :delay => config[:retryable_sleep],
      :before_attempt => wait_log,
      &block
    )
  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