serverkit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3973baadffe8fb3a024c183ff1736bce8f48c719
-  data.tar.gz: aac29f5ee26cc9c77d644b9c6dd7f2cd9c22eebd
+  metadata.gz: 0cb2f4173299cf4eec3b5b1004d1f006c0d211e0
+  data.tar.gz: 851e865ea88715d4eeaf697a7c053e6a5500b379
 SHA512:
-  metadata.gz: 6e93dd18c08bb32e80d57ea3b59e28b1eece1e0d93a438e51bcfbb3d8aae8c2fe17cfb7a36e1a279bd46b648bc40365d3f540b2dfe3c8668402f7701b64b606e
-  data.tar.gz: 33152a234df68bcd557b6ef38f0df5a58b29d0ac192315ab7b87cd87c2aa69449e1893ad91b19bab124b623c9d5137a2e8e02987f84d9794138bc0a1f509ea1f
+  metadata.gz: 23cb9453fdd628b6b87448b94a075826ca9d14367e2fe49b17d237cff832665a9b9be0fc90d112883da2e494772292516327e6d41aeffb1955f33e9b7b819b65
+  data.tar.gz: 12382244676a0ea0749f9f15577352cfd3ab9df973393d7a970ae7facdc1a3f942d875830ca092d5c62dab9e0f976d65fdd7eda05785901f616aaa404cc39424

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.3
+- Support JSON, executable, and directory recipe
+- Support service resource experimentally
+- Validate attribute type
+- Validate no resources recipe
+- Rename resource.name with resource.id
+- Rename package.package with package.name
+
 ## 0.0.2
 - Add `serverkit validate` action
 

data/README.md

@@ -2,42 +2,78 @@
 Configuration management toolkit for your infrastructure.
 
 ## Usage
-```sh
-# Write your recipe
-vi recipe.yml
+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.
 
-# Validate recipe
+```sh
 serverkit validate --recipe=recipe.yml
-
-# Check differences
 serverkit check --recipe=recipe.yml
+serverkit apply --recipe=recipe.yml
+```
 
-# Apply migration
+## Recipe
+A recipe is the most fundamental configuration which defines 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:
+
+- JSON file
+- YAML file named with \*.yaml or \*.yml
+- 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=recipes/
 ```
 
 ### Example
+This is an example recipe to install some packages, clone a git repository, and create a symlink.
+
 ```yaml
 # recipe.yml
 resources:
-  - name: install_mysql
-    type: homebrew
-    package: mysql
-  - name: install_redis
-    type: homebrew
-    package: redis
-  - name: install_licecap
-    type: homebrew_cask
-    package: licecap
-  - name: install_alfred
-    type: homebrew_cask
-    package: alfred
-  - name: clone_dotfiles
+  - id: install_mysql
+    type: package
+    name: mysql
+  - id: install_redis
+    type: package
+    name: redis
+  - id: clone_dotfiles
     type: git
     repository: git@github.com:r7kamura/dotfiles.git
     path: /Users/r7kamura/src/github.com/r7kamura/dotfiles
-  - name: symlink_zshrc
+  - id: symlink_zshrc
     type: symlink
     source: /Users/r7kamura/.zshrc
     destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
 ```
+
+## Resource
+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:
+
+- file
+- git
+- homebrew_cask
+- homebrew
+- package
+- service
+- symlink
+
+### Example
+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)
+    type: package     # type attribute (Serverkit::Resources::Package class is used for this)
+    name: mysql       # name attribute (package resource requires name attribute)
+```

data/examples/recipe.json

@@ -0,0 +1,48 @@
+{
+  "hosts": [
+    "localhost"
+  ],
+  "ssh": false,
+  "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"
+    },
+    {
+      "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/recipe.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "json"
+require "yaml"
+
+puts YAML.load_file(File.expand_path("../recipe.yml", __FILE__)).to_json

data/examples/recipe.yml

@@ -2,27 +2,27 @@ hosts:
   - localhost
 ssh: false
 resources:
-  - name: install_mysql
+  - id: install_mysql
     type: homebrew
-    package: mysql
-  - name: install_redis
+    name: mysql
+  - id: install_redis
     type: homebrew
-    package: redis
-  - name: install_licecap
+    name: redis
+  - id: install_licecap
     type: homebrew_cask
-    package: licecap
-  - name: install_alfred
+    name: licecap
+  - id: install_alfred
     type: homebrew_cask
-    package: alfred
-  - name: clone_dotfiles
+    name: alfred
+  - id: clone_dotfiles
     type: git
     repository: git@github.com:r7kamura/dotfiles.git
     path: /Users/r7kamura/src/github.com/r7kamura/dotfiles
-  - name: symlink_zshrc
+  - id: symlink_zshrc
     type: symlink
     source: /Users/r7kamura/.zshrc
     destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
-  - name: put_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

data/lib/serverkit/actions/apply.rb

@@ -7,13 +7,13 @@ module Serverkit
         recipe.resources.each do |resource|
           resource.backend = backend
           if resource.check
-            puts "[SKIP] #{resource.name}"
+            puts "[SKIP] #{resource.id}"
           else
             resource.apply
             if resource.check
-              puts "[DONE] #{resource.name}"
+              puts "[DONE] #{resource.id}"
             else
-              puts "[FAIL] #{resource.name}"
+              puts "[FAIL] #{resource.id}"
             end
           end
         end

data/lib/serverkit/actions/base.rb

@@ -1,4 +1,5 @@
 require "serverkit/recipe"
+require "serverkit/recipe_loader"
 require "specinfra"
 
 module Serverkit
@@ -31,7 +32,7 @@ module Serverkit
 
       # @return [Serverkit::Recipe]
       def recipe
-        @recipe ||= Recipe.load_from_path(@options[:recipe])
+        @recipe ||= RecipeLoader.new(@options[:recipe]).load
       end
     end
   end

data/lib/serverkit/actions/check.rb

@@ -7,9 +7,9 @@ module Serverkit
         recipe.resources.each do |resource|
           resource.backend = backend
           if resource.check
-            puts "[OK] #{resource.name}"
+            puts "[OK] #{resource.id}"
           else
-            puts "[NG] #{resource.name}"
+            puts "[NG] #{resource.id}"
           end
         end
       end

data/lib/serverkit/recipe.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/hash/deep_merge"
 require "active_support/core_ext/string/inflections"
 require "serverkit/errors/invalid_recipe_type"
 require "serverkit/errors/invalid_resources_type"
@@ -5,23 +6,16 @@ require "serverkit/resources/file"
 require "serverkit/resources/git"
 require "serverkit/resources/homebrew"
 require "serverkit/resources/homebrew_cask"
+require "serverkit/resources/service"
 require "serverkit/resources/symlink"
 require "yaml"
 
 module Serverkit
   class Recipe
-    class << self
-      # @param [String] path
-      def load_from_path(path)
-        recipe_data = YAML.load_file(path)
-        new(recipe_data)
-      end
-    end
-
     attr_reader :recipe_data
 
     # @param [Hash] recipe_data
-    def initialize(recipe_data)
+    def initialize(recipe_data = {})
       @recipe_data = recipe_data
     end
 
@@ -44,6 +38,20 @@ module Serverkit
       @recipe_data["hosts"]
     end
 
+    # @param [Serverkit::Recipe] recipe
+    # @return [Serverkit::Recipe]
+    def merge(recipe)
+      self.class.new(
+        recipe_data.deep_merge(recipe.recipe_data) do |key, a, b|
+          if a.is_a?(Array)
+            a | b
+          else
+            b
+          end
+        end
+      )
+    end
+
     # @return [Array<Serverkit::Resources::Base>]
     # @todo Delegate to resource builder
     def resources
@@ -89,9 +97,9 @@ module Serverkit
       @recipe_data.is_a?(Hash)
     end
 
-    # @return [Array<String>]
+    # @return [Array<String>, nil]
     def resources_property
-      @recipe_data["resources"] || []
+      @recipe_data["resources"]
     end
   end
 end

data/lib/serverkit/recipe_loader.rb

@@ -0,0 +1,79 @@
+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

data/lib/serverkit/resources/base.rb

@@ -1,4 +1,7 @@
 require "active_model"
+require "readable_validator"
+require "required_validator"
+require "type_validator"
 
 module Serverkit
   module Resources
@@ -18,7 +21,7 @@ module Serverkit
 
       attr_accessor :backend
 
-      attribute :name, required: true
+      attribute :id, required: true, type: String
 
       # @param [Hash] attributes
       def initialize(attributes)

data/lib/serverkit/resources/file.rb

@@ -1,15 +1,13 @@
 require "digest"
-require "readable_validator"
-require "required_validator"
 require "serverkit/resources/base"
 
 module Serverkit
   module Resources
     class File < Base
-      attribute :destination, required: true
-      attribute :group
-      attribute :owner
-      attribute :source, readable: true, required: true
+      attribute :destination, required: true, type: String
+      attribute :group, type: String
+      attribute :owner, type: String
+      attribute :source, readable: true, required: true, type: String
 
       def apply
         send_file if file_sendable?

data/lib/serverkit/resources/git.rb

@@ -5,9 +5,9 @@ module Serverkit
     class Git < Base
       DEFAULT_STATUS = "cloned"
 
-      attribute :path, required: true
-      attribute :repository, required: true
-      attribute :status, default: DEFAULT_STATUS
+      attribute :path, required: true, type: String
+      attribute :repository, required: true, type: String
+      attribute :status, default: DEFAULT_STATUS, type: String
 
       def apply
         clone if clonable?

data/lib/serverkit/resources/homebrew_cask.rb

@@ -3,15 +3,15 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class HomebrewCask < Base
-      attribute :package, required: true
+      attribute :name, required: true, type: String
 
       def apply
-        run_command("brew cask install #{package}")
+        run_command("brew cask install #{name}")
       end
 
       # @return [true, false]
       def check
-        check_command("/usr/local/bin/brew cask list -1 | grep -E '^#{package}$'")
+        check_command("/usr/local/bin/brew cask list -1 | grep -E '^#{name}$'")
       end
     end
   end

data/lib/serverkit/resources/package.rb

@@ -3,15 +3,15 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class Package < Base
-      attribute :package, required: true
+      attribute :name, required: true, type: String
 
       def apply
-        run_command_from_identifier(:install, package)
+        run_command_from_identifier(:install, name)
       end
 
       # @return [true, false]
       def check
-        check_command_from_identifier(:check_package_is_installed, package)
+        check_command_from_identifier(:check_package_is_installed, name)
       end
     end
   end

data/lib/serverkit/resources/service.rb

@@ -0,0 +1,17 @@
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Service < Base
+      attribute :name, required: true, type: String
+
+      def apply
+        run_command_from_identifier(:start, name)
+      end
+
+      def check
+        check_command_from_identifier(:check_service_is_running, name)
+      end
+    end
+  end
+end

data/lib/serverkit/resources/symlink.rb

@@ -3,8 +3,8 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class Symlink < Base
-      attribute :destination, required: true
-      attribute :source, required: true
+      attribute :destination, required: true, type: String
+      attribute :source, required: true, type: String
 
       def apply
         run_command_from_identifier(:link_file_to, source, destination)

data/lib/serverkit/version.rb

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

data/lib/type_validator.rb

@@ -0,0 +1,13 @@
+require "active_model"
+
+class TypeValidator < ActiveModel::EachValidator
+  def options
+    super.merge(allow_nil: true)
+  end
+
+  def validate_each(record, attribute, value)
+    unless value.is_a?(options[:with])
+      record.errors.add(attribute, "must be a #{options[:with]}, not #{value.class}")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -154,6 +154,8 @@ files:
 - README.md
 - Rakefile
 - bin/serverkit
+- examples/recipe.json
+- examples/recipe.rb
 - examples/recipe.yml
 - lib/readable_validator.rb
 - lib/required_validator.rb
@@ -167,14 +169,17 @@ files:
 - lib/serverkit/errors/invalid_recipe_type.rb
 - lib/serverkit/errors/invalid_resources_type.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
 - lib/serverkit/resources/homebrew.rb
 - lib/serverkit/resources/homebrew_cask.rb
 - lib/serverkit/resources/package.rb
+- lib/serverkit/resources/service.rb
 - lib/serverkit/resources/symlink.rb
 - lib/serverkit/version.rb
+- lib/type_validator.rb
 - serverkit.gemspec
 homepage: https://github.com/r7kamura/serverkit
 licenses: