Class: Kitchen::Driver::Aws::InstanceGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/kitchen/driver/aws/instance_generator.rb

Overview

A class for encapsulating the instance payload logic

Author:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, ec2, logger) ⇒ InstanceGenerator

Returns a new instance of InstanceGenerator.



36
37
38
39
40
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 36

def initialize(config, ec2, logger)
  @config = config
  @ec2 = ec2
  @logger = logger
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



34
35
36
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 34

def config
  @config
end

#ec2 ⇒ Object (readonly)

Returns the value of attribute ec2.



34
35
36
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 34

def ec2
  @ec2
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



34
35
36
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 34

def logger
  @logger
end

Instance Method Details

#ec2_instance_data ⇒ Object

Transform the provided config into the hash to send to AWS. Some fields can be passed in null, others need to be ommitted if they are null



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 44

def ec2_instance_data # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
  # Support for looking up security group id and subnet id using tags.

  if config[:subnet_id].nil? && config[:subnet_filter]
    config[:subnet_id] = ::Aws::EC2::Client
      .new(region: config[:region]).describe_subnets(
        filters: [
          {
            name: "tag:#{config[:subnet_filter][:tag]}",
            values: [config[:subnet_filter][:value]],
          },
        ]
      )[0][0].subnet_id

    if config[:subnet_id].nil?
      raise "The subnet tagged '#{config[:subnet_filter][:tag]}\
      #{config[:subnet_filter][:value]}' does not exist!"
    end
  end

  if config[:security_group_ids].nil? && config[:security_group_filter]
    security_group = ::Aws::EC2::Client
        .new(region: config[:region]).describe_security_groups(
        filters: [
            {
                name: "tag:#{config[:security_group_filter][:tag]}",
                values: [config[:security_group_filter][:value]],
            },
        ]
    )[0][0]

    if security_group
      config[:security_group_ids] = [security_group.group_id]
    else
      raise "The group tagged '#{config[:security_group_filter][:tag]} " +
        "#{config[:security_group_filter][:value]}' does not exist!"
    end
  end

  i = {
    instance_type: config[:instance_type],
    ebs_optimized: config[:ebs_optimized],
    image_id: config[:image_id],
    key_name: config[:aws_ssh_key_id],
    subnet_id: config[:subnet_id],
    private_ip_address: config[:private_ip_address],
  }

  availability_zone = config[:availability_zone]
  if availability_zone
    if availability_zone =~ /^[a-z]$/i
      availability_zone = "#{config[:region]}#{availability_zone}"
    end
    i[:placement] = { availability_zone: availability_zone.downcase }
  end
  tenancy = config[:tenancy]
  if tenancy
    if i.key?(:placement)
      i[:placement][:tenancy] = tenancy
    else
      i[:placement] = { tenancy: tenancy }
    end
  end
  unless config[:block_device_mappings].nil? || config[:block_device_mappings].empty?
    i[:block_device_mappings] = config[:block_device_mappings]
  end
  i[:security_group_ids] = Array(config[:security_group_ids]) if config[:security_group_ids]
  i[:user_data] = prepared_user_data if prepared_user_data
  if config[:iam_profile_name]
    i[:iam_instance_profile] = { name: config[:iam_profile_name] }
  end
  if !config.fetch(:associate_public_ip, nil).nil?
    i[:network_interfaces] =
      [{
        device_index: 0,
        associate_public_ip_address: config[:associate_public_ip],
        delete_on_termination: true,
      }]
    # If specifying `:network_interfaces` in the request, you must specify
    # network specific configs in the network_interfaces block and not at
    # the top level
    if config[:subnet_id]
      i[:network_interfaces][0][:subnet_id] = i.delete(:subnet_id)
    end
    if config[:private_ip_address]
      i[:network_interfaces][0][:private_ip_address] = i.delete(:private_ip_address)
    end
    if config[:security_group_ids]
      i[:network_interfaces][0][:groups] = i.delete(:security_group_ids)
    end
  end
  availability_zone = config[:availability_zone]
  if availability_zone
    if availability_zone =~ /^[a-z]$/i
      availability_zone = "#{config[:region]}#{availability_zone}"
    end
    i[:placement] = { availability_zone: availability_zone.downcase }
  end
  tenancy = config[:tenancy]
  if tenancy
    if i.key?(:placement)
      i[:placement][:tenancy] = tenancy
    else
      i[:placement] = { tenancy: tenancy }
    end
  end
  unless config[:instance_initiated_shutdown_behavior].nil? ||
      config[:instance_initiated_shutdown_behavior].empty?
    i[:instance_initiated_shutdown_behavior] = config[:instance_initiated_shutdown_behavior]
  end
  i
end

#prepared_user_data ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/kitchen/driver/aws/instance_generator.rb', line 157

def prepared_user_data
  # If user_data is a file reference, lets read it as such
  return nil if config[:user_data].nil?
  return @user_data if @user_data

  raw_user_data = config.fetch(:user_data)
  if !raw_user_data.include?("\0") && File.file?(raw_user_data)
    raw_user_data = File.read(raw_user_data)
  end

  @user_data = Base64.encode64(raw_user_data)
end