Class: Kitchen::Driver::Gce

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

Overview

Google Compute Engine driver for Test Kitchen

Author:

Constant Summary collapse

SCOPE_ALIAS_MAP = 
{
  "bigquery" => "bigquery",
  "cloud-platform" => "cloud-platform",
  "compute-ro" => "compute.readonly",
  "compute-rw" => "compute",
  "datastore" => "datastore",
  "logging-write" => "logging.write",
  "monitoring" => "monitoring",
  "monitoring-write" => "monitoring.write",
  "service-control" => "servicecontrol",
  "service-management" => "service.management",
  "sql" => "sqlservice",
  "sql-admin" => "sqlservice.admin",
  "storage-full" => "devstorage.full_control",
  "storage-ro" => "devstorage.read_only",
  "storage-rw" => "devstorage.read_write",
  "taskqueue" => "taskqueue",
  "useraccounts-ro" => "cloud.useraccounts.readonly",
  "useraccounts-rw" => "cloud.useraccounts",
  "userinfo-email" => "userinfo.email",
}.freeze
DISK_NAME_REGEX = 
/(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)/

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#state ⇒ Object

Returns the value of attribute state.



31
32
33
 
# File 'lib/kitchen/driver/gce.rb', line 31

def state
  @state
end

Instance Method Details

#authorization ⇒ Object 



254
255
256
257
258
259
260
261
 
# File 'lib/kitchen/driver/gce.rb', line 254

def authorization
  @authorization ||= Google::Auth.get_application_default(
    [
      "https://www.googleapis.com/auth/cloud-platform",
      "https://www.googleapis.com/auth/compute",
    ]
  )
end

#auto_migrate? ⇒ Boolean

Returns:

  • (Boolean) 


645
646
647
 
# File 'lib/kitchen/driver/gce.rb', line 645

def auto_migrate?
  preemptible? ? false : config[:auto_migrate]
end

#auto_restart? ⇒ Boolean

Returns:

  • (Boolean) 


649
650
651
 
# File 'lib/kitchen/driver/gce.rb', line 649

def auto_restart?
  preemptible? ? false : config[:auto_restart]
end

#boot_disk_source_image ⇒ Object 



525
526
527
 
# File 'lib/kitchen/driver/gce.rb', line 525

def boot_disk_source_image
  @boot_disk_source ||= image_url
end

#check_api_call(&block) ⇒ Object 



285
286
287
288
289
290
291
292
 
# File 'lib/kitchen/driver/gce.rb', line 285

def check_api_call(&block)
  yield
rescue Google::Apis::ClientError => e
  debug("API error: #{e.message}")
  false
else
  true
end

#connection ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/kitchen/driver/gce.rb', line 241

def connection
  return @connection unless @connection.nil?

  @connection = Google::Apis::ComputeV1::ComputeService.new
  @connection.authorization = authorization
  @connection.client_options = Google::Apis::ClientOptions.new.tap do |opts|
    opts.application_name    = "GoogleChefTestKitchen"
    opts.application_version = Kitchen::Driver::GCE_VERSION
  end

  @connection
end

#create(state) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/kitchen/driver/gce.rb', line 93

def create(state)
  @state = state
  return if state[:server_name]

  validate!

  server_name = generate_server_name

  create_disks_config

  info("Creating GCE instance <#{server_name}> in project #{project}, zone #{zone}...")
  operation = connection.insert_instance(project, zone, create_instance_object(server_name))

  wait_for_operation(operation)

  server              = server_instance(server_name)
  state[:server_name] = server_name
  state[:hostname]    = ip_address_for(server)
  state[:zone]        = zone

  info("Server <#{server_name}> created.")

  update_windows_password(server_name)

  info("Waiting for server <#{server_name}> to be ready...")
  wait_for_server

  info("GCE instance <#{server_name}> created and ready.")
rescue => e
  error("Error encountered during server creation: #{e.class}: #{e.message}")
  destroy(state)
  raise
end

#create_attached_disk(unique_disk_name, disk_config) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/kitchen/driver/gce.rb', line 487

def create_attached_disk(unique_disk_name, disk_config)
  disk = Google::Apis::ComputeV1::Disk.new
  disk.name    = unique_disk_name
  disk.size_gb = disk_config[:disk_size]
  disk.type    = disk_type_url_for(disk_config[:disk_type])

  info("Creating a #{disk_config[:disk_size]} GB disk named #{unique_disk_name}...")
  wait_for_operation(connection.insert_disk(project, zone, disk))
  info("Waiting for disk to be ready...")
  wait_for_status("READY") { connection.get_disk(project, zone, unique_disk_name) }
  info("Disk created successfully.")
  attached_disk = Google::Apis::ComputeV1::AttachedDisk.new
  attached_disk.source = disk_self_link(unique_disk_name)
  attached_disk.auto_delete = disk_config[:autodelete_disk]
  attached_disk
end

#create_disks(server_name) ⇒ Object 



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/kitchen/driver/gce.rb', line 443

def create_disks(server_name)
  disks = []
  config[:disks].each do |disk_name, disk_config|
    unique_disk_name = "#{server_name}-#{disk_name}"
    if disk_config[:boot]
      disk = create_local_disk(unique_disk_name, disk_config)
      disks.unshift(disk)
    elsif (disk_config[:disk_type] == "local-ssd") || disk_config[:custom_image]
      disk = create_local_disk(unique_disk_name, disk_config)
      disks.push(disk)
    else
      disk = create_attached_disk(unique_disk_name, disk_config)
      disks.push(disk)
    end
  end
  disks
end

#create_disks_config ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
 
# File 'lib/kitchen/driver/gce.rb', line 154

def create_disks_config
  # This can't be present in default_config because we couldn't
  # determine which disk configuration the user used otherwise
  disk_default_config = {
    autodelete_disk: true,
    disk_size: 10,
    disk_type: "pd-standard",
  }

  if old_disk_configuration_present?
    # If the old disk configuration is used,
    # we'll convert it to the new one
    config[:disks] = {
      disk1: {
        boot: true,
        autodelete_disk: config.fetch(:autodelete_disk, disk_default_config[:autodelete_disk]),
        disk_size: config.fetch(:disk_size, disk_default_config[:disk_size]),
        disk_type: config.fetch(:disk_type, disk_default_config[:disk_type]),
      },
    }
    raise "Disk type #{config[:disks][:disk1][:disk_type]} is not valid" unless valid_disk_type?(config[:disks][:disk1][:disk_type])
  elsif new_disk_configuration_present?
    # If the new disk configuration is present, ensure that for
    # every disk the needed configuration is set
    boot_disk_counter = 0
    config[:disks].each do |disk_name, disk_config|
      # te&/ => te
      raise "Disk name invalid. Must match #{DISK_NAME_REGEX}." unless valid_disk_name?(disk_name)

      # Update the config for the disk with the fixed config
      config[:disks][disk_name.to_sym] = disk_default_config.merge(disk_config)

      # Since the config was altered, we can't use disk_config (as it will be different or keys will not be present)
      raise "Disk type #{config[:disks][disk_name.to_sym][:disk_type]} for disk #{disk_name} is not valid" unless valid_disk_type?(config[:disks][disk_name.to_sym][:disk_type])

      unless disk_config[:boot].nil?
        boot_disk_counter += 1
        raise "Boot disk cannot be local SSD." if disk_config[:disk_type] == "local-ssd"
      end

      if disk_config[:disk_type] == "local-ssd"
        raise "#{disk_name}: Cannot use 'disk_size' with local SSD. They always have 375 GB (https://cloud.google.com/compute/docs/disks/#localssds)." unless disk_config[:disk_size].nil?

        # Since disk_size is set to 10 in default_config, it needs to be adjusted for local SSDs
        config[:disks][disk_name.to_sym][:disk_size] = nil
      end
    end
    if boot_disk_counter == 0
      first_disk = config[:disks].first[0]
      first_config = config[:disks].first[1]
      config[:disks][first_disk] = first_config.merge({ boot: true })
      warn("No bootdisk found - Assuming first disk will be boot disk")
    elsif boot_disk_counter > 1
      raise "More than one boot disk specified"
    end
  elsif !new_disk_configuration_present?
    # If no new disk configuration is present,
    # we'll set up the default configuration for the new style
    config[:disks] = {
      "disk1": disk_default_config.merge({ boot: true }),
    }
  end
end

#create_instance_object(server_name) ⇒ Object 



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

def create_instance_object(server_name)
  inst_obj                    = Google::Apis::ComputeV1::Instance.new
  inst_obj.name               = server_name
  inst_obj.disks              = create_disks(server_name)
  inst_obj.machine_type       = machine_type_url
  inst_obj.guest_accelerators = instance_guest_accelerators
  inst_obj.metadata           = instance_metadata
  inst_obj.network_interfaces = instance_network_interfaces
  inst_obj.scheduling         = instance_scheduling
  inst_obj.service_accounts   = instance_service_accounts unless instance_service_accounts.nil?
  inst_obj.tags               = instance_tags
  inst_obj.labels             = instance_labels

  inst_obj
end

#create_local_disk(unique_disk_name, disk_config) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/kitchen/driver/gce.rb', line 461

def create_local_disk(unique_disk_name, disk_config)
  disk   = Google::Apis::ComputeV1::AttachedDisk.new
  # Specifies the parameters for a new disk that will be created alongside the new instance.
  params = Google::Apis::ComputeV1::AttachedDiskInitializeParams.new
  disk.boot           = true if !disk_config[:boot].nil? && disk_config[:boot].to_s == "true"
  disk.auto_delete    = disk_config[:autodelete_disk]
  params.disk_size_gb = disk_config[:disk_size]
  params.disk_type    = disk_type_url_for(disk_config[:disk_type])

  if disk_config[:disk_type] == "local-ssd"
    info("Creating a 375 GB local ssd as scratch disk (https://cloud.google.com/compute/docs/disks/#localssds).")
    disk.type = "SCRATCH"
  elsif disk.boot
    info("Creating a #{disk_config[:disk_size]} GB boot disk named #{unique_disk_name} from image #{image_name}...")
    params.source_image = boot_disk_source_image unless disk_config[:disk_type] == "local-ssd"
    params.disk_name    = unique_disk_name unless disk_config[:disk_type] == "local-ssd"
  else
    info("Creating a #{disk_config[:disk_size]} GB extra disk named #{unique_disk_name} from image #{disk_config[:custom_image]}...")
    params.source_image = image_url(disk_config[:custom_image]) unless disk_config[:disk_type] == "local-ssd"
    params.disk_name    = unique_disk_name unless disk_config[:disk_type] == "local-ssd"

  end
  disk.initialize_params = params
  disk
end

#delete_disk(unique_disk_name) ⇒ Object 



504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/kitchen/driver/gce.rb', line 504

def delete_disk(unique_disk_name)
  begin
    connection.get_disk(project, zone, unique_disk_name)
  rescue Google::Apis::ClientError
    info("Unable to locate disk #{unique_disk_name} in project #{project}, zone #{zone}")
    return
  end

  info("Waiting for disk #{unique_disk_name} to be deleted...")
  wait_for_operation(connection.delete_disk(project, zone, unique_disk_name))
  info("Disk #{unique_disk_name} deleted successfully.")
end

#destroy(state) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/kitchen/driver/gce.rb', line 127

def destroy(state)
  @state      = state
  server_name = state[:server_name]
  return if server_name.nil?

  unless server_exist?(server_name)
    info("GCE instance <#{server_name}> does not exist - assuming it has been already destroyed.")
    return
  end

  info("Destroying GCE instance <#{server_name}>...")
  wait_for_operation(connection.delete_instance(project, zone, server_name))
  info("GCE instance <#{server_name}> destroyed.")

  state.delete(:server_name)
  state.delete(:hostname)
  state.delete(:zone)
end

#disk_self_link(unique_disk_name) ⇒ Object 



521
522
523
 
# File 'lib/kitchen/driver/gce.rb', line 521

def disk_self_link(unique_disk_name)
  "projects/#{project}/zones/#{zone}/disks/#{unique_disk_name}"
end

#disk_type_url_for(type) ⇒ Object 



517
518
519
 
# File 'lib/kitchen/driver/gce.rb', line 517

def disk_type_url_for(type)
  "zones/#{zone}/diskTypes/#{type}"
end

#env_user ⇒ Object 



599
600
601
 
# File 'lib/kitchen/driver/gce.rb', line 599

def env_user
  ENV["USER"] || "unknown"
end

#find_zone ⇒ Object 



382
383
384
385
386
387
 
# File 'lib/kitchen/driver/gce.rb', line 382

def find_zone
  zone = zones_in_region.sample
  raise "Unable to find a suitable zone in #{region}" if zone.nil?

  zone.name
end

#generate_server_name ⇒ Object 



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/kitchen/driver/gce.rb', line 432

def generate_server_name
  name = config[:inst_name] || "tk-#{instance.name.downcase}-#{SecureRandom.hex(3)}"

  if name.length > 63
    warn("The TK instance name (#{instance.name}) has been removed from the GCE instance name due to size limitations. Consider setting shorter platform or suite names.")
    name = "tk-#{SecureRandom.uuid}"
  end

  name.gsub(/([^-a-z0-9])/, "-")
end

#guest_accelerators ⇒ Object 



542
543
544
 
# File 'lib/kitchen/driver/gce.rb', line 542

def guest_accelerators
  config[:guest_accelerators]
end

#image_exist?(image = image_name) ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
 
# File 'lib/kitchen/driver/gce.rb', line 338

def image_exist?(image = image_name)
  check_api_call { connection.get_image(image_project, image) }
end

#image_name ⇒ Object 



350
351
352
 
# File 'lib/kitchen/driver/gce.rb', line 350

def image_name
  @image_name ||= config[:image_name] || image_name_for_family(config[:image_family])
end

#image_name_for_family(image_family) ⇒ Object 



533
534
535
536
 
# File 'lib/kitchen/driver/gce.rb', line 533

def image_name_for_family(image_family)
  image = connection.get_image_from_family(image_project, image_family)
  image.name
end

#image_project ⇒ Object 



354
355
356
 
# File 'lib/kitchen/driver/gce.rb', line 354

def image_project
  config[:image_project].nil? ? project : config[:image_project]
end

#image_url(image = image_name) ⇒ Object 



529
530
531
 
# File 'lib/kitchen/driver/gce.rb', line 529

def image_url(image = image_name)
  return "projects/#{image_project}/global/images/#{image}" if image_exist?(image)
end

#instance_guest_accelerators ⇒ Object 



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/kitchen/driver/gce.rb', line 546

def instance_guest_accelerators
  guest_accelerator_configs = []

  guest_accelerators.each do |guest_accelerator|
    next unless guest_accelerator.key?(:type)

    guest_accelerator_obj = Google::Apis::ComputeV1::AcceleratorConfig.new
    guest_accelerator_obj.accelerator_type = "zones/#{zone}/acceleratorTypes/#{guest_accelerator[:type]}"

    count = 1

    count = guest_accelerator[:count] if guest_accelerator.key?(:count)

    guest_accelerator_obj.accelerator_count = count

    guest_accelerator_configs << guest_accelerator_obj
  end

  guest_accelerator_configs
end

#instance_labels ⇒ Object 



595
596
597
 
# File 'lib/kitchen/driver/gce.rb', line 595

def instance_labels
  config[:labels]
end

#instance_metadata ⇒ Object 



584
585
586
587
588
589
590
591
592
593
 
# File 'lib/kitchen/driver/gce.rb', line 584

def instance_metadata
  Google::Apis::ComputeV1::Metadata.new.tap do |metadata_obj|
    metadata_obj.items = metadata.each_with_object([]) do |(k, v), memo|
      memo << Google::Apis::ComputeV1::Metadata::Item.new.tap do |item|
        item.key   = k.to_s
        item.value = v.to_s
      end
    end
  end
end

#instance_network_interfaces ⇒ Object 



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

def instance_network_interfaces
  interface                = Google::Apis::ComputeV1::NetworkInterface.new
  interface.network        = network_url if config[:subnet_project].nil?
  interface.network_ip     = network_ip unless network_ip.nil?
  interface.subnetwork     = subnet_url if subnet_url
  interface.access_configs = interface_access_configs

  Array(interface)
end

#instance_scheduling ⇒ Object 



633
634
635
636
637
638
639
 
# File 'lib/kitchen/driver/gce.rb', line 633

def instance_scheduling
  Google::Apis::ComputeV1::Scheduling.new.tap do |scheduling|
    scheduling.automatic_restart   = auto_restart?.to_s
    scheduling.preemptible         = preemptible?.to_s
    scheduling.on_host_maintenance = migrate_setting
  end
end

#instance_service_accounts ⇒ Object 



657
658
659
660
661
662
663
664
665
 
# File 'lib/kitchen/driver/gce.rb', line 657

def instance_service_accounts
  return if config[:service_account_scopes].nil? || config[:service_account_scopes].empty?

          = Google::Apis::ComputeV1::ServiceAccount.new
  .email  = config[:service_account_name]
  .scopes = config[:service_account_scopes].map { |scope| (scope) }

  Array()
end

#instance_tags ⇒ Object 



677
678
679
 
# File 'lib/kitchen/driver/gce.rb', line 677

def instance_tags
  Google::Apis::ComputeV1::Tags.new.tap { |tag_obj| tag_obj.items = config[:tags] }
end

#interface_access_configs ⇒ Object 



623
624
625
626
627
628
629
630
631
 
# File 'lib/kitchen/driver/gce.rb', line 623

def interface_access_configs
  return [] if config[:use_private_ip]

  access_config        = Google::Apis::ComputeV1::AccessConfig.new
  access_config.name   = "External NAT"
  access_config.type   = "ONE_TO_ONE_NAT"

  Array(access_config)
end

#ip_address_for(server) ⇒ Object 



400
401
402
 
# File 'lib/kitchen/driver/gce.rb', line 400

def ip_address_for(server)
  config[:use_private_ip] ? private_ip_for(server) : public_ip_for(server)
end

#machine_type_url ⇒ Object 



538
539
540
 
# File 'lib/kitchen/driver/gce.rb', line 538

def machine_type_url
  "zones/#{zone}/machineTypes/#{config[:machine_type]}"
end

#metadata ⇒ Object 



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/kitchen/driver/gce.rb', line 567

def metadata
  default_metadata = {
    "created-by" => "test-kitchen",
    "test-kitchen-instance" => instance.name,
    "test-kitchen-user" => env_user,
  }
  if winrm_transport?
    image_identifier = config[:image_family] || config[:image_name]
    default_metadata["windows-startup-script-ps1"] = 'netsh advfirewall firewall add rule name="winrm" dir=in action=allow protocol=TCP localport=5985;'
    if !image_identifier.nil? && image_identifier.include?("2008")
      default_metadata["windows-startup-script-ps1"] += "winrm quickconfig -q"
    end
  end

  config[:metadata].merge(default_metadata)
end

#migrate_setting ⇒ Object 



653
654
655
 
# File 'lib/kitchen/driver/gce.rb', line 653

def migrate_setting
  auto_migrate? ? "MIGRATE" : "TERMINATE"
end

#name ⇒ Object 



89
90
91
 
# File 'lib/kitchen/driver/gce.rb', line 89

def name
  "Google Compute (GCE)"
end

#network_ip ⇒ Object 



366
367
368
 
# File 'lib/kitchen/driver/gce.rb', line 366

def network_ip
  config[:network_ip]
end

#network_project ⇒ Object 



362
363
364
 
# File 'lib/kitchen/driver/gce.rb', line 362

def network_project
  config[:network_project].nil? ? project : config[:network_project]
end

#network_url ⇒ Object 



613
614
615
 
# File 'lib/kitchen/driver/gce.rb', line 613

def network_url
  "projects/#{network_project}/global/networks/#{config[:network]}"
end

#new_disk_configuration_present? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/kitchen/driver/gce.rb', line 150

def new_disk_configuration_present?
  !config[:disks].nil?
end

#old_disk_configuration_present? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/kitchen/driver/gce.rb', line 146

def old_disk_configuration_present?
  !config[:autodelete_disk].nil? || !config[:disk_size].nil? || !config[:disk_type].nil?
end

#operation_errors(operation_name) ⇒ Object 



741
742
743
744
745
746
 
# File 'lib/kitchen/driver/gce.rb', line 741

def operation_errors(operation_name)
  operation = zone_operation(operation_name)
  return [] if operation.error.nil?

  operation.error.errors
end

#preemptible? ⇒ Boolean

Returns:

  • (Boolean) 


641
642
643
 
# File 'lib/kitchen/driver/gce.rb', line 641

def preemptible?
  config[:preemptible]
end

#private_ip_for(server) ⇒ Object 



404
405
406
407
408
 
# File 'lib/kitchen/driver/gce.rb', line 404

def private_ip_for(server)
  server.network_interfaces.first.network_ip
rescue NoMethodError
  raise "Unable to determine private IP for instance"
end

#project ⇒ Object 



346
347
348
 
# File 'lib/kitchen/driver/gce.rb', line 346

def project
  config[:project]
end

#public_ip_for(server) ⇒ Object 



410
411
412
413
414
 
# File 'lib/kitchen/driver/gce.rb', line 410

def public_ip_for(server)
  server.network_interfaces.first.access_configs.first.nat_ip
rescue NoMethodError
  raise "Unable to determine public IP for instance"
end

#refresh_rate ⇒ Object 



685
686
687
 
# File 'lib/kitchen/driver/gce.rb', line 685

def refresh_rate
  config[:refresh_rate]
end

#region ⇒ Object 



370
371
372
 
# File 'lib/kitchen/driver/gce.rb', line 370

def region
  config[:region].nil? ? region_for_zone : config[:region]
end

#region_for_zone ⇒ Object 



374
375
376
 
# File 'lib/kitchen/driver/gce.rb', line 374

def region_for_zone
  @region_for_zone ||= connection.get_zone(project, zone).region.split("/").last
end

#server_exist?(server_name) ⇒ Boolean

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/kitchen/driver/gce.rb', line 342

def server_exist?(server_name)
  check_api_call { server_instance(server_name) }
end

#server_instance(server_name) ⇒ Object 



396
397
398
 
# File 'lib/kitchen/driver/gce.rb', line 396

def server_instance(server_name)
  connection.get_instance(project, zone, server_name)
end

#service_account_scope_url(scope) ⇒ Object 



667
668
669
670
671
 
# File 'lib/kitchen/driver/gce.rb', line 667

def (scope)
  return scope if scope.start_with?("https://www.googleapis.com/auth/")

  "https://www.googleapis.com/auth/#{translate_scope_alias(scope)}"
end

#subnet_project ⇒ Object 



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

def subnet_project
  config[:subnet_project].nil? ? project : config[:subnet_project]
end

#subnet_url ⇒ Object 



617
618
619
620
621
 
# File 'lib/kitchen/driver/gce.rb', line 617

def subnet_url
  return unless config[:subnet]

  "projects/#{subnet_project}/regions/#{region}/subnetworks/#{config[:subnet]}"
end

#translate_scope_alias(scope_alias) ⇒ Object 



673
674
675
 
# File 'lib/kitchen/driver/gce.rb', line 673

def translate_scope_alias(scope_alias)
  SCOPE_ALIAS_MAP.fetch(scope_alias, scope_alias)
end

#update_windows_password(server_name) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/kitchen/driver/gce.rb', line 267

def update_windows_password(server_name)
  return unless winrm_transport?

  username = instance.transport[:username]

  info("Resetting the Windows password for user #{username} on #{server_name}...")

  state[:password] = GoogleComputeWindowsPassword.new(
    project:,
    zone:,
    instance_name: server_name,
    email:         config[:email],
    username:
  ).new_password

  info("Password reset complete on #{server_name} complete.")
end

#valid_disk_name?(disk_name) ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/kitchen/driver/gce.rb', line 334

def valid_disk_name?(disk_name)
  disk_name.to_s.match(DISK_NAME_REGEX).to_s.length == disk_name.length
end

#valid_disk_type?(disk_type) ⇒ Boolean

Returns:

  • (Boolean) 


328
329
330
331
332
 
# File 'lib/kitchen/driver/gce.rb', line 328

def valid_disk_type?(disk_type)
  return false if disk_type.nil?

  check_api_call { connection.get_disk_type(project, zone, disk_type) }
end

#valid_machine_type? ⇒ Boolean

Returns:

  • (Boolean) 


298
299
300
301
302
 
# File 'lib/kitchen/driver/gce.rb', line 298

def valid_machine_type?
  return false if config[:machine_type].nil?

  check_api_call { connection.get_machine_type(project, zone, config[:machine_type]) }
end

#valid_network? ⇒ Boolean

Returns:

  • (Boolean) 


304
305
306
307
308
 
# File 'lib/kitchen/driver/gce.rb', line 304

def valid_network?
  return false if config[:network].nil?

  check_api_call { connection.get_network(network_project, config[:network]) }
end

#valid_project? ⇒ Boolean

Returns:

  • (Boolean) 


294
295
296
 
# File 'lib/kitchen/driver/gce.rb', line 294

def valid_project?
  check_api_call { connection.get_project(project) }
end

#valid_region? ⇒ Boolean

Returns:

  • (Boolean) 


322
323
324
325
326
 
# File 'lib/kitchen/driver/gce.rb', line 322

def valid_region?
  return false if config[:region].nil?

  check_api_call { connection.get_region(project, config[:region]) }
end

#valid_subnet? ⇒ Boolean

Returns:

  • (Boolean) 


310
311
312
313
314
 
# File 'lib/kitchen/driver/gce.rb', line 310

def valid_subnet?
  return false if config[:subnet].nil?

  check_api_call { connection.get_subnetwork(subnet_project, region, config[:subnet]) }
end

#valid_zone? ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
319
320
 
# File 'lib/kitchen/driver/gce.rb', line 316

def valid_zone?
  return false if config[:zone].nil?

  check_api_call { connection.get_zone(project, config[:zone]) }
end

#validate! ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/kitchen/driver/gce.rb', line 218

def validate!
  raise "Project #{config[:project]} is not a valid project" unless valid_project?
  raise "Either zone or region must be specified" unless config[:zone] || config[:region]
  raise "'any' is no longer a valid region" if config[:region] == "any"
  raise "Zone #{config[:zone]} is not a valid zone" if config[:zone] && !valid_zone?
  raise "Region #{config[:region]} is not a valid region" if config[:region] && !valid_region?
  raise "Machine type #{config[:machine_type]} is not valid" unless valid_machine_type?
  raise "Either image family or name must be specified" unless config[:image_family] || config[:image_name]
  raise "Network #{config[:network]} is not valid" unless valid_network?
  raise "Subnet #{config[:subnet]} is not valid" if config[:subnet] && !valid_subnet?
  raise "Email address of GCE user is not set" if winrm_transport? && config[:email].nil?
  raise "You cannot use autodelete_disk, disk_size or disk_type with the new disks configuration" if old_disk_configuration_present? && new_disk_configuration_present?
  raise "Disk image #{config[:image_name]} is not valid - check your image name and image project" if boot_disk_source_image.nil?

  warn("Both zone and region specified - region will be ignored.") if config[:zone] && config[:region]
  warn("Both image family and name specified - image family will be ignored") if config[:image_family] && config[:image_name]
  warn("Image project not specified - searching current project only") unless config[:image_project]
  warn("Subnet project not specified - searching current project only") if config[:subnet] && !config[:subnet_project]
  warn("Auto-migrate disabled for preemptible instance") if preemptible? && config[:auto_migrate]
  warn("Auto-restart disabled for preemptible instance") if preemptible? && config[:auto_restart]
  warn("These configs are deprecated - consider using new disks configuration") if old_disk_configuration_present?
end

#wait_for_operation(operation) ⇒ Object 



714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/kitchen/driver/gce.rb', line 714

def wait_for_operation(operation)
  operation_name = operation.name

  wait_for_status("DONE") { zone_operation(operation_name) }

  errors = operation_errors(operation_name)
  return if errors.empty?

  errors.each do |error|
    error("#{error.code}: #{error.message}")
  end

  raise "Operation #{operation_name} failed."
end

#wait_for_server ⇒ Object 



729
730
731
732
733
734
735
 
# File 'lib/kitchen/driver/gce.rb', line 729

def wait_for_server
  instance.transport.connection(state).wait_until_ready
rescue
  error("Server not reachable. Destroying server...")
  destroy(state)
  raise
end

#wait_for_status(requested_status, &block) ⇒ 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
 
# File 'lib/kitchen/driver/gce.rb', line 689

def wait_for_status(requested_status, &block)
  last_status = ""

  begin
    Timeout.timeout(wait_time) do
      loop do
        item = yield
        current_status = item.status

        unless last_status == current_status
          last_status = current_status
          info("Current status: #{current_status}")
        end

        break if current_status == requested_status

        sleep refresh_rate
      end
    end
  rescue Timeout::Error
    error("Request did not complete in #{wait_time} seconds. Check the Google Cloud Console for more info.")
    raise
  end
end

#wait_time ⇒ Object 



681
682
683
 
# File 'lib/kitchen/driver/gce.rb', line 681

def wait_time
  config[:wait_time]
end

#winrm_transport? ⇒ Boolean

Returns:

  • (Boolean) 


263
264
265
 
# File 'lib/kitchen/driver/gce.rb', line 263

def winrm_transport?
  instance.transport.name.casecmp("winrm") == 0
end

#zone ⇒ Object 



378
379
380
 
# File 'lib/kitchen/driver/gce.rb', line 378

def zone
  @zone ||= state[:zone] || config[:zone] || find_zone
end

#zone_operation(operation_name) ⇒ Object 



737
738
739
 
# File 'lib/kitchen/driver/gce.rb', line 737

def zone_operation(operation_name)
  connection.get_zone_operation(project, zone, operation_name)
end

#zones_in_region ⇒ Object 



389
390
391
392
393
394
 
# File 'lib/kitchen/driver/gce.rb', line 389

def zones_in_region
  connection.list_zones(project).items.select do |zone|
    zone.status == "UP" &&
      zone.region.split("/").last == region
  end
end