producer-core 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5075625b8dd7462b61363dfca8186442ecf2df57
-  data.tar.gz: fa274fc269efe57af84d363b116d248778b60756
+  metadata.gz: 1c2475905b4f530aaa6299d8ff7a85c05c588bb3
+  data.tar.gz: f2cfa1b86883199dee6760ae43dfbed5e8dcbe70
 SHA512:
-  metadata.gz: 7cebd961ba388776c216f61c5c7acbeb1b764b9140e59dffe4ea14d0859e446e0ff7b9b56d643b671bcc364333d2d62dc8b110ce20d8fd257e33958684815e29
-  data.tar.gz: 501ed6a4b3782ea91b689331a99b7fade6037e0e5bf0120dfb1f95384b3d8544e2dc69916ee4083fdc7788cd4b5ce597b8be57abd1a766a33e676cd981745502
+  metadata.gz: 6b7b4f2e271d4731f99256bc3f44be758e821b1ec44c82ace19cf3c59b846ef1d77dc7bb433159ba2686fdd5acf7aad632b6269e520202725a790770cf373d7d
+  data.tar.gz: 7dda9db4a723a9d479ff4e589bb9d3dbb9295d8dc939320287021b35b42468e12e22d4f5a8a91da590bd28983e89fe37dcf54c105fe99c5749095b922af98511

data/features/actions/file_append.feature

@@ -0,0 +1,17 @@
+@sshd
+Feature: `file_append' task action
+
+  Background:
+    Given a remote file named "some_file" with "some content"
+
+  Scenario: appends given content to requested file
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :append_content_to_file do
+        file_append 'some_file', ' added'
+      end
+      """
+    When I successfully execute the recipe
+    Then the remote file "some_file" must contain exactly "some content added"

data/features/actions/file_replace_content.feature

@@ -4,7 +4,7 @@ Feature: `file_replace_content' task action
   Background:
     Given a remote file named "some_file" with "some content"
 
-  Scenario: replace a string by another in the requested file
+  Scenario: replaces a string by another in the requested file
     Given a recipe with:
       """
       target 'some_host.test'
@@ -13,19 +13,17 @@ Feature: `file_replace_content' task action
         file_replace_content 'some_file', 'content', 'other content'
       end
       """
-    When I execute the recipe
-    Then the exit status must be 0
+    When I successfully execute the recipe
     And the remote file "some_file" must contain exactly "some other content"
 
-  Scenario: replace a regular expression by a string in the requested file
+  Scenario: replaces a regular expression by a string in the requested file
     Given a recipe with:
       """
       target 'some_host.test'
 
-      task :replace_string_in_file do
+      task :replace_regexp_in_file do
         file_replace_content 'some_file', /\w+\z/, 'other content'
       end
       """
-    When I execute the recipe
-    Then the exit status must be 0
+    When I successfully execute the recipe
     And the remote file "some_file" must contain exactly "some other content"

data/features/actions/file_write.feature

@@ -10,6 +10,5 @@ Feature: `file_write' task action
         file_write 'some_file', 'some_content'
       end
       """
-    When I execute the recipe
-    Then the exit status must be 0
+    When I successfully execute the recipe
     And the remote file "some_file" must contain "some_content"

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

@@ -0,0 +1,23 @@
+module Producer
+  module Core
+    module Actions
+      class FileAppend < Action
+        def apply
+          fs.file_write path, combined_content
+        end
+
+        def path
+          arguments[0]
+        end
+
+        def content
+          arguments[1]
+        end
+
+        def combined_content
+          fs.file_read(path) + content
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,8 @@ module Producer
     module Actions
       class ShellCommand < Action
         def apply
-          output.puts remote.execute(arguments.first)
+          remote.execute(arguments.first, output)
+          output.puts
         end
       end
     end

data/lib/producer/core/remote.rb

@@ -23,9 +23,8 @@ module Producer
         @fs ||= Remote::FS.new(session.sftp.connect)
       end
 
-      def execute(command)
-        output = ''
-        session.open_channel do |channel|
+      def execute(command, output = '')
+        channel = session.open_channel do |channel|
           channel.exec command do |ch, success|
             ch.on_data do |c, data|
               output << data
@@ -37,7 +36,7 @@ module Producer
             end
           end
         end
-        session.loop
+        channel.wait
         output
       end
 

data/lib/producer/core/task/dsl.rb

@@ -13,9 +13,11 @@ module Producer
         define_action :echo,  Actions::Echo
         define_action :sh,    Actions::ShellCommand
 
-        define_action :mkdir,                 Actions::Mkdir
-        define_action :file_write,            Actions::FileWriter
+        define_action :mkdir, Actions::Mkdir
+
+        define_action :file_append,           Actions::FileAppend
         define_action :file_replace_content,  Actions::FileReplaceContent
+        define_action :file_write,            Actions::FileWriter
 
         attr_reader :env, :block, :actions
 

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

@@ -6,18 +6,20 @@ module Producer
           raise 'no session for mock remote!'
         end
 
-        def execute(command)
+        def execute(command, output = '')
           tokens = command.split
           program = tokens.shift
 
           case program
           when 'echo'
-            tokens.join ' '
+            output << tokens.join(' ')
           when 'true'
-            ''
+            output << ''
           when 'false'
             raise RemoteCommandExecutionError
           end
+
+          output
         end
       end
     end

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.1.13'
+    VERSION = '0.1.14'
   end
 end

data/lib/producer/core.rb

@@ -10,6 +10,7 @@ require 'producer/core/action'
 require 'producer/core/actions/echo'
 require 'producer/core/actions/shell_command'
 require 'producer/core/actions/mkdir'
+require 'producer/core/actions/file_append'
 require 'producer/core/actions/file_replace_content'
 require 'producer/core/actions/file_writer'
 

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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Producer::Core
+  module Actions
+    describe FileAppend, :env do
+      let(:path)          { 'some_path' }
+      let(:content)       { 'some content' }
+      let(:added_content) { ' added' }
+      subject(:action)    { FileAppend.new(env, path, added_content) }
+
+      it_behaves_like 'action'
+
+      before { allow(remote_fs).to receive(:file_read).with(path) { content } }
+
+      describe '#apply' do
+        it 'appends given content to requested file on remote filesystem' do
+          expect(remote_fs)
+            .to receive(:file_write).with(path, action.combined_content)
+          action.apply
+        end
+      end
+
+      describe '#path' do
+        it 'returns the file path' do
+          expect(action.path).to eq path
+        end
+      end
+
+      describe '#content' do
+        it 'returns the content to append' do
+          expect(action.content).to eq added_content
+        end
+      end
+
+      describe '#combined_content' do
+        it 'returns original content and added content combined' do
+          expect(action.combined_content).to eq 'some content added'
+        end
+      end
+    end
+  end
+end

data/spec/producer/core/remote_spec.rb

@@ -79,6 +79,7 @@ module Producer::Core
     describe '#execute', :ssh do
       let(:arguments) { 'some remote command' }
       let(:command)   { "echo #{arguments}" }
+      let(:output)    { StringIO.new }
 
       it 'executes the given command in a new channel' do
         story_with_new_channel do |ch|
@@ -88,7 +89,7 @@ module Producer::Core
         expect_story_completed { remote.execute command }
       end
 
-      it 'returns the output' do
+      it 'returns the command standard output output' do
         story_with_new_channel do |ch|
           ch.sends_exec command
           ch.gets_data arguments
@@ -96,6 +97,15 @@ module Producer::Core
         expect(remote.execute command).to eq arguments
       end
 
+      it 'writes command standard output to provided output' do
+        story_with_new_channel do |ch|
+          ch.sends_exec command
+          ch.gets_data arguments
+        end
+        remote.execute command, output
+        expect(output.string).to eq arguments
+      end
+
       it 'raises an exception when the exit status code is not 0' do
         story_with_new_channel do |ch|
           ch.sends_exec command

data/spec/producer/core/task/dsl_spec.rb

@@ -7,7 +7,14 @@ module Producer::Core
       let(:env)     { Env.new }
       subject(:dsl) { DSL.new(env, &block) }
 
-      %w[echo sh mkdir file_write file_replace_content].each do |action|
+      %w[
+        echo
+        sh
+        mkdir
+        file_append
+        file_replace_content
+        file_write
+      ].each do |action|
         it "has `#{action}' action defined" do
           expect(dsl).to respond_to action.to_sym
         end

data/spec/support/test_env_helpers.rb

@@ -15,7 +15,9 @@ module TestEnvHelpers
 
   def expect_execution(command)
     opts = { expected_from: caller.first }
-    RSpec::Mocks.expect_message(env.remote, :execute, opts).with(command)
+    RSpec::Mocks
+      .expect_message(env.remote, :execute, opts)
+      .with(command, env.output)
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Thibault Jouan
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - bin/producer
 - features/actions/echo.feature
+- features/actions/file_append.feature
 - features/actions/file_replace_content.feature
 - features/actions/file_write.feature
 - features/actions/mkdir.feature
@@ -139,6 +140,7 @@ files:
 - lib/producer/core.rb
 - lib/producer/core/action.rb
 - lib/producer/core/actions/echo.rb
+- lib/producer/core/actions/file_append.rb
 - lib/producer/core/actions/file_replace_content.rb
 - lib/producer/core/actions/file_writer.rb
 - lib/producer/core/actions/mkdir.rb
@@ -171,6 +173,7 @@ files:
 - spec/fixtures/recipes/throw.rb
 - spec/producer/core/action_spec.rb
 - spec/producer/core/actions/echo_spec.rb
+- spec/producer/core/actions/file_append_spec.rb
 - spec/producer/core/actions/file_replace_content_spec.rb
 - spec/producer/core/actions/file_writer_spec.rb
 - spec/producer/core/actions/mkdir_spec.rb
@@ -226,6 +229,7 @@ specification_version: 4
 summary: Provisioning tool
 test_files:
 - features/actions/echo.feature
+- features/actions/file_append.feature
 - features/actions/file_replace_content.feature
 - features/actions/file_write.feature
 - features/actions/mkdir.feature
@@ -258,6 +262,7 @@ test_files:
 - spec/fixtures/recipes/throw.rb
 - spec/producer/core/action_spec.rb
 - spec/producer/core/actions/echo_spec.rb
+- spec/producer/core/actions/file_append_spec.rb
 - spec/producer/core/actions/file_replace_content_spec.rb
 - spec/producer/core/actions/file_writer_spec.rb
 - spec/producer/core/actions/mkdir_spec.rb