instance_selector 0.0.19 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87f301b11ff2afccccda9580ee7f09007265c341
-  data.tar.gz: 70a879d4c4e8f49c5b017cb1d5ffeeb4a3fea344
+  metadata.gz: 01b470486e6f8d771f2fb28b3b07c4f6e53907f2
+  data.tar.gz: 2c6af22e2ad09b6ba88c67ce048dde13652b4cda
 SHA512:
-  metadata.gz: 0a312b89c6fbc5f383c1a083687af8bcbf4550e08289f38732a5b87b841a3fcbc52ae543481e9187ba22022d61307eaa0f1b0595536b651e0f305c77fb66a8ad
-  data.tar.gz: f913ba1966b80808ac468f16d02cdbb5039d35e9e1fbccd5ebda10c270225c898a3582370dd84d89ef503570fc36ee961bc1ce42471b96bd1d3e0898e8359fd6
+  metadata.gz: edb58fda3b7905562b078699c81f6bd6df27971e7ec71af0ca1eba881e3de752f4afde83cb08fa9b38d6fbf8cb2c86f1336c8d7e386c70e36197956be85064ca
+  data.tar.gz: 70fac2a50eb5ab61094a4d71923bb886169d682dbfc8780c77336cb6e8b7ee2a784bdf62bb23a797e8b6ffab0d5d5b4dcfdb1235bb3fca0f790fac054af408a1

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  Max: 100
+

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Kevin McFadden
+Copyright (c) 2016 Kevin McFadden
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 Remove the configuration pain when deploying to cloud servers.
 
-When deploying applications with Capistrano, you need to itemize the servers for each role.  When you only have a server or two, this is easily managed. However, if you have many servers provisioned via a CM tool, keeping track of them becomes difficult.
+When deploying applications with Capistrano, you need to itemize the servers for each role.  When you only have a server or two this is easily managed, but keeping track of them becomes difficult if you have many servers provisioned via a CM tool or autoscaling.
 
 By tagging servers with some meta data when they are created, you can filter
 the server list to only the ones pertaining to the current deploy.
@@ -15,7 +15,7 @@ Currently, only EC2 instances are supported.
 
 Add this line to your application's Gemfile:
 
-    gem 'instance_selector'
+    gem 'instance_selector', require: false
 
 And then execute:
 
@@ -31,24 +31,33 @@ By default, only running instances will be included in the results.  Overriding
 
 ### Standalone
 
-    require 'instance_selector/connection'
-    conn = InstanceSelector::Connection.factory(:aws)
-    instances = connection.instances(:tags => {"Environment" => "staging", "Role" => "web"})
+    require 'instance_selector/provider'
+    provider = InstanceSelector::Provider.factory(:aws)
+    instances = provider.instances(:tags => {"Environment" => "staging", "Role" => "web"})
 
 ### With Capistrano
 
     require 'instance_selector/capistrano'
+
+    # Assign all web servers to the app role
     instance_selector :app, :aws, :tags => {"Environment" => "staging", "Role" => "web"}
 
+    # an exception is thrown if exactly one instance is not returned
+    instance_selector :db,
+                      :aws,
+                      :tags => {"Environment" => "staging", "Role" => "cron"},
+                      role_options: { primary: true },
+                      expect_count: 1
+
 ### Generic with Capistrano
 
     # Centralized instance selector config
     on :after, only: stages do
       @logger.log 1, "Selecting instances from the cloud"
-      instance_selector :app, :aws, tags: {"Environment" => stage, "Role" => "social-web"}
-      instance_selector :sidekiq, :aws, tags: {"Environment" => stage, "Role" => "social-sidekiq"}
+      instance_selector :app, :aws, tags: {"Environment" => stage, "Role" => "web"}
+      instance_selector :sidekiq, :aws, tags: {"Environment" => stage, "Role" => "sidekiq"}
       # NOTE: Only one cron host is supported! Tag appropriately.
-      instance_selector :cron, :aws, tags: {"Environment" => stage, "CronRole" => "social-web"}
+      instance_selector :cron, :aws, tags: {"Environment" => stage, "CronRole" => "web"}
     end
 
 ### Filters
@@ -71,25 +80,3 @@ http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-Describ
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-## License
-
-Copyright (c) 2013 Kevin McFadden
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/instance_selector.gemspec

@@ -4,27 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'instance_selector/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "instance_selector"
+  spec.name          = 'instance_selector'
   spec.version       = InstanceSelector::VERSION
-  spec.authors       = ["Kevin McFadden"]
-  spec.email         = ["kmcfadden@gmail.com"]
-  spec.description   = %q{Retrieve cloud instance DNS names from metadata search}
-  spec.summary       = %q{}
-  spec.homepage      = "https://github.com/n3bulous/instance_selector"
-  spec.license       = "MIT"
+  spec.authors       = ['Kevin McFadden']
+  spec.email         = ['kmcfadden@gmail.com']
+  spec.description   = 'Retrieve cloud instance DNS names from metadata search'
+  spec.summary       = ''
+  spec.homepage      = 'https://github.com/n3bulous/instance_selector'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-
-  spec.add_dependency "fog", "~> 1.4"
+  spec.add_dependency 'fog-aws', '~> 0.9.2'
   spec.add_dependency('capistrano', '~> 2.1')
   spec.add_dependency('slop', '~> 3.4')
-  spec.add_dependency('nokogiri', '~> 1.5.0')
-
+  spec.add_dependency('nokogiri', '~> 1.5')
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 end

data/lib/instance_selector.rb

@@ -1,7 +1,11 @@
-__LIB_DIR__ = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.unshift __LIB_DIR__ unless $LOAD_PATH.include?(__LIB_DIR__)
+$LOAD_PATH.unshift __LIB_DIR__ unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
-require "instance_selector/version"
-require "instance_selector/connection"
+class UnexpectedInstanceCount < StandardError
+end
+
+require 'instance_selector/version'
+require 'instance_selector/provider'
+require 'instance_selector/providers/provider'
 require 'instance_selector/providers/aws'
-require 'fog'
+require 'instance_selector/providers/override'
+require 'fog/aws'

data/lib/instance_selector/capistrano.rb

@@ -4,19 +4,26 @@ Capistrano::Configuration.instance(:must_exist).load do
   # Yes, this is a hack
   @instance_selector_instances = {}
 
-  def instance_selector(cap_role, provider, args={})
-    client = InstanceSelector::Connection.factory(provider)
-    instances = client.instances(client.args_to_filters(args))
-    role(cap_role, *instances.keys)
+  def instance_selector(cap_role, provider, args = {})
+    role_options = args.delete(:role_options) || {}
+    provider = :override if ENV['HOSTS']
+    client = InstanceSelector::Provider.factory(provider)
 
+    begin
+      instances = client.instances(args)
+    rescue UnexpectedInstanceCount => e
+      abort("#{cap_role}: #{e.message}")
+    end
+
+    role(cap_role, *instances.keys, role_options)
     @instance_selector_instances.merge!(instances)
   end
 
   # Not namespaced due to collision with the above method.
-  desc "List all cloud instances for a stage"
+  desc 'List all cloud instances for a stage'
   task :instance_selector_list do
     puts
-    @instance_selector_instances.sort_by {|k,v| v[:name].to_s}.each do |k, v|
+    @instance_selector_instances.sort_by { |_k, v| v[:name].to_s }.each do |k, v|
       puts k + "\t" + v.values.join("\t")
     end
   end

data/lib/instance_selector/provider.rb

@@ -0,0 +1,20 @@
+module InstanceSelector
+  class UnsupportedProviderException < RuntimeError; end
+
+  # Provider factory for different cloud APIs
+  class Provider
+    def self.factory(provider, options = {})
+      provider = :override if ENV['HOSTS']
+
+      case provider
+      when :aws
+        Providers::AWS.new(options)
+      when :override
+        Providers::Override.new(options)
+      else
+        raise UnsupportedProviderException,
+              "#{provider} is not a supported provider"
+      end
+    end
+  end
+end

data/lib/instance_selector/providers/aws.rb

@@ -1,71 +1,75 @@
 module InstanceSelector
   module Providers
-    class AWS
-      def initialize(options={})
+    # AWS Provider
+    class AWS < AbstractProvider
+      def initialize(options = {})
         @fog = options.delete(:fog_client)
 
         unless @fog
           @options = {
-            region: 'us-east-1',
+            region: 'us-east-1'
           }.merge(options)
 
           connect
         end
       end
 
+      def instances(args = {})
+        expect_count = args.delete(:expect_count)
+        filters = args_to_filters(args)
+        instances = on_demand_instances(filters).merge(spot_instances(filters))
+
+        if expect_count && expect_count != instances.size
+          raise UnexpectedInstanceCount, "Expected #{expect_count}, got #{instances.size}"
+        end
+
+        instances
+      end
+
+      private
 
       def dns_from_instance_reservation_set(reservation_set)
-        reservation_set.inject({}) do |memo, i|
+        reservation_set.each_with_object({}) do |i, memo|
           # Each instancesSet can have multiple instances
           # Odd, but explains why it's plural.
           i['instancesSet'].each do |instance|
-            key = instance['dnsName'].empty? ? instance['ipAddress'] : instance['dnsName']
-            memo[key] = {name: instance['tagSet']['Name'], instance_id: instance['instanceId']}
-          end
+            key = instance['dnsName'] || instance['ipAddress'] || instance['privateIpAddress']
 
-          memo
+            memo[key] = { name: instance['tagSet']['Name'],
+                          identifier: instance['instanceId'] }
+          end
         end
       end
 
-      def on_demand_instances(filters={})
-        instances = @fog.describe_instances({"instance-state-name" => "running"}.merge(filters))
+      def on_demand_instances(filters = {})
+        instances = @fog.describe_instances({ 'instance-state-name' => 'running' }.merge(filters))
 
         dns_from_instance_reservation_set instances.body['reservationSet']
       end
 
-      def spot_instances(filters={})
-        requests = @fog.describe_spot_instance_requests({'state' => 'active'}.merge(filters))
-        requests.body['spotInstanceRequestSet'].inject({}) do |memo, req|
-
+      def spot_instances(filters = {})
+        requests = @fog.describe_spot_instance_requests({ 'state' => 'active' }.merge(filters))
+        requests.body['spotInstanceRequestSet'].each_with_object({}) do |req, memo|
           if req['instanceId'] && !req['instanceId'].empty?
             instances = @fog.describe_instances('instance-id' => req['instanceId'])
             memo.merge! dns_from_instance_reservation_set(instances.body['reservationSet'])
           end
-
-          memo
         end
       end
 
-
-      def instances(filters={})
-        on_demand_instances(filters).merge(spot_instances(filters))
-      end
-
       def connect
-        begin
-          @fog = Fog::Compute.new(provider:              'AWS',
-                                  region:                @options[:region],
-                                  aws_access_key_id:     ENV['AWS_ACCESS_KEY_ID'],
-                                  aws_secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'])
-        rescue
-          @fog = Fog::Compute.new(provider: 'AWS', region: @options[:region])
-        ensure
-          unless @fog
-            abort <<-EOS
-              Could not authenticate with AWS.
-              Please create a .fog file or set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
-            EOS
-          end
+        @fog = Fog::Compute.new(provider:              'AWS',
+                                region:                @options[:region],
+                                aws_access_key_id:     ENV['AWS_ACCESS_KEY_ID'],
+                                aws_secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'])
+      rescue
+        @fog = Fog::Compute.new(provider: 'AWS', region: @options[:region])
+      ensure
+        unless @fog
+          abort <<-EOS
+            Could not authenticate with AWS.
+            Please create a .fog file or set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
+          EOS
         end
       end
 
@@ -77,17 +81,15 @@ module InstanceSelector
 
       def parse_spot_request_id(spot_request_id)
         return {} unless spot_request_id
-        { "spot-instance-request-id" => spot_request_id }
+        { 'spot-instance-request-id' => spot_request_id }
       end
 
       def parse_tags(tags)
         return {} unless tags
-        tags.inject({}) do |memo, tag|
+        tags.each_with_object({}) do |tag, memo|
           memo["tag:#{tag[0]}"] = tag[1]
-          memo
         end
       end
-
     end
   end
 end

data/lib/instance_selector/providers/override.rb

@@ -0,0 +1,19 @@
+module InstanceSelector
+  module Providers
+    # Uses the HOSTS environment variable instead of a cloud provider
+    class Override < AbstractProvider
+      def initialize(_options = {})
+        @hosts = ENV['HOSTS']
+      end
+
+      def instances(_args = {})
+        results = {}
+        ENV['HOSTS'].split(',').each do |host|
+          results[host] = { name: host, identifier: 'N/A' }
+        end
+
+        results
+      end
+    end
+  end
+end

data/lib/instance_selector/providers/provider.rb

@@ -0,0 +1,16 @@
+module InstanceSelector
+  module Providers
+    # Abstract class for providers
+    class AbstractProvider
+      # Returns a hash of instance network resources and the associated attributes.
+      # e.g. (not realistic data):
+      #   {
+      #     '127.0.0.1' => { name: 'localhost', identifier: 'N/A' }
+      #     '10.10.1.1' => { name: 'aws name tag', identifier: 'i-abcdef01' }
+      #   }
+      def instances(_args = {})
+        raise NotImplementedError, 'A provider must implement #instances'
+      end
+    end
+  end
+end

data/lib/instance_selector/version.rb

@@ -1,3 +1,3 @@
 module InstanceSelector
-  VERSION = "0.0.19"
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: instance_selector
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin McFadden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-12 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: fog
+  name: fog-aws
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Retrieve cloud instance DNS names from metadata search
@@ -102,7 +102,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,8 +112,10 @@ files:
 - instance_selector.gemspec
 - lib/instance_selector.rb
 - lib/instance_selector/capistrano.rb
-- lib/instance_selector/connection.rb
+- lib/instance_selector/provider.rb
 - lib/instance_selector/providers/aws.rb
+- lib/instance_selector/providers/override.rb
+- lib/instance_selector/providers/provider.rb
 - lib/instance_selector/version.rb
 homepage: https://github.com/n3bulous/instance_selector
 licenses:
@@ -124,17 +127,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: ''

data/lib/instance_selector/connection.rb

@@ -1,14 +0,0 @@
-module InstanceSelector
-  class UnsupportedProviderException < Exception; end;
-
-  class Connection
-    def self.factory(provider, options={})
-      conn = case provider
-             when :aws
-               Providers::AWS.new(options)
-             else
-               raise UnsupportedProviderException, "#{provider} is not a supported provider"
-             end
-    end
-  end
-end