Module: AmiSpec

Defined in:
lib/ami_spec.rb,
lib/ami_spec/version.rb,
lib/ami_spec/server_spec.rb,
lib/ami_spec/wait_for_rc.rb,
lib/ami_spec/aws_instance.rb,
lib/ami_spec/wait_for_ssh.rb,
lib/ami_spec/server_spec_options.rb,
lib/ami_spec/aws_instance_options.rb

Defined Under Namespace

Classes: AwsInstance, AwsInstanceOptions, InstanceConnectionTimeout, ServerSpec, ServerSpecOptions, WaitForRC, WaitForSSH

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.invoke ⇒ Object 



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
 
# File 'lib/ami_spec.rb', line 85

def self.invoke
  options = Trollop::options do
    opt :role, "The role to test, this should map to a directory in the spec folder", type: :string
    opt :ami, "The ami ID to run tests against", type: :string
    opt :role_ami_file, "A file containing comma separated roles and amis. i.e.\nweb_server,ami-id.",
        type: :string
    opt :specs, "The directory to find ServerSpecs", type: :string, required: true
    opt :subnet_id, "The subnet to start the instance in", type: :string, required: true
    opt :key_name, "The SSH key name to assign to instances", type: :string, required: true
    opt :key_file, "The SSH private key file associated to the key_name", type: :string, required: true
    opt :ssh_user, "The user to ssh to the instance as", type: :string, required: true
    opt :aws_region, "The AWS region, defaults to AWS_DEFAULT_REGION environment variable", type: :string
    opt :aws_instance_type, "The ec2 instance type, defaults to t2.micro", type: :string, default: 't2.micro'
    opt :aws_security_groups, "Security groups to associate to the launched instances. May be specified multiple times",
        type: :strings, default: nil
    opt :aws_public_ip, "Launch instances with a public IP"
    opt :ssh_retries, "The number of times we should try sshing to the ec2 instance before giving up. Defaults to 30",
        type: :int, default: 30
    opt :tags, "Additional tags to add to launched instances in the form of comma separated key=value pairs. i.e. Name=AmiSpec", type: :string, default: ""
    opt :debug, "Don't terminate instances on exit"
    opt :buildkite, "Output section separators for buildkite"
    opt :wait_for_rc, "Wait for oldschool SystemV scripts to run before conducting tests. Currently only supports Ubuntu with upstart"
    opt :user_data_file, "File path for aws ec2 user data", type: :string
    opt :iam_instance_profile_arn, "IAM instance profile to use", type: :string
  end

  if options[:role] && options[:ami]
    options[:amis] = { options[:role] => options[:ami] }
    options.delete(:role)
    options.delete(:ami)
  elsif options[:role_ami_file]
    file_lines = File.read(options[:role_ami_file]).split("\n")
    file_array = file_lines.collect { |line| line.split(',') }.flatten
    options[:amis] = Hash[*file_array]
    options.delete(:role_ami_file)
  else
    fail "You must specify either role and ami or role_ami_file"
  end

  unless File.exist? options[:key_file]
    fail "Key file #{options[:key_file]} not found"
  end

  unless options[:user_data_file] and File.exist? options[:user_data_file]
    fail "User Data file #{options[:user_data_file]} not found"
  end

  options[:tags] = parse_tags(options[:tags])

  exit run(options)
end

.parse_tags(tags) ⇒ Object 



137
138
139
140
141
 
# File 'lib/ami_spec.rb', line 137

def self.parse_tags(tags)
  tag_pairs = tags.split(',')
  tag_key_values = tag_pairs.collect{ |pair| pair.split('=')}.flatten
  Hash[*tag_key_values]
end

.run(options) ⇒ Object

Parameters:

amis

A hash of roles and amis in the format of: => ami_id. i.e. => ‘ami-abcd1234’

specs

A string of the directory to find ServerSpecs. There should be a folder in this directory for each role found in ::amis

subnet_id

The subnet_id to start instances in.

key_name

The SSH key name to assign to instances. This key name must exist on the executing host for passwordless login.

key_file

The SSH key file to use to connect to the host.

aws_region

AWS region to connect to Defaults to AWS_DEFAULT_REGION

aws_security_group_ids

AWS Security groups to assign to the instances Defaults to the default security group for the VPC

aws_instance_type

AWS ec2 instance type

aws_public_ip

Should the instances get a public IP address

ssh_user

The username to SSH to the AMI with.

ssh_retries

Set the maximum number of ssh retries while waiting for the instance to boot.

tags:

Additional tags to add to launched instances in the form of comma separated key=value pairs

debug

Don’t terminate the instances on exit

buildkite

Output section separators for buildkite

Returns:

Boolean - The result of all the server specs.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ami_spec.rb', line 47

def self.run(options)
  instances = []
  options[:amis].each_pair do |role, ami|
    aws_instance_options = AwsInstanceOptions.new(options.merge(role: role, ami: ami))
    instances << AwsInstance.start(aws_instance_options)
  end

  results = []
  instances.each do |instance|
    ip_address = options[:aws_public_ip] ? instance.public_ip_address : instance.private_ip_address
    WaitForSSH.wait(ip_address, options[:ssh_user], options[:key_file], options[:ssh_retries])
    WaitForRC.wait(ip_address, options[:ssh_user], options[:key_file]) if options[:wait_for_rc]

    server_spec_options = ServerSpecOptions.new(options.merge(instance: instance))
    results << ServerSpec.new(server_spec_options).run
   end

  results.all?
ensure
  stop_instances(instances, options[:debug])
end