ami_spec 0.2.0 → 0.3.0

data/lib/ami_spec.rb

@@ -36,6 +36,8 @@ module AmiSpec
   #   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
   # == Returns:
@@ -96,6 +98,7 @@ module AmiSpec
       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 :wait_for_rc, "Wait for oldschool SystemV scripts to run before conducting tests. Currently only supports Ubuntu with upstart"
     end
@@ -113,6 +116,14 @@ module AmiSpec
       fail "You must specify either role and ami or role_ami_file"
     end
 
+    options[:tags] = parse_tags(options[:tags])
+
     exit run(options)
   end
+
+  def self.parse_tags(tags)
+    tag_pairs = tags.split(',')
+    tag_key_values = tag_pairs.collect{ |pair| pair.split('=')}.flatten
+    Hash[*tag_key_values]
+  end
 end

data/lib/ami_spec/aws_instance.rb

@@ -20,6 +20,7 @@ module AmiSpec
       @public_ip = options.fetch(:aws_public_ip)
       @region = options.fetch(:aws_region)
       @security_group_ids = options.fetch(:aws_security_groups)
+      @tags = ec2ify_tags(options.fetch(:tags))
     end
 
     def_delegators :@instance, :instance_id, :tags, :terminate, :private_ip_address, :public_ip_address
@@ -39,6 +40,10 @@ module AmiSpec
       !@region.nil? ? {region: @region} : {}
     end
 
+    def ec2ify_tags(tags)
+      tags.map { |k,v| {key: k, value: v} }
+    end
+
     def instances_options
       params = {
         image_id: @ami,
@@ -61,7 +66,7 @@ module AmiSpec
     end
 
     def tag_instance
-      @instance.create_tags(tags: [{ key: 'AmiSpec', value: @role }])
+      @instance.create_tags(tags: [{ key: 'AmiSpec', value: @role }] + @tags)
     end
   end
 end

data/lib/ami_spec/aws_instance_options.rb

@@ -12,5 +12,6 @@ module AmiSpec
     property :aws_public_ip
     property :aws_region
     property :aws_security_groups
+    property :tags
   end
 end

data/lib/ami_spec/version.rb

@@ -1,3 +1,3 @@
 module AmiSpec
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/ami_spec_spec.rb

@@ -21,6 +21,12 @@ describe AmiSpec do
     )
   end
 
+  describe '#invoke' do
+    it 'raises a system exit with no arguments' do
+      expect{ described_class.invoke }.to raise_error(SystemExit)
+    end
+  end
+
   describe '#run' do
     before do
       allow(AmiSpec::WaitForSSH).to receive(:wait).and_return(true)
@@ -51,4 +57,18 @@ describe AmiSpec do
       end
     end
   end
+
+  describe '#parse_tags' do
+    it 'parses a single key/value pair' do
+      expect(described_class.parse_tags("Name=AmiSpec")).to eq( { "Name"=>"AmiSpec" } )
+    end
+
+    it 'parses multiple key/value pairs' do
+      expect(described_class.parse_tags("Name=AmiSpec,Owner=Me")).to eq( { "Name"=>"AmiSpec", "Owner"=>"Me" } )
+    end
+
+    it 'parses an empty string' do
+      expect(described_class.parse_tags("")).to eq({})
+    end
+  end
 end

data/spec/aws_instance_spec.rb

@@ -7,6 +7,7 @@ describe AmiSpec::AwsInstance do
   let(:client_double) { instance_double(Aws::EC2::Client) }
   let(:new_ec2_double) { instance_double(Aws::EC2::Types::Instance) }
   let(:ec2_double) { instance_double(Aws::EC2::Instance) }
+  let(:tags) { {} }
   subject(:aws_instance) do
     described_class.new(
       role: role,
@@ -16,7 +17,8 @@ describe AmiSpec::AwsInstance do
       aws_instance_type: 't2.micro',
       aws_public_ip: false,
       aws_security_groups: sec_group_id,
-      aws_region: region
+      aws_region: region,
+      tags: tags
     )
   end
 
@@ -78,6 +80,17 @@ describe AmiSpec::AwsInstance do
       end
     end
 
+    context 'with tags' do
+      let(:tags) { {"Name" => "AmiSpec"} }
+
+      it 'tags the instance' do
+        expect(ec2_double).to receive(:create_tags).with(
+                                 {tags: [{ key: 'AmiSpec', value: role}, { key: "Name", value: "AmiSpec"}]}
+                               )
+        start
+      end
+    end
+
     it 'tags the instance with a role' do
       expect(ec2_double).to receive(:create_tags).with(
                                  hash_including(tags: [{ key: 'AmiSpec', value: role}])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ami_spec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk