producer-core 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ed15ccec37cb38bc7c4ea42a911708acd30630f
-  data.tar.gz: bc36933dae78ef8311eb2e840ab22cbb2927dd11
+  metadata.gz: 5075625b8dd7462b61363dfca8186442ecf2df57
+  data.tar.gz: fa274fc269efe57af84d363b116d248778b60756
 SHA512:
-  metadata.gz: 9128d8070fb39fa4cc1e4a6ba1ea9a19c29ac32b2088a412d2da5b66a5560b3b6bf9332a689423d246f936eb6aa9552b0e97a131679e11670048be996f194ceb
-  data.tar.gz: 1be0962d9d254e3f33a04636b66413084f957541456d7202cf120da1085d4cd33b856dcb464532356188e9123e77127be1ffa390a22caf3e283df3afd2919d99
+  metadata.gz: 7cebd961ba388776c216f61c5c7acbeb1b764b9140e59dffe4ea14d0859e446e0ff7b9b56d643b671bcc364333d2d62dc8b110ce20d8fd257e33958684815e29
+  data.tar.gz: 501ed6a4b3782ea91b689331a99b7fade6037e0e5bf0120dfb1f95384b3d8544e2dc69916ee4083fdc7788cd4b5ce597b8be57abd1a766a33e676cd981745502

data/Guardfile

@@ -4,8 +4,9 @@ guard :cucumber, cli: '--format pretty --quiet' do
   watch(%r{\Afeatures/step_definitions/.+_steps\.rb\z}) { 'features' }
 end
 
-guard :rspec, cmd: 'rspec -f doc', all_after_pass: true do
+guard :rspec, cmd: 'rspec -f doc' do
   watch(%r{\Aspec/.+_spec\.rb\z})
-  watch(%r{\Alib/(.+)\.rb\z})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')    { 'spec' }
+  watch(%r{\Alib/(.+)\.rb\z})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')        { 'spec' }
+  watch(%r{\Aspec/support/.+\.rb\z})  { 'spec' }
 end

data/features/actions/file_replace_content.feature

@@ -0,0 +1,31 @@
+@sshd
+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
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :replace_string_in_file do
+        file_replace_content 'some_file', 'content', 'other content'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the remote file "some_file" must contain exactly "some other content"
+
+  Scenario: replace a regular expression by a string in the requested file
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :replace_string_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
+    And the remote file "some_file" must contain exactly "some other content"

data/features/recipes/registry.feature

@@ -0,0 +1,21 @@
+Feature: key/value registry
+
+  Scenario: `set' keyword registers a value in the registry
+    Given a recipe with:
+      """
+      set :some_key, 'some_value'
+
+      puts env.registry[:some_key]
+      """
+    When I successfully execute the recipe
+    Then the output must contain "some_value"
+
+  Scenario: `get' keyword fetches a value from the registry
+    Given a recipe with:
+      """
+      set :some_key, 'some_value'
+
+      puts get :some_key
+      """
+    When I successfully execute the recipe
+    Then the output must contain "some_value"

data/features/steps/remote_steps.rb

@@ -6,6 +6,10 @@ Given /^a remote file named "([^"]+)"$/ do |file_name|
   write_file file_name, ''
 end
 
+Given /^a remote file named "([^"]+)" with "([^"]+)"$/ do |file_name, content|
+  write_file file_name, content
+end
+
 Then /^the remote directory "([^"]+)" should exists$/ do |path|
   check_directory_presence([path], true)
 end
@@ -13,3 +17,7 @@ end
 Then /^the remote file "([^"]+)" should contain "([^"]+)"/ do |path, content|
   check_file_content path, content, true
 end
+
+Then /^the remote file "([^"]+)" should contain exactly "([^"]+)"/ do |path, content|
+  check_exact_file_content path, content
+end

data/features/tasks/registry.feature

@@ -0,0 +1,13 @@
+Feature: access to registry from task DSL
+
+  Scenario: `get' keyword fetches a value from the registry
+    Given a recipe with:
+      """
+      set :some_key, 'some_value'
+
+      task :output_some_key do
+        echo get :some_key
+      end
+      """
+    When I successfully execute the recipe
+    Then the output must contain "some_value"

data/features/tests/file_contains.feature

@@ -0,0 +1,28 @@
+@sshd
+Feature: `file_contains' condition keyword
+
+  Background:
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :testing_content_in_file_presense do
+        condition { file_contains 'some_file', 'some_content' }
+
+        echo 'evaluated'
+      end
+      """
+
+  Scenario: succeeds when file contains expected content
+    Given a remote file named "some_file" with "some_content"
+    When I successfully execute the recipe
+    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
+    Then the output must not contain "evaluated"
+
+  Scenario: fails when file does not exist
+    When I successfully execute the recipe
+    Then the output must not contain "evaluated"

data/lib/producer/core/action.rb

@@ -1,8 +1,6 @@
 module Producer
   module Core
     class Action
-      require 'forwardable'
-
       extend Forwardable
       def_delegators :@env, :input, :output, :remote
       def_delegators :remote, :fs

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

@@ -0,0 +1,27 @@
+module Producer
+  module Core
+    module Actions
+      class FileReplaceContent < Action
+        def apply
+          fs.file_write path, replaced_content
+        end
+
+        def path
+          arguments[0]
+        end
+
+        def pattern
+          arguments[1]
+        end
+
+        def replacement
+          arguments[2]
+        end
+
+        def replaced_content
+          fs.file_read(path).gsub pattern, replacement
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,10 @@ module Producer
           end
         end
 
-        define_test :has_env,   Tests::HasEnv
-        define_test :has_dir,   Tests::HasDir
-        define_test :has_file,  Tests::HasFile
+        define_test :file_contains, Tests::FileContains
+        define_test :has_env,       Tests::HasEnv
+        define_test :has_dir,       Tests::HasDir
+        define_test :has_file,      Tests::HasFile
 
         attr_reader :block, :env, :tests
 

data/lib/producer/core/env.rb

@@ -1,18 +1,28 @@
 module Producer
   module Core
     class Env
-      attr_reader   :input, :output
+      attr_reader   :input, :output, :registry
       attr_accessor :target
 
-      def initialize(input: $stdin, output: $stdout)
-        @input  = input
-        @output = output
-        @target = nil
+      def initialize(input: $stdin, output: $stdout, remote: nil, registry: {})
+        @input    = input
+        @output   = output
+        @registry = registry
+        @remote   = remote
+        @target   = nil
       end
 
       def remote
         @remote ||= Remote.new(target)
       end
+
+      def [](key)
+        @registry[key]
+      end
+
+      def []=(key, value)
+        @registry[key] = value
+      end
     end
   end
 end

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

@@ -37,6 +37,14 @@ module Producer
             task("#{name}", *args, &block)
           end
         end
+
+        def set(key, value)
+          env[key] = value
+        end
+
+        def get(key)
+          env[key]
+        end
       end
     end
   end

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

@@ -12,8 +12,6 @@ module Producer
           end
         end
 
-        require 'forwardable'
-
         extend Forwardable
         def_delegators :@variables, :[], :key?
 

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

@@ -2,16 +2,10 @@ module Producer
   module Core
     class Remote
       class FS
-        require 'net/sftp'
+        attr_reader :sftp
 
-        attr_reader :remote
-
-        def initialize(remote)
-          @remote = remote
-        end
-
-        def sftp
-          @sftp ||= @remote.session.sftp.connect
+        def initialize(sftp)
+          @sftp = sftp
         end
 
         def dir?(path)
@@ -30,6 +24,12 @@ module Producer
           sftp.mkdir! path
         end
 
+        def file_read(path)
+          sftp.file.open(path) { |f| content = f.read }
+        rescue Net::SFTP::StatusException
+          nil
+        end
+
         def file_write(path, content)
           sftp.file.open path, 'w' do |f|
             f.write content

data/lib/producer/core/remote.rb

@@ -1,9 +1,6 @@
 module Producer
   module Core
     class Remote
-      require 'etc'
-      require 'net/ssh'
-
       attr_reader :hostname
 
       def initialize(hostname)
@@ -23,7 +20,7 @@ module Producer
       end
 
       def fs
-        @fs ||= Remote::FS.new(self)
+        @fs ||= Remote::FS.new(session.sftp.connect)
       end
 
       def execute(command)

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

@@ -13,8 +13,9 @@ 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_write,            Actions::FileWriter
+        define_action :file_replace_content,  Actions::FileReplaceContent
 
         attr_reader :env, :block, :actions
 
@@ -37,6 +38,10 @@ module Producer
         def ask(question, choices, prompter: Prompter)
           prompter.new(env.input, env.output).prompt(question, choices)
         end
+
+        def get(key)
+          env[key]
+        end
       end
     end
   end

data/lib/producer/core/test.rb

@@ -1,8 +1,6 @@
 module Producer
   module Core
     class Test
-      require 'forwardable'
-
       extend Forwardable
       def_delegators :@env, :remote
       def_delegators :remote, :fs

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

@@ -0,0 +1,25 @@
+module Producer
+  module Core
+    module Testing
+      class MockRemote < Remote
+        def session
+          raise 'no session for mock remote!'
+        end
+
+        def execute(command)
+          tokens = command.split
+          program = tokens.shift
+
+          case program
+          when 'echo'
+            tokens.join ' '
+          when 'true'
+            ''
+          when 'false'
+            raise RemoteCommandExecutionError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/testing.rb

@@ -0,0 +1 @@
+require 'producer/core/testing/mock_remote'

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

@@ -0,0 +1,18 @@
+module Producer
+  module Core
+    module Tests
+      class FileContains < Test
+        def verify
+          content = file_content
+          content ? content.include?(arguments[1]) : false
+        end
+
+        private
+
+        def file_content
+          fs.file_read(arguments[0])
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/version.rb

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

data/lib/producer/core.rb

@@ -1,12 +1,21 @@
+require 'forwardable'
+
+require 'etc'
+require 'net/ssh'
+require 'net/sftp'
+
+
 # task actions
 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_replace_content'
 require 'producer/core/actions/file_writer'
 
 # condition tests (need to be defined before the condition DSL)
 require 'producer/core/test'
+require 'producer/core/tests/file_contains'
 require 'producer/core/tests/has_dir'
 require 'producer/core/tests/has_env'
 require 'producer/core/tests/has_file'

data/producer-core.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(/\Abin\//) { |f| File.basename(f) }
 
 
-  s.add_dependency 'net-ssh'
-  s.add_dependency 'net-sftp'
+  s.add_dependency 'net-ssh',   '~> 2.7.0'
+  s.add_dependency 'net-sftp',  '~> 2.1.2'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'cucumber'

data/spec/producer/core/action_spec.rb

@@ -2,47 +2,6 @@ require 'spec_helper'
 
 module Producer::Core
   describe Action do
-    let(:input)       { StringIO.new }
-    let(:output)      { StringIO.new }
-    let(:env)         { Env.new(input: input, output: output) }
-    let(:arguments)   { [:some, :arguments] }
-    subject(:action)  { Action.new(env, *arguments) }
-
-    describe '#env' do
-      it 'returns the assigned env' do
-        expect(action.env).to be env
-      end
-    end
-
-    describe '#arguments' do
-      it 'returns the assigned arguments' do
-        expect(action.arguments).to eq arguments
-      end
-    end
-
-    describe '#input' do
-      it 'returns env input' do
-        expect(action.input).to be input
-      end
-    end
-
-    describe '#output' do
-      it 'delegates to env output' do
-        action.output.puts 'some content'
-        expect(output.string).to eq "some content\n"
-      end
-    end
-
-    describe '#remote' do
-      it 'returns env remote' do
-        expect(action.remote).to be action.env.remote
-      end
-    end
-
-    describe '#fs' do
-      it 'returns env remote fs' do
-        expect(action.fs).to be action.env.remote.fs
-      end
-    end
+    it_behaves_like 'action'
   end
 end

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

@@ -1,15 +1,18 @@
 require 'spec_helper'
 
 module Producer::Core
-  describe Actions::Echo do
-    let(:env)       { Env.new(output: StringIO.new) }
-    let(:text)      { 'hello' }
-    subject(:echo)  { Actions::Echo.new(env, text) }
+  module Actions
+    describe Echo, :env do
+      let(:text)      { 'hello' }
+      subject(:echo)  { Echo.new(env, text) }
 
-    describe '#apply' do
-      it 'writes the given string to env output with a record separator' do
-        echo.apply
-        expect(env.output.string).to eq "hello\n"
+      it_behaves_like 'action'
+
+      describe '#apply' do
+        it 'writes the given string to env output with a record separator' do
+          echo.apply
+          expect(output).to eq "hello\n"
+        end
       end
     end
   end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module Producer::Core
+  module Actions
+    describe FileReplaceContent, :env do
+      let(:path)        { 'some_path' }
+      let(:pattern)     { 'content' }
+      let(:replacement) { 'other content' }
+      let(:content)     { 'some content' }
+      subject(:action)  { FileReplaceContent.new(env, path, pattern, replacement) }
+
+      it_behaves_like 'action'
+
+      before { allow(remote_fs).to receive(:file_read).with(path) { content } }
+
+      describe '#apply' do
+        it 'writes replaced content to file on remote filesystem' do
+          expect(remote_fs)
+            .to receive(:file_write).with(path, action.replaced_content)
+          action.apply
+        end
+      end
+
+      describe '#path' do
+        it 'returns the file path' do
+          expect(action.path).to eq path
+        end
+      end
+
+      describe '#pattern' do
+        it 'returns the pattern' do
+          expect(action.pattern).to eq pattern
+        end
+      end
+
+      describe '#replacement' do
+        it 'returns the replacement' do
+          expect(action.replacement).to eq replacement
+        end
+      end
+
+      describe '#replaced_content' do
+        it 'returns content with pattern occurrences pattern replaced' do
+          expect(action.replaced_content).to eq 'some other content'
+        end
+      end
+    end
+  end
+end

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

@@ -1,28 +1,31 @@
 require 'spec_helper'
 
 module Producer::Core
-  describe Actions::FileWriter do
-    let(:env)         { Env.new }
-    let(:path)        { 'some_path' }
-    let(:content)     { 'some_content' }
-    subject(:writer)  { Actions::FileWriter.new(env, path, content) }
+  module Actions
+    describe FileWriter, :env do
+      let(:path)        { 'some_path' }
+      let(:content)     { 'some_content' }
+      subject(:writer)  { FileWriter.new(env, path, content) }
 
-    describe '#apply' do
-      it 'writes content to file on remote filesystem' do
-        expect(writer.fs).to receive(:file_write).with(path, content)
-        writer.apply
+      it_behaves_like 'action'
+
+      describe '#apply' do
+        it 'writes content to file on remote filesystem' do
+          expect(remote_fs).to receive(:file_write).with(path, content)
+          writer.apply
+        end
       end
-    end
 
-    describe '#path' do
-      it 'returns the path' do
-        expect(writer.path).to eq path
+      describe '#path' do
+        it 'returns the path' do
+          expect(writer.path).to eq path
+        end
       end
-    end
 
-    describe '#content' do
-      it 'returns the content' do
-        expect(writer.content).to eq content
+      describe '#content' do
+        it 'returns the content' do
+          expect(writer.content).to eq content
+        end
       end
     end
   end

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

@@ -1,23 +1,25 @@
 require 'spec_helper'
 
 module Producer::Core
-  describe Actions::Mkdir do
-    let(:env)       { Env.new }
-    let(:path)      { 'some_path' }
-    subject(:mkdir) { Actions::Mkdir.new(env, path) }
+  module Actions
+    describe Mkdir, :env do
+      let(:path)      { 'some_path' }
+      subject(:mkdir) { Mkdir.new(env, path) }
 
-    describe '#apply' do
-      it 'creates directory on remote filesystem' do
-        expect(mkdir.fs).to receive(:mkdir).with(path)
-        mkdir.apply
+      it_behaves_like 'action'
+
+      describe '#apply' do
+        it 'creates directory on remote filesystem' do
+          expect(remote_fs).to receive(:mkdir).with(path)
+          mkdir.apply
+        end
       end
-    end
 
-    describe '#path' do
-      it 'returns the path' do
-        expect(mkdir.path).to eq path
+      describe '#path' do
+        it 'returns the path' do
+          expect(mkdir.path).to eq path
+        end
       end
     end
   end
 end
-