serverkit 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5b26c6d22c758ec66cc5435e50d8289c591da71
-  data.tar.gz: 3324355b6866cbff2a99117b0643449617f54eb0
+  metadata.gz: c2ffa547528d62052da5018705e1f1d1e048a586
+  data.tar.gz: 199bc68d2e3378ff9d5f30c0dcc2fc744ea09053
 SHA512:
-  metadata.gz: 5a7e75d9406ddfc9266015b7cf210bf25069bc5142747f06e99bb51ee72c3df1342ed644d099114fd9354c05e82a6ea3bc396a33d4d7d1c3deb11ab78a248052
-  data.tar.gz: 50816a5d8ad6bccadf3e1359edc4a3d4c0280cbcb72231be70bd6aa2dc6873c6d30692b134da1f146f8a97ad2ad35b72ac38ed58317b42b847722362440f19f9
+  metadata.gz: 027930d6d1455a60425664686b809f6e428f001c070149e0861019718ae1dd40a5f58bb308a43758d97112d795bf105542a50ef7370da197d036a7279ab36d0d
+  data.tar.gz: d7ffaf6db341a8b14a65a3283a516806c5de94c9878ba6f0dc6cbcbf9b511b633cd7c69e407ffdae86f95b33e9d7146177ebc5e3fa6aa2bfe7a8b345eb84b28b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.4
+- Add new feature: Handlers
+- Add command resource type
+- Change id attribute to optional
+- Improve validation error message on missing type case
+
 ## 0.2.3
 - Support multiple types on TypeValidator
 - Fix validation bug on missing type resource

data/README.md

@@ -22,33 +22,27 @@ $ serverkit inspect 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"
@@ -130,27 +124,23 @@ In ERB template, you can use given variables via methods named after its keys.
 ### Example
 This is an example recipe to install some packages, clone a git repository, and create a symlink.
 
-```yaml
+```yml
 # variables.yml
 dotfiles_repository: r7kamura/dotfiles
 user: r7kamura
 ```
 
-```yaml
+```yml
 # recipe.yml.erb
 resources:
-  - id: install_mysql
-    type: package
+  - type: package
     name: mysql
-  - id: install_redis
-    type: package
+  - type: package
     name: redis
-  - id: clone_dotfiles
-    type: git
+  - type: git
     repository: git@github.com:<%= dotfiles_repository %>.git
     path: /Users/<%= user %>/src/github.com/<%= dotfiles_repository %>
-  - id: symlink_zshrc
-    type: symlink
+  - type: symlink
     source: /Users/<%= user %>/.zshrc
     destination: /Users/<%= user %>/src/github.com/<%= dotfiles_repository %>/.zshrc
 ```
@@ -161,10 +151,12 @@ A resource is a statement of configuration policy that describes the desired sta
 ### Type
 A resource must have a type property. Currently the following types are available:
 
+- command
 - file
 - git
 - homebrew
 - homebrew_cask
+- nothing
 - package
 - recipe
 - service
@@ -173,11 +165,37 @@ A resource must have a type property. Currently the following types are availabl
 - [rbenv_ruby](https://github.com/r7kamura/serverkit-rbenv)
 
 ### Example
-An example package resource that has id, type, and name attributes.
+An example package resource that has type and name attributes.
 
-```yaml
+```yml
 resources:
-  - 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)
+  - type: package
+    name: mysql
+```
+
+## Handlers
+When any changes are successfully applied to a resource and it has notify property,
+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.
+
+```yml
+resources:
+  - type: defaults
+    domain: com.apple.dock
+    key: autohide
+    value: 1
+    notify:
+      - restart_dock
+  - id: empty_dock
+    type: defaults
+    domain: com.apple.dock
+    key: persistent-apps
+    value: []
+    notify:
+      - restart_dock
+handlers:
+  - id: restart_dock
+    type: command
+    script: killall Dock
 ```

data/example/recipes/dotfiles.yml.erb

@@ -1,9 +1,7 @@
 resources:
-  - id: clone_dotfiles
-    type: git
+  - type: git
     repository: git@github.com:<%= dotfiles_github_repository %>.git
     path: /Users/<%= user %>/src/github.com/<%= dotfiles_github_repository %>
-  - id: symlink_zshrc
-    type: symlink
+  - type: symlink
     source: /Users/<%= user %>/.zshrc
     destination: /Users/<%= user %>/src/github.com/<%= dotfiles_github_repository %>/linked/.zshrc

data/example/recipes/homebrew.yml

@@ -1,7 +1,5 @@
 resources:
-  - id: install_mysql
-    type: homebrew
+  - type: homebrew
     name: mysql
-  - id: install_redis
-    type: homebrew
+  - type: homebrew
     name: redis

data/example/recipes/homebrew_cask.yml

@@ -1,7 +1,5 @@
 resources:
-  - id: install_licecap
-    type: homebrew_cask
+  - type: homebrew_cask
     name: licecap
-  - id: install_alfred
-    type: homebrew_cask
+  - type: homebrew_cask
     name: alfred

data/example/recipes/recipe.json

@@ -1,19 +1,16 @@
 {
   "resources": [
     {
-      "id": "install_homebrew_packages",
       "type": "recipe",
       "path": "example/recipes/homebrew.yml"
     },
     {
-      "id": "install_homebrew_cask_packages",
       "type": "recipe",
       "path": "example/recipes/homebrew_cask.yml"
     },
     {
-      "id": "install_dotfiles",
       "type": "recipe",
       "path": "example/recipes/dotfiles.yml.erb"
     }
   ]
-}
+}

data/example/recipes/recipe.yml

@@ -1,10 +1,16 @@
 resources:
-  - id: install_homebrew_packages
-    type: recipe
+  - type: recipe
     path: example/recipes/homebrew.yml
-  - id: install_homebrew_cask_packages
-    type: recipe
+  - type: recipe
     path: example/recipes/homebrew_cask.yml
-  - id: install_dotfiles
-    type: recipe
+  - type: recipe
     path: example/recipes/dotfiles.yml.erb
+  - type: nothing
+    notify:
+      - handler_test
+  - type: nothing
+    notify:
+      - handler_test
+handlers:
+  - id: handler_test
+    type: nothing

data/lib/serverkit/actions/apply.rb

@@ -7,15 +7,15 @@ module Serverkit
       def run
         backends.map do |backend|
           Thread.new do
-            recipe.resources.map(&:dup).each do |resource|
+            recipe.resources.map(&:dup).map do |resource|
               resource.backend = backend
-              if resource.check
-                puts "[SKIP] #{resource.id} on #{host_for(backend)}"
-              else
-                resource.apply
-                result = resource.check ? "DONE" : "FAIL"
-                puts "[#{result}] #{resource.id} on #{host_for(backend)}"
-              end
+              resource.run_apply
+              puts resource.inspect_apply_result
+              resource
+            end.select(&:notifiable?).flat_map(&:handlers).uniq.map(&:dup).each do |handler|
+              handler.backend = backend
+              handler.run_apply
+              puts handler.inspect_apply_result
             end
           end
         end.each(&:join)

data/lib/serverkit/actions/base.rb

@@ -59,12 +59,6 @@ module Serverkit
         options[:hosts].split(",")
       end
 
-      # @param [Specinfra::Backend::Base]
-      # @return [String]
-      def host_for(backend)
-        backend.get_config(:host) || "localhost"
-      end
-
       # @return [Slop] Command-line options
       def options
         @options ||= Slop.parse!(@argv, help: true) do

data/lib/serverkit/actions/check.rb

@@ -9,8 +9,8 @@ module Serverkit
           Thread.new do
             recipe.resources.map(&:dup).each do |resource|
               resource.backend = backend
-              result = resource.check ? "OK" : "NG"
-              puts "[ #{result} ] #{resource.id} on #{host_for(backend)}"
+              resource.run_check
+              puts resource.inspect_check_result
             end
           end
         end.each(&:join)

data/lib/serverkit/errors/missing_resource_type_error.rb

@@ -0,0 +1,12 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class MissingResourceTypeError < Base
+      # @return [String]
+      def to_s
+        "Missing resource type"
+      end
+    end
+  end
+end

data/lib/serverkit/recipe.rb

@@ -28,6 +28,13 @@ module Serverkit
       end
     end
 
+    # @return [Array<Serverkit::Resource>]
+    def handlers
+      @handlers ||= Array(handlers_property).flat_map do |attributes|
+        ResourceBuilder.new(self, attributes).build.to_a
+      end
+    end
+
     # @param [Serverkit::Recipe] recipe
     # @return [Serverkit::Recipe]
     def merge(recipe)
@@ -76,6 +83,11 @@ module Serverkit
       resources.flat_map(&:all_errors)
     end
 
+    # @return [Array<String>, nil]
+    def handlers_property
+      @recipe_data["handlers"]
+    end
+
     def has_valid_typed_resources_property?
       resources_property.is_a?(Array)
     end

data/lib/serverkit/resource_builder.rb

@@ -1,8 +1,12 @@
 require "active_support/core_ext/string/inflections"
+require "serverkit/resources/command"
 require "serverkit/resources/file"
 require "serverkit/resources/git"
 require "serverkit/resources/homebrew_cask"
 require "serverkit/resources/homebrew"
+require "serverkit/resources/missing"
+require "serverkit/resources/nothing"
+require "serverkit/resources/package"
 require "serverkit/resources/recipe"
 require "serverkit/resources/service"
 require "serverkit/resources/symlink"
@@ -30,7 +34,10 @@ module Serverkit
 
     # @return [Class]
     def resource_class
-      if has_known_type?
+      case
+      when type.nil?
+        Resources::Missing
+      when has_known_type?
         Resources.const_get(resource_class_name, false)
       else
         Resources::Unknown
@@ -39,9 +46,7 @@ module Serverkit
 
     # @return [String] (e.g. "File", "Symlink")
     def resource_class_name
-      if type.is_a?(String)
-        type.camelize
-      end
+      type.to_s.camelize
     end
 
     # @note Expected to return String in normal case

data/lib/serverkit/resources/base.rb

@@ -24,7 +24,9 @@ module Serverkit
 
       attr_reader :attributes, :recipe
 
-      attribute :id, required: true, type: String
+      attribute :id, type: String
+      attribute :notify, type: Array
+      attribute :type, type: String
 
       # @param [Serverkit::Recipe] recipe
       # @param [Hash] attributes
@@ -33,23 +35,73 @@ module Serverkit
         @recipe = recipe
       end
 
-      # @note For override use
+      # @note For override
       # @return [Array<Serverkit::Errors::Base>]
       def all_errors
         attribute_validation_errors
       end
 
+      # @return [Array<Serverkit::Resource>]
+      def handlers
+        @handlers ||= notify.map do |id|
+          recipe.handlers.find do |handler|
+            handler.id == id
+          end
+        end.compact
+      end
+
+      # @note For logging and notifying
+      # @return [String]
+      def id
+        @attributes["id"] || default_id
+      end
+
+      # @return [String]
+      def inspect_apply_result
+        case @recheck_result
+        when nil
+          "[SKIP] #{result_inspection_suffix}"
+        when false
+          "[FAIL] #{result_inspection_suffix}"
+        else
+          "[DONE] #{result_inspection_suffix}"
+        end
+      end
+
+      # @return [String]
+      def inspect_check_result
+        if @check_result
+          "[ OK ] #{result_inspection_suffix}"
+        else
+          "[ NG ] #{result_inspection_suffix}"
+        end
+      end
+
+      # @return [true, false] True if this resource should call any handler
+      def notifiable?
+        @recheck_result == true && !handlers.nil?
+      end
+
+      # @note #check and #apply wrapper
+      def run_apply
+        unless run_check
+          apply
+          @recheck_result = recheck
+        end
+      end
+
+      # @note #check wrapper
+      # @return [true, false]
+      def run_check
+        @check_result = check
+      end
+
       # @note recipe resource will override to replace itself with multiple resources
       # @return [Array<Serverkit::Resources::Base>]
       def to_a
         [self]
       end
 
-      # @return [String]
-      def type
-        @attributes["type"]
-      end
-
       private
 
       # @return [Array<Serverkit::Errors::AttributeValidationError>]
@@ -60,6 +112,11 @@ module Serverkit
         end
       end
 
+      # @return [String]
+      def backend_host
+        backend.get_config(:host) || "localhost"
+      end
+
       # @return [true, false]
       def check_command(*args)
         run_command(*args).success?
@@ -70,6 +127,23 @@ module Serverkit
         run_command_from_identifier(*args).success?
       end
 
+      # @note For override
+      # @return [String]
+      def default_id
+        type
+      end
+
+      # @note For override
+      # @return [true, false]
+      def recheck
+        check
+      end
+
+      # @return [String]
+      def result_inspection_suffix
+        "#{type} #{id} on #{backend_host}"
+      end
+
       # @return [Specinfra::CommandResult]
       def run_command(*args)
         backend.run_command(*args)

data/lib/serverkit/resources/command.rb

@@ -0,0 +1,24 @@
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Command < Base
+      attribute :script, required: true, type: String
+
+      # @note Override
+      def apply
+        run_command(script)
+      end
+
+      # @note Override
+      def check
+        false
+      end
+
+      # @note Override
+      def recheck
+        true
+      end
+    end
+  end
+end

data/lib/serverkit/resources/file.rb

@@ -9,13 +9,14 @@ module Serverkit
       attribute :owner, type: String
       attribute :source, readable: true, required: true, type: String
 
+      # @note Override
       def apply
         send_file if file_sendable?
         change_group unless has_valid_group?
         change_owner unless has_valid_owner?
       end
 
-      # @return [true, false]
+      # @note Override
       def check
         has_file? && has_same_content? && has_valid_group? && has_valid_owner?
       end
@@ -30,6 +31,11 @@ module Serverkit
         run_command_from_identifier(:change_file_owner, destination, owner)
       end
 
+      # @note Override
+      def default_id
+        destination
+      end
+
       def file_sendable?
         !has_file? || !has_same_content?
       end

data/lib/serverkit/resources/git.rb

@@ -9,12 +9,13 @@ module Serverkit
       attribute :repository, required: true, type: String
       attribute :status, default: DEFAULT_STATUS, type: String
 
+      # @note Override
       def apply
         clone if clonable?
         update if updatable?
       end
 
-      # @return [true, false]
+      # @note Override
       def check
         has_git? && cloned? && !updatable?
       end
@@ -33,6 +34,11 @@ module Serverkit
         check_command_from_identifier(:check_file_is_directory, git_path)
       end
 
+      # @note Override
+      def default_id
+        repository
+      end
+
       # @return [String] Path to .git directory in the cloned repository
       def git_path
         ::File.join(path, ".git")

data/lib/serverkit/resources/homebrew_cask.rb

@@ -5,14 +5,22 @@ module Serverkit
     class HomebrewCask < Base
       attribute :name, required: true, type: String
 
+      # @note Override
       def apply
         run_command("brew cask install #{name}")
       end
 
-      # @return [true, false]
+      # @note Override
       def check
         check_command("/usr/local/bin/brew cask list -1 | grep -E '^#{name}$'")
       end
+
+      private
+
+      # @note Override
+      def default_id
+        name
+      end
     end
   end
 end

data/lib/serverkit/resources/missing.rb

@@ -0,0 +1,13 @@
+require "serverkit/errors/missing_resource_type_error"
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Missing < Base
+      # @return [Array<Serverkit::Errors::MissingResourceTypeError>]
+      def all_errors
+        [Errors::MissingResourceTypeError.new]
+      end
+    end
+  end
+end

data/lib/serverkit/resources/nothing.rb

@@ -0,0 +1,24 @@
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    # A class to do nothing for debugging.
+    class Nothing < Base
+      # @note Override
+      def apply
+      end
+
+      # @note Override for #apply to be always called
+      def check
+        false
+      end
+
+      private
+
+      # @note Override to always pass rechecking
+      def recheck
+        true
+      end
+    end
+  end
+end

data/lib/serverkit/resources/package.rb

@@ -5,14 +5,22 @@ module Serverkit
     class Package < Base
       attribute :name, required: true, type: String
 
+      # @note Override
       def apply
         run_command_from_identifier(:install_package, name)
       end
 
-      # @return [true, false]
+      # @note Override
       def check
         check_command_from_identifier(:check_package_is_installed, name)
       end
+
+      private
+
+      # @note Override
+      def default_id
+        name
+      end
     end
   end
 end

data/lib/serverkit/resources/service.rb

@@ -5,13 +5,22 @@ module Serverkit
     class Service < Base
       attribute :name, required: true, type: String
 
+      # @note Override
       def apply
         run_command_from_identifier(:start, name)
       end
 
+      # @note Override
       def check
         check_command_from_identifier(:check_service_is_running, name)
       end
+
+      private
+
+      # @note Override
+      def default_id
+        name
+      end
     end
   end
 end

data/lib/serverkit/resources/symlink.rb

@@ -6,14 +6,22 @@ module Serverkit
       attribute :destination, required: true, type: String
       attribute :source, required: true, type: String
 
+      # @note Override
       def apply
         run_command_from_identifier(:link_file_to, source, destination)
       end
 
-      # @return [true, false]
+      # @note Override
       def check
         check_command_from_identifier(:check_file_is_linked_to, source, destination)
       end
+
+      private
+
+      # @note Override
+      def default_id
+        destination
+      end
     end
   end
 end

data/lib/serverkit/variables.rb

@@ -13,15 +13,7 @@ module Serverkit
     # @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
-      )
+      self.class.new(variables_data.deep_merge(variables.variables_data))
     end
 
     # @return [Hashie::Mash]

data/lib/serverkit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -204,6 +204,7 @@ files:
 - lib/serverkit/errors/invalid_resources_type_error.rb
 - lib/serverkit/errors/missing_action_name_argument_error.rb
 - lib/serverkit/errors/missing_recipe_path_argument_error.rb
+- lib/serverkit/errors/missing_resource_type_error.rb
 - lib/serverkit/errors/non_existent_path_error.rb
 - lib/serverkit/errors/unknown_action_name_error.rb
 - lib/serverkit/errors/unknown_resource_type_error.rb
@@ -213,10 +214,13 @@ files:
 - lib/serverkit/recipe.rb
 - lib/serverkit/resource_builder.rb
 - lib/serverkit/resources/base.rb
+- lib/serverkit/resources/command.rb
 - lib/serverkit/resources/file.rb
 - lib/serverkit/resources/git.rb
 - lib/serverkit/resources/homebrew.rb
 - lib/serverkit/resources/homebrew_cask.rb
+- lib/serverkit/resources/missing.rb
+- lib/serverkit/resources/nothing.rb
 - lib/serverkit/resources/package.rb
 - lib/serverkit/resources/recipe.rb
 - lib/serverkit/resources/service.rb
@@ -251,3 +255,4 @@ signing_key:
 specification_version: 4
 summary: Configuration management toolkit for IT automation.
 test_files: []
+has_rdoc: