producer-core 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f750e0a3e7e1507d6ae506e7a225d36013e32a46
-  data.tar.gz: dd1936c1fca2cedd04e3526de0de5b6c0a20a540
+  metadata.gz: 928f078bd25c17856fcd95f5f95b1cf5f62cc2f6
+  data.tar.gz: 795822a79e878ed17e775216ecb75e4760739435
 SHA512:
-  metadata.gz: 746ff40b2247ebaafe28ed7c1ce080a70bd079ae3ddb31fb90f38e49e19f2e9344218b0c5f1923eb392ac6f0e81b9c3bac08dbb03805abbcb6d42067965e7086
-  data.tar.gz: cf618dde3593f0e0da83f4c3cdce8cef3896610bea5a42cfd5c5cc04aa4229b80ce15be530482449d716c7e0581b5bd38d2a6d475da57bef8da5520dc25e956e
+  metadata.gz: 537ca3e1729156f2ea60a7e9a7cf975a7fdc88b807670be525e49c7a56b6c7372adc7c5dacd0af18174ec96b9a8ecb46041d139f59f7132ab6f3dc3ba68ab911
+  data.tar.gz: b7a099e4ffb7438e8a02336fac5f36cd58960e29009946546bd7fbf47ea96fc15b5dc45e838f15214d0f090d0ac8172380fc746e4e0aeba1878e57b013b6d08c

data/README.md

@@ -136,7 +136,7 @@ end
 Usage
 -----
 
-    Usage: producer [options] [recipes]
+    Usage: producer [options] [recipes] [-- recipe_arguments...]
     
     options:
         -v, --verbose                    enable verbose mode

data/Rakefile

@@ -5,12 +5,15 @@ task default: %i[features spec]
 
 Cucumber::Rake::Task.new(:features)
 
-Cucumber::Rake::Task.new(:features_no_sshd) do |t|
+Cucumber::Rake::Task.new(:features_ci) do |t|
   t.instance_eval { @desc << ' excluding @ci_skip' }
   t.cucumber_opts = '--tags ~@ci_skip'
+  t.profile = 'quiet' if ENV.key? 'TRAVIS'
 end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--format progress' if ENV.key? 'TRAVIS'
+end
 
 desc 'Run CI test suite'
-task ci: %i[features_no_sshd spec]
+task ci: %i[features_ci spec]

data/config/cucumber.yaml

@@ -1 +1,2 @@
-default: --require features/support --require features/steps
+default: --require features/support --require features/steps --no-source
+quiet: --format progress

data/features/cli/debug.feature

@@ -3,7 +3,7 @@ Feature: CLI debug option
   Scenario: reports recipe errors with their cause
     Given a recipe with an error
     When I execute the recipe with option -d
-    Then the output must match /\ARuntimeError:.*\n\ncause:\nRuntimeError:/
+    Then the output must match /\ARecipeEvaluationError:.*\n\ncause:\nRuntimeError:/
 
   Scenario: does not exclude anything from backtrace
     Given a recipe using a remote
@@ -11,3 +11,9 @@ Feature: CLI debug option
     Then the output must contain "producer"
     And the output must contain "net-ssh"
     And the output must contain ruby lib directory
+
+  Scenario: enables debug mode from the environment
+    Given a recipe with an error
+    And I set the environment variable "PRODUCER_DEBUG"
+    When I execute the recipe
+    Then the output must contain "producer"

data/features/cli/dry_run.feature

@@ -15,3 +15,8 @@ Feature: CLI dry run option
   Scenario: prints a warning before any output
     When I successfully execute the recipe with option -n
     Then the output must match /\AWarning: running in dry run mode, actions will NOT be applied/
+
+  Scenario: enables dry run mode from the environment
+    Given I set the environment variable "PRODUCER_DRYRUN"
+    When I successfully execute the recipe
+    Then the output must contain "running in dry run"

data/features/cli/error_reporting.feature

@@ -4,7 +4,7 @@ Feature: CLI error reporting
     Given a recipe with an error
     When I execute the recipe
     Then the exit status must be 70
-    And the output must match /\ARuntimeError: some error\n/
+    And the output must match /\ARecipeEvaluationError: some error\n/
 
   Scenario: reports errors with a backtrace
     Given a recipe with an error

data/features/cli/usage.feature

@@ -4,14 +4,10 @@ Feature: CLI usage
   Scenario: prints the usage when an argument is missing
     When I run `producer`
     Then the exit status must be 64
-    And the output must contain exactly:
-      """
-      Usage: producer [options] [recipes]
+    And the output must contain exactly the usage
 
-      options:
-          -v, --verbose                    enable verbose mode
-          -d, --debug                      enable debug mode
-          -n, --dry-run                    enable dry run mode
-          -t, --target HOST                target host
-
-      """
+  @exec
+  Scenario: prints the usage when unknown option switch is given
+    When I run `producer --unknown-option`
+    Then the exit status must be 64
+    And the output must contain exactly the usage

data/features/cli/verbose.feature

@@ -41,3 +41,8 @@ Feature: CLI verbose option
       """
     When I successfully execute the recipe with option -v
     Then the output must match /action: .{,70}$/
+
+  Scenario: enables verbose mode from the environment
+    Given I set the environment variable "PRODUCER_VERBOSE"
+    When I successfully execute the recipe
+    Then the output must contain "Task"

data/features/recipe/errors.feature

@@ -0,0 +1,9 @@
+Feature: recipe errors
+
+  Scenario: reports when remote target is invalid
+    Given a recipe with:
+      """
+      task(:some_task) { sh 'true' }
+      """
+    When I execute the recipe
+    Then the output must match /\ARemoteInvalidError:\s+\w+/

data/features/ssh/config.feature

@@ -14,7 +14,7 @@ Feature: SSH settings
     When I successfully execute the recipe
     Then the output must contain my current login name
 
-  @mocked_home_directory
+  @mocked-home-directory
   Scenario: uses configured SSH user name for a given host
     Given an SSH config with:
       """

data/features/steps/environment_steps.rb

@@ -0,0 +1,3 @@
+Given /^I set the environment variable "([^"]+)"$/ do |variable|
+  set_environment_variable variable, 'yes'
+end

data/lib/producer/core/action.rb

@@ -9,7 +9,7 @@ module Producer
 
       attr_reader :env, :arguments, :options
 
-      def initialize(env, *args, **options)
+      def initialize env, *args, **options
         @env        = env
         @arguments  = args
         @options    = options
@@ -24,17 +24,15 @@ module Producer
         [name, inspect_arguments].join ' '
       end
 
-
-      private
+    private
 
       def inspect_arguments
         @arguments.inspect[0, INSPECT_ARGUMENTS_SUM_LEN - name.length]
       end
 
-      def check_arguments_size!(size)
-        if arguments.compact.size != size
-          fail ArgumentError, '`%s\' action requires %d arguments' % [name, size]
-        end
+      def check_arguments_size! size
+        return if arguments.compact.size == size
+        fail ArgumentError, '`%s\' action requires %d arguments' % [name, size]
       end
     end
   end

data/lib/producer/core/actions/file_append.rb

@@ -16,7 +16,7 @@ module Producer
         end
 
         def combined_content
-          original_content = fs.file_read(@path)
+          original_content = fs.file_read @path
 
           return @content unless original_content
           original_content + @content

data/lib/producer/core/actions/file_writer.rb

@@ -18,8 +18,7 @@ module Producer
           fs.setstat @path, @options unless @options.empty?
         end
 
-
-        private
+      private
 
         def arguments_size
           2

data/lib/producer/core/actions/mkdir.rb

@@ -14,10 +14,10 @@ module Producer
         end
 
         def apply
-          @path.descend do |p|
-            next if fs.dir? p
-            fs.mkdir p.to_s
-            fs.setstat p.to_s, @options unless @options.empty?
+          @path.descend do |path|
+            next if fs.dir? path
+            fs.mkdir path.to_s
+            fs.setstat path.to_s, @options unless @options.empty?
           end
         end
       end

data/lib/producer/core/actions/shell_command.rb

@@ -12,7 +12,7 @@ module Producer
         end
 
         def apply
-          remote.execute(@command, output, error_output)
+          remote.execute @command, output, error_output
         end
       end
     end

data/lib/producer/core/actions/yaml_writer.rb

@@ -11,8 +11,7 @@ module Producer
           'yaml_write'
         end
 
-
-        private
+      private
 
         def arguments_size
           1

data/lib/producer/core/cli.rb

@@ -1,54 +1,63 @@
 module Producer
   module Core
     class CLI
-      ArgumentError = Class.new(::ArgumentError)
+      ArgumentError = Class.new(ArgumentError)
 
-      USAGE = "Usage: #{File.basename $0} [options] [recipes]".freeze
+      USAGE =
+        "Usage: #{File.basename $0} [options] [recipes] [-- recipe_argument...]"
+          .freeze
 
       EX_USAGE    = 64
       EX_SOFTWARE = 70
 
       ARGUMENTS_SEPARATOR = '--'.freeze
 
+      ENV_VERBOSE_KEY = 'PRODUCER_VERBOSE'.freeze
+      ENV_DEBUG_KEY   = 'PRODUCER_DEBUG'.freeze
+      ENV_DRYRUN_KEY  = 'PRODUCER_DRYRUN'.freeze
+
       class << self
-        def run!(arguments, stdin: $stdin, stdout: $stdout, stderr: $stderr)
-          cli = new(arguments, stdin: stdin, stdout: stdout, stderr: stderr)
-          begin
-            cli.parse_arguments!
-            cli.run
-          rescue ArgumentError => e
-            stderr.puts e.message
-            exit EX_USAGE
-          rescue StandardError => e
-            ef = ErrorFormatter.new(
-              debug:        cli.env.debug?,
-              force_cause:  [RecipeEvaluationError]
-            )
-            stderr.puts ef.format e
-            exit EX_SOFTWARE
-          end
+        def run! arguments, stdin: $stdin, stdout: $stdout, stderr: $stderr
+          cli = new arguments, ENV, stdin: stdin, stdout: stdout, stderr: stderr
+          cli.parse_arguments!
+          cli.run
+        rescue ArgumentError => e
+          stderr.puts e.message
+          exit EX_USAGE
+        rescue StandardError => e
+          ef = ErrorFormatter.new(
+            debug:        cli.env.debug?,
+            force_cause:  [RecipeEvaluationError]
+          )
+          stderr.puts ef.format e
+          exit EX_SOFTWARE
         end
       end
 
       attr_reader :arguments, :stdin, :stdout, :stderr, :env
 
-      def initialize(args, stdin: $stdin, stdout: $stdout, stderr: $stderr)
+      def initialize args, environment, stdin: $stdin, stdout: $stdout,
+          stderr: $stderr
         @arguments  = args
         @stdin      = stdin
         @stdout     = stdout
         @stderr     = stderr
         @env        = build_env
+
+        configure_environment! environment
       end
 
       def parse_arguments!
         if @arguments.include? ARGUMENTS_SEPARATOR
           @arguments, @env.recipe_argv = split_arguments_lists @arguments
         end
-        option_parser.parse!(@arguments)
+        option_parser.parse! @arguments
         fail ArgumentError, option_parser if @arguments.empty?
+      rescue OptionParser::InvalidOption
+        raise ArgumentError, option_parser
       end
 
-      def run(worker: Worker.new(@env))
+      def run worker: Worker.new(@env)
         evaluate_recipes.each { |recipe| worker.process recipe.tasks }
       ensure
         @env.cleanup
@@ -58,17 +67,22 @@ module Producer
         @arguments.map { |e| Recipe::FileEvaluator.evaluate(e, @env) }
       end
 
-
-      private
+    private
 
       def build_env
         Env.new(input: @stdin, output: @stdout, error_output: @stderr)
       end
 
-      def split_arguments_lists(arguments)
+      def configure_environment! environment
+        @env.verbose  = true if environment.key? ENV_VERBOSE_KEY
+        @env.debug    = true if environment.key? ENV_DEBUG_KEY
+        @env.dry_run  = true if environment.key? ENV_DRYRUN_KEY
+      end
+
+      def split_arguments_lists arguments
         arguments
           .chunk  { |e| e == ARGUMENTS_SEPARATOR }
-          .reject { |b, a| b }
+          .reject { |a, _| a }
           .map    &:last
       end
 
@@ -78,23 +92,20 @@ module Producer
           opts.separator ''
           opts.separator 'options:'
 
-          opts.on '-v', '--verbose', 'enable verbose mode' do |e|
-            env.verbose = true
-          end
-
-          opts.on '-d', '--debug', 'enable debug mode' do |e|
-            env.debug = true
-          end
-
-          opts.on '-n', '--dry-run', 'enable dry run mode' do |e|
-            env.dry_run = true
-          end
-
+          option_parser_add_boolean_options opts
           opts.on '-t', '--target HOST', 'target host' do |e|
             env.target = e
           end
         end
       end
+
+      def option_parser_add_boolean_options opts
+        { v: 'verbose', d: 'debug', n: 'dry run' }.each do |k, v|
+          opts.on "-#{k}", "--#{v.tr ' ', '-'}", "enable #{v} mode" do
+            env.send "#{v.tr ' ', '_'}=", true
+          end
+        end
+      end
     end
   end
 end

data/lib/producer/core/condition.rb

@@ -2,7 +2,7 @@ module Producer
   module Core
     class Condition
       class << self
-        def define_test(keyword, test)
+        def define_test keyword, test
           {
             keyword         => false,
             "no_#{keyword}" => true
@@ -19,7 +19,7 @@ module Producer
           end
         end
 
-        def evaluate(env, *args, &block)
+        def evaluate env, *args, &block
           new.tap do |o|
             o.instance_eval { @env = env }
             return_value = o.instance_exec *args, &block
@@ -44,7 +44,7 @@ module Producer
 
       attr_reader :tests, :return_value
 
-      def initialize(tests = [], return_value = nil)
+      def initialize tests = [], return_value = nil
         @tests        = tests
         @return_value = return_value
       end

data/lib/producer/core/env.rb

@@ -7,7 +7,8 @@ module Producer
       attr_reader   :input, :output, :error_output, :registry, :logger
       attr_accessor :target, :verbose, :debug, :dry_run, :recipe_argv
 
-      def initialize(input: $stdin, output: $stdout, error_output: $stderr, remote: nil, registry: {})
+      def initialize input: $stdin, output: $stdout, error_output: $stderr,
+          remote: nil, registry: {}
         @verbose = @debug = @dry_run = false
         @input        = input
         @output       = output
@@ -20,10 +21,10 @@ module Producer
         @remote ||= Remote.new(target)
       end
 
-      def [](*args)
+      def [] *args
         @registry.fetch *args
       rescue KeyError
-        fail RegistryKeyError, args.first.inspect
+        raise RegistryKeyError, args.first.inspect
       end
       alias get []
 
@@ -34,7 +35,7 @@ module Producer
         end
       end
 
-      def log(message, severity = :info)
+      def log message, severity = :info
         logger.send severity, message
       end
 

data/lib/producer/core/error_formatter.rb

@@ -8,7 +8,7 @@ module Producer
         /\/net-sftp/
       ].freeze
 
-      def initialize(debug: false, force_cause: [])
+      def initialize debug: false, force_cause: []
         @debug        = debug
         @force_cause  = force_cause
       end
@@ -17,46 +17,45 @@ module Producer
         !!@debug
       end
 
-      def format(exception)
-        lines = format_exception exception, filter: !debug?
-
+      def format exception
         if debug? && exception.cause
+          lines = format_exception exception, filter: true
           lines << ''
           lines << 'cause:'
           lines << format_exception(exception.cause, filter: false)
+        else
+          lines = format_exception exception, filter: !debug?
         end
 
-        lines.join("\n")
+        lines.join "\n"
       end
 
+    private
 
-      private
-
-      def format_exception(exception, filter: true)
+      def format_exception exception, filter: true
         [
           format_message(exception),
           *format_backtrace(exception.backtrace, filter: filter)
         ]
       end
 
-      def format_message(exception)
-        exception = exception.cause if @force_cause.include? exception.class
+      def format_message exception
         "#{exception.class.name.split('::').last}: #{exception.message}"
       end
 
-      def format_backtrace(backtrace, filter: true)
+      def format_backtrace backtrace, filter: true
         backtrace = filter_backtrace backtrace if filter
         indent_backtrace backtrace
       end
 
-      def filter_backtrace(backtrace)
+      def filter_backtrace backtrace
         backtrace.reject do |line|
           FILTERS.any? { |filter| line =~ filter }
         end
       end
 
-      def indent_backtrace(backtrace)
-        backtrace.map { |e| '  %s' % e }
+      def indent_backtrace backtrace
+        backtrace.map { |e| '  ' + e }
       end
     end
   end

data/lib/producer/core/errors.rb

@@ -8,5 +8,6 @@ module Producer
     RecipeEvaluationError       = Class.new(RuntimeError)
     RemoteCommandExecutionError = Class.new(RuntimeError)
     RegistryKeyError            = Class.new(RuntimeError)
+    RemoteInvalidError          = Class.new(ArgumentError)
   end
 end

data/lib/producer/core/logger_formatter.rb

@@ -1,14 +1,13 @@
 module Producer
   module Core
     class LoggerFormatter < Logger::Formatter
-      def call(severity, datetime, progname, message)
+      def call severity, _datetime, _progname, message
         prefix(severity) + message + "\n"
       end
 
+    private
 
-      private
-
-      def prefix(severity)
+      def prefix severity
         severity == 'WARN' ? 'Warning: ' : ''
       end
     end

data/lib/producer/core/prompter.rb

@@ -3,14 +3,14 @@ module Producer
     class Prompter
       attr_reader :input, :output
 
-      def initialize(input, output)
+      def initialize input, output
         @input  = input
         @output = output
       end
 
-      def prompt(question, choices)
-        cs = choices.each_with_index.inject('') do |m, (c, i)|
-          m += "#{i}: #{c.last}\n"
+      def prompt question, choices
+        cs = choices.each_with_index.inject '' do |m, (c, i)|
+          m + "#{i}: #{c.last}\n"
         end
         output.puts "#{question}\n#{cs}Choice:"
         choice = input.gets

data/lib/producer/core/recipe/file_evaluator.rb

@@ -3,12 +3,12 @@ module Producer
     class Recipe
       class FileEvaluator
         class << self
-          def evaluate(file_path, env)
+          def evaluate file_path, env
             content = File.read(file_path)
             begin
               Recipe.new(env).tap { |o| o.instance_eval content, file_path }
-            rescue Exception => e
-              fail RecipeEvaluationError, e.message, [
+            rescue ::StandardError, ::ScriptError => e
+              raise RecipeEvaluationError, e.message, [
                 '%s (recipe)' % file_path,
                 *e.backtrace
               ]

data/lib/producer/core/recipe.rb

@@ -2,7 +2,7 @@ module Producer
   module Core
     class Recipe
       class << self
-        def define_macro(name, block)
+        def define_macro name, block
           [self, Task].each do |klass|
             klass.class_eval do
               define_method(name) { |*args| task name, *args, &block }
@@ -10,7 +10,7 @@ module Producer
           end
         end
 
-        def compose_macro(name, macro, *base_args)
+        def compose_macro name, macro, *base_args
           [self, Task].each do |klass|
             klass.class_eval do
               define_method(name) { |*args| send macro, *(base_args + args) }
@@ -24,32 +24,32 @@ module Producer
       def_delegator :@env, :[],   :get
       attr_reader :env, :tasks
 
-      def initialize(env)
+      def initialize env
         @env    = env
         @tasks  = []
       end
 
-      def source(filepath)
+      def source filepath
         instance_eval File.read("./#{filepath}.rb"), "#{filepath}.rb"
       end
 
-      def target(hostname = nil)
+      def target hostname = nil
         if hostname then env.target ||= hostname else env.target end
       end
 
-      def task(name, *args, &block)
+      def task name, *args, &block
         Task.evaluate(env, name, *args, &block).tap { |o| @tasks << o }
       end
 
-      def macro(name, &block)
+      def macro name, &block
         self.class.class_eval { define_macro name, block }
       end
 
-      def compose_macro(name, macro, *base_args)
-        self.class.class_eval { compose_macro name, macro, *base_args}
+      def compose_macro name, macro, *base_args
+        self.class.class_eval { compose_macro name, macro, *base_args }
       end
 
-      def test_macro(name, &block)
+      def test_macro name, &block
         Condition.define_test(name, block)
       end
     end

data/lib/producer/core/remote/environment.rb

@@ -3,7 +3,7 @@ module Producer
     class Remote
       class Environment
         class << self
-          def string_to_hash(str)
+          def string_to_hash str
             Hash[str.each_line.map { |l| l.chomp.split '=', 2 }]
           end
         end