kondate 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38db840e774d8575edff8aa3dbbd3d90d46e9dbb
-  data.tar.gz: 4988f05f9ff465ead90e59abc233c6101f46d0f7
+  metadata.gz: bfe91929a45399f7e8a221f3fb5e213e397c08ec
+  data.tar.gz: 6b9b197d8d7c53862c9df96a01c15ab88ac95775
 SHA512:
-  metadata.gz: dcfa3c75c22e6915c0fe3f234b9c1046476ebcf311a346e5f029eeb9fb9722f63d0f8862513af02147127ab8eadf0920660a9ebfe9c4786967bc9d73d7fea988
-  data.tar.gz: 9caa081558c981e425fbb34d567b7be60bc1ccd7e7dd2f7a60c5951ad0e7c1eec07ec821ff920f729376bebd257a26d4680c24759ab6523036f7e05bdf577d40
+  metadata.gz: 600de96b908537679071fd2aa4fa1a44c6e843834118ebb89f50b02106e021662e4f49cda5bc7c44e39ca145cf938370181a13daa246ce5d98cbb9db1a8b4c0d
+  data.tar.gz: c624cf7f23eda9397538da28ebf161dbcc36236745112db1395112f6f27ca88e84344f213e4a029a65c28ef8b2d9a75dc7f2001ad2f60ed1a034964fab647358

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.1.2 (2015/11/24)
+
+Enhancments:
+
+* Support environments properties.
+
 # 0.1.1 (2015/11/24)
 
 Changes:

data/README.md

@@ -47,25 +47,26 @@ $ bundle exec kondate serverspec <host>
 ```
 .
 ├── .kondate.conf     # kondate configuration
-├── bootstrap.rb    # itamae bootstrap
-├── hosts.yml       # manages hostnames and its roles
-├── properties      # manages run_lists and attributes
-│   ├── nodes       # host specific properties
-│   └── roles       # role properties
-│       └── sample.yml
-├── secrets         # manages secrets attributes such as passwords
+├── bootstrap.rb      # itamae bootstrap
+├── hosts.yml         # manages hostnames and its roles
+├── properties        # manages run_lists and attributes
+│   ├── nodes         # host specific properties
+│   ├── roles         # role properties
+│   └── environments  # environment properties
+├── secrets           # manages secrets attributes such as passwords
 │   └── properties
 │       ├── nodes
-│       └── roles
-├── recipes         # itamae recipes
-│   ├── middleware  # middleware recipes
+│       ├── roles
+│       └── environments
+├── recipes           # itamae recipes
+│   ├── middleware    # middleware recipes
 │   │   └── base
 │   │       └── default.rb
-│   └── roles       # role recipes
-└── spec            # serverspec specs
-    ├── middleware  # middleware recipes specs
+│   └── roles         # role recipes
+└── spec              # serverspec specs
+    ├── middleware    # middleware recipes specs
     │   └── base_spec.rb
-    ├─  roles       # role recipes specs
+    ├─  roles         # role recipes specs
     └── spec_helper.rb
 ```
 
@@ -80,8 +81,10 @@ middleware_recipes_serverspec_dir: spec/middleware
 roles_recipes_serverspec_dir: spec/roles
 nodes_properties_dir: properties/nodes
 roles_properties_dir: properties/roles
+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
 plugin_dir: lib
 host_plugin:
   type: file
@@ -117,10 +120,10 @@ You can create your own host plugin. See `Host Plugin` section for more details.
 Property files are places to write recipes to run and attributes values.
 
 ```
-├── properties      # manages run_lists and attributes
-│   ├── nodes       # host specific properties
-│   └── roles       # role properties
-│       └── sample.yml
+├── properties        # manages run_lists and attributes
+│   ├── nodes         # host specific properties
+│   ├── roles         # role properties
+│   └── environments  # environment properties
 ```
 
 An example looks like below:
@@ -141,7 +144,7 @@ attributes:
 
 The attributes variables are accessible like `attrs['rbenv']['versions']` in recipes, which is equivalent and short version of `node['attributes']['rbenv']['versions']`.
 
-You can also prepare a host-specific property file such as:
+You can also prepare host-specific property files such as:
 
 properties/nodes/#{host}.yml
 
@@ -151,7 +154,19 @@ attributes:
     worker_processes: 8
 ```
 
-These files are merged on kondate execution in order of `role` + `node` (`node` file overwrites `role` file).
+In addition, you can also prepare environment property files such as:
+
+properties/environments/development.yml
+
+```
+attributes:
+  global:
+    aws_region: ap-northeast-1
+```
+
+The `global` is a reserved name, the `global` is used to only store global attributes, and do not run `global` recipe.
+
+These files are merged on kondate execution in order of `environment` + `role` + `node` (`node` > `role` > `environment` in the strong order).
 
 ### secret properties
 
@@ -161,7 +176,8 @@ Secret properties are places to write confidential attributes.
 ├── secrets         # manages secrets attributes such as passwords
 │   └── properties
 │       ├── nodes
-│       └── roles
+│       ├── roles
+│       └── environments
 ```
 
 An example looks like below:
@@ -250,21 +266,28 @@ require 'yaml'
 
 module Kondate
   module HostPlugin
-    class File
+    # YAML format
+    #
+    # host1: [role1, role2]
+    # host2: [role1, role2]
+    class File < Base
       # @param [HashWithIndifferentAccess] config
       def initialize(config)
+        super
         raise ConfigError.new('file: path is not configured') unless config.path
         @path = config.path
       end
 
+      # @param [String] host hostname
+      # @return [String] environment name
+      def get_environment(host)
+        ENV['ENVIRONMENT']
+      end
+
       # @param [String] host hostname
       # @return [Array] array of roles
       def get_roles(host)
-        # YAML format
-        #
-        # host1: [role1, role2]
-        # host2: [role1, role2]
-        YAML.load_file(@path)[host]
+        YAML.load_file(@path)[host]['roles']
       end
     end
   end

data/lib/kondate.rb

@@ -8,3 +8,4 @@ require "kondate/property_builder"
 require "kondate/hash_ext"
 require "kondate/string_util"
 require "kondate/error"
+require "kondate/host_plugin/base"

data/lib/kondate/cli.rb

@@ -34,6 +34,7 @@ module Kondate
       templates_dir = File.join(Kondate::ROOT, 'lib', 'kondate', 'templates')
       templates_dir_length = templates_dir.length
       Find.find(templates_dir).select {|f| File.file?(f) }.each do |src|
+        next if File.basename(src) == '.gitkeep'
         dst = File.join(target_dir, src[templates_dir_length+1 .. -1])
         dst_dir = File.dirname(dst)
         unless Dir.exist?(dst_dir)
@@ -94,8 +95,9 @@ module Kondate
 
           ENV['TARGET_NODE_FILE'] = property_file
           recipes = YAML.load_file(property_file)['attributes'].keys.map {|recipe|
+            next if recipe == 'global'
             File.join(Config.middleware_recipes_serverspec_dir, recipe)
-          }
+          }.compact
           recipes << File.join(Config.roles_recipes_serverspec_dir, role)
           t.pattern = '{' + recipes.join(',') + '}_spec.rb'
         end

data/lib/kondate/config.rb

@@ -41,8 +41,10 @@ module Kondate
           'roles_recipes_serverspec_dir' => roles_recipes_serverspec_dir,
           'nodes_properties_dir' => nodes_properties_dir,
           'roles_properties_dir' => roles_properties_dir,
+          'environments_properties_dir' => environments_properties_dir,
           'secret_nodes_properties_dir' => secret_nodes_properties_dir,
           'secret_roles_properties_dir' => secret_roles_properties_dir,
+          'secret_environments_properties_dir' => secret_environments_properties_dir,
         }
       end
 
@@ -70,6 +72,10 @@ module Kondate
         config[:roles_properties_dir] || 'properties/roles'
       end
 
+      def environments_properties_dir
+        config[:environments_properties_dir] || 'properties/environments'
+      end
+
       def secret_nodes_properties_dir
         config[:secret_nodes_properties_dir] || 'secrets/properties/nodes'
       end
@@ -78,6 +84,10 @@ module Kondate
         config[:secret_roles_properties_dir] || 'secrets/properties/roles'
       end
 
+      def secret_environments_properties_dir
+        config[:secret_environments_properties_dir] || 'secrets/properties/environments'
+      end
+
       def plugin_dir
         File.expand_path(config[:plugin_dir] || 'lib')
       end

data/lib/kondate/host_plugin/base.rb

@@ -0,0 +1,24 @@
+module Kondate
+  module HostPlugin
+    class Base
+      attr_reader :config
+
+      # @param [HashWithIndifferentAccess] config
+      def initialize(config)
+        @config = config
+      end
+
+      # @param [String] host hostname
+      # @return [String] environment name
+      def get_environment(host)
+        ENV['ENVIRONMENT']
+      end
+
+      # @param [String] host hostname
+      # @return [Array] array of roles
+      def get_roles(host)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/kondate/host_plugin/file.rb

@@ -2,17 +2,27 @@ require 'yaml'
 
 module Kondate
   module HostPlugin
-    class File
+    # YAML format
+    #
+    # host1: [role1, role2]
+    # host2: [role1, role2]
+    class File < Base
+      # @param [HashWithIndifferentAccess] config
       def initialize(config)
+        super
         raise ConfigError.new('file: path is not configured') unless config.path
         @path = config.path
       end
 
+      # @param [String] host hostname
+      # @return [String] environment name
+      def get_environment(host)
+        ENV['ENVIRONMENT']
+      end
+
+      # @param [String] host hostname
+      # @return [Array] array of roles
       def get_roles(host)
-        # YAML format
-        #
-        # host1: [role1, role2]
-        # host2: [role1, role2]
         YAML.load_file(@path)[host]
       end
     end

data/lib/kondate/property_builder.rb

@@ -9,6 +9,16 @@ module Kondate
       @host = host
     end
 
+    def environment
+      @environment ||=
+        begin
+          vagrant? ? '' : Config.host_plugin.get_environment(@host)
+        rescue => e
+          $stderr.puts "cannot get environment from host:#{@host}, #{e.class} #{e.message}"
+          ''
+        end
+    end
+
     def roles
       @roles ||=
         begin
@@ -58,6 +68,14 @@ module Kondate
       File.join(Config.secret_roles_properties_dir, "#{role}.yml")
     end
 
+    def environment_file(environment)
+      File.join(Config.environments_properties_dir, "#{environment}.yml")
+    end
+
+    def secret_environment_file(environment)
+      File.join(Config.secret_environments_properties_dir, "#{environment}.yml")
+    end
+
     def get_content(yaml_file)
       content = File.exist?(yaml_file) ? YAML.load_file(yaml_file) : {}
       content.is_a?(Hash) ? content : {}
@@ -69,16 +87,22 @@ 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))
+      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))
 
       property = HashExt.new.deep_merge!({
-        'role'  => role,
-        'roles' => roles,
-        'attributes' => {},
-      }).deep_merge!(role_property).
+        'environment' => environment,
+        'role'        => role,
+        'roles'       => roles,
+        'attributes'  => {},
+      }).
+      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
@@ -93,7 +117,7 @@ module Kondate
       if property['attributes'].empty?
         nil
       else
-        Tempfile.open("provisioning_") do |fp|
+        Tempfile.open("kondate_") do |fp|
           YAML.dump(property, fp)
         end.path
       end

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

@@ -5,8 +5,10 @@ middleware_recipes_serverspec_dir: spec/middleware
 roles_recipes_serverspec_dir: spec/roles
 nodes_properties_dir: properties/nodes
 roles_properties_dir: properties/roles
+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
 plugin_dir: lib
 host_plugin:
   type: file

data/lib/kondate/templates/bootstrap.rb

@@ -3,6 +3,7 @@ require 'kondate'
 
 recipes = node['attributes'].keys
 recipes.each do |recipe|
+  next if recipe == 'global'
   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"))

data/lib/kondate/version.rb

@@ -1,3 +1,3 @@
 module Kondate
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kondate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - sonots
@@ -142,15 +142,24 @@ files:
 - lib/kondate/config.rb
 - lib/kondate/error.rb
 - lib/kondate/hash_ext.rb
+- lib/kondate/host_plugin/base.rb
 - lib/kondate/host_plugin/file.rb
 - lib/kondate/property_builder.rb
 - lib/kondate/string_util.rb
 - lib/kondate/templates/.kondate.conf
 - lib/kondate/templates/bootstrap.rb
 - lib/kondate/templates/hosts.yml
+- lib/kondate/templates/properties/environments/.gitkeep
+- lib/kondate/templates/properties/nodes/.gitkeep
 - lib/kondate/templates/properties/roles/sample.yml
 - lib/kondate/templates/recipes/middleware/base/default.rb
+- lib/kondate/templates/recipes/roles/.gitkeep
+- lib/kondate/templates/secrets/properties/environments/.gitkeep
+- lib/kondate/templates/secrets/properties/nodes/.gitkeep
+- lib/kondate/templates/secrets/properties/roles/.gitkeep
+- lib/kondate/templates/spec/middleware/.gitkeep
 - lib/kondate/templates/spec/middleware/base_spec.rb
+- lib/kondate/templates/spec/roles/.gitkeep
 - lib/kondate/templates/spec/spec_helper.rb
 - lib/kondate/version.rb
 homepage: https://github.com/sonots/kondate