kondate 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38160e964f7ea99cbd0bc387cc9309c27c3a442e
-  data.tar.gz: 1ea9ea5b11e0e70d80f1894c682c0cd156dcbcba
+  metadata.gz: e27ee012dcd65e359a123934dacca0609013fbad
+  data.tar.gz: 9f8ccc65a962d95e60836256546f015d9d78e809
 SHA512:
-  metadata.gz: 3c1385a0f8868aea7ce912b88cb36576d23fefc3e8a7f6347fa66f0653a495b35f30d456b72a3b810ab397b3f6a19d57bf91084f674e593783bba89b0190015d
-  data.tar.gz: d7eadd64d34d4842561a4e5659a07048da0574740688a6d939d2d8efc6fa7e0066b9a70fd9b1558b568ca901245e17d7d99c1ef1dde2ccbae3de99a9a8c34794
+  metadata.gz: c6cbc270b4b074b9738edece8ccaa6f759729533ae83b108e5ac5922c735a80fe5723ed1628426e09a92da3e2300f97fa4d6cbf231aff09532f5b5c0c3f072c1
+  data.tar.gz: 560015c973fcf3d17dbced58d7e37a825b4b5e412aa0af325d4c322c96307c03ba28e66858b9eea8b6c0b4fbe81183ae59ab909233b3f588f036739287d67f1d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.0 (2016-12-01)
+
+Enhancements:
+
+* Add a feature to explore possible role files
+
 # 0.3.3 (2016-11-20)
 
 Changes:

data/README.md

@@ -268,6 +268,28 @@ Configuring following lines for vagrant is also recommended:
 
 See [templates/spec/spec_helper.rb](./lib/kondate/templates/spec/spec_helper.rb) for an example.
 
+### Exploring role files
+
+Available version: >= v0.4.0
+
+Assume `role` is delimited with `-` (you can configure the delimiter) such as `myapp-web-staging`, this feature explores role files in order of:
+
+1. myapp-web-staging.yml
+1. myapp-web-base.yml
+1. myapp-web.yml
+1. myapp-base.yml
+1. myapp.yml
+1. base.yml
+
+This makes it possible to share a property file, for example, `myapp-web.yml` among `myapp-web-staging` and `myapp-web-production` roles.
+
+To enable this feature, you need to configure .kondate.conf as:
+
+```
+explore_role_files: true # default is false
+role_delimiter: "-" # default is -
+```
+
 ## Host Plugin
 
 The default reads `hosts.yml` to resolve roles of a host, but
@@ -312,12 +334,12 @@ module Kondate
         raise ConfigError.new('file: path is not configured') unless config.path
         @path = config.path
 
-        @roles_of = YAML.load_file(@path)
-        @hosts_of = {}
-        @roles_of.each do |host, roles|
+        @roles_of_host = YAML.load_file(@path)
+        @hosts_of_role = {}
+        @roles_of_host.each do |host, roles|
           roles.each do |role|
-            @hosts_of[role] ||= []
-            @hosts_of[role] << host
+            @hosts_of_role[role] ||= []
+            @hosts_of_role[role] << host
           end
         end
       end
@@ -331,7 +353,7 @@ module Kondate
       # @param [String] host hostname
       # @return [Array] array of roles
       def get_roles(host)
-        @roles_of[host]
+        @roles_of_host[host]
       end
 
       # @param [String] role role
@@ -339,7 +361,7 @@ module Kondate
       #
       # Available from kondate >= 0.3.0
       def get_hosts(role)
-        @hosts_of[role]
+        @hosts_of_role[role]
       end
 
       # Optional

data/lib/kondate.rb

@@ -4,6 +4,8 @@ end
 
 require "kondate/version"
 require "kondate/config"
+require "kondate/role_file"
+require "kondate/property_file"
 require "kondate/property_builder"
 require "kondate/hash_ext"
 require "kondate/string_util"

data/lib/kondate/cli.rb

@@ -56,14 +56,7 @@ module Kondate
     option :profile,                     :type => :string,  :default => nil, :desc => "[EXPERIMENTAL] Save profiling data", :banner => "PATH"
     option :recipe_graph,                :type => :string,  :default => nil, :desc => "[EXPERIMENTAL] Write recipe dependency graph in DOT", :banner => "PATH"
     def itamae(host)
-      property_files = build_property_files(host)
-      begin
-        if proceed?(property_files)
-          exit(-1) unless do_itamae(host, property_files)
-        end
-      ensure
-        clean_property_files(property_files)
-      end
+      with_host(host) {|property_files| do_itamae(host, property_files) }
     end
 
     desc "itamae-role <role>", "Execute itamae for multiple hosts in the role"
@@ -76,25 +69,7 @@ module Kondate
     option :recipe_graph,                 :type => :string,  :default => nil, :desc => "[EXPERIMENTAL] Write recipe dependency graph in DOT", :banner => "PATH"
     option :parallel, :aliases => ["-p"], :type => :numeric, :default => Facter['processorcount'].value.to_i 
     def itamae_role(role)
-      $stdout.puts "Number of parallels is #{@options[:parallel]}"
-      hosts = Kondate::Config.host_plugin.get_hosts(role)
-      if hosts.nil? or hosts.empty?
-        $stderr.puts 'No host'
-        exit(1)
-      end
-      $stdout.puts "Target hosts are [#{hosts.join(", ")}]"
-
-      property_files_of, summarized_property_files, hosts_of = build_property_files_of(hosts)
-      begin
-        if proceed?(summarized_property_files, hosts_of)
-          successes = Parallel.map(hosts, in_processes: @options[:parallel]) do |host|
-            do_itamae(host, property_files_of[host])
-          end
-          exit(-1) unless successes.all?
-        end
-      ensure
-        property_files_of.values.each {|property_files| clean_property_files(property_files) }
-      end
+      with_role(role) {|host, property_files| do_itamae(host, property_files) }
     end
 
     desc "serverspec <host>", "Execute serverspec"
@@ -104,14 +79,7 @@ module Kondate
     option :confirm,                     :type => :boolean, :default => true
     option :vagrant,                     :type => :boolean, :default => false
     def serverspec(host)
-      property_files = build_property_files(host)
-      begin
-        if proceed?(property_files)
-          exit(-1) unless do_serverspec(host, property_files)
-        end
-      ensure
-        clean_property_files(property_files)
-      end
+      with_host(host) {|property_files| do_serverspec(host, property_files) }
     end
 
     desc "serverspec-role <role>", "Execute serverspec for multiple hosts in the role"
@@ -122,6 +90,24 @@ module Kondate
     option :vagrant,                      :type => :boolean, :default => false
     option :parallel, :aliases => ["-p"], :type => :numeric, :default => Facter['processorcount'].value.to_i 
     def serverspec_role(role)
+      with_role(role) {|host, property_files| do_serverspec(host, property_files) }
+    end
+
+    private
+
+    def with_host(host, &block)
+      property_files = build_property_files(host)
+      begin
+        print_property_files(property_files)
+        if proceed?(property_files)
+          exit(-1) unless yield(property_files)
+        end
+      ensure
+        clean_property_files(property_files)
+      end
+    end
+
+    def with_role(role, &block)
       $stdout.puts "Number of parallels is #{@options[:parallel]}"
       hosts = Kondate::Config.host_plugin.get_hosts(role)
       if hosts.nil? or hosts.empty?
@@ -130,21 +116,20 @@ module Kondate
       end
       $stdout.puts "Target hosts are [#{hosts.join(", ")}]"
 
-      property_files_of, summarized_property_files, hosts_of = build_property_files_of(hosts)
+      property_files_of_host, summarized_property_files, hosts_of_role = build_property_files_of_host(hosts)
       begin
-        if proceed?(summarized_property_files, hosts_of)
+        print_property_files(summarized_property_files, hosts_of_role)
+        if proceed?(summarized_property_files)
           successes = Parallel.map(hosts, in_processes: @options[:parallel]) do |host|
-            do_serverspec(host, property_files_of[host])
+            yield(host, property_files_of_host[host])
           end
           exit(-1) unless successes.all?
         end
       ensure
-        property_files_of.values.each {|files| clean_property_files(files) }
+        property_files_of_host.values.each {|property_files| clean_property_files(property_files) }
       end
     end
 
-    private
-
     def do_itamae(host, property_files)
       env = {}
       env['RUBYOPT'] = "-I #{Config.plugin_dir} -r bundler/setup -r ext/itamae/kondate"
@@ -153,7 +138,7 @@ module Kondate
         command = "bundle exec itamae ssh"
         command << " -h #{host}"
 
-        properties = YAML.load_file(property_file)
+        properties = property_file.load
 
         if @options[:vagrant]
           command << " --vagrant"
@@ -164,7 +149,7 @@ module Kondate
           command << " -p #{properties['ssh_port'] || config[:port] || 22}"
         end
 
-        command << " -y #{property_file}"
+        command << " -y #{property_file.path}"
         command << " -l=debug" if @options[:debug]
         command << " --dry-run" if @options[:dry_run]
         command << " --profile=#{@options[:profile]}" if @options[:profile]
@@ -182,14 +167,14 @@ module Kondate
       env['RUBYOPT'] = "-I #{Config.plugin_dir} -r bundler/setup -r ext/serverspec/kondate"
       property_files.each do |role, property_file|
         next if property_file.nil?
-        recipes = YAML.load_file(property_file)['attributes'].keys.map {|recipe|
-          File.join(Config.middleware_recipes_serverspec_dir, recipe)
+        spec_files = property_file.load['attributes'].keys.map {|recipe|
+          File.join(Config.middleware_recipes_serverspec_dir, "#{recipe}_spec.rb")
         }.compact
-        recipes << File.join(Config.roles_recipes_serverspec_dir, role)
-        spec_files = recipes.map {|recipe| "#{recipe}_spec.rb"}.select! {|spec| File.exist?(spec) }
+        spec_files << RoleFile.explore(Config.roles_recipes_serverspec_dir, role, "_spec.rb")
+        spec_files.select! {|spec| File.exist?(spec) }
 
         env['TARGET_HOST'] = host
-        env['TARGET_NODE_FILE'] = property_file
+        env['TARGET_NODE_FILE'] = property_file.path
         command = "bundle exec rspec #{spec_files.map{|f| f.shellescape }.join(' ')}"
         $stdout.puts "env #{env.map {|k, v| "#{k}=#{v.shellescape}" }.join(' ')} #{command}"
         return false unless system(env, command)
@@ -197,8 +182,7 @@ module Kondate
       true
     end
 
-    def proceed?(property_files, hosts_of = {})
-      print_property_files(property_files, hosts_of)
+    def proceed?(property_files)
       if property_files.values.compact.empty?
         $stderr.puts "Nothing to run"
         false
@@ -210,7 +194,7 @@ module Kondate
       end
     end
 
-    def print_property_files(property_files, hosts_of = {})
+    def print_property_files(property_files, hosts_of_role = {})
       roles = property_files.keys
       if roles.nil? or roles.empty?
         $stderr.puts 'No role'
@@ -219,17 +203,18 @@ module Kondate
       $stdout.puts "Show property files for roles: [#{roles.join(", ")}]"
 
       property_files.each do |role, property_file|
-        hosts = hosts_of[role]
+        hosts = hosts_of_role[role]
         if hosts.nil? # itamae
           $stdout.print "Show property file for role: #{role}"
         else # itamae_role
           $stdout.print "Show representative property file for role: #{role}"
-          $stdout.print " [#{hosts.join(", ")}]"
+          $stdout.print " hosts: [#{hosts.join(", ")}]"
         end
+        $stdout.print ", sources: #{property_file.source_files}"
 
         if property_file
           $stdout.puts
-          $stdout.puts mask_secrets(File.read(property_file))
+          $stdout.puts property_file.read
         else
           $stdout.puts " (no attribute, skipped)"
         end
@@ -249,8 +234,8 @@ module Kondate
 
       property_files = {}
       roles.each do |role|
-        if path = builder.install(role, @options[:recipe])
-          property_files[role] = path
+        if property_file = builder.install(role, @options[:recipe])
+          property_files[role] = property_file
         else
           property_files[role] = nil
         end
@@ -259,22 +244,17 @@ module Kondate
       property_files
     end
 
-    def build_property_files_of(hosts)
+    def build_property_files_of_host(hosts)
       summarized_property_files = {}
-      property_files_of = {}
-      hosts_of = {}
+      property_files_of_host = {}
+      hosts_of_role = {}
       hosts.each do |host|
         property_files = build_property_files(host)
-        property_files_of[host] = property_files
-        property_files.each {|role, path| summarized_property_files[role] ||= path }
-        property_files.each {|role, path| (hosts_of[role] ||= []) << host }
+        property_files_of_host[host] = property_files
+        property_files.each {|role, property_file| summarized_property_files[role] ||= property_file }
+        property_files.each {|role, property_file| (hosts_of_role[role] ||= []) << host }
       end
-      [property_files_of, summarized_property_files, hosts_of]
-    end
-
-    def mask_secrets(str)
-      str.gsub(/(.*key[^:]*): (.*)$/, '\1: *******').
-        gsub(/(.*password[^:]*): (.*)$/, '\1: *******')
+      [property_files_of_host, summarized_property_files, hosts_of_role]
     end
   end
 end

data/lib/kondate/config.rb

@@ -88,6 +88,14 @@ module Kondate
         config[:secret_environments_properties_dir] || 'secrets/properties/environments'
       end
 
+      def explore_role_files?
+        !config[:explore_role_files].nil?
+      end
+
+      def role_delimiter
+        config[:role_delimiter] || '-'
+      end
+
       def plugin_dir
         File.expand_path(config[:plugin_dir] || 'lib')
       end

data/lib/kondate/host_plugin/file.rb

@@ -13,12 +13,12 @@ module Kondate
         raise ConfigError.new('file: path is not configured') unless config.path
         @path = config.path
 
-        @roles_of = YAML.load_file(@path)
-        @hosts_of = {}
-        @roles_of.each do |host, roles|
+        @roles_of_host = YAML.load_file(@path)
+        @hosts_of_role = {}
+        @roles_of_host.each do |host, roles|
           roles.each do |role|
-            @hosts_of[role] ||= []
-            @hosts_of[role] << host
+            @hosts_of_role[role] ||= []
+            @hosts_of_role[role] << host
           end
         end
       end
@@ -32,7 +32,7 @@ module Kondate
       # @param [String] host hostname
       # @return [Array] array of roles
       def get_roles(host)
-        @roles_of[host]
+        @roles_of_host[host]
       end
 
       # @param [String] role role
@@ -40,7 +40,7 @@ module Kondate
       #
       # Available from kondate >= 0.3.0
       def get_hosts(role)
-        @hosts_of[role]
+        @hosts_of_role[role]
       end
     end
   end

data/lib/kondate/property_builder.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'tempfile'
+require_relative 'property_file'
 
 module Kondate
   class PropertyBuilder
@@ -49,8 +50,9 @@ module Kondate
       if roles.empty? # maybe, development (vagrant) env
         @roles = filters # append specified roles
         @roles.each do |role|
-          unless File.exist?(role_file(role))
-            $stderr.puts "#{role_file(role)} does not exist, possibly typo?"
+          file = role_file(role)
+          unless File.exist?(file)
+            $stderr.puts "#{file} does not exist, possibly typo?"
             exit(1)
           end
         end
@@ -76,11 +78,11 @@ module Kondate
     end
 
     def role_file(role)
-      File.join(Config.roles_properties_dir, "#{role}.yml")
+      RoleFile.explore(Config.roles_properties_dir, role, ".yml")
     end
 
     def secret_role_file(role)
-      File.join(Config.secret_roles_properties_dir, "#{role}.yml")
+      RoleFile.explore(Config.secret_roles_properties_dir, role, ".yml")
     end
 
     def environment_file(environment)
@@ -105,25 +107,24 @@ module Kondate
     #
     # This file is automatically created and removed
     def install(role, filter_recipes = nil)
-      node_property               = get_content(node_file)
-      secret_node_property        = get_content(secret_node_file)
-      role_property               = get_content(role_file(role))
-      secret_role_property        = get_content(secret_role_file(role))
-      environment_property        = get_content(environment_file(environment))
-      secret_environment_property = get_content(secret_environment_file(environment))
+      files = [
+        environment_file(environment),
+        secret_environment_file(environment),
+        role_file(role),
+        secret_role_file(role),
+        node_file,
+        secret_node_file,
+      ].compact.select {|f| File.readable?(f) }
 
       property = HashExt.new.deep_merge!({
         'environment' => environment,
         'role'        => role,
         'roles'       => roles,
         'hostinfo'    => hostinfo,
-      }).
-      deep_merge!(environment_property).
-      deep_merge!(secret_environment_property).
-      deep_merge!(role_property).
-      deep_merge!(secret_role_property).
-      deep_merge!(node_property).
-      deep_merge!(secret_node_property).to_h
+      })
+      files.each do |file|
+        property.deep_merge!(get_content(file))
+      end
       property['attributes'] ||= {}
 
       # filter out the recipe
@@ -137,9 +138,9 @@ module Kondate
         nil
       else
         fp = Tempfile.create("kondate_")
-        YAML.dump(property, fp)
+        YAML.dump(property.to_h, fp)
         fp.close
-        fp.path
+        PropertyFile.new(fp.path, files)
       end
     end
   end

data/lib/kondate/property_file.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module Kondate
+  class PropertyFile
+    attr_reader :path, :source_files
+
+    def initialize(path, source_files)
+      @path = path
+      @source_files = source_files
+    end
+
+    def read
+      mask_secrets(File.read(path))
+    end
+
+    def load
+      YAML.load_file(path)
+    end
+
+    private
+
+    def mask_secrets(str)
+      str.gsub(/(.*key[^:]*): (.*)$/, '\1: *******').
+        gsub(/(.*password[^:]*): (.*)$/, '\1: *******')
+    end
+  end
+end

data/lib/kondate/role_file.rb

@@ -0,0 +1,60 @@
+require_relative 'config'
+
+module Kondate
+  class RoleFile
+    attr_reader :dir, :role, :ext
+
+    def self.explore(dir, role, ext = nil)
+      self.new(dir, role, ext).explore
+    end
+
+    def initialize(dir, role, ext = nil)
+      @dir = dir
+      @role = role
+      @ext = ext
+    end
+
+    # Returns readable role file exploring possible role files. For example,
+    # if `role` is `myapp-web-staging`, this method explores files as
+    #
+    # 1. myapp-web-staging.yml
+    # 1. myapp-web-base.yml
+    # 1. myapp-web.yml
+    # 1. myapp-base.yml
+    # 1. myapp.yml
+    # 1. base.yml
+    #
+    # @return [String] detected file path or last candidate path
+    def explore
+      paths = if Config.explore_role_files?
+                possible_paths
+              else
+                [get_path]
+              end
+      paths.find {|path| File.readable?(path) } || paths.last
+    end
+
+    private
+
+    def get_path(role = nil)
+      "#{File.join(dir, role || @role)}#{ext}"
+    end
+
+    def possible_paths
+      possible_roles.map {|role| get_path(role) }
+    end
+
+    def possible_roles
+      parts = role.split('-')
+      roles = []
+      roles << 'base'
+      roles << parts.shift
+      parts.each do |part|
+        last = roles.last
+        roles << "#{last}-base"
+        roles << "#{last}-#{part}"
+      end
+      roles
+    end
+  end
+end

data/lib/kondate/templates/.kondate.conf

@@ -9,6 +9,8 @@ environments_properties_dir: properties/environments
 secret_nodes_properties_dir: secrets/properties/nodes
 secret_roles_properties_dir: secrets/properties/roles
 secret_environments_properties_dir: secrets/properties/environments
+explore_role_files: true
+role_delimiter: "-"
 plugin_dir: lib
 host_plugin:
   type: file

data/lib/kondate/templates/bootstrap.rb

@@ -5,6 +5,7 @@ recipes = node['attributes'].keys
 recipes.each do |recipe|
   include_recipe(File.join(Kondate::Config.middleware_recipes_dir, recipe, "default.rb"))
 end
-if File.exist?(File.join(Kondate::Config.roles_recipes_dir, node[:role], "default.rb"))
-  include_recipe(File.join(Kondate::Config.roles_recipes_dir, node[:role], "default.rb"))
+role_recipe = Kondate::RoleFile.explore(Kondate::Config.roles_recipes_dir, node[:role], "#{File::SEPARATOR}default.rb")
+if File.exist?(role_recipe)
+  include_recipe(role_recipe)
 end

data/lib/kondate/version.rb

@@ -1,3 +1,3 @@
 module Kondate
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kondate
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - sonots
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: itamae
@@ -177,6 +177,8 @@ files:
 - lib/kondate/host_plugin/base.rb
 - lib/kondate/host_plugin/file.rb
 - lib/kondate/property_builder.rb
+- lib/kondate/property_file.rb
+- lib/kondate/role_file.rb
 - lib/kondate/string_util.rb
 - lib/kondate/templates/.kondate.conf
 - lib/kondate/templates/bootstrap.rb