ec2-host 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39e4a2fac919c9e5cf6b23be541b7da53956f896
-  data.tar.gz: 263d3173a1b304d5485fbff857d82be36568f2b3
+  metadata.gz: dc628fa546f382774069143d6c6e5469091985f6
+  data.tar.gz: ab4e0f46e19adf37a1cdd7079818f3e6f78c556c
 SHA512:
-  metadata.gz: 0600f9fe0186ca52f37895f19cdeb9847bcaca97d9248e19fc67c60ef909c651feed5beb34ea4065c6d20f718d4de494d13315d330c98dd0a8b0ff1ce82678d8
-  data.tar.gz: 493a74c50c86e98bf2ce0cd601f677e4ca0b83729b6ba2f9dd74982a9822bca9c95deb0e095f9fcb5e628fec4d06088281cca590bd9389b8490cd10ecf78356f
+  metadata.gz: e5cdc6c9ac53423f828ccc5e0e62049b291e1506ae39e1761943839a8aa911d17cb282314b6d58e0372d577e63eea823279d3b498d48707076d1a4ef6e88de71
+  data.tar.gz: 6fc6ff602bee4177f7843b308b7b32b00c526c098496576b1c1a2e8ebcc98d829598a58cb6685f525c17aea8dffcbb0dadc5acd800ef131615d2b9a271903011

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.0 (2016/12/01)
+
+Enhancements:
+
+* Support role levels more than 3 by ROLE_MAX_DEPTH configuration
+
 # 0.4.2 (2016/11/28)
 
 Enhancements:

data/README.md

@@ -38,6 +38,7 @@ ec2-host parameters:
 * **OPTIONAL_STRING_TAGS (optional)**: You may add optional non-array tags. You can specify multiple tags like `Service,Status`. 
 * **OPTIONAL_ARRAY_TAGS (optional)**: You may add optional array tags. Array tags allows multiple values delimited by `ARRAY_TAG_DELIMITER` (default: `,`)
 * **ARRAY_TAG_DELIMITER (optional)**: A delimiter to express array. Default is `,`
+* **ROLE_MAX_DEPTH (optional)**: The maximum depth of levels of roles. Default is 3.
 * **LOG_LEVEL (optional)**: Log level such as `info`, `debug`, `error`. The default is `info`. 
 
 See [example.conf](./example/example.conf)
@@ -115,9 +116,9 @@ $ bin/ec2-host --help
 Usage: ec2-host [options]
         --hostname one,two,three     name or private_dns_name
     -r, --role one,two,three         role
-        --r1, --role1 one,two,three  role1, the 1st part of role delimited by :
-        --r2, --role2 one,two,three  role2, the 2st part of role delimited by :
-        --r3, --role3 one,two,three  role3, the 3st part of role delimited by :
+        --r1, --role1 one,two,three  role1, 1th part of role delimited by :
+        --r2, --role2 one,two,three  role2, 2th part of role delimited by :
+        --r3, --role3 one,two,three  role3, 3th part of role delimited by :
         --instance-id one,two,three  instance_id
         --state one,two,three        filter with instance state (default: running)
         --monitoring one,two,three   filter with instance monitoring

data/example/example.conf

@@ -7,4 +7,5 @@ ROLE_TAG_DELIMITER=:
 OPTIONAL_STRING_TAGS=Service,Status
 OPTIONAL_ARRAY_TAGS=Tags
 ARRAY_TAG_DELIMITER=,
+ROLE_MAX_DEPTH=5
 LOG_LEVEL=info

data/lib/ec2/host/cli.rb

@@ -31,15 +31,11 @@ class EC2
         op.on('-r', '--role one,two,three', Array, "role") {|v|
           opts[:role] = v
         }
-        op.on('--r1', '--role1 one,two,three', Array, "role1, the 1st part of role delimited by #{Config.role_tag_delimiter}") {|v|
-          opts[:role1] = v
-        }
-        op.on('--r2', '--role2 one,two,three', Array, "role2, the 2st part of role delimited by #{Config.role_tag_delimiter}") {|v|
-          opts[:role2] = v
-        }
-        op.on('--r3', '--role3 one,two,three', Array, "role3, the 3st part of role delimited by #{Config.role_tag_delimiter}") {|v|
-          opts[:role3] = v
-        }
+        1.upto(Config.role_max_depth).each do |i|
+          op.on("--r#{i}", "--role#{i} one,two,three", Array, "role#{i}, #{i}th part of role delimited by #{Config.role_tag_delimiter}") {|v|
+            opts["role#{i}".to_sym] = v
+          }
+        end
         op.on('--instance-id one,two,three', Array, "instance_id") {|v|
           opts[:instance_id] = v
         }
@@ -55,9 +51,12 @@ class EC2
           }
         end
         op.on('-a', '--all', "list all hosts (remove default filter)") {|v|
-          [:hostname, :role, :role1, :role2, :role3, :instance_id, :state, :monitoring].each do |key|
+          [:hostname, :role, :instance_id, :state, :monitoring].each do |key|
             opts.delete(key)
           end
+          1.upto(Config.role_max_depth).each do |i|
+            opts.delete("role#{i}".to_sym)
+          end
           Config.optional_options.each do |opt, tag|
             opts.delete(opt.to_sym)
           end

data/lib/ec2/host/config.rb

@@ -104,6 +104,10 @@ class EC2
         @array_tag_delimiter ||= ENV['ARRAY_TAG_DELIMITER'] || config.fetch('ARRAY_TAG_DELIMITER', ',')
       end
 
+      def self.role_max_depth
+        @role_max_depth ||= Integer(ENV['ROLE_MAX_DEPTH'] || config.fetch('ROLE_MAX_DEPTH', 3))
+      end
+
       # private
 
       def self.optional_array_options

data/lib/ec2/host/ec2_client.rb

@@ -44,16 +44,14 @@ class EC2
 
       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
+          return [{name: "tag:#{Config.roles_tag}", values: ["*#{role.first}*"]}]
+        end
+        1.upto(Config.role_max_depth).each do |i|
+          if role = (condition["role#{i}".to_sym] || condition["usage#{i}".to_sym]) and role.size == 1
+            return [{name: "tag:#{Config.roles_tag}", values: ["*#{role.first}*"]}]
+          end
         end
+        nil
       end
     end
   end

data/lib/ec2/host/host_data.rb

@@ -180,20 +180,23 @@ class EC2
       def role_match?(condition)
         # usage is an alias of role
         if role = (condition[:role] || condition[:usage])
-          role1, role2, role3 = role.first.split(':')
+          parts = role.first.split(Config.role_tag_delimiter, Config.role_max_depth)
         else
-          role1 = (condition[:role1] || condition[:usage1] || []).first
-          role2 = (condition[:role2] || condition[:usage2] || []).first
-          role3 = (condition[:role3] || condition[:usage3] || []).first
+          parts = 1.upto(Config.role_max_depth).map do |i|
+            (condition["role#{i}".to_sym] || condition["usage#{i}".to_sym] || []).first
+          end
         end
-        if role1
-          return false unless roles.find {|role| role.match?(role1, role2, role3) }
+        if parts.first
+          return false unless roles.find {|role| role.match?(*parts) }
         end
         true
       end
 
       def instance_match?(condition)
-        condition = HashUtil.except(condition, :role, :role1, :role2, :role3, :usage, :usage1, :usage2, :usage3)
+        excepts = [:role, :usage]
+        1.upto(Config.role_max_depth).each {|i| excepts << "role#{i}".to_sym }
+        1.upto(Config.role_max_depth).each {|i| excepts << "usage#{i}".to_sym }
+        condition = HashUtil.except(condition, *excepts)
         condition.each do |key, values|
           v = instance_variable_recursive_get(key)
           if v.is_a?(Array)

data/lib/ec2/host/role_data.rb

@@ -2,40 +2,43 @@ class EC2
   class Host
     # Represents each role
     class RoleData
-      attr_reader :role1, :role2, :role3
-
-      def initialize(role1, role2 = nil, role3 = nil)
-        @role1 = role1
-        @role2 = role2
-        @role3 = role3
+      def initialize(*parts)
+        @parts = parts
       end
 
       def self.build(role)
-        role1, role2, role3 = role.split(Config.role_tag_delimiter, 3)
-        new(role1, role2, role3)
+        parts = role.split(Config.role_tag_delimiter, Config.role_max_depth)
+        new(*parts)
       end
 
       # @return [String] something like "admin:jenkins:slave"
       def role
-        @role ||= [role1, role2, role3].compact.reject(&:empty?).join(Config.role_tag_delimiter)
+        @role ||= @parts.compact.reject(&:empty?).join(Config.role_tag_delimiter)
       end
       alias :to_s :role
 
+      1.upto(Config.role_max_depth).each do |i|
+        define_method("role#{i}") do
+          @parts[i-1]
+        end
+      end
+
       # @return [Array] something like ["admin", "admin:jenkins", "admin:jenkins:slave"]
       def uppers
-        uppers = [RoleData.new(role1)]
-        uppers << RoleData.new(role1, role2) if role2 and !role2.empty?
-        uppers << RoleData.new(role1, role2, role3) if role3 and !role3.empty?
-        uppers
+        parts = @parts.dup
+        upper_parts = []
+        upper_parts << [parts.shift]
+        parts.each do |part|
+          break if part.nil? or part.empty?
+          upper_parts << [*(upper_parts.last), part]
+        end
+        upper_parts.map {|parts| RoleData.new(*parts) }
       end
 
-      def match?(role1, role2 = nil, role3 = nil)
-        if role3
-          role1 == self.role1 and role2 == self.role2 and role3 == self.role3
-        elsif role2
-          role1 == self.role1 and role2 == self.role2
-        else
-          role1 == self.role1
+      def match?(*parts)
+        (Config.role_max_depth-1).downto(0).each do |i|
+          next unless parts[i]
+          return @parts[0..i] == parts[0..i]
         end
       end
 

data/lib/ec2/host/version.rb

@@ -1,5 +1,5 @@
 class EC2
   class Host
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

data/spec/host_spec.rb

@@ -46,11 +46,12 @@ describe EC2::Host do
       expect(subject.keys).to eq([
         'hostname',
         'roles',
-        'region',
         'service',
         'status',
         'tags',
+        'region',
         'instance_id',
+        'instance_type',
         'private_ip_address',
         'public_ip_address',
         'launch_time',

data/spec/role_data_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe EC2::Host::RoleData do
+  describe 'initialize' do
+    let(:subject) { EC2::Host::RoleData.new('web', 'test') }
+    it do
+      expect(subject.role1).to eq('web')
+      expect(subject.role2).to eq('test')
+      expect(subject.role3).to be_nil
+    end
+  end
+
+  describe '#build' do
+    let(:subject) { EC2::Host::RoleData.build('web:test') }
+    it do
+      expect(subject.role1).to eq('web')
+      expect(subject.role2).to eq('test')
+      expect(subject.role3).to be_nil
+    end
+  end
+
+  describe '#uppers' do
+    let(:subject) { EC2::Host::RoleData.build('web:test').uppers }
+    it do
+      expect(subject[0]).to eq('web')
+      expect(subject[1]).to eq('web:test')
+      expect(subject[2]).to be_nil
+    end
+  end
+
+  describe '#match?' do
+    let(:subject) { EC2::Host::RoleData.build('web:test') }
+    it do
+      expect(subject.match?('web')).to be_truthy
+      expect(subject.match?('web', 'test')).to be_truthy
+      expect(subject.match?('web', 'test', 'wrong')).to be_falsey
+      expect(subject.match?('web', 'wrong')).to be_falsey
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ec2-host
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -219,6 +219,7 @@ files:
 - lib/ec2/host/string_util.rb
 - lib/ec2/host/version.rb
 - spec/host_spec.rb
+- spec/role_data_spec.rb
 - spec/spec_helper.rb
 - terraform.tf
 homepage: https://github.com/sonots/ec2-host
@@ -247,5 +248,6 @@ specification_version: 4
 summary: Search hosts on AWS EC2
 test_files:
 - spec/host_spec.rb
+- spec/role_data_spec.rb
 - spec/spec_helper.rb
 has_rdoc: