producer-core 0.5.7 → 0.5.8

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

@@ -4,41 +4,41 @@ module Producer
       class FS
         attr_reader :sftp
 
-        def initialize(sftp)
+        def initialize sftp
           @sftp = sftp
         end
 
-        def dir?(path)
+        def dir? path
           sftp.stat!(path).directory?
         rescue Net::SFTP::StatusException
           false
         end
 
-        def file?(path)
+        def file? path
           sftp.stat!(path).file?
         rescue Net::SFTP::StatusException
           false
         end
 
-        def setstat(path, attributes)
+        def setstat path, attributes
           sftp.setstat! path, attributes
         end
 
-        def chmod(path, mode)
+        def chmod path, mode
           setstat path, permissions: mode
         end
 
-        def mkdir(path, attributes = {})
-          ret = sftp.mkdir! path, attributes
+        def mkdir path, attributes = {}
+          sftp.mkdir! path, attributes
         end
 
-        def file_read(path)
-          sftp.file.open(path) { |f| content = f.read }
+        def file_read path
+          sftp.file.open(path) { |f| f.read }
         rescue Net::SFTP::StatusException
           nil
         end
 
-        def file_write(path, content)
+        def file_write path, content
           sftp.file.open path, 'w' do |f|
             f.write content
           end

data/lib/producer/core/remote.rb

@@ -4,12 +4,18 @@ module Producer
       attr_reader :hostname
       attr_writer :session
 
-      def initialize(hostname)
+      def initialize hostname
         @hostname = hostname
       end
 
       def session
-        @session ||= Net::SSH.start(@hostname, user_name)
+        @session ||= begin
+          if !@hostname
+            fail RemoteInvalidError,
+              "remote target is invalid: `#{@hostname.inspect}'"
+          end
+          Net::SSH.start(@hostname, user_name)
+        end
       end
 
       def config
@@ -24,18 +30,18 @@ module Producer
         @fs ||= Remote::FS.new(session.sftp.connect)
       end
 
-      def execute(command, output = '', error_output = '')
+      def execute command, output = '', error_output = ''
         session.open_channel do |channel|
-          channel.exec command do |ch, success|
-            ch.on_data do |c, data|
+          channel.exec command do |ch, _success|
+            ch.on_data do |_c, data|
               output << data
             end
 
-            ch.on_extended_data do |c, type, data|
+            ch.on_extended_data do |_c, _type, data|
               error_output << data
             end
 
-            ch.on_request 'exit-status' do |c, data|
+            ch.on_request 'exit-status' do |_c, data|
               exit_status = data.read_long
               fail RemoteCommandExecutionError, command if exit_status != 0
             end

data/lib/producer/core/task.rb

@@ -2,13 +2,13 @@ module Producer
   module Core
     class Task
       class << self
-        def define_action(keyword, klass)
-          define_method(keyword) do |*args|
+        def define_action keyword, klass
+          define_method keyword do |*args|
             @actions << klass.new(@env, *args)
           end
         end
 
-        def evaluate(env, name, *args, &block)
+        def evaluate env, name, *args, &block
           new(env, name).tap { |o| o.instance_exec *args, &block }
         end
       end
@@ -32,7 +32,7 @@ module Producer
 
       attr_reader :name, :actions, :condition
 
-      def initialize(env, name, actions = [], condition = true)
+      def initialize env, name, actions = [], condition = true
         @env        = env
         @name       = name
         @actions    = actions
@@ -43,22 +43,28 @@ module Producer
         !!@condition
       end
 
-      def condition(&block)
+      def condition &block
         @condition = Condition.evaluate(@env, &block) if block
         @condition
       end
 
-      def task(name, *args, &block)
+      def task name, *args, &block
         @actions << self.class.evaluate(@env, name, *args, &block)
       end
 
-      def ask(question, choices, prompter: Prompter.new(@env.input, @env.output))
-        prompter.prompt(question, choices)
+      def ask question, choices, prompter: build_prompter
+        prompter.prompt question, choices
       end
 
-      def template(path, variables = {})
+      def template path, variables = {}
         Template.new(path).render variables
       end
+
+    private
+
+      def build_prompter
+        Prompter.new(@env.input, @env.output)
+      end
     end
   end
 end

data/lib/producer/core/template.rb

@@ -3,28 +3,27 @@ module Producer
     class Template
       SEARCH_PATH = 'templates'.freeze
 
-      def initialize(path, search_path: SEARCH_PATH)
+      def initialize path, search_path: SEARCH_PATH
         @path         = Pathname.new(path)
         @search_path  = Pathname.new(search_path)
       end
 
-      def render(variables = {})
+      def render variables = {}
         case (file_path = resolve_path).extname
-        when '.yaml'  then render_yaml file_path
-        when '.erb'   then render_erb file_path, variables
+          when '.yaml'  then render_yaml file_path
+          when '.erb'   then render_erb file_path, variables
         end
       end
 
+    private
 
-      private
-
-      def render_erb(file_path, variables = {})
+      def render_erb file_path, variables = {}
         tpl = ERB.new(File.read(file_path), nil, '-')
         tpl.filename = file_path.to_s
         tpl.result build_erb_binding variables
       end
 
-      def render_yaml(file_path)
+      def render_yaml file_path
         YAML.load(File.read(file_path))
       end
 
@@ -36,11 +35,11 @@ module Producer
         end
       end
 
-      def resolve_suffix(path)
+      def resolve_suffix path
         Pathname.glob("#{path}.{erb,yaml}").first
       end
 
-      def build_erb_binding(variables)
+      def build_erb_binding variables
         Object.new.instance_eval do |o|
           variables.each do |k, v|
             o.instance_variable_set "@#{k}", v

data/lib/producer/core/test.rb

@@ -7,7 +7,7 @@ module Producer
 
       attr_reader :env, :arguments
 
-      def initialize(env, *arguments, negated: false)
+      def initialize env, *arguments, negated: false
         @env        = env
         @arguments  = arguments
         @negated    = negated

data/lib/producer/core/testing/aruba_program_wrapper.rb

@@ -2,8 +2,8 @@ module Producer
   module Core
     module Testing
       class ArubaProgramWrapper
-        def initialize(argv, stdin = $stdin, stdout = $stdout, stderr = $stderr,
-          kernel = Kernel)
+        def initialize argv, stdin = $stdin, stdout = $stdout, stderr = $stderr,
+          kernel = Kernel
           @argv   = argv
           @stdin  = stdin
           @stdout = stdout

data/lib/producer/core/testing/cucumber/output_steps.rb

@@ -1,3 +1,15 @@
+Then /^the output must contain exactly the usage$/ do
+  assert_exact_output <<-eoh, all_output
+Usage: producer [options] [recipes] [-- recipe_argument...]
+
+options:
+    -v, --verbose                    enable verbose mode
+    -d, --debug                      enable debug mode
+    -n, --dry-run                    enable dry run mode
+    -t, --target HOST                target host
+  eoh
+end
+
 Then /^the output must match \/([^\/]+)\/$/ do |pattern|
   assert_matching_output pattern, all_output
 end

data/lib/producer/core/testing/cucumber/recipe_steps.rb

@@ -1,13 +1,13 @@
-def run_recipe(remote: false, options: nil, check: false, rargv: nil)
+def run_recipe remote: false, options: nil, check: false, rargv: nil
   command = %w[producer recipe.rb]
   case remote
-  when :unknown then command += %w[-t unknown_host.test]
-  when true     then command += %w[-t some_host.test]
+    when :unknown then command += %w[-t unknown_host.test]
+    when true     then command += %w[-t some_host.test]
   end
   command << options if options
   command << ['--', *rargv] if rargv
 
-  with_env 'HOME' => File.expand_path(current_dir) do
+  with_environment 'HOME' => expand_path('.') do
     run_simple command.join(' '), false
   end
 
@@ -72,5 +72,5 @@ When /^I successfully execute the recipe with arguments "([^"]+)"$/ do |rargv|
 end
 
 When /^I execute the recipe interactively$/ do
-  run_interactive 'producer recipe.rb'
+  run 'producer recipe.rb'
 end

data/lib/producer/core/testing/cucumber/remote_steps.rb

@@ -1,11 +1,11 @@
-def stat_mode(path)
-  in_current_dir do
+def stat_mode path
+  cd '.' do
     ('%o' % [File::Stat.new(path).mode])[-4, 4]
   end
 end
 
 Given /^a remote directory named "([^"]+)"$/ do |path|
-  create_dir path
+  create_directory path
 end
 
 Given /^a remote file named "([^"]+)"$/ do |file_name|
@@ -17,7 +17,7 @@ Given /^a remote file named "([^"]+)" with "([^"]+)"$/ do |file_name, content|
 end
 
 Then /^the remote directory "([^"]+)" must exist$/ do |path|
-  check_directory_presence [path], true
+  expect(path).to be_an_existing_directory
 end
 
 Then /^the remote file "([^"]+)" must exist$/ do |path|
@@ -25,19 +25,19 @@ Then /^the remote file "([^"]+)" must exist$/ do |path|
 end
 
 Then /^the remote file "([^"]+)" must contain "([^"]+)"$/ do |path, content|
-  check_file_content path, content, true
+  expect(path).to have_file_content Regexp.new(content)
 end
 
 Then /^the remote file "([^"]+)" must contain exactly "([^"]+)"$/ do |path, content|
-  check_file_content path, content
+  expect(path).to have_file_content content
 end
 
 Then /^the remote file "([^"]+)" must contain exactly:$/ do |path, content|
-  check_file_content path, content
+  expect(path).to have_file_content content
 end
 
 Then /^the remote file "([^"]+)" must match \/([^\/]+)\/$/ do |path, pattern|
-  check_file_content path, /#{pattern}/, true
+  expect(path).to have_file_content /#{pattern}/
 end
 
 Then /^the remote file "([^"]+)" must have (\d+) mode$/ do |path, mode|

data/lib/producer/core/testing/cucumber.rb

@@ -18,12 +18,12 @@ end
 # Use aruba "in process" optimization only for scenarios not tagged @exec.
 # We need a real process in a few cases: real program name, interactive usage…
 Before('@exec') do
-  Aruba.process = Aruba::SpawnProcess
+  aruba.config.command_launcher = :spawn
 end
 
 Before('~@exec') do
-  Aruba::InProcess.main_class = Producer::Core::Testing::ArubaProgramWrapper
-  Aruba.process = Aruba::InProcess
+  aruba.config.command_launcher = :in_process
+  aruba.config.main_class       = Producer::Core::Testing::ArubaProgramWrapper
 end
 
 # Enable cucumber-sshd "fast" mode (persists sshd across scenarios), and

data/lib/producer/core/testing/mock_remote.rb

@@ -3,35 +3,37 @@ module Producer
     module Testing
       class MockRemote < Remote
         def session
-          fail 'no session for mock remote!'
+          fail RuntimeError, 'no session for mock remote!'
         end
 
-        def execute(command, output = '', error_output = '')
-          tokens = command.gsub(/\d?>.*/, '').split
-          program = tokens.shift
+        def execute command, output = '', error_output = ''
+          program, *args = command.gsub(/\d?>.*/, '').split
+          program_output = command =~ />&2\z/ ? error_output : output
+          send "handle_program_#{program}", args, program_output
+          output
+        end
 
-          case program
-          when 'echo'
-            out = tokens.join(' ') << "\n"
-            if command =~ />&2\z/
-              error_output << out
-            else
-              output << out
-            end
-          when 'true'
-            output << ''
-          when 'false'
-            fail RemoteCommandExecutionError
-          when 'type'
-            fail RemoteCommandExecutionError unless %w[
-              echo
-              true
-              false
-              type
-            ].include? tokens.first
-          end
+      private
 
-          output
+        def handle_program_echo args, output
+          output << args.join(' ') << "\n"
+        end
+
+        def handle_program_true _, output
+          output << ''
+        end
+
+        def handle_program_false *_
+          fail RemoteCommandExecutionError
+        end
+
+        def handle_program_type args, _
+          fail RemoteCommandExecutionError unless %w[
+            echo
+            true
+            false
+            type
+          ].include? args.first
         end
       end
     end

data/lib/producer/core/tests/condition_test.rb

@@ -7,7 +7,7 @@ module Producer
         def_delegator :condition,   :met?,   :verify
 
         def condition
-          Condition.evaluate(env, *condition_args, &condition_block)
+          Condition.evaluate env, *condition_args, &condition_block
         end
 
         def condition_args

data/lib/producer/core/tests/file_contains.rb

@@ -7,11 +7,10 @@ module Producer
           content ? content.include?(arguments[1]) : false
         end
 
-
-        private
+      private
 
         def file_content
-          fs.file_read(arguments[0])
+          fs.file_read arguments[0]
         end
       end
     end

data/lib/producer/core/tests/file_eq.rb

@@ -6,8 +6,7 @@ module Producer
           file_content ? file_content == expected_content : false
         end
 
-
-        private
+      private
 
         def file_content
           @file_content ||= fs.file_read(arguments[0])

data/lib/producer/core/tests/file_match.rb

@@ -6,8 +6,7 @@ module Producer
           !!(file_content =~ arguments[1])
         end
 
-
-        private
+      private
 
         def file_content
           fs.file_read(arguments[0]) or ''

data/lib/producer/core/tests/has_env.rb

@@ -4,15 +4,12 @@ module Producer
       class HasEnv < Test
         def verify
           case arguments.size
-          when 1
-            remote.environment.key? key
-          when 2
-            remote.environment[key] == arguments.last
+            when 1 then remote.environment.key? key
+            when 2 then remote.environment[key] == arguments.last
           end
         end
 
-
-        private
+      private
 
         def key
           arguments.first.to_s.upcase

data/lib/producer/core/tests/has_executable.rb

@@ -3,7 +3,7 @@ module Producer
     module Tests
       class HasExecutable < Test
         def verify
-          remote.execute("type #{arguments.first}")
+          remote.execute "type #{arguments.first}"
           true
         rescue RemoteCommandExecutionError
           false

data/lib/producer/core/tests/shell_command_status.rb

@@ -6,7 +6,7 @@ module Producer
         def_delegator :@arguments, :first, :command
 
         def verify
-          remote.execute(command)
+          remote.execute command
           true
         rescue RemoteCommandExecutionError
           false

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.5.7'.freeze
+    VERSION = '0.5.8'.freeze
   end
 end

data/lib/producer/core/worker.rb

@@ -4,22 +4,23 @@ module Producer
       DRY_RUN_WARNING =
         'running in dry run mode, actions will NOT be applied'.freeze
 
-      def initialize(env)
+      def initialize env
         @env = env
       end
 
-      def process(tasks)
+      def process tasks
         @env.log DRY_RUN_WARNING, :warn if @env.dry_run?
 
         tasks.each { |t| process_task t }
       end
 
-      def process_task(task, indent_level = 0)
+      def process_task task, indent_level = 0
         if task.condition_met?
           log "Task: `#{task}' applying...", indent_level
           task.actions.each do |e|
             case e
-            when Task then process_task e, indent_level + 2
+            when Task
+              process_task e, indent_level + 2
             else
               log " action: #{e}", indent_level
               e.apply unless @env.dry_run?
@@ -30,10 +31,9 @@ module Producer
         end
       end
 
+    private
 
-      private
-
-      def log(message, indent_level)
+      def log message, indent_level
         message = [' ' * indent_level, message].join
         @env.log message
       end

data/lib/producer/core.rb

@@ -8,7 +8,6 @@ require 'yaml'
 require 'net/ssh'
 require 'net/sftp'
 
-
 # task actions
 require 'producer/core/action'
 require 'producer/core/actions/echo'

data/producer-core.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec',         '~> 3.1'
   s.add_development_dependency 'cucumber',      '~> 2.0'
-  s.add_development_dependency 'aruba',         '~> 0.5'
-  s.add_development_dependency 'cucumber-sshd', '~> 1.1'
+  s.add_development_dependency 'aruba',         '~> 0.8'
+  s.add_development_dependency 'cucumber-sshd', '~> 1.1.1'
   s.add_development_dependency 'rake',          '~> 10.1'
 end

data/spec/producer/core/cli_spec.rb

@@ -8,15 +8,16 @@ module Producer::Core
     let(:options)     { [] }
     let(:recipe_file) { fixture_path_for 'recipes/some_recipe.rb' }
     let(:arguments)   { [*options, recipe_file] }
+    let(:environment) { {} }
 
-    subject(:cli)     { described_class.new(arguments) }
+    subject(:cli)     { described_class.new(arguments, environment) }
 
     describe '.run!' do
       subject(:run!) { described_class.run! arguments }
 
-      it 'builds a new CLI instance with given arguments' do
+      it 'builds a new CLI instance with given arguments and environment' do
         expect(described_class)
-          .to receive(:new).with(arguments, anything).and_call_original
+          .to receive(:new).with(arguments, ENV, anything).and_call_original
         run!
       end
 
@@ -54,7 +55,7 @@ module Producer::Core
 
         it 'prints a report to the error stream' do
           expect { trap_exit { run! } }
-            .to output(/\ARemoteCommandExecutionError: false$/).to_stderr
+            .to output(/\ARecipeEvaluationError: false$/).to_stderr
         end
       end
     end
@@ -75,6 +76,30 @@ module Producer::Core
       it 'assigns CLI stderr as the env error output' do
         expect(cli.env.error_output).to be cli.stderr
       end
+
+      context 'when PRODUCER_VERBOSE environment variable is set' do
+        before { environment['PRODUCER_VERBOSE'] = 'yes' }
+
+        it 'enables env verbose mode' do
+          expect(cli.env).to be_verbose
+        end
+      end
+
+      context 'when PRODUCER_DEBUG environment variable is set' do
+        before { environment['PRODUCER_DEBUG'] = 'yes' }
+
+        it 'enables env debug mode' do
+          expect(cli.env).to be_debug
+        end
+      end
+
+      context 'when PRODUCER_DRYRUN environment variable is set' do
+        before { environment['PRODUCER_DRYRUN'] = 'yes' }
+
+        it 'enables env dry run mode' do
+          expect(cli.env).to be_dry_run
+        end
+      end
     end
 
     describe '#parse_arguments!' do

data/spec/producer/core/remote_spec.rb

@@ -27,6 +27,14 @@ module Producer::Core
         allow(Net::SSH).to receive(:start) { Object.new }
         expect(remote.session).to be remote.session
       end
+
+      context 'when hostname is invalid' do
+        let(:hostname) { nil }
+
+        it 'raises RemoteInvalidError' do
+          expect { remote.session }.to raise_error RemoteInvalidError
+        end
+      end
     end
 
     describe '#config' do
@@ -128,7 +136,7 @@ module Producer::Core
 
         it 'raises an exception' do
           expect { remote.execute command }
-            .to raise_error(RemoteCommandExecutionError)
+            .to raise_error RemoteCommandExecutionError
         end
 
         it 'includes the command in the exception message' do