RubyGems - ec2-host - Versions diffs - 0.3.1 → 0.4.0 - Mend

ec2-host 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +4 -4
data/.gitignore +2 -0
data/.yardopts +6 -0
data/CHANGELOG.md +8 -0
data/README.md +42 -8
data/docs/EC2.html +132 -0
data/docs/EC2/Host.html +889 -0
data/docs/EC2/Host/CLI.html +616 -0
data/docs/EC2/Host/Config.html +1193 -0
data/docs/EC2/Host/EC2Client.html +273 -0
data/docs/EC2/Host/HashUtil.html +178 -0
data/docs/EC2/Host/HostData.html +1772 -0
data/docs/EC2/Host/RoleData.html +932 -0
data/docs/EC2/Host/StringUtil.html +359 -0
data/docs/_index.html +201 -0
data/docs/class_list.html +58 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +57 -0
data/docs/css/style.css +339 -0
data/docs/file.LICENSE.html +95 -0
data/docs/file.README.html +323 -0
data/docs/file_list.html +63 -0
data/docs/frames.html +26 -0
data/docs/index.html +323 -0
data/docs/js/app.js +219 -0
data/docs/js/full_list.js +181 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +489 -0
data/docs/top-level-namespace.html +112 -0
data/ec2-host.gemspec +1 -2
data/{sample.conf → example/example.conf} +1 -1
data/lib/ec2-host.rb +1 -1
data/lib/ec2/host.rb +12 -4
data/lib/ec2/host/config.rb +13 -15
data/lib/ec2/host/ec2_client.rb +60 -0
data/lib/ec2/host/host_data.rb +156 -103
data/lib/ec2/host/role_data.rb +11 -7
data/spec/host_spec.rb +67 -42
data/spec/spec_helper.rb +6 -6
data/terraform.tf +39 -0
metadata +31 -22
data/doc.sh +0 -5
data/lib/ec2/host/client_util.rb +0 -44
data/spec/README.md +0 -35

data/docs/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EC2.html" title="EC2 (class)">EC2</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Thu Nov 24 10:25:36 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.2).
+</div>
+  </body>
+</html>

data/ec2-host.gemspec CHANGED

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "ec2-host"
-  gem.version       = '0.3.1'
+  gem.version       = '0.4.0'
   gem.author        = ['Naotoshi Seo']
   gem.email         = ['sonots@gmail.com']
   gem.homepage      = 'https://github.com/sonots/ec2-host'
@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.add_runtime_dependency 'aws-sdk'
-  gem.add_runtime_dependency 'hashie'
   gem.add_runtime_dependency 'dotenv'
   gem.add_development_dependency 'yard'

data/{sample.conf → example/example.conf} RENAMED

@@ -1,6 +1,6 @@
 AWS_ACCESS_KEY_ID=xxxxxxx
 AWS_SECRET_ACCESS_KEY=xxxxxx
-AWS_REGION=ap-northeast-1
+AWS_DEFAULT_REGION=ap-northeast-1
 HOSTNAME_TAG=Name
 ROLES_TAG=Roles
 ROLE_TAG_DELIMITER=:

data/lib/ec2-host.rb CHANGED

@@ -3,5 +3,5 @@ require_relative 'ec2/host/hash_util'
 require_relative 'ec2/host/config'
 require_relative 'ec2/host/host_data'
 require_relative 'ec2/host/role_data'
-require_relative 'ec2/host/client_util'
+require_relative 'ec2/host/ec2_client'
 require_relative 'ec2/host'

data/lib/ec2/host.rb CHANGED

@@ -40,7 +40,7 @@ class EC2
     # @return [Host::Data] representing myself
     def self.me
-      new(instance_id: ClientUtil.instance_id).each do |d|
+      new(instance_id: ec2_client.instance_id).each do |d|
         return d
       end
       raise 'Not Found'
@@ -48,11 +48,19 @@ class EC2
     # Configure EC2::Host
     #
-    # @params [Hash] params see EC2::Host::Config for configurable parameters
+    # @param [Hash] params see EC2::Host::Config for configurable parameters
     def self.configure(params = {})
       Config.configure(params)
     end
+    def self.ec2_client
+      @ec2_client ||= EC2Client.new
+    end
+    def ec2_client
+      self.class.ec2_client
+    end
     attr_reader :conditions, :options
     # @param [Array of Hash, or Hash] conditions (and options)
@@ -92,7 +100,7 @@ class EC2
     # @yieldparam [Host::Data] data entry
     def each(&block)
       @conditions.each do |condition|
-        search(ClientUtil.instances(condition), condition, &block)
+        search(ec2_client.instances(condition), condition, &block)
       end
       return self
     end
@@ -101,7 +109,7 @@ class EC2
     def search(instances, condition)
       instances.each do |i|
-        d = EC2::Host::HostData.initialize(i)
+        d = EC2::Host::HostData.new(i)
         next unless d.match?(condition)
         yield d
       end

data/lib/ec2/host/config.rb CHANGED

@@ -10,7 +10,7 @@ class EC2
           :aws_profile,
           :aws_access_key_id,
           :aws_secret_access_key,
-          :aws_credentials_file,
+          :aws_credential_file,
           :log_level,
           :hostname_tag,
           :roles_tag,
@@ -29,24 +29,31 @@ class EC2
       end
       def self.aws_region
-        @aws_region ||= ENV['AWS_REGION'] || config.fetch('AWS_REGION')
+        @aws_region ||=
+          ENV['AWS_REGION'] || config.fetch('AWS_REGION', nil) || # ref. old aws cli
+          ENV['AWS_DEFAULT_REGION'] || config.fetch('AWS_DEFAULT_REGION') # ref. aws cli and terraform
       end
       def self.aws_profile
-        @aws_profile ||= ENV['AWS_PROFILE'] || config.fetch('AWS_PROFILE', 'default')
+        @aws_profile ||=
+          ENV['AWS_PROFILE'] || config.fetch('AWS_PROFILE', 'nil') || # ref. old aws cli
+          ENV['AWS_DEFAULT_PROFILE'] || config.fetch('AWS_DEFAULT_PROFILE', 'default') # ref. aws cli and terraform
       end
       def self.aws_access_key_id
+        # ref. aws cli and terraform
         @aws_access_key_id ||= ENV['AWS_ACCESS_KEY_ID'] || config.fetch('AWS_ACCESS_KEY_ID', nil)
       end
       def self.aws_secret_access_key
+        # ref. aws cli and terraform
         @aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY'] || config.fetch('AWS_SECRET_ACCESS_KEY', nil)
       end
-      # this is not an official aws sdk environment variable
-      def self.aws_credentials_file
-        @aws_credentials_file ||= ENV['AWS_CREDENTIALS_FILE'] || config.fetch('AWS_CREDENTIALS_FILE', nil)
+      def self.aws_credential_file
+        @aws_credential_file ||=
+          ENV['AWS_CREDENTIALS_FILE'] || config.fetch('AWS_CREDENTIALS_FILE', nil) ||
+          ENV['AWS_CREDENTIAL_FILE'] || config.fetch('AWS_CREDENTIAL_FILE', nil) # ref. aws cli (supported lately)
       end
       def self.log_level
@@ -79,15 +86,6 @@ class EC2
       # private
-      def self.aws_credentials
-        @aws_credentials ||=
-          if aws_access_key_id and aws_secret_access_key
-            Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
-          else
-            Aws::SharedCredentials.new(profile_name: aws_profile, path: aws_credentials_file)
-          end
-      end
       def self.optional_array_options
         @optional_array_options ||= Hash[optional_array_tags.map {|tag|
           [StringUtil.singularize(StringUtil.underscore(tag)), tag]

data/lib/ec2/host/ec2_client.rb ADDED

@@ -0,0 +1,60 @@
+require 'net/http'
+require 'aws-sdk'
+class EC2
+  class Host
+    class EC2Client
+      def instances(condition)
+        filters = build_filters(condition)
+        instances =
+          if filters
+            ec2.describe_instances(filters: filters)
+          elsif instance_id = condition[:instance_id]
+            ec2.describe_instances(instance_ids: Array(instance_id))
+          else
+            ec2.describe_instances
+          end
+        instances.reservations.map(&:instances).flatten
+      end
+      def instance_id
+        return @instance_id if @instance_id
+        begin
+          http_conn = Net::HTTP.new('169.254.169.254')
+          http_conn.open_timeout = 5
+          @instance_id = http_conn.start {|http| http.get('/latest/meta-data/instance-id').body }
+        rescue Net::OpenTimeout
+          raise "HTTP connection to 169.254.169.254 is timeout. Probably, not an EC2 instance?"
+        end
+      end
+      private
+      def ec2
+        @ec2 ||= Aws::EC2::Client.new(region: Config.aws_region, credentials: credentials)
+      end
+      def credentials
+        if Config.aws_access_key_id and Config.aws_secret_access_key
+          Aws::Credentials.new(Config.aws_access_key_id, Config.aws_secret_access_key)
+        else
+          Aws::SharedCredentials.new(profile_name: Config.aws_profile, path: Config.aws_credential_file)
+        end
+      end
+      def build_filters(condition)
+        if role = (condition[:role] || condition[:usage]) and role.size == 1
+          [{name: "tag:#{Config.roles_tag}", values: ["*#{role.first}*"]}]
+        elsif role1 = (condition[:role1] || condition[:usage1]) and role1.size == 1
+          [{name: "tag:#{Config.roles_tag}", values: ["*#{role1.first}*"]}]
+        elsif role2 = (condition[:role2] || condition[:usage2]) and role2.size == 1
+          [{name: "tag:#{Config.roles_tag}", values: ["*#{role2.first}*"]}]
+        elsif role3 = (condition[:role3] || condition[:usage3]) and role3.size == 1
+          [{name: "tag:#{Config.roles_tag}", values: ["*#{role3.first}*"]}]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ec2/host/host_data.rb CHANGED

@@ -1,98 +1,93 @@
-require 'forwardable'
-require 'hashie/mash'
 require 'json'
 class EC2
   class Host
     # Represents each host
-    class HostData < Hashie::Mash
+    class HostData
+      attr_reader :instance
       # :hostname, # tag:Name or hostname part of private_dns_name
       # :roles,    # tag:Roles.split(',') such as web:app1,db:app1
       # :region,   # ENV['AWS_REGION'],
       # :instance, # Aws::EC2::Types::Instance itself
       #
       # and OPTIONAL_ARRAY_TAGS, OPTIONAL_STRING_TAGS
+      def initialize(instance)
+        @instance = instance
+      end
-      extend Forwardable
-      def_delegators :instance,
-        :instance_id,
-        :private_ip_address,
-        :public_ip_address,
-        :launch_time
-      def state; self[:instance].state.name; end
-      def monitoring; self[:instance].monitoring.state; end
-      alias_method :ip, :private_ip_address
-      alias_method :start_date, :launch_time
-      def usages; self[:roles]; end
-      def self.initialize(instance)
-        d = self.new
-        d.instance = instance
-        d.set_hostname
-        d.set_roles
-        d.set_region
-        d.set_string_tags
-        d.set_array_tags
-        d
+      def hostname
+        return @hostname if @hostname
+        @hostname = find_string_tag(Config.hostname_tag)
+        @hostname = instance.private_dns_name.split('.').first if @hostname.empty?
+        @hostname
       end
-      # match with condition or not
-      #
-      # @param [Hash] condition search parameters
-      def match?(condition)
-        return false if !condition[:state] and (terminated? or shutting_down?)
-        return false unless role_match?(condition)
-        condition = HashUtil.except(condition,
-          :role, :role1, :role2, :role3,
-          :usage, :usage1, :usage2, :usage3
-        )
-        condition.each do |key, values|
-          v = get_value(key)
-          if v.is_a?(Array)
-            return false unless v.find {|_| values.include?(_) }
-          else
-            return false unless values.include?(v)
-          end
-        end
-        true
+      def roles
+        return @roles if @roles
+        roles = find_array_tag(Config.roles_tag)
+        @roles = roles.map {|role| EC2::Host::RoleData.build(role) }
       end
-      def inspect
-        sprintf "#<Aws::Host::HostData %s>", info
+      def region
+        Config.aws_region
       end
-      def info
-        if self[:hostname] and self[:status] and self[:roles] and self[:tags] and self[:service]
-          # special treatment for DeNA ;)
-          info = "#{self[:hostname]}:#{self[:status]}"
-          info << "(#{self[:roles].join(' ')})" unless self[:roles].empty?
-          info << "[#{self[:tags].join(' ')}]" unless self[:tags].empty?
-          info << "{#{self[:service]}}" unless self[:service].empty?
-          info
-        else
-          to_hash.to_s
+      Config.optional_string_tags.each do |tag|
+        field = StringUtil.underscore(tag)
+        define_method(field) do
+          instance_variable_get("@#{field}") || instance_variable_set("@#{field}", find_string_tag(tag))
         end
       end
-      def to_hash
-        HashUtil.except(self, :instance).to_h.merge(
-          instance_id: instance_id,
-          private_ip_address: private_ip_address,
-          public_ip_address: public_ip_address,
-          launch_time: launch_time,
-          state: state,
-          monitoring: monitoring,
-        )
+      Config.optional_array_tags.each do |tag|
+        field = StringUtil.underscore(tag)
+        define_method(field) do
+          instance_variable_get("@#{field}") || instance_variable_set("@#{field}", find_array_tag(tag))
+        end
       end
-      # private
+      def instance_id
+        instance.instance_id
+      end
-      # "instance.instance_id" => self.send("instance").send("instance_id")
-      def get_value(key)
-        v = self
-        key.to_s.split('.').each {|k| v = v[k] || v.send(k) }
-        v
+      def instance_type
+        instance.instance_type
+      end
+      def private_ip_address
+        instance.private_ip_address
+      end
+      def public_ip_address
+        instance.public_ip_address
+      end
+      def launch_time
+        instance.launch_time
+      end
+      def state
+        instance.state.name
+      end
+      def monitoring
+        instance.monitoring.state
+      end
+      # compatibility with dino-host
+      def ip
+        private_ip_address
+      end
+      # compatibility with dino-host
+      def start_date
+        launch_time
+      end
+      # compatibility with dino-host
+      def usages
+        roles
       end
       def terminated?
@@ -119,49 +114,59 @@ class EC2
         state == "pending"
       end
-      def role_match?(condition)
-        # usage is an alias of role
-        if role = (condition[:role] || condition[:usage])
-          role1, role2, role3 = role.first.split(':')
-        else
-          role1 = (condition[:role1] || condition[:usage1] || []).first
-          role2 = (condition[:role2] || condition[:usage2] || []).first
-          role3 = (condition[:role3] || condition[:usage3] || []).first
-        end
-        if role1
-          return false unless self[:roles].find {|role| role.match?(role1, role2, role3) }
-        end
+      # match with condition or not
+      #
+      # @param [Hash] condition search parameters
+      def match?(condition)
+        return false if !condition[:state] and (terminated? or shutting_down?)
+        return false unless role_match?(condition)
+        return false unless instance_match?(condition)
         true
       end
-      def set_hostname
-        self[:hostname] = find_string_tag(Config.hostname_tag)
-        self[:hostname] = self[:instance].private_dns_name.split('.').first if self[:hostname].empty?
-      end
-      def set_roles
-        roles  = find_array_tag(Config.roles_tag)
-        self[:roles] = roles.map {|role| EC2::Host::RoleData.initialize(role) }
-      end
-      def set_region
-        self[:region] = Config.aws_region
-      end
-      def set_string_tags
+      def to_hash
+        params = {
+          "hostname" => hostname,
+          "roles" => roles,
+        }
         Config.optional_string_tags.each do |tag|
           field = StringUtil.underscore(tag)
-          self[field] = find_string_tag(tag)
+          params[field] = send(field)
         end
-      end
-      def set_array_tags
         Config.optional_array_tags.each do |tag|
           field = StringUtil.underscore(tag)
-          self[field] = find_array_tag(tag)
+          params[field] = send(field)
         end
+        params.merge!(
+          "region" => region,
+          "instance_id" => instance_id,
+          "instance_type" => instance_type,
+          "private_ip_address" => private_ip_address,
+          "public_ip_address" => public_ip_address,
+          "launch_time" => launch_time,
+          "state" => state,
+          "monitoring" => monitoring,
+        )
       end
+      def info
+        if self.class.display_short_info?
+          info = "#{hostname}:#{status}"
+          info << "(#{roles.join(',')})" unless roles.empty?
+          info << "[#{tags.join(',')}]" unless tags.empty?
+          info << "{#{service}}" unless service.empty?
+          info
+        else
+          to_hash.to_s
+        end
+      end
+      def inspect
+        sprintf "#<Aws::Host::HostData %s>", info
+      end
+      private
       def find_string_tag(key)
         v = instance.tags.find {|tag| tag.key == key }
         v ? v.value : ''
@@ -171,6 +176,54 @@ class EC2
         v = instance.tags.find {|tag| tag.key == key }
         v ? v.value.split(Config.array_tag_delimiter) : []
       end
+      def role_match?(condition)
+        # usage is an alias of role
+        if role = (condition[:role] || condition[:usage])
+          role1, role2, role3 = role.first.split(':')
+        else
+          role1 = (condition[:role1] || condition[:usage1] || []).first
+          role2 = (condition[:role2] || condition[:usage2] || []).first
+          role3 = (condition[:role3] || condition[:usage3] || []).first
+        end
+        if role1
+          return false unless roles.find {|role| role.match?(role1, role2, role3) }
+        end
+        true
+      end
+      def instance_match?(condition)
+        condition = HashUtil.except(condition, :role, :role1, :role2, :role3, :usage, :usage1, :usage2, :usage3)
+        condition.each do |key, values|
+          v = instance_variable_recursive_get(key)
+          if v.is_a?(Array)
+            return false unless v.find {|_| values.include?(_) }
+          else
+            return false unless values.include?(v)
+          end
+        end
+        true
+      end
+      # "instance.instance_id" => self.instance.instance_id
+      def instance_variable_recursive_get(key)
+        v = self
+        key.to_s.split('.').each {|k| v = v.send(k) }
+        v
+      end
+      # compatibility with dono-host
+      #
+      # If Service,Status,Tags tags are defined
+      #
+      #     OPTIONAL_STRING_TAGS=Service,Status
+      #     OPTIONAL_ARRAY_TAGS=Tags
+      #
+      # show in short format, otherwise, same with to_hash.to_s
+      def self.display_short_info?
+        return @display_short_info unless @display_short_info.nil?
+        @display_short_info = method_defined?(:service) and method_defined?(:status) and method_defined?(:tags)
+      end
     end
   end
 end