stack_master 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 134af119f4a1e7ac352e26c21921f3b1c31cdd4f
-  data.tar.gz: b2945a13aa2168a9f4b2c8c4ae60883fa10d0f49
+  metadata.gz: 1e9fbbd483a550665172b60c679b887fcad750ac
+  data.tar.gz: 6be2fc55ee1c3bdb20b54f8e807b7482ac6000a1
 SHA512:
-  metadata.gz: d2fb9a998fc5ac28093551d67b3fe5832ba3c0ce411812590070cff1a87552f1ff30d8d9ea30b82d2c94e40961598a0dc15ac911d1672484a2bc85d209a71a94
-  data.tar.gz: b6f3477bdaaa9f42d8a75367a55c1b40938e7550eb9ce37f2c1bea11fa093e57064732c2b5919b2a0d215981fd9a08706fd574418ac5a079aa1b844865b2f968
+  metadata.gz: 6c26185a54b4b9ee4a3e1d092f51139884b8089c60679ef67334b1a1ff241b0a0ef35d24410ea2776df3b74e4ef8cdc086b230941466e0132ff22d79d649a238
+  data.tar.gz: 2b30a1899670f668df76ec2c4ee6135ced4cfb40c553d4b7cf69c7ce0942600c82d1fccc79f3d8e160cf9ae73468816c5f5427a63a456d1996afbffc4a35edf6

data/README.md

@@ -211,6 +211,24 @@ web_ami:
 
 Note that the corresponding array resolver is named `latest_amis_by_tags`
 
+### Latest AMI by attribute
+
+Looks up the latest AMI ID by a given set of attributes. By default it will only return AMIs from the account the stack is created in, but you can specify the account ID or [certain keywords mentioned in the aws documentation](http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-DescribeImages.html)
+
+This selects the latest wily hvm AMI from Ubuntu (using the account id):
+
+```yaml
+bastion_ami:
+  latest_ami:
+    owners: 099720109477
+    filters:
+      name: ubuntu/images/hvm/ubuntu-wily-15.10-amd64-server-*
+```
+
+A set of possible attributes is available in the [AWS documentation](https://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Client.html#describe_images-instance_method)
+
+Any value can be an array of possible matches.
+
 ### Custom parameter resolvers
 
 New parameter resolvers can be created in a separate gem.

data/lib/stack_master.rb

@@ -28,11 +28,13 @@ require "stack_master/security_group_finder"
 require "stack_master/parameter_loader"
 require "stack_master/parameter_resolver"
 require "stack_master/resolver_array"
+require "stack_master/parameter_resolvers/ami_finder"
 require "stack_master/parameter_resolvers/stack_output"
 require "stack_master/parameter_resolvers/secret"
 require "stack_master/parameter_resolvers/sns_topic_name"
 require "stack_master/parameter_resolvers/security_group"
 require "stack_master/parameter_resolvers/latest_ami_by_tags"
+require "stack_master/parameter_resolvers/latest_ami"
 require "stack_master/utils"
 require "stack_master/config"
 require "stack_master/paged_response_accumulator"

data/lib/stack_master/parameter_resolvers/ami_finder.rb

@@ -0,0 +1,36 @@
+module StackMaster
+  module ParameterResolvers
+    class AmiFinder
+      def initialize(region)
+        @region = region
+      end
+
+      def build_filters_from_string(value, prefix = nil)
+        filters = value.split(',').map do |name_with_value|
+          name, value = name_with_value.strip.split('=')
+          name = prefix ? "#{prefix}:#{name}" : name
+          { name: name, values: [value] }
+        end
+        filters
+      end
+
+      def build_filters_from_hash(hash)
+        hash.map { |key, value| {name: key, values: Array(value.to_s)}}
+      end
+
+      def find_latest_ami(filters, owners = ['self'])
+        images = ec2.describe_images(owners: owners, filters: filters).images
+        sorted_images = images.sort do |a, b|
+          Time.parse(a.creation_date) <=> Time.parse(b.creation_date)
+        end
+        sorted_images.last
+      end
+
+      private
+
+      def ec2
+        @ec2 ||= Aws::EC2::Client.new(region: @region)
+      end
+    end
+  end
+end

data/lib/stack_master/parameter_resolvers/latest_ami.rb

@@ -0,0 +1,19 @@
+module StackMaster
+  module ParameterResolvers
+    class LatestAmi < Resolver
+      array_resolver class_name: 'LatestAmis'
+
+      def initialize(config, stack_definition)
+        @config = config
+        @stack_definition = stack_definition
+        @ami_finder = AmiFinder.new(@stack_definition.region)
+      end
+
+      def resolve(value)
+        owners = Array(value.fetch('owners', 'self').to_s)
+        filters = @ami_finder.build_filters_from_hash(value.fetch('filters'))
+        @ami_finder.find_latest_ami(filters, owners).try(:image_id)
+      end
+    end
+  end
+end

data/lib/stack_master/parameter_resolvers/latest_ami_by_tags.rb

@@ -6,32 +6,12 @@ module StackMaster
       def initialize(config, stack_definition)
         @config = config
         @stack_definition = stack_definition
+        @ami_finder = AmiFinder.new(@stack_definition.region)
       end
 
       def resolve(value)
-        filters = build_filters(value)
-        find_latest_ami(filters).try(:image_id)
-      end
-
-      private
-
-      def ec2
-        @ec2 ||= Aws::EC2::Client.new(region: @stack_definition.region)
-      end
-
-      def build_filters(value)
-        value.split(',').map do |tag_with_value|
-          tag, value = tag_with_value.strip.split('=')
-          { name: "tag:#{tag}", values: [value] }
-        end
-      end
-
-      def find_latest_ami(filters)
-        images = ec2.describe_images(filters: filters).images
-        sorted_images = images.sort do |a, b|
-          Time.parse(a.creation_date) <=> Time.parse(b.creation_date)
-        end
-        sorted_images.last
+        filters = @ami_finder.build_filters_from_string(value, prefix = "tag")
+        @ami_finder.find_latest_ami(filters).try(:image_id)
       end
     end
   end

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/stack_master/parameter_resolvers/ami_finder_spec.rb

@@ -0,0 +1,68 @@
+RSpec.describe StackMaster::ParameterResolvers::AmiFinder do
+  subject(:resolver) { described_class.new('us-east-1') }
+  let(:ec2) { Aws::EC2::Client.new }
+
+  before do
+    allow(Aws::EC2::Client).to receive(:new).and_return(ec2)
+  end
+
+  describe '#build_filters_from_string' do
+    context 'when a single key-value pair is specified' do
+      it 'returns an array with a single hash' do
+        expect(resolver.build_filters_from_string('my-attr=my-value', nil)).to eq [
+          { name: 'my-attr', values: ['my-value']}
+        ]
+      end
+    end
+
+    context 'when multiple key-value pairs are specified' do
+      it 'returns an array with multiple hashes' do
+        expect(resolver.build_filters_from_string('my-attr=my-value,foo=bar', nil)).to eq [
+          { name: 'my-attr', values: ['my-value']},
+          { name: 'foo', values: ['bar']}
+        ]
+      end
+    end
+
+    context 'when a prefix is supplied' do
+      it 'adds the prefix to the filter' do
+        expect(resolver.build_filters_from_string('my-tag=my-value', 'tag')).to eq [
+          { name: 'tag:my-tag', values: ['my-value']}
+        ]
+      end
+    end
+  end
+
+  describe '#build_filters_from_hash' do
+    it 'outputs a hash of values in the format expected by the AWS API' do
+      expect(resolver.build_filters_from_hash({'foo' => 'bacon'})).to eq([{name: 'foo', values: ['bacon']}])
+    end
+  end
+
+  describe '#find_latest_ami' do
+    let(:filter) { [{ name: "String", values: ["String"]}] }
+
+    context 'when matches are found' do
+      before do
+        ec2.stub_responses(:describe_images, images: [
+          { image_id: '1', creation_date: '2015-01-02 00:00:00', tags: [{ key: 'my-tag', value: 'my-value' }] },
+          { image_id: '2', creation_date: '2015-01-03 00:00:00', tags: [{ key: 'my-tag', value: 'my-value' }] }
+        ])
+      end
+
+      it 'returns the latest one' do
+        expect(resolver.find_latest_ami(filter).image_id).to eq '2'
+      end
+    end
+
+    context 'when no matches are found' do
+      before do
+        ec2.stub_responses(:describe_images, images: [])
+      end
+
+      it 'returns nil' do
+        expect(resolver.find_latest_ami(filter)).to be_nil
+      end
+    end
+  end
+end

data/spec/stack_master/parameter_resolvers/latest_ami_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe StackMaster::ParameterResolvers::LatestAmi do
+  let(:config) { double(base_dir: '/base') }
+  let(:stack_definition) { double(stack_name: 'mystack', region: 'us-east-1') }
+  subject(:resolver) { described_class.new(config, stack_definition) }
+  let(:ec2) { Aws::EC2::Client.new }
+
+  before do
+    allow(Aws::EC2::Client).to receive(:new).and_return(ec2)
+  end
+
+  context 'when matches are found' do
+    before do
+      ec2.stub_responses(:describe_images, images: [
+        { image_id: '1', creation_date: '2015-01-02 00:00:00', name: 'foo' },
+        { image_id: '2', creation_date: '2015-01-03 00:00:00', name: 'foo' }
+      ])
+    end
+
+    it 'returns the latest one' do
+      expect(resolver.resolve('filters' => {'name' => 'foo'})).to eq '2'
+    end
+  end
+
+  context 'when no matches are found' do
+    before do
+      ec2.stub_responses(:describe_images, images: [])
+    end
+
+    it 'returns nil' do
+      expect(resolver.resolve('filters' => {'name' => 'foo'})).to be_nil
+    end
+  end
+
+  context 'when an owner_id is passed' do
+    let(:ami_finder) { StackMaster::ParameterResolvers::AmiFinder.new('us-east-1') }
+    before do
+      expect(StackMaster::ParameterResolvers::AmiFinder).to receive(:new).and_return(ami_finder)
+      allow(ami_finder).to receive(:build_filters_from_hash).and_call_original
+    end
+
+    it 'calls find_latest_ami with the owner and filters' do
+      expect(ami_finder).to receive(:find_latest_ami).with([{name: 'foo', values: ['bacon']}], ['123456'])
+      resolver.resolve({'owners' => 123456, 'filters' => {'foo' => 'bacon'} })
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -335,6 +335,8 @@ files:
 - lib/stack_master/paged_response_accumulator.rb
 - lib/stack_master/parameter_loader.rb
 - lib/stack_master/parameter_resolver.rb
+- lib/stack_master/parameter_resolvers/ami_finder.rb
+- lib/stack_master/parameter_resolvers/latest_ami.rb
 - lib/stack_master/parameter_resolvers/latest_ami_by_tags.rb
 - lib/stack_master/parameter_resolvers/secret.rb
 - lib/stack_master/parameter_resolvers/security_group.rb
@@ -385,7 +387,9 @@ files:
 - spec/stack_master/paged_response_accumulator_spec.rb
 - spec/stack_master/parameter_loader_spec.rb
 - spec/stack_master/parameter_resolver_spec.rb
-- spec/stack_master/parameter_resolvers/latest_ami_by_tag_spec.rb
+- spec/stack_master/parameter_resolvers/ami_finder_spec.rb
+- spec/stack_master/parameter_resolvers/latest_ami_by_tags_spec.rb
+- spec/stack_master/parameter_resolvers/latest_ami_spec.rb
 - spec/stack_master/parameter_resolvers/secret_spec.rb
 - spec/stack_master/parameter_resolvers/security_group_spec.rb
 - spec/stack_master/parameter_resolvers/security_groups_spec.rb
@@ -435,7 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track
@@ -473,7 +477,9 @@ test_files:
 - spec/stack_master/paged_response_accumulator_spec.rb
 - spec/stack_master/parameter_loader_spec.rb
 - spec/stack_master/parameter_resolver_spec.rb
-- spec/stack_master/parameter_resolvers/latest_ami_by_tag_spec.rb
+- spec/stack_master/parameter_resolvers/ami_finder_spec.rb
+- spec/stack_master/parameter_resolvers/latest_ami_by_tags_spec.rb
+- spec/stack_master/parameter_resolvers/latest_ami_spec.rb
 - spec/stack_master/parameter_resolvers/secret_spec.rb
 - spec/stack_master/parameter_resolvers/security_group_spec.rb
 - spec/stack_master/parameter_resolvers/security_groups_spec.rb