serverkit 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2ffa547528d62052da5018705e1f1d1e048a586
-  data.tar.gz: 199bc68d2e3378ff9d5f30c0dcc2fc744ea09053
+  metadata.gz: 9c4c6ff6ddcad1fa170004f086a310380bbc9aea
+  data.tar.gz: 9e5ec0a8584f01b1478630d124a51b5675afaf5c
 SHA512:
-  metadata.gz: 027930d6d1455a60425664686b809f6e428f001c070149e0861019718ae1dd40a5f58bb308a43758d97112d795bf105542a50ef7370da197d036a7279ab36d0d
-  data.tar.gz: d7ffaf6db341a8b14a65a3283a516806c5de94c9878ba6f0dc6cbcbf9b511b633cd7c69e407ffdae86f95b33e9d7146177ebc5e3fa6aa2bfe7a8b345eb84b28b
+  metadata.gz: 15ef8e9c19eb85523f43c01bf70de32d5f82a57b28328a185c72a138d57454f95a0d6b41223582ae621c5c73fd62e8efefc871e5e9683b46ff1fdb20cb90539f
+  data.tar.gz: 7b7e70797e2b8f4fe0ce5d4301f4a741f1d8baa01db8c2a54f8bddcc2c7133ea1b86b9d92be04fc54e36efdf183bd9a594f1512acad455d90e134a3ba4ecffac

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.5
+- Fix bug on resource with no notify property
+
 ## 0.2.4
 - Add new feature: Handlers
 - Add command resource type

data/README.md

@@ -1,6 +1,22 @@
 # 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 IT automation.
 
+- [Usage](#usage)
+  - [serverkit validate](#serverkit-validate)
+  - [serverkit inspect](#serverkit-inspect)
+  - [serverkit check](#serverkit-check)
+  - [serverkit apply](#serverkit-apply)
+  - [SSH support](#ssh-support)
+- [Recipe](#recipe)
+  - [Format](#format)
+  - [Variables](#variables)
+  - [Example](#example)
+- [Resource](#resource)
+  - [Type](#type)
+  - [Example](#example-1)
+- [Handlers](#handlers)
+- [Plug-in](#plug-in)
+
 ## Usage
 Write a recipe, then run `serverkit` executable to validate, inspect, check, and apply the recipe.
 
@@ -56,12 +72,12 @@ Shows the difference between your recipe and the state of the target host.
 
 ```
 $ serverkit check recipe.yml
-[ OK ] install_mysql
-[ OK ] install_redis
-[ OK ] install_licecap
-[ OK ] install_alfred
-[ NG ] clone_dotfiles
-[ NG ] symlink_zshrc
+[ OK ] homebrew mysql on localhost
+[ OK ] homebrew redis on localhost
+[ OK ] homebrew_cask licecap on localhost
+[ OK ] homebrew_cask alfred on localhost
+[ NG ] git git@github.com:r7kamura/dotfiles.git on localhost
+[ NG ] symlink /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc on localhost
 ```
 
 ### serverkit apply
@@ -69,12 +85,12 @@ Executes migration process to fill-in the gaps.
 
 ```
 $ serverkit apply recipe.yml
-[SKIP] install_mysql
-[SKIP] install_redis
-[SKIP] install_licecap
-[SKIP] install_alfred
-[DONE] clone_dotfiles
-[DONE] symlink_zshrc
+[SKIP] homebrew mysql on localhost
+[SKIP] homebrew redis on localhost
+[SKIP] homebrew_cask licecap on localhost
+[SKIP] homebrew_cask alfred on localhost
+[DONE] git git@github.com:r7kamura/dotfiles.git on localhost
+[DONE] symlink /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc on localhost
 ```
 
 ### SSH support
@@ -149,7 +165,7 @@ resources:
 A resource is a statement of configuration policy that describes the desired state for an item.
 
 ### Type
-A resource must have a type property. Currently the following types are available:
+A resource must have a type attribute. Currently the following types are available:
 
 - command
 - file
@@ -161,8 +177,6 @@ A resource must have a type property. Currently the following types are availabl
 - recipe
 - service
 - symlink
-- [defaults](https://github.com/r7kamura/serverkit-defaults)
-- [rbenv_ruby](https://github.com/r7kamura/serverkit-rbenv)
 
 ### Example
 An example package resource that has type and name attributes.
@@ -174,7 +188,7 @@ resources:
 ```
 
 ## Handlers
-When any changes are successfully applied to a resource and it has notify property,
+When any changes are successfully applied to a resource and it has notify attribute,
 it notifies handlers that are referenced by their id.
 The notified handlers will run only once after all resources finished their applications.
 Here's an example of restarting Dock on Mac OS X when its preferences change.
@@ -187,8 +201,7 @@ resources:
     value: 1
     notify:
       - restart_dock
-  - id: empty_dock
-    type: defaults
+  - type: defaults
     domain: com.apple.dock
     key: persistent-apps
     value: []
@@ -199,3 +212,20 @@ handlers:
     type: command
     script: killall Dock
 ```
+
+## Plug-in
+A plug-in is provided as a gem.
+Serverkit calls `Bundler.require(:default)` before running an action,
+so you can add any behaviors to serverkit via gems defined in Gemfile.
+For example, [serverkit-rbenv](https://github.com/r7kamura/serverkit-rbenv) gem
+adds a custom resource type named `rbenv_ruby` by defining `Serverkit::Resources::RbenvRuby` class.
+Serverkit finds `Serverkit::Resources::FooBar` resource class from `type: "foo_bar"`.
+
+- [serverkit-defaults](https://github.com/r7kamura/serverkit-defaults)
+- [serverkit-rbenv](https://github.com/r7kamura/serverkit-rbenv)
+
+```rb
+# Gemfile
+gem "serverkit"
+gem "serverkit-rbenv"
+```

data/example/recipes/recipe.yml

@@ -11,6 +11,10 @@ resources:
   - type: nothing
     notify:
       - handler_test
+  - type: command
+    check_script: "false"
+    script: echo test
+    recheck_script: "true"
 handlers:
   - id: handler_test
     type: nothing

data/lib/serverkit/recipe.rb

@@ -59,7 +59,7 @@ module Serverkit
 
     # @return [Hash] Fully-expanded recipe data
     def to_hash
-      { "resources" => resources.map(&:attributes) }
+      @recipe_data.merge("resources" => resources.map(&:attributes))
     end
 
     def valid?

data/lib/serverkit/resources/base.rb

@@ -43,7 +43,7 @@ module Serverkit
 
       # @return [Array<Serverkit::Resource>]
       def handlers
-        @handlers ||= notify.map do |id|
+        @handlers ||= Array(notify).map do |id|
           recipe.handlers.find do |handler|
             handler.id == id
           end

data/lib/serverkit/resources/command.rb

@@ -3,7 +3,9 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class Command < Base
+      attribute :check_script, type: String
       attribute :script, required: true, type: String
+      attribute :recheck_script, type: String
 
       # @note Override
       def apply
@@ -12,12 +14,29 @@ module Serverkit
 
       # @note Override
       def check
-        false
+        if check_script
+          check_command(check_script)
+        else
+          false
+        end
+      end
+
+      private
+
+      def default_id
+        script
       end
 
       # @note Override
       def recheck
-        true
+        case
+        when recheck_script
+          check_command(recheck_script)
+        when check_script
+          check_command(check_script)
+        else
+          true
+        end
       end
     end
   end

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ryo Nakamura