serverkit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7d32c86ed73e992891971d99e1f5fed1c3d20e9
-  data.tar.gz: 53173d404b9a4b86e7d0c84f6717531ab73e290c
+  metadata.gz: 612a45453d00dd4da8b327be21c8513dfb920292
+  data.tar.gz: 4beb20763b868203c302697f114b508c5f5f4cd8
 SHA512:
-  metadata.gz: 3063377dafa07b971082c048a1795aa16a0b0e0c714f9779f599c2caced4a2486eec5fe27d5510b5df203a8748f736fa3b5cfeda23a5eebbb499ede87d76c042
-  data.tar.gz: 2193c293ed47692cccfb58b0221086c5fb6cef4f232e61d7a64e69c35e3195c719f3fb4dbe337369bdd283754f9096848c8190dae087fc69f8146aaaeb3decad
+  metadata.gz: 4172b07769a11c4002e67caff3cb009262912e188b583893e4a9bf00a3a9432934088ae1c2c4df5bcf433a9e8621eaa1e33c122aab7547d03f118b39d0511ae6
+  data.tar.gz: 5068bbb81ac75922f293ff2061a41a22de161acfadf5fb64efd3100906e37014202fedec6604ecd748d1a5b716e3834e303e113be12b27c78ccee969d5610093

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0
+- Support multiple hosts
+- Change `--host=` option to `--hosts=`
+- Change variables use on ERB template
+- Force recipe validation on all actions
+
 ## 0.1.0
 - Support execution over SSH with --host option
 - Remove --recipe=... option and require recipe path in 2nd command-line argument

data/README.md

@@ -62,12 +62,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 ] install_mysql
+[ OK ] install_redis
+[ OK ] install_licecap
+[ OK ] install_alfred
+[ NG ] clone_dotfiles
+[ NG ] symlink_zshrc
 ```
 
 ### serverkit apply
@@ -83,6 +83,16 @@ $ serverkit apply recipe.yml
 [DONE] symlink_zshrc
 ```
 
+### SSH support
+Use `--hosts=` option to execute serverkit over SSH.
+Serverkit does not require any installation on server-side.
+If you want to specify SSH configuration, write it into your ~/.ssh/config.
+
+```
+$ serverkit apply recipe.yml --hosts=alpha.example.com
+$ serverkit apply recipe.yml --hosts=alpha.example.com,bravo.example.com
+```
+
 ## Recipe
 A recipe describes the desired state of your server.
 It is mostly a collection of resources, defined using certain patterns.
@@ -115,7 +125,7 @@ $ serverkit apply recipes/
 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 use given variables via `variables` method.
+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.
@@ -137,12 +147,12 @@ resources:
     name: redis
   - id: clone_dotfiles
     type: git
-    repository: git@github.com:<%= variables["dotfiles_repository"] %>.git
-    path: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_repository"] %>
+    repository: git@github.com:<%= dotfiles_repository %>.git
+    path: /Users/<%= user %>/src/github.com/<%= dotfiles_repository %>
   - id: symlink_zshrc
     type: symlink
-    source: /Users/<%= variables["user"] %>/.zshrc
-    destination: /Users/<%= variables["user"] %>/src/github.com/<%= variables["dotfiles_repository"] %>/.zshrc
+    source: /Users/<%= user %>/.zshrc
+    destination: /Users/<%= user %>/src/github.com/<%= dotfiles_repository %>/.zshrc
 ```
 
 ## Resource

data/example/recipes/dotfiles.yml.erb

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

data/lib/readable_validator.rb

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

data/lib/serverkit/actions/apply.rb

@@ -1,22 +1,24 @@
 require "serverkit/actions/base"
+require "thread"
 
 module Serverkit
   module Actions
     class Apply < Base
-      def call
-        recipe.resources.each do |resource|
-          resource.backend = backend
-          if resource.check
-            puts "[SKIP] #{resource.id}"
-          else
-            resource.apply
-            if resource.check
-              puts "[DONE] #{resource.id}"
-            else
-              puts "[FAIL] #{resource.id}"
+      def run
+        backends.map do |backend|
+          Thread.new do
+            recipe.resources.map(&:dup).each 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
             end
           end
-        end
+        end.each(&:join)
       end
     end
   end

data/lib/serverkit/actions/base.rb

@@ -14,48 +14,65 @@ module Serverkit
         @argv = argv
       end
 
+      def call
+        setup
+        run
+      end
+
       private
 
       def abort_with_errors
         abort recipe.errors.map { |error| "Error: #{error}" }.join("\n")
       end
 
-      # @return [Specinfra::Backend::Base]
-      def backend
-        @backend ||= backend_class.new(backend_options)
+      # @return [Array<Specinfra::Backend::Base>]
+      def backends
+        if options[:hosts]
+          hosts.map do |host|
+            backend_class.new(
+              disable_sudo: true,
+              host: host,
+              ssh_options: {
+                user: ssh_user_for(host),
+              },
+            )
+          end
+        else
+          [backend_class.new]
+        end
       end
 
       def backend_class
-        if host
+        if options[:hosts]
           Specinfra::Backend::Ssh
         else
           Specinfra::Backend::Exec
         end
       end
 
-      def backend_options
-        {
-          disable_sudo: true,
-          host: host,
-          ssh_options: {
-            user: ssh_user,
-          },
-        }
+      def hosts
+        options[:hosts].split(",")
       end
 
-      def host
-        options[:host]
+      # @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
           banner "Usage: serverkit ACTION [options]"
-          on "--host=", "Pass hostname to use SSH"
+          on "--hosts=", "Pass hostname to execute command over SSH"
           on "--variables=", "Path to variables file for ERB recipe"
         end
       end
 
+      def setup
+        abort_with_errors unless recipe.valid?
+      end
+
       # @return [Serverkit::Recipe]
       def recipe
         @recipe ||= Loaders::RecipeLoader.new(recipe_path, variables_path: options[:variables]).load
@@ -66,8 +83,9 @@ module Serverkit
         @argv[1] or raise Errors::MissingRecipePathArgumentError
       end
 
+      # @param [String] host
       # @return [String] User name used on SSH
-      def ssh_user
+      def ssh_user_for(host)
         Net::SSH::Config.for(host)[:user] || Etc.getlogin
       end
     end

data/lib/serverkit/actions/check.rb

@@ -1,17 +1,19 @@
 require "serverkit/actions/base"
+require "thread"
 
 module Serverkit
   module Actions
     class Check < Base
-      def call
-        recipe.resources.each do |resource|
-          resource.backend = backend
-          if resource.check
-            puts "[OK] #{resource.id}"
-          else
-            puts "[NG] #{resource.id}"
+      def run
+        backends.map do |backend|
+          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)}"
+            end
           end
-        end
+        end.each(&:join)
       end
     end
   end

data/lib/serverkit/actions/inspect.rb

@@ -1,15 +1,10 @@
 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
+      def run
+        puts JSON.pretty_generate(recipe.to_hash)
       end
     end
   end

data/lib/serverkit/actions/validate.rb

@@ -3,12 +3,8 @@ require "serverkit/actions/base"
 module Serverkit
   module Actions
     class Validate < Base
-      def call
-        if recipe.valid?
-          puts "Success"
-        else
-          abort_with_errors
-        end
+      def run
+        puts "Success"
       end
     end
   end

data/lib/serverkit/command.rb

@@ -28,7 +28,7 @@ module Serverkit
       else
         raise Errors::UnknownActionNameError
       end
-    rescue Errors::Base, Slop::MissingOptionError => exception
+    rescue Errors::Base, Slop::MissingArgumentError, Slop::MissingOptionError => exception
       abort "Error: #{exception}"
     end
 

data/lib/serverkit/loaders/base_loader.rb

@@ -15,7 +15,6 @@ module Serverkit
         @path = path
       end
 
-      # @todo Rescue Error::ENOENT error
       def load
         case
         when !pathname.exist?

data/lib/serverkit/loaders/recipe_loader.rb

@@ -5,7 +5,7 @@ require "serverkit/recipe"
 module Serverkit
   module Loaders
     class RecipeLoader < BaseLoader
-      DEFAULT_VARIABLES = {}
+      DEFAULT_VARIABLES_DATA = {}
 
       # @param [String] path
       # @param [String, nil] variables_path
@@ -17,8 +17,9 @@ module Serverkit
       private
 
       # @note Override
+      # @return [Binding]
       def binding_for_erb
-        ErbBindingContext.new(variables_data).binding
+        variables.to_mash.binding
       end
 
       # @note Override to pass @variables_path
@@ -45,30 +46,16 @@ module Serverkit
         Serverkit::Recipe
       end
 
-      # @return [Hash]
-      def variables_data
+      # @return [Serverkit::Variables]
+      def variables
         @variables ||= begin
           if has_variables_path?
-            load_variables.to_hash
+            load_variables
           else
-            DEFAULT_VARIABLES.dup
+            Variables.new(DEFAULT_VARIABLES_DATA.dup)
           end
         end
       end
-
-      class ErbBindingContext
-        attr_reader :variables
-
-        # @param [hash] variables
-        def initialize(variables)
-          @variables = variables
-        end
-
-        # @note Change method visibility to public
-        def binding
-          super
-        end
-      end
     end
   end
 end

data/lib/serverkit/variables.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/hash/deep_merge"
+require "hashie/mash"
 
 module Serverkit
   class Variables
@@ -23,9 +24,16 @@ module Serverkit
       )
     end
 
-    # @return [Hash]
-    def to_hash
-      @variables_data.dup
+    # @return [Hashie::Mash]
+    def to_mash
+      BindableMash.new(@variables_data.dup)
+    end
+
+    class BindableMash < Hashie::Mash
+      # @note Override visibility from private to public
+      def binding
+        super
+      end
     end
   end
 end

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/serverkit.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activemodel"
   spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "hashie"
   spec.add_runtime_dependency "highline"
   spec.add_runtime_dependency "slop", "~> 3.4"
   spec.add_runtime_dependency "specinfra"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: highline
   requirement: !ruby/object:Gem::Requirement