serverkit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a46215c909742a449201656305440413650b941f
-  data.tar.gz: 1e23e1ae21759a680affbdf69389e1900d59e8d7
+  metadata.gz: 3973baadffe8fb3a024c183ff1736bce8f48c719
+  data.tar.gz: aac29f5ee26cc9c77d644b9c6dd7f2cd9c22eebd
 SHA512:
-  metadata.gz: ea78669c98502fea368c1f8c9042249190b988c8a12e82400276f82c396c9edc38db5fd4d3f4dc6a791091d07fd172bb57fcd16bb7349ee7d6030cb4ac910ec3
-  data.tar.gz: 1d4a29c33da839040b7ce029047a7f2f14d1d64663cd028505e98051c0b3f58b9695b661c52079376d97e26250edfad0e0c511b5d8502aec14598fd4ae7fd6ca
+  metadata.gz: 6e93dd18c08bb32e80d57ea3b59e28b1eece1e0d93a438e51bcfbb3d8aae8c2fe17cfb7a36e1a279bd46b648bc40365d3f540b2dfe3c8668402f7701b64b606e
+  data.tar.gz: 33152a234df68bcd557b6ef38f0df5a58b29d0ac192315ab7b87cd87c2aa69449e1893ad91b19bab124b623c9d5137a2e8e02987f84d9794138bc0a1f509ea1f

data/.rubocop.yml

@@ -31,6 +31,12 @@ Style/DoubleNegation:
 Style/FormatString:
   Enabled: false
 
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/MultilineBlockChain:
   Enabled: false
 

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.0.2
+- Add `serverkit validate` action
+
+## 0.0.1
+- 1st Release on 2015-03-30
+- Support `serverkit check` and `serverkit apply` actions

data/README.md

@@ -1,16 +1,19 @@
 # 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 building servers.
+Configuration management toolkit for your infrastructure.
 
 ## Usage
 ```sh
 # Write your recipe
 vi recipe.yml
 
-# Check
-bundle exec serverkit check --recipe=recipe.yml
+# Validate recipe
+serverkit validate --recipe=recipe.yml
 
-# Apply
-bundle exec serverkit apply --recipe=recipe.yml
+# Check differences
+serverkit check --recipe=recipe.yml
+
+# Apply migration
+serverkit apply --recipe=recipe.yml
 ```
 
 ### Example

data/lib/readable_validator.rb

@@ -0,0 +1,9 @@
+require "active_model"
+
+class ReadableValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless File.readable?(value)
+      record.errors.add(attribute, "is unreadable")
+    end
+  end
+end

data/lib/required_validator.rb

@@ -0,0 +1,9 @@
+require "active_model"
+
+class RequiredValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value.nil?
+      record.errors.add(attribute, "is required")
+    end
+  end
+end

data/lib/serverkit/actions/validate.rb

@@ -0,0 +1,15 @@
+require "serverkit/actions/base"
+
+module Serverkit
+  module Actions
+    class Validate < Base
+      def call
+        if recipe.valid?
+          puts "Success"
+        else
+          abort recipe.errors.map { |error| "Error: #{error}" }.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/serverkit/command.rb

@@ -1,5 +1,6 @@
 require "serverkit/actions/apply"
 require "serverkit/actions/check"
+require "serverkit/actions/validate"
 require "slop"
 
 module Serverkit
@@ -7,6 +8,7 @@ module Serverkit
     ACTION_NAMES = %w(
       apply
       check
+      validate
     )
 
     # @param [Array<String>] argv
@@ -24,6 +26,8 @@ module Serverkit
         apply
       when action_name == "check"
         check
+      when action_name == "validate"
+        validate
       end
     rescue Slop::MissingOptionError => exception
       abort "Error: #{exception}"
@@ -67,5 +71,9 @@ module Serverkit
         on "-r", "--recipe=", "Path to recipe file", required: true
       end
     end
+
+    def validate
+      Actions::Validate.new(options).call
+    end
   end
 end

data/lib/serverkit/errors/base.rb

@@ -0,0 +1,6 @@
+module Serverkit
+  module Errors
+    class Base
+    end
+  end
+end

data/lib/serverkit/errors/invalid_recipe_type.rb

@@ -0,0 +1,16 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class InvalidRecipeType < Base
+      # @param [Class] type
+      def initialize(type)
+        @type = type
+      end
+
+      def to_s
+        "Recipe data must be a Hash, not #{@type}"
+      end
+    end
+  end
+end

data/lib/serverkit/errors/invalid_resources_type.rb

@@ -0,0 +1,16 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class InvalidResourcesType < Base
+      # @param [Class] type
+      def initialize(type)
+        @type = type
+      end
+
+      def to_s
+        "resources property must be an Array, not #{@type}"
+      end
+    end
+  end
+end

data/lib/serverkit/recipe.rb

@@ -1,4 +1,6 @@
 require "active_support/core_ext/string/inflections"
+require "serverkit/errors/invalid_recipe_type"
+require "serverkit/errors/invalid_resources_type"
 require "serverkit/resources/file"
 require "serverkit/resources/git"
 require "serverkit/resources/homebrew"
@@ -11,39 +13,85 @@ module Serverkit
     class << self
       # @param [String] path
       def load_from_path(path)
-        raw_recipe = YAML.load_file(path)
-        new(raw_recipe)
+        recipe_data = YAML.load_file(path)
+        new(recipe_data)
       end
     end
 
-    # @param [Hash] raw_recipe
-    def initialize(raw_recipe)
-      @raw_recipe = raw_recipe
+    attr_reader :recipe_data
+
+    # @param [Hash] recipe_data
+    def initialize(recipe_data)
+      @recipe_data = recipe_data
     end
 
-    # @return [Array<Serverkit::Resources::Base>]
-    # @todo Delegate to resource builder
-    def resources
-      @resources ||= resource_properties.map do |properties|
-        Resources.const_get(properties["type"].camelize, false).new(properties)
+    # @return [Array<Serverkit::Errors::Base>]
+    def errors
+      @errors ||= begin
+        case
+        when !has_valid_typed_recipe_data?
+          errors_for_invalid_typed_recipe_data
+        when !has_valid_typed_resources_property?
+          errors_for_invalid_typed_resources_property
+        else
+          errors_in_resources
+        end
       end
     end
 
     # @return [Array<String>]
     def hosts
-      @raw_recipe["hosts"]
+      @recipe_data["hosts"]
+    end
+
+    # @return [Array<Serverkit::Resources::Base>]
+    # @todo Delegate to resource builder
+    def resources
+      @resources ||= resources_property.map do |attributes|
+        Resources.const_get(attributes["type"].camelize, false).new(attributes)
+      end
     end
 
     # @return [true, false] Flag to use SSH (default: true)
     def ssh?
-      @raw_recipe["ssh"] != false
+      @recipe_data["ssh"] != false
+    end
+
+    def valid?
+      errors.empty?
     end
 
     private
 
+    # @return [Array<Serverkit::Errors::Base>]
+    def errors_for_invalid_typed_recipe_data
+      [Errors::InvalidRecipeType.new(@recipe_data.class)]
+    end
+
+    # @return [Array<Serverkit::Errors::Base>]
+    def errors_for_invalid_typed_resources_property
+      [Errors::InvalidResourcesType.new(resources_property.class)]
+    end
+
+    # @return [Array<Serverkit::Errors::Base>]
+    def errors_in_resources
+      resources.flat_map do |resource|
+        resource.validate
+        resource.errors.to_a
+      end
+    end
+
+    def has_valid_typed_resources_property?
+      resources_property.is_a?(Array)
+    end
+
+    def has_valid_typed_recipe_data?
+      @recipe_data.is_a?(Hash)
+    end
+
     # @return [Array<String>]
-    def resource_properties
-      @raw_recipe["resources"] || []
+    def resources_property
+      @recipe_data["resources"] || []
     end
   end
 end

data/lib/serverkit/resources/base.rb

@@ -1,16 +1,28 @@
+require "active_model"
+
 module Serverkit
   module Resources
     class Base
+      class << self
+        # @note DSL method to define attribute with its validations
+        def attribute(name, options = {})
+          default = options.delete(:default)
+          define_method(name) do
+            @attributes[name.to_s] || default
+          end
+          validates name, options unless options.empty?
+        end
+      end
+
+      include ActiveModel::Validations
+
       attr_accessor :backend
 
-      # @param [Hash] properties
-      def initialize(properties)
-        @properties = properties
-      end
+      attribute :name, required: true
 
-      # @return [String]
-      def name
-        @properties["name"]
+      # @param [Hash] attributes
+      def initialize(attributes)
+        @attributes = attributes
       end
 
       private

data/lib/serverkit/resources/file.rb

@@ -1,9 +1,16 @@
 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
+
       def apply
         send_file if file_sendable?
         change_group unless has_valid_group?
@@ -25,20 +32,10 @@ module Serverkit
         run_command_from_identifier(:change_file_owner, destination, owner)
       end
 
-      # @return [String]
-      def destination
-        @properties["destination"]
-      end
-
       def file_sendable?
         !has_file? || !has_same_content?
       end
 
-      # @return [String]
-      def group
-        @properties["group"]
-      end
-
       def has_file?
         check_command_from_identifier(:check_file_is_file, destination)
       end
@@ -55,17 +52,11 @@ module Serverkit
         owner.nil? || check_command_from_identifier(:check_file_is_owned_by, destination, owner)
       end
 
-      # @todo Rescue Errno::ENOENT from File.read
       # @return [String]
       def local_file_sha256sum
         ::Digest::SHA256.hexdigest(::File.read(source))
       end
 
-      # @return [String]
-      def owner
-        @properties["owner"]
-      end
-
       # @return [String]
       def remote_file_sha256sum
         run_command_from_identifier(:get_file_sha256sum, destination).stdout.rstrip
@@ -74,11 +65,6 @@ module Serverkit
       def send_file
         run_command_from_identifier(:send_file, source, destination)
       end
-
-      # @return [String]
-      def source
-        @properties["source"]
-      end
     end
   end
 end

data/lib/serverkit/resources/git.rb

@@ -5,6 +5,10 @@ module Serverkit
     class Git < Base
       DEFAULT_STATUS = "cloned"
 
+      attribute :path, required: true
+      attribute :repository, required: true
+      attribute :status, default: DEFAULT_STATUS
+
       def apply
         clone if clonable?
         update if updatable?
@@ -48,21 +52,6 @@ module Serverkit
         run_command("cd #{path} && git ls-remote origin HEAD").stdout.split.first
       end
 
-      # @return [String] Where to locate cloned repository
-      def path
-        @properties["path"]
-      end
-
-      # @return [String] Git repository URL
-      def repository
-        @properties["repository"]
-      end
-
-      # @return [String]
-      def status
-        @properties["status"] || DEFAULT_STATUS
-      end
-
       def updatable?
         status == "updated" && !updated?
       end

data/lib/serverkit/resources/homebrew_cask.rb

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

data/lib/serverkit/resources/package.rb

@@ -3,6 +3,8 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class Package < Base
+      attribute :package, required: true
+
       def apply
         run_command_from_identifier(:install, package)
       end
@@ -11,13 +13,6 @@ module Serverkit
       def check
         check_command_from_identifier(:check_package_is_installed, package)
       end
-
-      private
-
-      # @return [String]
-      def package
-        @properties["package"]
-      end
     end
   end
 end

data/lib/serverkit/resources/symlink.rb

@@ -3,6 +3,9 @@ require "serverkit/resources/base"
 module Serverkit
   module Resources
     class Symlink < Base
+      attribute :destination, required: true
+      attribute :source, required: true
+
       def apply
         run_command_from_identifier(:link_file_to, source, destination)
       end
@@ -11,18 +14,6 @@ module Serverkit
       def check
         check_command_from_identifier(:check_file_is_linked_to, source, destination)
       end
-
-      private
-
-      # @return [String]
-      def destination
-        @properties["destination"]
-      end
-
-      # @return [String]
-      def source
-        @properties["source"]
-      end
     end
   end
 end

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 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 building servers."
+  spec.summary       = "Configuration management toolkit for your infrastructure."
   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)/}) }
@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "activemodel"
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "slop", "~> 3.4"
   spec.add_runtime_dependency "specinfra"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -134,17 +148,24 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/serverkit
 - examples/recipe.yml
+- lib/readable_validator.rb
+- lib/required_validator.rb
 - lib/serverkit.rb
 - lib/serverkit/actions/apply.rb
 - lib/serverkit/actions/base.rb
 - lib/serverkit/actions/check.rb
+- lib/serverkit/actions/validate.rb
 - lib/serverkit/command.rb
+- lib/serverkit/errors/base.rb
+- lib/serverkit/errors/invalid_recipe_type.rb
+- lib/serverkit/errors/invalid_resources_type.rb
 - lib/serverkit/recipe.rb
 - lib/serverkit/resources/base.rb
 - lib/serverkit/resources/file.rb
@@ -178,6 +199,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Configuration management toolkit for building servers.
+summary: Configuration management toolkit for your infrastructure.
 test_files: []
 has_rdoc: