gce-host 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f473115294b06f624354470a0b77ff09e5275f28
-  data.tar.gz: f1fdc1d27677d158fa9fa5952bc35a29e91d163e
+  metadata.gz: f1b7d2580b2e20e9f49b95b23fd29520075b2ae8
+  data.tar.gz: 17c9de1adc6e4a5f456e3d75b8c08db4a06ba01d
 SHA512:
-  metadata.gz: 0cec3a2009fa765ec7e72ca048dcead0d88bb7459a6e765b67be057d4178e2d83ef6b43f3f973e7496aac61c81e8313421d5d836fa46b7d3fb595d24334b4800
-  data.tar.gz: 6a69cf30ef0cef6f6326b0858a30dc639e5106781a78640742b4acfb29bf92751d1f39e7fad065a724b69cfdb9b5861a904084eb7e2bb0cd5a79b599690d7893
+  metadata.gz: 774f8e55112193adfdce84863dc93e34a7cf1d71aa78a60be78c003a4d59259fa07dee525d1b81489e36c769795d574985f49772243f72f3d822159b38a402da
+  data.tar.gz: f1dd7e96959f7d906e71f16da61a13188013fcf39d9aa5a3d3604aa4a498c4240ace304f33193ec84c7198087180d2c7fafddc17b8069eae746e422aa72fd45b

data/CHANGELOG.md

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

data/README.md

@@ -17,7 +17,7 @@ You can manage roles of a host, and search hosts having a specified role using t
 
 ## Configuration
 
-You can write a configuration file located at `/etc/sysconfig/gce-host` for CentOS, or `/etc/default/gce-host` for Ubuntu (You can configure this path by `GCE_HOST_CONFIG_FILE` environment variable), or as environment variables:
+You can write a configuration file located at `/etc/sysconfig/gce-host` or `/etc/default/gce-host` (You can configure this path by `GCE_HOST_CONFIG_FILE` environment variable), or as environment variables:
 
 GOOGLE API parameters:
 
@@ -35,6 +35,7 @@ gce-host parameters:
 * **OPTIONAL_STRING_KEYS (optional)**: You may add optional non-array metadata keys. You can specify multiple keys like `service,status`. 
 * **OPTIONAL_ARRAY_KEYS (optional)**: You may add optional array metadata keys. Array allows multiple values delimited by `ARRAY_VALUE_DELIMITER` (default: `,`)
 * **ARRAY_VALUE_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)
@@ -120,9 +121,9 @@ $ bin/gce-host --help
 Usage: gce-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 :
         --state one,two,three        filter with instance state (default: running)
     -a, --all                        list all hosts (remove default filter)
         --private-ip, --ip           show private ip address instead of hostname

data/example/example.conf

@@ -5,5 +5,6 @@ ROLE_VALUE_DELIMITER=:
 OPTIONAL_STRING_KEYS=service,status
 OPTIONAL_ARRAY_KEYS=tags
 ARRAY_VALUE_DELIMITER=,
+ROLE_MAX_DEPTH=5
 LOG_LEVEL=info
 STATUS=state

data/lib/gce/host/cli.rb

@@ -31,15 +31,11 @@ class GCE
         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_value_delimiter}") {|v|
-          opts[:role1] = v
-        }
-        op.on('--r2', '--role2 one,two,three', Array, "role2, the 2st part of role delimited by #{Config.role_value_delimiter}") {|v|
-          opts[:role2] = v
-        }
-        op.on('--r3', '--role3 one,two,three', Array, "role3, the 3st part of role delimited by #{Config.role_value_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_value_delimiter}") {|v|
+            opts["role#{i}".to_sym] = v
+          }
+        end
         op.on('--instance-id one,two,three', Array, "instance_id") {|v|
           opts[:instance_id] = v
         }
@@ -52,9 +48,12 @@ class GCE
           }
         end
         op.on('-a', '--all', "list all hosts (remove default filter)") {|v|
-          [:hostname, :role, :role1, :role2, :role3, :instance_id, Config.status.to_sym].each do |key|
+          [:hostname, :role, :instance_id, Config.status.to_sym].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.keys.each do |opt|
             opts.delete(opt.to_sym)
           end

data/lib/gce/host/config.rb

@@ -4,6 +4,8 @@ require 'inifile'
 
 class GCE
   class Host
+    class ConfigError < StandardError; end
+
     class Config
       def self.configure(params)
         params.each do |key, val|
@@ -93,6 +95,10 @@ class GCE
         @status ||= ENV['STATUS'] || config.fetch('STATUS', 'status')
       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/gce/host/host_data.rb

@@ -175,14 +175,14 @@ class GCE
       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_value_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
@@ -195,7 +195,10 @@ class GCE
       end
 
       def instance_match?(condition)
-        condition = HashUtil.except(condition, :role, :role1, :role2, :role3, :usage, :usage1, :usage2, :usage3, Config.status.to_sym)
+        excepts = [:role, :usage, Config.status.to_sym]
+        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/gce/host/role_data.rb

@@ -2,47 +2,68 @@ class GCE
   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
+      # Initialize role data with role parts
+      #
+      #     RoleData.new('admin', 'jenkins', 'slave')
+      #
+      # @param [Array] role_parts such as ['admin', 'jenkins', 'slave']
+      def initialize(*role_parts)
+        @role_parts = role_parts
       end
 
+      # Create a role data with role delimiter by Config.role_value_delimiter
+      #
+      #     RoleData.build('admin:jenkins:slave')
+      #
+      # @param [String] role such as "admin:jenkins:slave"
       def self.build(role)
-        role1, role2, role3 = role.split(Config.role_value_delimiter, 3)
-        new(role1, role2, role3)
+        role_parts = role.split(Config.role_value_delimiter, Config.role_max_depth)
+        new(*role_parts)
       end
 
       # @return [String] something like "admin:jenkins:slave"
       def role
-        @role ||= [role1, role2, role3].compact.reject(&:empty?).join(Config.role_value_delimiter)
+        @role ||= @role_parts.compact.reject(&:empty?).join(Config.role_value_delimiter)
       end
       alias :to_s :role
 
+      1.upto(Config.role_max_depth).each do |i|
+        define_method("role#{i}") do
+          @role_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
+        role_parts = @role_parts.dup
+        upper_role_parts = []
+        upper_role_parts << [role_parts.shift]
+        role_parts.each do |role_part|
+          break if role_part.nil? or role_part.empty?
+          upper_role_parts << [*(upper_role_parts.last), role_part]
+        end
+        upper_role_parts.map {|role_parts| RoleData.new(*role_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
+      # Check whether given role parts matches with this role data object
+      #
+      #     RoleData.new('admin', 'jenkins', 'slave').match?('admin') #=> true
+      #     RoleData.new('admin', 'jenkins', 'slave').match?('admin', 'jenkins') #=> true
+      #     RoleData.new('admin', 'jenkins', 'slave').match?('admin', 'jenkins', 'slave') #=> true
+      #     RoleData.new('admin', 'jenkins', 'slave').match?('admin', 'jenkins', 'master') #=> false
+      #
+      # @param [Array] role_parts such as ["admin", "jenkins", "slave"]
+      def match?(*role_parts)
+        (Config.role_max_depth-1).downto(0).each do |i|
+          next unless role_parts[i]
+          return @role_parts[0..i] == role_parts[0..i]
         end
       end
 
       # Equality
       #
-      #     Role::Data.new('admin') == Role::Data.new('admin') #=> true
-      #     Role::Data.new('admin', 'jenkin') == "admin:jenkins" #=> true
+      #     RoleData.new('admin') == Role::Data.new('admin') #=> true
+      #     RoleData.new('admin', 'jenkin') == "admin:jenkins" #=> true
       #
       # @param [Object] other
       def ==(other)

data/lib/gce/host/version.rb

@@ -1,5 +1,5 @@
 class GCE
   class Host
-    VERSION = '0.3.4'
+    VERSION = '0.4.0'
   end
 end

data/spec/host_spec.rb

@@ -4,13 +4,13 @@ shared_examples_for 'host' do
   it 'should respond_to' do
     [ :hostname,
       :roles,
-      :zone,
       GCE::Host::Config.status.to_sym,
       :service,
       :status,
       :tags,
+      :zone,
       :instance,
-      :instance_id,
+      :machine_type,
       :private_ip_address,
       :private_ip_addresses,
       :public_ip_address,
@@ -47,11 +47,11 @@ describe GCE::Host do
       expect(subject.keys).to eq([
         'hostname',
         'roles',
-        'zone',
         'service',
         'status',
         'tags',
-        'instance_id',
+        'zone',
+        'machine_type',
         'private_ip_address',
         'public_ip_address',
         'creation_timestamp',

data/spec/role_data_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe GCE::Host::RoleData do
+  describe 'initialize' do
+    let(:subject) { GCE::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) { GCE::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) { GCE::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) { GCE::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

data/terraform.tf

@@ -5,7 +5,7 @@ provider "google" {
 
 resource "google_compute_instance" "gce-host-web" {
   name         = "gce-host-web"
-  machine_type = "n1-standard-1"
+  machine_type = "f1-micro"
   zone         = "asia-northeast1-a"
 
   disk {
@@ -20,7 +20,7 @@ resource "google_compute_instance" "gce-host-web" {
   }
 
   metadata {
-    roles = "foo,web:test"
+    roles = "foo,web:test:foo:bar:baz"
     service = "gce-host"
     status = "reserve"
     tags = "standby"
@@ -29,7 +29,7 @@ resource "google_compute_instance" "gce-host-web" {
 
 resource "google_compute_instance" "gce-host-db" {
   name         = "gce-host-db"
-  machine_type = "n1-standard-1"
+  machine_type = "f1-micro"
   zone         = "asia-northeast1-a"
 
   disk {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gce-host
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.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: google-api-client
@@ -207,6 +207,7 @@ files:
 - lib/gce/host/version.rb
 - spec/gce_client_spec.rb
 - spec/host_spec.rb
+- spec/role_data_spec.rb
 - spec/spec_helper.rb
 - terraform.tf
 homepage: https://github.com/sonots/gce-host
@@ -236,5 +237,6 @@ summary: Search hosts on GCP GCE
 test_files:
 - spec/gce_client_spec.rb
 - spec/host_spec.rb
+- spec/role_data_spec.rb
 - spec/spec_helper.rb
 has_rdoc: