producer-core 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 746db32442ceec92cc0067f515e69d43c052afee
-  data.tar.gz: 8c3b7aaf1f0e4b6722609243204b635f1d5db6af
+  metadata.gz: a8faaa83c5e385860c285a917432f88805b1445d
+  data.tar.gz: b52d94053b00d17230c749c322951a9bb827cf62
 SHA512:
-  metadata.gz: ddfa5f0ffa6e5bd5b67f93d2c89b580ded6edc99876dad0e38daf5f2a3c0b36eb87b73cf0bb7ad97a257efaebe53a454263a81a838accf980dc87ee8bb531290
-  data.tar.gz: ffe69bcb350968fa1e3e97cc5ea5668efa4ac191d1e21731c7cedf797e0f9609b3a356d0441e0ec4b1bd4b3e72f910f2ba037a070edff111a4d922947a599e12
+  metadata.gz: f6b3876fbe282f363d89b8fde05c0c39d9631e13cb64fa42b7bc5fae4773b76ceba55895906afa1a51b34429de16b5ca24cb75ba3f68d78222cd9148fe0e26ad
+  data.tar.gz: 4ad7ba7ef20948f5ad4ddc795fb7a6a075f5de6fd06591e86edd8b8114e20e5aa22c405652c074b5624915f44223de00dd250071997146d4baaa7b942173adb2

data/features/action_file_append.feature

@@ -7,11 +7,9 @@ Feature: `file_append' task action
   Scenario: appends given content to requested file
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :file_append_action do
         file_append 'some_file', ' added'
       end
       """
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote file "some_file" must contain exactly "some content added"

data/features/action_file_replace_content.feature

@@ -6,8 +6,6 @@ Feature: `file_replace_content' task action
     And a remote file named "other_file" with "some content"
     And a recipe with:
       """
-      target 'some_host.test'
-
       task :file_replace_content_action_string do
         file_replace_content 'some_file', 'content', 'other content'
       end
@@ -18,9 +16,9 @@ Feature: `file_replace_content' task action
       """
 
   Scenario: replaces a string by another in the requested file
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote file "some_file" must contain exactly "some other content"
 
   Scenario: replaces a regular expression by a string in the requested file
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote file "other_file" must contain exactly "some other content"

data/features/action_file_write.feature

@@ -4,8 +4,6 @@ Feature: `file_write' task action
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :file_write_action do
         file_write 'some_file',       'some_content'
         file_write 'some_file_0600',  'some_content', 0600
@@ -14,10 +12,10 @@ Feature: `file_write' task action
       """
 
   Scenario: writes given data to given file path
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote file "some_file" must contain "some_content"
 
   Scenario: creates file with given permissions
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote file "some_file_0600" must have 0600 mode
     And  the remote file "some_file_0700" must have 0700 mode

data/features/action_mkdir.feature

@@ -4,8 +4,6 @@ Feature: `mkdir' task action
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :mkdir_action do
         mkdir 'some_directory'
         mkdir 'some_directory_0700', 0700
@@ -14,10 +12,10 @@ Feature: `mkdir' task action
       """
 
   Scenario: creates directory given as argument
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote directory "some_directory" must exists
 
   Scenario: creates directory with given permissions
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the remote directory "some_directory_0700" must have 0700 mode
     And  the remote directory "some_directory_0500" must have 0500 mode

data/features/action_sh.feature

@@ -4,36 +4,40 @@ Feature: `sh' task action
   Scenario: forwards standard ouput
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :sh_action do
         sh '\echo hello from remote'
       end
       """
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain exactly "hello from remote\n"
 
-  Scenario: aborts on failed command execution
+  Scenario: forwards error ouput
     Given a recipe with:
       """
-      target 'some_host.test'
+      task :sh_action do
+        sh '\echo error from remote >&2'
+      end
+      """
+    When I successfully execute the recipe on remote target
+    Then the error output must contain exactly "error from remote\n"
 
+  Scenario: aborts on failed command execution
+    Given a recipe with:
+      """
       task :sh_action_aborting do
         sh '\false'
         sh '\echo after_fail'
       end
       """
-    When I execute the recipe
+    When I execute the recipe on remote target
     Then the output must not contain "after_fail"
 
   Scenario: prints command when execution fail
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :sh_action_command_error do
         sh '\false'
       end
       """
-    When I execute the recipe
+    When I execute the recipe on remote target
     Then the output must match /\A\w+Error:\s+\\false/

data/features/cli_target.feature

@@ -10,6 +10,6 @@ Feature: CLI target option
       end
       """
 
-  Scenario: prints tasks name
+  Scenario: override the recipe target
     When I successfully execute the recipe with option -t other_host.example
     Then the output must contain exactly "other_host.example\n"

data/features/recipe_test_macro.feature

@@ -22,8 +22,6 @@ Feature: `test_macro' recipe keyword
   Scenario: has access to core tests
     Given a recipe with:
       """
-      target 'some_host.test'
-
       test_macro(:other_env?) { |k| env? k }
 
       [:shell, :non_existent_var].each do |k|
@@ -33,7 +31,7 @@ Feature: `test_macro' recipe keyword
         end
       end
       """
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "shell_ok"
     Then the output must not contain "non_existent_var_ok"
 

data/features/steps/output_steps.rb

@@ -21,3 +21,7 @@ end
 Then /^the output must contain exactly:$/ do |content|
   assert_exact_output content, all_output
 end
+
+Then /^the error output must contain exactly "([^"]+)"$/ do |content|
+  assert_exact_output content, all_stderr
+end

data/features/steps/recipe_steps.rb

@@ -6,11 +6,20 @@ When /^I execute the recipe$/ do
   run_simple 'producer recipe.rb', false
 end
 
+When /^I execute the recipe on remote target$/ do
+  run_simple 'producer recipe.rb -t some_host.test', false
+end
+
 When /^I successfully execute the recipe$/ do
   step 'I execute the recipe'
   assert_exit_status 0
 end
 
+When /^I successfully execute the recipe on remote target$/ do
+  step 'I execute the recipe on remote target'
+  assert_exit_status 0
+end
+
 When /^I successfully execute the recipe with option (-.+)$/ do |option|
   run_simple "producer #{option} recipe.rb", false
   assert_exit_status 0

data/features/test_dir.feature

@@ -4,8 +4,6 @@ Feature: `dir?' condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :dir_test do
         condition { dir? 'some_directory' }
 
@@ -15,9 +13,9 @@ Feature: `dir?' condition keyword
 
   Scenario: succeeds when directory exists
     Given a remote directory named "some_directory"
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "evaluated"
 
   Scenario: fails when directory does not exist
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "evaluated"

data/features/test_env.feature

@@ -4,8 +4,6 @@ Feature: `env?' condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :env_test_definition_ok do
         condition { env? :shell }
 
@@ -32,17 +30,17 @@ Feature: `env?' condition keyword
       """
 
   Scenario: succeeds when remote environment variable is defined
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "definition_ok"
 
   Scenario: fails when remote environment variable is not defined
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "definition_ko"
 
   Scenario: succeeds when remote environment variable value match
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "value_ok"
 
   Scenario: fails when remote environment variable value does not match
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "value_ko"

data/features/test_executable.feature

@@ -4,8 +4,6 @@ Feature: `executable?' condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :executable_test_ok do
         condition { executable? 'true' }
 
@@ -20,9 +18,9 @@ Feature: `executable?' condition keyword
       """
 
   Scenario: succeeds when remote executable is available
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "test_ok"
 
   Scenario: fails when remote executable is not available
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "test_ko"

data/features/test_file.feature

@@ -4,8 +4,6 @@ Feature: `file?' condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :file_test do
         condition { file? 'some_file' }
 
@@ -15,9 +13,9 @@ Feature: `file?' condition keyword
 
   Scenario: succeeds when file exists
     Given a remote file named "some_file"
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "evaluated"
 
   Scenario: fails when file does not exist
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "evaluated"

data/features/test_file_contains.feature

@@ -4,8 +4,6 @@ Feature: `file_contains' condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :file_contains_test do
         condition { file_contains 'some_file', 'some_content' }
 
@@ -15,14 +13,14 @@ Feature: `file_contains' condition keyword
 
   Scenario: succeeds when file contains expected content
     Given a remote file named "some_file" with "some_content"
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "evaluated"
 
   Scenario: fails when file does not contain expected content
     Given a remote file named "some_file" with "some_other_content"
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "evaluated"
 
   Scenario: fails when file does not exist
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "evaluated"

data/features/test_negated_test.feature

@@ -4,8 +4,6 @@ Feature: negated test prefix (no_)
   Scenario: prefixed test fails when non-prefixed test is successful
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :successful_test do
         condition { env? :shell }
 
@@ -18,15 +16,13 @@ Feature: negated test prefix (no_)
         echo 'negated_test'
       end
       """
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "successful_test"
     And the output must not contain "negated_test"
 
   Scenario: prefixed test fails when non-prefixed test is failing
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :failing_test do
         condition { env? :inexistent_var }
 
@@ -39,6 +35,6 @@ Feature: negated test prefix (no_)
         echo 'negated_test'
       end
       """
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "failing_test"
     And the output must contain "negated_test"

data/features/test_shell_command_status.feature

@@ -4,8 +4,6 @@ Feature: `sh' and `` condition keyword
   Background:
     Given a recipe with:
       """
-      target 'some_host.test'
-
       task :sh_test_ok do
         condition { sh 'true' }
 
@@ -32,17 +30,17 @@ Feature: `sh' and `` condition keyword
       """
 
   Scenario: succeeds when remote command execution is a success
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "test_ok"
 
   Scenario: fails when remote executable is not available
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "test_ko"
 
   Scenario: `` alias, succeeds when remote executable is available
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must contain "test_backtick_ok"
 
   Scenario: `` alias, fails when remote executable is not available
-    When I successfully execute the recipe
+    When I successfully execute the recipe on remote target
     Then the output must not contain "test_backtick_ko"

data/lib/producer/core/action.rb

@@ -2,7 +2,7 @@ module Producer
   module Core
     class Action
       extend Forwardable
-      def_delegators :@env, :input, :output, :remote
+      def_delegators :@env, :input, :output, :error_output, :remote
       def_delegators :remote, :fs
 
       attr_reader :env, :arguments

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

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

data/lib/producer/core/cli.rb

@@ -31,7 +31,7 @@ module Producer
         @arguments  = args
         @stdin      = stdin
         @stdout     = stdout
-        @env        = Env.new(input: stdin, output: stdout)
+        @env        = Env.new(input: stdin, output: stdout, error_output: stderr)
       end
 
       def parse_arguments!

data/lib/producer/core/env.rb

@@ -1,15 +1,16 @@
 module Producer
   module Core
     class Env
-      attr_reader   :input, :output, :registry, :logger
+      attr_reader   :input, :output, :error_output, :registry, :logger
       attr_accessor :target, :verbose, :dry_run
 
-      def initialize(input: $stdin, output: $stdout, remote: nil, registry: {})
-        @verbose  = @dry_run = false
-        @input    = input
-        @output   = output
-        @remote   = remote
-        @registry = registry
+      def initialize(input: $stdin, output: $stdout, error_output: $stderr, remote: nil, registry: {})
+        @verbose      = @dry_run = false
+        @input        = input
+        @output       = output
+        @error_output = error_output
+        @remote       = remote
+        @registry     = registry
       end
 
       def remote

data/lib/producer/core/remote.rb

@@ -24,13 +24,17 @@ module Producer
         @fs ||= Remote::FS.new(session.sftp.connect)
       end
 
-      def execute(command, output = '')
+      def execute(command, output = '', error_output = '')
         channel = session.open_channel do |channel|
           channel.exec command do |ch, success|
             ch.on_data do |c, data|
               output << data
             end
 
+            ch.on_extended_data do |c, type, data|
+              error_output << data
+            end
+
             ch.on_request 'exit-status' do |c, data|
               exit_status = data.read_long
               fail RemoteCommandExecutionError, command if exit_status != 0

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

@@ -6,13 +6,18 @@ module Producer
           fail 'no session for mock remote!'
         end
 
-        def execute(command, output = '')
-          tokens = command.split
+        def execute(command, output = '', error_output = '')
+          tokens = command.gsub(/\d?>.*/, '').split
           program = tokens.shift
 
           case program
           when 'echo'
-            output << tokens.join(' ') << "\n"
+            out = tokens.join(' ') << "\n"
+            if command =~ />&2\z/
+              error_output << out
+            else
+              output << out
+            end
           when 'true'
             output << ''
           when 'false'

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.2.10'.freeze
+    VERSION = '0.2.11'.freeze
   end
 end

data/spec/producer/core/actions/shell_command_spec.rb

@@ -19,6 +19,15 @@ module Producer::Core
           sh.apply
           expect(output).to eq "#{command_args}\n"
         end
+
+        context 'when content is written to standard error' do
+          let(:command) { "echo #{command_args} >&2" }
+
+          it 'writes errors to given error stream' do
+            sh.apply
+            expect(error_output).to eq "#{command_args}\n"
+          end
+        end
       end
     end
   end

data/spec/producer/core/cli_spec.rb

@@ -12,7 +12,9 @@ module Producer::Core
     let(:stdout)      { StringIO.new }
     let(:stderr)      { StringIO.new }
 
-    subject(:cli)     { CLI.new(arguments, stdin: stdin, stdout: stdout) }
+    subject(:cli)     { described_class.new(
+                          arguments,
+                          stdin: stdin, stdout: stdout, stderr: stderr) }
 
     describe '.run!' do
       let(:cli) { double('cli').as_null_object }
@@ -118,6 +120,10 @@ module Producer::Core
       it 'assigns CLI stdout as the env output' do
         expect(cli.env.output).to be stdout
       end
+
+      it 'assigns CLI stderr as the env error output' do
+        expect(cli.env.error_output).to be stderr
+      end
     end
 
     describe '#parse_arguments!' do

data/spec/producer/core/env_spec.rb

@@ -10,6 +10,10 @@ module Producer::Core
         expect(env.input).to be $stdin
       end
 
+      it 'assigns $stderr as the default error output' do
+        expect(env.error_output).to be $stderr
+      end
+
       it 'assigns no default target' do
         expect(env.target).not_to be
       end
@@ -51,6 +55,15 @@ module Producer::Core
         end
       end
 
+      context 'when error output is given as argument' do
+        let(:error_output)  { StringIO.new }
+        subject(:env)       { described_class.new(error_output: error_output) }
+
+        it 'assigns the given error output' do
+          expect(env.error_output).to be error_output
+        end
+      end
+
       context 'when remote is given as argument' do
         let(:remote)  { double 'remote' }
         subject(:env) { described_class.new(remote: remote) }

data/spec/producer/core/remote_spec.rb

@@ -106,6 +106,16 @@ module Producer::Core
         expect(output.string).to eq arguments
       end
 
+      it 'writes command error output to provided error output' do
+        error_output = StringIO.new
+        story_with_new_channel do |ch|
+          ch.sends_exec command
+          ch.gets_extended_data arguments
+        end
+        remote.execute command, output, error_output
+        expect(error_output.string).to eq arguments
+      end
+
       context 'when command execution fails' do
         before do
           story_with_new_channel do |ch|

data/spec/support/shared_action.rb

@@ -29,6 +29,12 @@ module Producer::Core
       end
     end
 
+    describe '#error_output' do
+      it 'returns env error output' do
+        expect(action.error_output).to be env.error_output
+      end
+    end
+
     describe '#remote' do
       it 'returns env remote' do
         expect(action.remote).to be env.remote

data/spec/support/test_env_helpers.rb

@@ -9,6 +9,10 @@ module TestEnvHelpers
     env.output.string
   end
 
+  def error_output
+    env.error_output.string
+  end
+
   def remote_fs
     env.remote.fs
   end
@@ -17,14 +21,18 @@ module TestEnvHelpers
     opts = { expected_from: caller.first }
     RSpec::Mocks
       .expect_message(env.remote, :execute, opts)
-      .with(command, env.output)
+      .with(command, env.output, env.error_output)
   end
 
 
   private
 
   def build_env
-    Producer::Core::Env.new(output: StringIO.new, remote: build_remote)
+    Producer::Core::Env.new(
+      output:       StringIO.new,
+      error_output: StringIO.new,
+      remote:       build_remote
+    )
   end
 
   def build_remote

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Thibault Jouan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh