serverkit 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb2f4173299cf4eec3b5b1004d1f006c0d211e0
-  data.tar.gz: 851e865ea88715d4eeaf697a7c053e6a5500b379
+  metadata.gz: 10080848f2805e6c3836073587e6be22407c01e6
+  data.tar.gz: 0867ac71a5aa865f8448aa12afbb513ed7c99db8
 SHA512:
-  metadata.gz: 23cb9453fdd628b6b87448b94a075826ca9d14367e2fe49b17d237cff832665a9b9be0fc90d112883da2e494772292516327e6d41aeffb1955f33e9b7b819b65
-  data.tar.gz: 12382244676a0ea0749f9f15577352cfd3ab9df973393d7a970ae7facdc1a3f942d875830ca092d5c62dab9e0f976d65fdd7eda05785901f616aaa404cc39424
+  metadata.gz: d69a3bf329a1cad28e178f10a3767aac3c2b2b03dbb6b431d71827e8883e9628e0543ca4e7633dc9e80a32a9c206cfad4f8d5466e480f68036a70bb04b5ac649
+  data.tar.gz: 353146a60c1c4fe93439b205bba7750073459ffdcdd891ecfaa2f165bfddacab863692d2eb041d667c5caa22c18ee7b925ea9cb2f78f82db5a5ef3af1571d93a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.4
+- Support ERB recipe and variables injection
+
 ## 0.0.3
 - Support JSON, executable, and directory recipe
 - Support service resource experimentally

data/README.md

@@ -1,5 +1,5 @@
 # Serverkit [![Build Status](https://travis-ci.org/r7kamura/serverkit.svg)](https://travis-ci.org/r7kamura/serverkit) [![Code Climate](https://codeclimate.com/github/r7kamura/serverkit/badges/gpa.svg)](https://codeclimate.com/github/r7kamura/serverkit)
-Configuration management toolkit for your infrastructure.
+Configuration management toolkit for IT automation.
 
 ## Usage
 This gem provides `serverkit` executable with 3 actions.
@@ -14,29 +14,49 @@ serverkit apply --recipe=recipe.yml
 ```
 
 ## Recipe
-A recipe is the most fundamental configuration which defines the desired state of your server.
+A recipe describes the desired state of your server.
 It is mostly a collection of resources, defined using certain patterns.
 
 ### Format
-A recipe can be specified as a path to one of:
+A recipe can be specified as a path to one of the following patterns:
 
 - JSON file
 - YAML file named with \*.yaml or \*.yml
+- ERB file named with \*.json.erb or \*.yml.erb
 - Executable to output JSON
 - Directory including recipe files recursively
 
 ```sh
-serverkit apply --recipe=recipe.yml
-serverkit apply --recipe=recipe.json
 serverkit apply --recipe=recipe
+serverkit apply --recipe=recipe.json
+serverkit apply --recipe=recipe.json.erb
+serverkit apply --recipe=recipe.json.erb --variables=variables
+serverkit apply --recipe=recipe.json.erb --variables=variables.json
+serverkit apply --recipe=recipe.json.erb --variables=variables.json.erb
+serverkit apply --recipe=recipe.json.erb --variables=variables.yml
+serverkit apply --recipe=recipe.json.erb --variables=variables.yml.erb
+serverkit apply --recipe=recipe.yml
+serverkit apply --recipe=recipe.yml.erb
 serverkit apply --recipe=recipes/
 ```
 
+### Variables
+When using ERB recipe, you can also give optional variables file
+that defines configurations in a Hash object for ERB template.
+It supports similar format variation with Recipe.
+In ERB template, you can refer given variables via `variables` method.
+
 ### Example
 This is an example recipe to install some packages, clone a git repository, and create a symlink.
 
 ```yaml
-# recipe.yml
+# variables.yml
+dotfiles_repository: r7kamura/dotfiles
+user: r7kamura
+```
+
+```yaml
+# recipe.yml.erb
 resources:
   - id: install_mysql
     type: package
@@ -46,12 +66,12 @@ resources:
     name: redis
   - id: clone_dotfiles
     type: git
-    repository: git@github.com:r7kamura/dotfiles.git
-    path: /Users/r7kamura/src/github.com/r7kamura/dotfiles
+    repository: git@github.com:<%= variables["dotfiles_repository"] %>.git
+    path: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_repository"] %>
   - id: symlink_zshrc
     type: symlink
-    source: /Users/r7kamura/.zshrc
-    destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
+    source: /Users/<%= variables["user"] %>/.zshrc
+    destination: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_repository"] %>/.zshrc
 ```
 
 ## Resource
@@ -73,7 +93,7 @@ An example package resource that has id, type, and name attributes.
 
 ```yaml
 resources:
-  - id: install_mysql #   id attirbute (This resource is identified by this unique id)
+  - id: install_mysql # id attirbute (This resource is identified by this unique id)
     type: package     # type attribute (Serverkit::Resources::Package class is used for this)
     name: mysql       # name attribute (package resource requires name attribute)
 ```

data/{examples → example/recipes}/recipe.json

@@ -1,8 +1,4 @@
 {
-  "hosts": [
-    "localhost"
-  ],
-  "ssh": false,
   "resources": [
     {
       "id": "install_mysql",
@@ -35,14 +31,6 @@
       "type": "symlink",
       "source": "/Users/r7kamura/.zshrc",
       "destination": "/Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc"
-    },
-    {
-      "id": "put_zshrc",
-      "type": "file",
-      "source": "/Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc",
-      "destination": "/Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc",
-      "user": "r7kamura",
-      "group": "staff"
     }
   ]
-}
+}

data/{examples → example/recipes}/recipe.yml

@@ -1,6 +1,3 @@
-hosts:
-  - localhost
-ssh: false
 resources:
   - id: install_mysql
     type: homebrew
@@ -22,9 +19,3 @@ resources:
     type: symlink
     source: /Users/r7kamura/.zshrc
     destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
-  - id: put_zshrc
-    type: file
-    source: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
-    destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
-    user: r7kamura
-    group: staff

data/example/recipes/recipe.yml.erb

@@ -0,0 +1,21 @@
+resources:
+  - id: install_mysql
+    type: homebrew
+    name: mysql
+  - id: install_redis
+    type: homebrew
+    name: redis
+  - id: install_licecap
+    type: homebrew_cask
+    name: licecap
+  - id: install_alfred
+    type: homebrew_cask
+    name: alfred
+  - id: clone_dotfiles
+    type: git
+    repository: git@github.com:<%= variables["dotfiles_github_repository"] %>.git
+    path: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_github_repository"] %>
+  - id: symlink_zshrc
+    type: symlink
+    source: /Users/<%= variables["user"] %>/.zshrc
+    destination: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_github_repository"] %>/linked/.zshrc

data/example/variables/variables.yml

@@ -0,0 +1,2 @@
+dotfiles_github_repository: r7kamura/dotfiles
+user: r7kamura

data/lib/serverkit/actions/base.rb

@@ -1,5 +1,5 @@
+require "serverkit/loaders/recipe_loader"
 require "serverkit/recipe"
-require "serverkit/recipe_loader"
 require "specinfra"
 
 module Serverkit
@@ -18,21 +18,12 @@ module Serverkit
 
       # @return [Specinfra::Backend::Base]
       def backend
-        @backend ||= backend_class.new
-      end
-
-      # @return [Class]
-      def backend_class
-        if recipe.ssh?
-          Specinfra::Backend::Ssh
-        else
-          Specinfra::Backend::Exec
-        end
+        @backend ||= Specinfra::Backend::Exec.new
       end
 
       # @return [Serverkit::Recipe]
       def recipe
-        @recipe ||= RecipeLoader.new(@options[:recipe]).load
+        @recipe ||= Loaders::RecipeLoader.new(@options[:recipe], variables_path: @options[:variables]).load
       end
     end
   end

data/lib/serverkit/command.rb

@@ -69,6 +69,7 @@ module Serverkit
       @options ||= Slop.parse!(@argv) do
         banner "Usage: serverkit ACTION [options]"
         on "-r", "--recipe=", "Path to recipe file", required: true
+        on "--variables=", "Path to variables file for ERB recipe"
       end
     end
 

data/lib/serverkit/loaders/base_loader.rb

@@ -0,0 +1,130 @@
+require "erb"
+require "json"
+require "pathname"
+require "tempfile"
+require "yaml"
+
+module Serverkit
+  module Loaders
+    class BaseLoader
+      YAML_EXTNAMES = [".yaml", ".yml"]
+
+      # @param [String] path
+      def initialize(path)
+        @path = path
+      end
+
+      # @todo Rescue Error::ENOENT error
+      # @return [Serverkit::Recipe]
+      def load
+        case
+        when has_directory_path?
+          load_from_directory
+        when has_erb_path?
+          load_from_erb
+        else
+          loaded_class.new(load_data)
+        end
+      end
+
+      private
+
+      # @return [Binding]
+      def binding_for_erb
+        TOPLEVEL_BINDING
+      end
+
+      # @return [String]
+      def expand_erb
+        ERB.new(pathname.read).result(binding_for_erb)
+      end
+
+      # @return [String]
+      def expanded_erb_path_suffix
+        "." + pathname.basename(".erb").to_s.split(".", 2).last
+      end
+
+      # @note Memoizing to prevent GC
+      # @return [Tempfile]
+      def expanded_erb_tempfile
+        @expanded_erb_tempfile ||= Tempfile.new(["", expanded_erb_path_suffix]).tap do |tempfile|
+          tempfile << expand_erb
+          tempfile.close
+          tempfile
+        end
+      end
+
+      # @return [String]
+      def execute
+        `#{pathname}`
+      end
+
+      def has_directory_path?
+        pathname.directory?
+      end
+
+      def has_erb_path?
+        pathname.extname == ".erb"
+      end
+
+      def has_executable_path?
+        pathname.executable?
+      end
+
+      def has_yaml_path?
+        YAML_EXTNAMES.include?(pathname.extname)
+      end
+
+      # @return [Hash]
+      def load_data
+        case
+        when has_executable_path?
+          load_data_from_executable
+        when has_erb_path?
+          load_data_from_erb
+        when has_yaml_path?
+          load_data_from_yaml
+        else
+          load_data_from_json
+        end
+      end
+
+      # @return [Serverkit::Recipe]
+      def load_from_directory
+        loads_from_directory.inject(loaded_class.new, :merge)
+      end
+
+      # @return [Serverkit::Recipe]
+      def load_from_erb
+        self.class.new(expanded_erb_tempfile.path).load
+      end
+
+      # @return [Array<Serverkit::Recipe>]
+      def loads_from_directory
+        Dir.glob(pathname.join("*")).sort.flat_map do |path|
+          self.class.new(path).load
+        end
+      end
+
+      # @return [Hash]
+      def load_data_from_executable
+        JSON.parse(execute)
+      end
+
+      # @return [Hash]
+      def load_data_from_json
+        JSON.parse(pathname.read)
+      end
+
+      # @return [Hash]
+      def load_data_from_yaml
+        YAML.load_file(pathname)
+      end
+
+      # @return [Pathname]
+      def pathname
+        @pathname ||= Pathname.new(@path)
+      end
+    end
+  end
+end

data/lib/serverkit/loaders/recipe_loader.rb

@@ -0,0 +1,64 @@
+require "serverkit/loaders/base_loader"
+require "serverkit/loaders/variables_loader"
+require "serverkit/recipe"
+
+module Serverkit
+  module Loaders
+    class RecipeLoader < BaseLoader
+      DEFAULT_VARIABLES = {}
+
+      # @param [String] path
+      # @param [String, nil] variables_path
+      def initialize(path, variables_path: nil)
+        super(path)
+        @variables_path = variables_path
+      end
+
+      private
+
+      # @note Override
+      def binding_for_erb
+        ErbBindingContext.new(variables_data).binding
+      end
+
+      def has_variables_path?
+        !@variables_path.nil?
+      end
+
+      # @return [Serverkit::Variables]
+      def load_variables
+        Loaders::VariablesLoader.new(@variables_path).load
+      end
+
+      # @note Implementation
+      def loaded_class
+        Serverkit::Recipe
+      end
+
+      # @return [Hash]
+      def variables_data
+        @variables ||= begin
+          if has_variables_path?
+            load_variables.to_hash
+          else
+            DEFAULT_VARIABLES.dup
+          end
+        end
+      end
+
+      class ErbBindingContext
+        attr_reader :variables
+
+        # @param [hash] variables
+        def initialize(variables)
+          @variables = variables
+        end
+
+        # @note Change method visibility to public
+        def binding
+          super
+        end
+      end
+    end
+  end
+end

data/lib/serverkit/loaders/variables_loader.rb

@@ -0,0 +1,15 @@
+require "serverkit/loaders/base_loader"
+require "serverkit/variables"
+
+module Serverkit
+  module Loaders
+    class VariablesLoader < BaseLoader
+      private
+
+      # @note Implementation
+      def loaded_class
+        Serverkit::Variables
+      end
+    end
+  end
+end

data/lib/serverkit/recipe.rb

@@ -8,7 +8,6 @@ require "serverkit/resources/homebrew"
 require "serverkit/resources/homebrew_cask"
 require "serverkit/resources/service"
 require "serverkit/resources/symlink"
-require "yaml"
 
 module Serverkit
   class Recipe
@@ -60,11 +59,6 @@ module Serverkit
       end
     end
 
-    # @return [true, false] Flag to use SSH (default: true)
-    def ssh?
-      @recipe_data["ssh"] != false
-    end
-
     def valid?
       errors.empty?
     end

data/lib/serverkit/variables.rb

@@ -0,0 +1,31 @@
+require "active_support/core_ext/hash/deep_merge"
+
+module Serverkit
+  class Variables
+    attr_reader :variables_data
+
+    # @param [Hash] variables_data
+    def initialize(variables_data = {})
+      @variables_data = variables_data
+    end
+
+    # @param [Serverkit::Variables] variables
+    # @return [Serverkit::Variables]
+    def merge(variables)
+      self.class.new(
+        variables_data.deep_merge(variables.variables_data) do |key, a, b|
+          if a.is_a?(Array)
+            a | b
+          else
+            b
+          end
+        end
+      )
+    end
+
+    # @return [Hash]
+    def to_hash
+      @variables_data.dup
+    end
+  end
+end

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/serverkit.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Serverkit::VERSION
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
-  spec.summary       = "Configuration management toolkit for your infrastructure."
+  spec.summary       = "Configuration management toolkit for IT automation."
   spec.homepage      = "https://github.com/r7kamura/serverkit"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -154,9 +154,11 @@ files:
 - README.md
 - Rakefile
 - bin/serverkit
-- examples/recipe.json
-- examples/recipe.rb
-- examples/recipe.yml
+- example/recipes/recipe.json
+- example/recipes/recipe.rb
+- example/recipes/recipe.yml
+- example/recipes/recipe.yml.erb
+- example/variables/variables.yml
 - lib/readable_validator.rb
 - lib/required_validator.rb
 - lib/serverkit.rb
@@ -168,8 +170,10 @@ files:
 - lib/serverkit/errors/base.rb
 - lib/serverkit/errors/invalid_recipe_type.rb
 - lib/serverkit/errors/invalid_resources_type.rb
+- lib/serverkit/loaders/base_loader.rb
+- lib/serverkit/loaders/recipe_loader.rb
+- lib/serverkit/loaders/variables_loader.rb
 - lib/serverkit/recipe.rb
-- lib/serverkit/recipe_loader.rb
 - lib/serverkit/resources/base.rb
 - lib/serverkit/resources/file.rb
 - lib/serverkit/resources/git.rb
@@ -178,6 +182,7 @@ files:
 - lib/serverkit/resources/package.rb
 - lib/serverkit/resources/service.rb
 - lib/serverkit/resources/symlink.rb
+- lib/serverkit/variables.rb
 - lib/serverkit/version.rb
 - lib/type_validator.rb
 - serverkit.gemspec
@@ -204,6 +209,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Configuration management toolkit for your infrastructure.
+summary: Configuration management toolkit for IT automation.
 test_files: []
 has_rdoc: 

data/lib/serverkit/recipe_loader.rb

@@ -1,79 +0,0 @@
-require "json"
-
-module Serverkit
-  class RecipeLoader
-    YAML_EXTNAMES = [".yaml", ".yml"]
-
-    # @param [String] path
-    def initialize(path)
-      @path = path
-    end
-
-    # @todo Care Error::ENOENT error
-    # @return [Serverkit::Recipe]
-    def load
-      if has_directory_path?
-        load_recipe_from_directory
-      else
-        Recipe.new(load_data)
-      end
-    end
-
-    private
-
-    # @return [String] This executable must print reicpe in JSON format into standard output
-    def execute
-      `#{@path}`
-    end
-
-    # @return [String]
-    def extname
-      @extname ||= File.extname(@path)
-    end
-
-    def has_directory_path?
-      File.directory?(@path)
-    end
-
-    def has_executable_path?
-      File.executable?(@path)
-    end
-
-    def has_yaml_path?
-      YAML_EXTNAMES.include?(extname)
-    end
-
-    def load_data
-      case
-      when has_executable_path?
-        load_data_from_executable
-      when has_yaml_path?
-        load_data_from_yaml
-      else
-        load_data_from_json
-      end
-    end
-
-    def load_recipe_from_directory
-      load_recipes_from_directory.inject(Recipe.new, :merge)
-    end
-
-    def load_recipes_from_directory
-      Dir.glob(File.join(@path, "*")).sort.flat_map do |path|
-        self.class.new(path).load
-      end
-    end
-
-    def load_data_from_executable
-      JSON.parse(execute)
-    end
-
-    def load_data_from_json
-      JSON.parse(File.read(@path))
-    end
-
-    def load_data_from_yaml
-      YAML.load_file(@path)
-    end
-  end
-end