serverkit 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 656a155cfa4b8c499bafcfdbda76075bb28d1570
-  data.tar.gz: adc66fb429d351629b872e61dcfc8ad2d11c40ce
+  metadata.gz: e7d32c86ed73e992891971d99e1f5fed1c3d20e9
+  data.tar.gz: 53173d404b9a4b86e7d0c84f6717531ab73e290c
 SHA512:
-  metadata.gz: a21e147dcf7e37feae2c6eec67242cec814353bb4583df2b02698c9498546dc476f419574c67214c453e7173db3896c91a413c9ef503f2c130bf23cc70303af1
-  data.tar.gz: c4f77002e8336a5a635d2d8516d9db3522fc6a596eaf95d0c7dcc758ef9de439f0d72334ce4d0d24b9f76ce9f0b926de871ea5b2cecabd0d5b9c1892532f3b67
+  metadata.gz: 3063377dafa07b971082c048a1795aa16a0b0e0c714f9779f599c2caced4a2486eec5fe27d5510b5df203a8748f736fa3b5cfeda23a5eebbb499ede87d76c042
+  data.tar.gz: 2193c293ed47692cccfb58b0221086c5fb6cef4f232e61d7a64e69c35e3195c719f3fb4dbe337369bdd283754f9096848c8190dae087fc69f8146aaaeb3decad

data/.rubocop.yml

@@ -22,6 +22,9 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Style/AndOr:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0
+- Support execution over SSH with --host option
+- Remove --recipe=... option and require recipe path in 2nd command-line argument
+
 ## 0.0.6
 - Add `serverkit inspec` action
 - Define required ruby version with 2.0.0 or higher in gemspec

data/README.md

@@ -9,7 +9,7 @@ Validates recipe schema, resources, and attributes.
 For instance, it shows validation error if `source` attributes is missing in `file` resource.
 
 ```
-$ serverkit validate --recipe=recipe.yml
+$ serverkit validate recipe.yml
 Error: source attribute is required in file resource
 Error: path attribute can't be unreadable path in recipe resource
 ```
@@ -18,7 +18,7 @@ Error: path attribute can't be unreadable path in recipe resource
 Shows fully-expanded recipe data in JSON format.
 
 ```
-$ serverkit inspect --recipe=recipe.yml
+$ serverkit inspect recipe.yml
 {
   "resources": [
     {
@@ -61,7 +61,7 @@ $ serverkit inspect --recipe=recipe.yml
 Shows the difference between your recipe and the state of the target host.
 
 ```
-$ serverkit check --recipe=recipe.yml
+$ serverkit check recipe.yml
 [OK] install_mysql
 [OK] install_redis
 [OK] install_licecap
@@ -74,7 +74,7 @@ $ serverkit check --recipe=recipe.yml
 Executes migration process to fill-in the gaps.
 
 ```
-$ serverkit apply --recipe=recipe.yml
+$ serverkit apply recipe.yml
 [SKIP] install_mysql
 [SKIP] install_redis
 [SKIP] install_licecap
@@ -97,18 +97,18 @@ A recipe can be specified as a path to one of the following patterns:
 - Directory including recipe files recursively
 
 ```
-$ serverkit apply --recipe=recipe
-$ serverkit apply --recipe=recipe.json
-$ serverkit apply --recipe=recipe.json.erb
-$ serverkit apply --recipe=recipe.json.erb --variables=variables
-$ serverkit apply --recipe=recipe.json.erb --variables=variables.json
-$ serverkit apply --recipe=recipe.json.erb --variables=variables.json.erb
-$ serverkit apply --recipe=recipe.json.erb --variables=variables.yml
-$ serverkit apply --recipe=recipe.json.erb --variables=variables.yml.erb
-$ serverkit apply --recipe=recipe.json.erb --variables=variables/
-$ serverkit apply --recipe=recipe.yml
-$ serverkit apply --recipe=recipe.yml.erb
-$ serverkit apply --recipe=recipes/
+$ serverkit apply recipe
+$ serverkit apply recipe.json
+$ serverkit apply recipe.json.erb
+$ serverkit apply recipe.json.erb --variables=variables
+$ serverkit apply recipe.json.erb --variables=variables.json
+$ serverkit apply recipe.json.erb --variables=variables.json.erb
+$ serverkit apply recipe.json.erb --variables=variables.yml
+$ serverkit apply recipe.json.erb --variables=variables.yml.erb
+$ serverkit apply recipe.json.erb --variables=variables/
+$ serverkit apply recipe.yml
+$ serverkit apply recipe.yml.erb
+$ serverkit apply recipes/
 ```
 
 ### Variables

data/lib/serverkit/actions/base.rb

@@ -1,17 +1,17 @@
+require "etc"
+require "net/ssh"
+require "serverkit/errors/missing_recipe_path_argument_error"
 require "serverkit/loaders/recipe_loader"
 require "serverkit/recipe"
+require "slop"
 require "specinfra"
 
 module Serverkit
   module Actions
     class Base
-      # @param [Hash] options
-      def initialize(options)
-        @options = options
-      end
-
-      def call
-        raise NotImplementedError
+      # @param [Array] argv Command-line arguments given to serverkit executable
+      def initialize(argv)
+        @argv = argv
       end
 
       private
@@ -22,12 +22,53 @@ module Serverkit
 
       # @return [Specinfra::Backend::Base]
       def backend
-        @backend ||= Specinfra::Backend::Exec.new
+        @backend ||= backend_class.new(backend_options)
+      end
+
+      def backend_class
+        if host
+          Specinfra::Backend::Ssh
+        else
+          Specinfra::Backend::Exec
+        end
+      end
+
+      def backend_options
+        {
+          disable_sudo: true,
+          host: host,
+          ssh_options: {
+            user: ssh_user,
+          },
+        }
+      end
+
+      def host
+        options[:host]
+      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 "--variables=", "Path to variables file for ERB recipe"
+        end
       end
 
       # @return [Serverkit::Recipe]
       def recipe
-        @recipe ||= Loaders::RecipeLoader.new(@options[:recipe], variables_path: @options[:variables]).load
+        @recipe ||= Loaders::RecipeLoader.new(recipe_path, variables_path: options[:variables]).load
+      end
+
+      # @return [String, nil]
+      def recipe_path
+        @argv[1] or raise Errors::MissingRecipePathArgumentError
+      end
+
+      # @return [String] User name used on SSH
+      def ssh_user
+        Net::SSH::Config.for(host)[:user] || Etc.getlogin
       end
     end
   end

data/lib/serverkit/command.rb

@@ -2,7 +2,9 @@ require "serverkit/actions/apply"
 require "serverkit/actions/check"
 require "serverkit/actions/inspect"
 require "serverkit/actions/validate"
-require "slop"
+require "serverkit/errors/missing_action_name_argument_error"
+require "serverkit/errors/missing_recipe_path_argument_error"
+require "serverkit/errors/unknown_action_name_error"
 
 module Serverkit
   class Command
@@ -14,7 +16,7 @@ module Serverkit
     def call
       case action_name
       when nil
-        abort_for_missing_action_name
+        raise Errors::MissingActionNameArgumentError
       when "apply"
         apply
       when "check"
@@ -24,55 +26,34 @@ module Serverkit
       when "validate"
         validate
       else
-        abort_for_unknown_action_name
+        raise Errors::UnknownActionNameError
       end
-    rescue Slop::MissingOptionError => exception
+    rescue Errors::Base, Slop::MissingOptionError => exception
       abort "Error: #{exception}"
     end
 
     private
 
-    def abort_for_missing_action_name
-      abort "Error: Missing action name"
-    end
-
-    def abort_for_unknown_action_name
-      abort "Error: Unknown action name `#{action_name}`"
-    end
-
     # @return [String, nil]
     def action_name
-      ARGV.first
+      @argv.first
     end
 
     def apply
-      Actions::Apply.new(options).call
+      Actions::Apply.new(@argv).call
     end
 
     def check
-      Actions::Check.new(options).call
-    end
-
-    def has_unknown_action_name?
-      !ACTION_NAMES.include?(action_name)
+      Actions::Check.new(@argv).call
     end
 
     # @note #inspect is reserved ;(
     def _inspect
-      Actions::Inspect.new(options).call
-    end
-
-    # @return [Hash] Command-line options
-    def options
-      @options ||= Slop.parse!(@argv) do
-        banner "Usage: serverkit ACTION [options]"
-        on "-r", "--recipe=", "Path to recipe file", required: true
-        on "--variables=", "Path to variables file for ERB recipe"
-      end
+      Actions::Inspect.new(@argv).call
     end
 
     def validate
-      Actions::Validate.new(options).call
+      Actions::Validate.new(@argv).call
     end
   end
 end

data/lib/serverkit/errors/base.rb

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

data/lib/serverkit/errors/missing_action_name_argument_error.rb

@@ -0,0 +1,12 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class MissingActionNameArgumentError < Base
+      # @return [String]
+      def to_s
+        abort "Missing action name argument"
+      end
+    end
+  end
+end

data/lib/serverkit/errors/missing_recipe_path_argument_error.rb

@@ -0,0 +1,12 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class MissingRecipePathArgumentError < Base
+      # @return [String]
+      def to_s
+        abort "Missing recipe path argument"
+      end
+    end
+  end
+end

data/lib/serverkit/errors/non_existent_path_error.rb

@@ -0,0 +1,17 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class NonExistentPathError < Base
+      # @param [#to_s] path
+      def initialize(path)
+        @path = path
+      end
+
+      # @return [String]
+      def to_s
+        abort "No such file or directory `#{@path}`"
+      end
+    end
+  end
+end

data/lib/serverkit/errors/unknown_action_name_error.rb

@@ -0,0 +1,17 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class UnknownActionNameError < Base
+      # @param [String] action_name
+      def initialize(action_name)
+        @action_name = action_name
+      end
+
+      # @return [String]
+      def to_s
+        abort "Unknown action name `#{@action_name}`"
+      end
+    end
+  end
+end

data/lib/serverkit/loaders/base_loader.rb

@@ -1,6 +1,7 @@
 require "erb"
 require "json"
 require "pathname"
+require "serverkit/errors/non_existent_path_error"
 require "tempfile"
 require "yaml"
 
@@ -17,6 +18,8 @@ module Serverkit
       # @todo Rescue Error::ENOENT error
       def load
         case
+        when !pathname.exist?
+          raise Errors::NonExistentPathError, pathname
         when has_directory_path?
           load_from_directory
         when has_erb_path?

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.0.6"
+  VERSION = "0.1.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 "highline"
   spec.add_runtime_dependency "slop", "~> 3.4"
   spec.add_runtime_dependency "specinfra"
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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: slop
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +188,10 @@ files:
 - lib/serverkit/errors/base.rb
 - lib/serverkit/errors/invalid_recipe_type_error.rb
 - 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/non_existent_path_error.rb
+- lib/serverkit/errors/unknown_action_name_error.rb
 - lib/serverkit/errors/unknown_resource_type_error.rb
 - lib/serverkit/loaders/base_loader.rb
 - lib/serverkit/loaders/recipe_loader.rb