serverkit 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40d5fe026687af52454bb4f3507ee76df5c24892
-  data.tar.gz: f5ff7864e5a727ee33b68bc66624b9bc338d1a6d
+  metadata.gz: 656a155cfa4b8c499bafcfdbda76075bb28d1570
+  data.tar.gz: adc66fb429d351629b872e61dcfc8ad2d11c40ce
 SHA512:
-  metadata.gz: 2fe05e953601daa2a7dbaa05151d4142e09f8ef588af30e9e600efe3dd179f45843dff9aae5f6c7dd69e0a09b0eb65c950b748f67d2c27ca5971c3453ca1b8cd
-  data.tar.gz: 198e7ee4550b9aa16ff52a57056073612be2dcd00cd85cad0e0545b62881591343356312e84b2abe0def220b7311b893dd8cf3279ac3e619a5e731a5263d4df2
+  metadata.gz: a21e147dcf7e37feae2c6eec67242cec814353bb4583df2b02698c9498546dc476f419574c67214c453e7173db3896c91a413c9ef503f2c130bf23cc70303af1
+  data.tar.gz: c4f77002e8336a5a635d2d8516d9db3522fc6a596eaf95d0c7dcc758ef9de439f0d72334ce4d0d24b9f76ce9f0b926de871ea5b2cecabd0d5b9c1892532f3b67

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.6
+- Add `serverkit inspec` action
+- Define required ruby version with 2.0.0 or higher in gemspec
+- Improve recipe validation accuracy
+
 ## 0.0.5
 - Add `recipe` resource type
 - Improve validation error message

data/README.md

@@ -2,15 +2,85 @@
 Configuration management toolkit for IT automation.
 
 ## Usage
-This gem provides `serverkit` executable with 3 actions.
-`validate` action validates your recipe format.
-`check` action shows the difference between your recipe and the state of the target host.
-`apply` action executes migration programs to fill-in the gaps.
-
-```sh
-serverkit validate --recipe=recipe.yml
-serverkit check --recipe=recipe.yml
-serverkit apply --recipe=recipe.yml
+Write a recipe, then run `serverkit` executable to validate, inspect, check, and apply the recipe.
+
+### serverkit validate
+Validates recipe schema, resources, and attributes.
+For instance, it shows validation error if `source` attributes is missing in `file` resource.
+
+```
+$ serverkit validate --recipe=recipe.yml
+Error: source attribute is required in file resource
+Error: path attribute can't be unreadable path in recipe resource
+```
+
+### serverkit inspect
+Shows fully-expanded recipe data in JSON format.
+
+```
+$ serverkit inspect --recipe=recipe.yml
+{
+  "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:r7kamura/dotfiles.git",
+      "path": "/Users/r7kamura/src/github.com/r7kamura/dotfiles"
+    },
+    {
+      "id": "symlink_zshrc",
+      "type": "symlink",
+      "source": "/Users/r7kamura/.zshrc",
+      "destination": "/Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc"
+    }
+  ]
+}
+```
+
+### serverkit check
+Shows the difference between your recipe and the state of the target host.
+
+```
+$ serverkit check --recipe=recipe.yml
+[OK] install_mysql
+[OK] install_redis
+[OK] install_licecap
+[OK] install_alfred
+[NG] clone_dotfiles
+[NG] symlink_zshrc
+```
+
+### serverkit apply
+Executes migration process to fill-in the gaps.
+
+```
+$ serverkit apply --recipe=recipe.yml
+[SKIP] install_mysql
+[SKIP] install_redis
+[SKIP] install_licecap
+[SKIP] install_alfred
+[DONE] clone_dotfiles
+[DONE] symlink_zshrc
 ```
 
 ## Recipe
@@ -26,26 +96,26 @@ A recipe can be specified as a path to one of the following patterns:
 - Executable to output JSON
 - Directory including recipe files recursively
 
-```sh
-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.json.erb --variables=variables/
-serverkit apply --recipe=recipe.yml
-serverkit apply --recipe=recipe.yml.erb
-serverkit apply --recipe=recipes/
+```
+$ 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.json.erb --variables=variables/
+$ 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.
+In ERB template, you can use given variables via `variables` method.
 
 ### Example
 This is an example recipe to install some packages, clone a git repository, and create a symlink.

data/lib/readable_validator.rb

@@ -3,7 +3,7 @@ require "active_model"
 class ReadableValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     unless File.readable?(value)
-      record.errors.add(attribute, "is unreadable")
+      record.errors.add(attribute, "can't be unreadable path")
     end
   end
 end

data/lib/serverkit/actions/base.rb

@@ -16,6 +16,10 @@ module Serverkit
 
       private
 
+      def abort_with_errors
+        abort recipe.errors.map { |error| "Error: #{error}" }.join("\n")
+      end
+
       # @return [Specinfra::Backend::Base]
       def backend
         @backend ||= Specinfra::Backend::Exec.new

data/lib/serverkit/actions/inspect.rb

@@ -0,0 +1,16 @@
+require "serverkit/actions/base"
+require "yaml"
+
+module Serverkit
+  module Actions
+    class Inspect < Base
+      def call
+        if recipe.valid?
+          puts JSON.pretty_generate(recipe.to_hash)
+        else
+          abort_with_errors
+        end
+      end
+    end
+  end
+end

data/lib/serverkit/actions/validate.rb

@@ -7,7 +7,7 @@ module Serverkit
         if recipe.valid?
           puts "Success"
         else
-          abort recipe.errors.map { |error| "Error: #{error}" }.join("\n")
+          abort_with_errors
         end
       end
     end

data/lib/serverkit/command.rb

@@ -1,33 +1,30 @@
 require "serverkit/actions/apply"
 require "serverkit/actions/check"
+require "serverkit/actions/inspect"
 require "serverkit/actions/validate"
 require "slop"
 
 module Serverkit
   class Command
-    ACTION_NAMES = %w(
-      apply
-      check
-      validate
-    )
-
     # @param [Array<String>] argv
     def initialize(argv)
       @argv = argv
     end
 
     def call
-      case
-      when has_no_action_name?
+      case action_name
+      when nil
         abort_for_missing_action_name
-      when has_unknown_action_name?
-        abort_for_unknown_action_name
-      when action_name == "apply"
+      when "apply"
         apply
-      when action_name == "check"
+      when "check"
         check
-      when action_name == "validate"
+      when "inspect"
+        _inspect
+      when "validate"
         validate
+      else
+        abort_for_unknown_action_name
       end
     rescue Slop::MissingOptionError => exception
       abort "Error: #{exception}"
@@ -56,14 +53,15 @@ module Serverkit
       Actions::Check.new(options).call
     end
 
-    def has_no_action_name?
-      action_name.nil?
-    end
-
     def has_unknown_action_name?
       !ACTION_NAMES.include?(action_name)
     end
 
+    # @note #inspect is reserved ;(
+    def _inspect
+      Actions::Inspect.new(options).call
+    end
+
     # @return [Hash] Command-line options
     def options
       @options ||= Slop.parse!(@argv) do

data/lib/serverkit/recipe.rb

@@ -50,6 +50,11 @@ module Serverkit
       end
     end
 
+    # @return [Hash] Fully-expanded recipe data
+    def to_hash
+      { "resources" => resources.map(&:attributes) }
+    end
+
     def valid?
       errors.empty?
     end

data/lib/serverkit/resources/base.rb

@@ -22,7 +22,7 @@ module Serverkit
 
       attr_accessor :backend
 
-      attr_reader :recipe
+      attr_reader :attributes, :recipe
 
       attribute :id, required: true, type: String
 

data/lib/serverkit/resources/package.rb

@@ -6,7 +6,7 @@ module Serverkit
       attribute :name, required: true, type: String
 
       def apply
-        run_command_from_identifier(:install, name)
+        run_command_from_identifier(:install_package, name)
       end
 
       # @return [true, false]

data/lib/serverkit/resources/recipe.rb

@@ -7,7 +7,11 @@ module Serverkit
 
       # @note Override
       def to_a
-        loaded_recipe.resources
+        if valid?
+          loaded_recipe.resources
+        else
+          self
+        end
       end
 
       private

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/serverkit.gemspec

@@ -3,17 +3,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "serverkit/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "serverkit"
-  spec.version       = Serverkit::VERSION
-  spec.authors       = ["Ryo Nakamura"]
-  spec.email         = ["r7kamura@gmail.com"]
-  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)/}) }
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.name                  = "serverkit"
+  spec.version               = Serverkit::VERSION
+  spec.authors               = ["Ryo Nakamura"]
+  spec.email                 = ["r7kamura@gmail.com"]
+  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)/}) }
+  spec.bindir                = "bin"
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths         = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
 
   spec.add_runtime_dependency "activemodel"
   spec.add_runtime_dependency "activesupport"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -167,6 +167,7 @@ files:
 - lib/serverkit/actions/apply.rb
 - lib/serverkit/actions/base.rb
 - lib/serverkit/actions/check.rb
+- lib/serverkit/actions/inspect.rb
 - lib/serverkit/actions/validate.rb
 - lib/serverkit/command.rb
 - lib/serverkit/errors/attribute_validation_error.rb
@@ -205,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="