serverkit 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f40c38c419fd96b3e97a018266dccf0e33b61840
-  data.tar.gz: 88d12492f9067a4b315659ede04688121467a050
+  metadata.gz: 1a4d86f76bbf1a6d2d6bec6525dc21c83c6589b4
+  data.tar.gz: 1d830d60b2cfda0a6fb116bc9655c27cf7918037
 SHA512:
-  metadata.gz: f05703924e9cb0f31d9930b90562805c8eabff0f8bf84485aaf910d602985bac4bf3bd46173f4d2e585fa8998c8e1285659da7dcc17ac078b4a831277bd08ab1
-  data.tar.gz: 9094021c5a28689cc70cafcbaac895486a2fd44a4fbc447a6d61d29a55b66dfe5c6ec9506f8cc14161adf16046de0329cacc3bfb4e8ca4a5b85839aaf38497da
+  metadata.gz: a7b0c470e401472711cfa0806c26d4d9b33fc1fd6c685b74e5adf6b3c4363f6cc7e17ebb8c9c95813cc1249da8b64bf57259de722f70793c0a0c216a41b4137a
+  data.tar.gz: a1aa16f2bacb3c84ca27a59541b06ce6e133a0bac4638ab88183437484edaafd4773156c303f1130da893b8f13337a9abee4cb50edd192a5868d5c4d40750f76

data/.rubocop.yml

@@ -1,6 +1,9 @@
 Lint/HandleExceptions:
   Enabled: false
 
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
 Lint/UnusedBlockArgument:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.5
+- Add logger with `--log-level=` and `--no-color` options
+
 ## 0.3.4
 - Add -f option on symlink resource
 - Change attributes naming rule: status -> state

data/README.md

@@ -7,6 +7,7 @@ Configuration management toolkit for IT automation.
   - [serverkit check](#serverkit-check)
   - [serverkit apply](#serverkit-apply)
   - [SSH support](#ssh-support)
+  - [Log](#log)
 - [Recipe](#recipe)
   - [Format](#format)
   - [Variables](#variables)
@@ -107,6 +108,17 @@ $ serverkit apply recipe.yml --hosts=alpha.example.com
 $ serverkit apply recipe.yml --hosts=alpha.example.com,bravo.example.com
 ```
 
+### Log
+You can change serverkit log level by passing `--log-level=` command line option.
+Available values are `DEBUG`, `ERROR`, `FATAL`, `WARN`, OR `INFO` (default).
+General result lines like `[SKIP] ...` and `[ OK ] ...` are logged with FATAL level,
+and all shell commands executed on hosts are logged with DEBUG level.
+Pass `--no-color` option if you would like to disable colored log outputs.
+
+```
+$ serverkit apply recipe.yml --hosts=alpha.example.com --log-level=debug --no-color
+```
+
 ## Recipe
 A recipe describes the desired state of your server.
 It is mostly a collection of resources, defined using certain patterns.

data/example/recipes/recipe.yml

@@ -12,7 +12,7 @@ resources:
     notify:
       - handler_test
   - type: command
-    check_script: "false"
+    check_script: foo
     script: echo test
     recheck_script: "true"
 handlers:

data/lib/serverkit/actions/apply.rb

@@ -4,29 +4,35 @@ require "thread"
 module Serverkit
   module Actions
     class Apply < Base
+      # Apply recipe so that all backends have ideal states, then exit with 0 or 1
       def run
-        successful = backends.map do |backend|
+        if apply_resources
+          exit
+        else
+          exit(1)
+        end
+      end
+
+      private
+
+      # @return [true, false] True if all backends have ideal states
+      def apply_resources
+        backends.map do |backend|
           Thread.new do
             resources = recipe.resources.map(&:clone).map do |resource|
               resource.backend = backend
               resource.run_apply
-              puts resource.inspect_apply_result
+              backend.logger.report_apply_result_of(resource)
               resource
             end
-            handlers = resources.select(&:notifiable?).flat_map(&:handlers).uniq.map(&:clone).map do |handler|
+            handlers = resources.select(&:notifiable?).flat_map(&:handlers).uniq.map(&:clone).each do |handler|
               handler.backend = backend
               handler.run_apply
-              puts handler.inspect_apply_result
-              handler
+              backend.logger.report_apply_result_of(handler)
             end
             resources + handlers
           end
         end.map(&:value).flatten.all?(&:successful?)
-        if successful
-          exit
-        else
-          exit(1)
-        end
       end
     end
   end

data/lib/serverkit/actions/base.rb

@@ -1,6 +1,7 @@
 require "bundler"
-require "etc"
-require "net/ssh"
+require "logger"
+require "serverkit/backends/local_backend"
+require "serverkit/backends/ssh_backend"
 require "serverkit/loaders/recipe_loader"
 require "serverkit/recipe"
 require "slop"
@@ -9,12 +10,16 @@ require "specinfra"
 module Serverkit
   module Actions
     class Base
+      DEFAULT_LOG_LEVEL = ::Logger::INFO
+
       # @param [String, nil] hosts
+      # @param [Fixnum] log_level
       # @param [String] recipe_path
       # @param [Hash, nil] ssh_options For override default ssh options
       # @param [Stirng, nil] variables_path
-      def initialize(hosts: nil, recipe_path: nil, ssh_options: nil, variables_path: nil)
+      def initialize(hosts: nil, log_level: nil, recipe_path: nil, ssh_options: nil, variables_path: nil)
         @hosts = hosts
+        @log_level = log_level
         @recipe_path = recipe_path
         @ssh_options = ssh_options
         @variables_path = variables_path
@@ -31,27 +36,18 @@ module Serverkit
         abort recipe.errors.map { |error| "Error: #{error}" }.join("\n")
       end
 
-      # @return [Array<Specinfra::Backend::Base>]
+      # @return [Array<Serverkit::Backends::Base>]
       def backends
         if has_hosts?
           hosts.map do |host|
-            backend_class.new(
+            Backends::SshBackend.new(
               host: host,
-              ssh_options: {
-                user: ssh_user_for(host),
-              }.merge(ssh_options),
+              log_level: @log_level,
+              ssh_options: @ssh_options,
             )
           end
         else
-          [backend_class.new]
-        end
-      end
-
-      def backend_class
-        if has_hosts?
-          Specinfra::Backend::Ssh
-        else
-          Specinfra::Backend::Exec
+          [Backends::LocalBackend.new(log_level: @log_level)]
         end
       end
 
@@ -76,21 +72,10 @@ module Serverkit
         abort_with_errors unless recipe.valid?
       end
 
-      # @return [Hash]
-      def ssh_options
-        @ssh_options || {}
-      end
-
       # @return [Serverkit::Recipe]
       def recipe
         @recipe ||= Loaders::RecipeLoader.new(@recipe_path, variables_path: @variables_path).load
       end
-
-      # @param [String] host
-      # @return [String] User name used on SSH
-      def ssh_user_for(host)
-        Net::SSH::Config.for(host)[:user] || Etc.getlogin
-      end
     end
   end
 end

data/lib/serverkit/actions/check.rb

@@ -4,22 +4,29 @@ require "thread"
 module Serverkit
   module Actions
     class Check < Base
+      # Check if all backends have ideal states, then exit with exit-code 0 or 1
       def run
-        successful = backends.map do |backend|
+        if check_resources
+          exit
+        else
+          exit(1)
+        end
+      end
+
+      private
+
+      # @return [true, false] True if all backends have ideal states
+      def check_resources
+        backends.map do |backend|
           Thread.new do
             recipe.resources.map(&:clone).map do |resource|
               resource.backend = backend
               resource.run_check
-              puts resource.inspect_check_result
+              backend.logger.report_check_result_of(resource)
               resource
             end
           end
         end.map(&:value).flatten.all?(&:successful?)
-        if successful
-          exit
-        else
-          exit(1)
-        end
       end
     end
   end

data/lib/serverkit/backends/base_backend.rb

@@ -0,0 +1,69 @@
+require "active_support/core_ext/module/delegation"
+require "serverkit/logger"
+
+module Serverkit
+  module Backends
+    class BaseBackend
+      delegate(
+        :send_file,
+        to: :specinfra_backend,
+      )
+
+      def initialize(log_level: nil)
+        @log_level = log_level
+      end
+
+      # @return [true, false]
+      def check_command(*args)
+        run_command(*args).success?
+      end
+
+      # @return [true, false]
+      def check_command_from_identifier(*args)
+        run_command_from_identifier(*args).success?
+      end
+
+      # @return [String]
+      def get_command_from_identifier(*args)
+        specinfra_backend.command.get(*args)
+      end
+
+      # @note Override me
+      # @return [String]
+      # @example "localhost"
+      def host
+        raise NotImplementedError
+      end
+
+      # @return [Serverkit::Logger]
+      def logger
+        @logger ||= Serverkit::Logger.new($stdout).tap do |_logger|
+          _logger.level = @log_level
+        end
+      end
+
+      # @return [Specinfra::CommandResult]
+      def run_command(*args)
+        logger.debug("Running #{args.first.inspect} on #{host}")
+        specinfra_backend.run_command(*args).tap do |result|
+          logger.debug(result.stdout) unless result.stdout.empty?
+          logger.debug(result.stderr) unless result.stderr.empty?
+          logger.debug("Finished with #{result.exit_status} on #{host}")
+        end
+      end
+
+      # @return [Specinfra::CommandResult]
+      def run_command_from_identifier(*args)
+        run_command(get_command_from_identifier(*args))
+      end
+
+      private
+
+      # @note Override me
+      # @return [Specinfra::Backend::Base]
+      def specinfra_backend
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/serverkit/backends/local_backend.rb

@@ -0,0 +1,22 @@
+require "serverkit/backends/base_backend"
+require "specinfra"
+
+module Serverkit
+  module Backends
+    class LocalBackend < BaseBackend
+      HOST = "localhost"
+
+      # @note Override
+      def host
+        HOST
+      end
+
+      private
+
+      # @return [Specinfra::Backend::Exec]
+      def specinfra_backend
+        @specinfra_backend ||= Specinfra::Backend::Exec.new
+      end
+    end
+  end
+end

data/lib/serverkit/backends/ssh_backend.rb

@@ -0,0 +1,42 @@
+require "etc"
+require "net/ssh"
+require "serverkit/backends/base_backend"
+require "specinfra"
+
+module Serverkit
+  module Backends
+    class SshBackend < BaseBackend
+      DEFAULT_SSH_OPTIONS = {}
+
+      attr_reader :host
+
+      # @param [String] host
+      # @param [Hash] ssh_options
+      def initialize(host: nil, ssh_options: nil, **args)
+        super(**args)
+        @host = host
+        @ssh_options = ssh_options
+      end
+
+      private
+
+      # @return [Specinfra::Backend::Ssh]
+      def specinfra_backend
+        @specinfra_backend ||= ::Specinfra::Backend::Ssh.new(
+          host: host,
+          ssh_options: ssh_options,
+        )
+      end
+
+      # @return [Hash]
+      def ssh_options
+        { user: user }.merge(@ssh_options || DEFAULT_SSH_OPTIONS)
+      end
+
+      # @return [String]
+      def user
+        ::Net::SSH::Config.for(@host)[:user] || ::Etc.getlogin
+      end
+    end
+  end
+end

data/lib/serverkit/command.rb

@@ -1,3 +1,4 @@
+require "rainbow"
 require "serverkit/actions/apply"
 require "serverkit/actions/check"
 require "serverkit/actions/inspect"
@@ -10,12 +11,22 @@ module Serverkit
   # Command clsas takes care of command line interface.
   # It builds and runs an Action object from given command line arguements.
   class Command
+    LOG_LEVELS_TABLE = {
+      nil => Logger::INFO,
+      "DEBUG" => Logger::DEBUG,
+      "ERROR" => Logger::ERROR,
+      "FATAL" => Logger::FATAL,
+      "INFO" => Logger::INFO,
+      "WARN" => Logger::WARN,
+    }
+
     # @param [Array<String>] argv
     def initialize(argv)
       @argv = argv
     end
 
     def call
+      setup
       case action_name
       when nil
         raise Errors::MissingActionNameArgumentError
@@ -50,6 +61,7 @@ module Serverkit
     def action_options
       {
         hosts: hosts,
+        log_level: log_level,
         recipe_path: recipe_path,
         variables_path: variables_path,
       }.reject do |key, value|
@@ -71,14 +83,21 @@ module Serverkit
     def command_line_options
       @command_line_options ||= Slop.parse!(@argv, help: true) do
         banner "Usage: serverkit ACTION [options]"
-        on "--hosts=", "Pass hostname to execute command over SSH"
+        on "--hosts=", "Hostname to execute command over SSH"
+        on "--log-level=", "Log level (DEBUG, INFO, WARN, ERROR, FATAL)"
+        on "--no-color", "Disable coloring"
         on "--variables=", "Path to variables file for ERB recipe"
       end
     end
 
     # @return [String, nil]
     def hosts
-      command_line_options[:hosts]
+      command_line_options["hosts"]
+    end
+
+    # @return [Fixnum]
+    def log_level
+      LOG_LEVELS_TABLE[command_line_options["log-level"]] || ::Logger::UNKNOWN
     end
 
     # @return [String]
@@ -86,12 +105,16 @@ module Serverkit
       @argv[1] or raise Errors::MissingRecipePathArgumentError
     end
 
+    def setup
+      ::Rainbow.enabled = !command_line_options["no-color"]
+    end
+
     def validate
       Actions::Validate.new(action_options).call
     end
 
     def variables_path
-      command_line_options[:variables]
+      command_line_options["variables"]
     end
   end
 end

data/lib/serverkit/logger.rb

@@ -0,0 +1,77 @@
+require "logger"
+require "rainbow"
+
+module Serverkit
+  # A logger class that has a simple formatter by default.
+  class Logger < ::Logger
+    def initialize(*)
+      super
+      self.formatter = Formatter.new
+    end
+
+    # @param [Serverkit::Resources::Base]
+    def report_apply_result_of(resource)
+      message = ResourceApplyStateView.new(resource).to_s
+      fatal(message)
+    end
+
+    # @param [Serverkit::Resources::Base]
+    def report_check_result_of(resource)
+      message = ResourceCheckStateView.new(resource).to_s
+      fatal(message)
+    end
+
+    class Formatter
+      def call(severity, time, program_name, message)
+        message = message.to_s.gsub(/\n\z/, "") + "\n"
+        message = Rainbow(message).black.bright if severity == "DEBUG"
+        message
+      end
+    end
+
+    class ResourceStateView
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def to_s
+        "[#{result_tag}] #{@resource.type} #{@resource.id} on #{backend_host}"
+      end
+
+      private
+
+      def backend_host
+        @resource.backend.host
+      end
+    end
+
+    class ResourceApplyStateView < ResourceStateView
+      private
+
+      # @return [String]
+      def result_tag
+        case @resource.recheck_result
+        when nil
+          "SKIP"
+        when false
+          "FAIL"
+        else
+          "DONE"
+        end
+      end
+    end
+
+    class ResourceCheckStateView < ResourceStateView
+      private
+
+      # @return [String]
+      def result_tag
+        if @resource.check_result
+          " OK "
+        else
+          " NG "
+        end
+      end
+    end
+  end
+end

data/lib/serverkit/resources/base.rb

@@ -1,4 +1,5 @@
 require "active_model"
+require "active_support/core_ext/module/delegation"
 require "readable_validator"
 require "required_validator"
 require "serverkit/errors/attribute_validation_error"
@@ -22,12 +23,22 @@ module Serverkit
 
       attr_accessor :backend
 
-      attr_reader :attributes, :recipe
+      attr_reader :attributes, :check_result, :recheck_result, :recipe
 
       attribute :id, type: String
       attribute :notify, type: Array
       attribute :type, type: String
 
+      delegate(
+        :check_command,
+        :check_command_from_identifier,
+        :get_command_from_identifier,
+        :run_command,
+        :run_command_from_identifier,
+        :send_file,
+        to: :backend,
+      )
+
       # @param [Serverkit::Recipe] recipe
       # @param [Hash] attributes
       def initialize(recipe, attributes)
@@ -56,27 +67,6 @@ module Serverkit
         @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?
@@ -96,9 +86,16 @@ module Serverkit
         @check_result = !!check
       end
 
-      # @return [true, false]
       def successful?
-        @check_result == true || @recheck_result == true
+        successful_on_check? || successful_on_recheck?
+      end
+
+      def successful_on_check?
+        @check_result == true
+      end
+
+      def successful_on_recheck?
+        @check_result == true
       end
 
       # @note recipe resource will override to replace itself with multiple resources
@@ -117,21 +114,6 @@ 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?
-      end
-
-      # @return [true, false]
-      def check_command_from_identifier(*args)
-        run_command_from_identifier(*args).success?
-      end
-
       # @note For override
       # @return [String]
       def default_id
@@ -144,21 +126,6 @@ module Serverkit
         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)
-      end
-
-      # @return [Specinfra::CommandResult]
-      def run_command_from_identifier(*args)
-        run_command(backend.command.get(*args))
-      end
-
       # @return [Array<Symbol>]
       def required_attribute_names
         _validators.select do |key, validators|

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/serverkit.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "bundler"
   spec.add_runtime_dependency "hashie"
   spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "rainbow"
   spec.add_runtime_dependency "slop", "~> 3.4"
   spec.add_runtime_dependency "specinfra"
   spec.add_development_dependency "pry", "0.10.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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
@@ -197,6 +211,9 @@ files:
 - lib/serverkit/actions/check.rb
 - lib/serverkit/actions/inspect.rb
 - lib/serverkit/actions/validate.rb
+- lib/serverkit/backends/base_backend.rb
+- lib/serverkit/backends/local_backend.rb
+- lib/serverkit/backends/ssh_backend.rb
 - lib/serverkit/command.rb
 - lib/serverkit/errors/attribute_validation_error.rb
 - lib/serverkit/errors/base.rb
@@ -211,6 +228,7 @@ files:
 - lib/serverkit/loaders/base_loader.rb
 - lib/serverkit/loaders/recipe_loader.rb
 - lib/serverkit/loaders/variables_loader.rb
+- lib/serverkit/logger.rb
 - lib/serverkit/recipe.rb
 - lib/serverkit/resource_builder.rb
 - lib/serverkit/resources/base.rb
@@ -255,3 +273,4 @@ signing_key:
 specification_version: 4
 summary: Configuration management toolkit for IT automation.
 test_files: []
+has_rdoc: