producer-core 0.1.2 → 0.1.3

data/features/steps/remote_steps.rb

@@ -0,0 +1,3 @@
+Given(/^a remote file named "(.*?)"$/) do |file_name|
+  write_file file_name, ''
+end

data/features/support/ssh.rb

@@ -76,6 +76,7 @@ Protocol 2
 HostKey #{File.expand_path @base_path}/#{KEY_PATH}
 PidFile /dev/null
 UsePrivilegeSeparation no
+Subsystem sftp /usr/lib/openssh/sftp-server
 ForceCommand HOME=#{File.expand_path @base_path} sh -c "cd ~; $SSH_ORIGINAL_COMMAND"
     eoh
 

data/features/tests/has_file.feature

@@ -0,0 +1,23 @@
+@sshd
+Feature: `has_file' condition keyword
+
+  Background:
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :testing_file_existence do
+        condition { has_file 'some_file' }
+
+        echo 'evaluated'
+      end
+      """
+
+  Scenario: succeeds when file exists
+    Given a remote file named "some_file"
+    When I successfully execute the recipe
+    Then the output must 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.rb

@@ -6,6 +6,7 @@ require 'producer/core/actions/shell_command'
 # condition tests (need to be defined before the condition DSL)
 require 'producer/core/test'
 require 'producer/core/tests/has_env'
+require 'producer/core/tests/has_file'
 
 require 'producer/core/cli'
 require 'producer/core/condition'
@@ -17,6 +18,7 @@ require 'producer/core/recipe'
 require 'producer/core/recipe/dsl'
 require 'producer/core/remote'
 require 'producer/core/remote/environment'
+require 'producer/core/remote/fs'
 require 'producer/core/task'
 require 'producer/core/task/dsl'
 require 'producer/core/version'

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

@@ -16,7 +16,8 @@ module Producer
           end
         end
 
-        define_test :has_env, Tests::HasEnv
+        define_test :has_env,   Tests::HasEnv
+        define_test :has_file,  Tests::HasFile
 
         attr_accessor :tests
 

data/lib/producer/core/remote.rb

@@ -14,6 +14,10 @@ module Producer
         @session ||= Net::SSH.start(@hostname, Etc.getlogin)
       end
 
+      def fs
+        @fs ||= Remote::FS.new(self)
+      end
+
       def execute(command)
         output = ''
         session.open_channel do |channel|

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

@@ -0,0 +1,23 @@
+module Producer
+  module Core
+    class Remote
+      class FS
+        require 'net/sftp'
+
+        def initialize(remote)
+          @remote = remote
+        end
+
+        def sftp
+          @sftp ||= @remote.session.sftp.connect
+        end
+
+        def has_file?(path)
+          sftp.stat!(path).file?
+        rescue Net::SFTP::StatusException
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Producer
+  module Core
+    module Tests
+      class HasFile < Test
+        def success?
+          env.remote.fs.has_file? arguments.first
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/producer-core.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
 
   s.add_dependency 'net-ssh'
+  s.add_dependency 'net-sftp'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'cucumber'

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

@@ -6,7 +6,7 @@ module Producer::Core
     let(:env)     { double('env') }
     subject(:dsl) { Condition::DSL.new(env, &block) }
 
-    %w[has_env].each do |test|
+    %w[has_env has_file].each do |test|
       it "has `#{test}' test defined" do
         expect(dsl).to respond_to test.to_sym
       end

data/spec/producer/core/remote/fs_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+module Producer::Core
+  describe Remote::FS do
+    let(:remote)  { Remote.new('some_host.example') }
+    subject(:fs)  { Remote::FS.new(remote) }
+
+    describe '#new' do
+      it 'assigns the remote given as argument' do
+        expect(fs.instance_eval { @remote }).to be remote
+      end
+    end
+
+    describe '#sftp', :ssh do
+      before { sftp_story }
+
+      it 'builds a new SFTP session' do
+        expect(remote.session.sftp).to receive(:connect)
+        fs.sftp
+      end
+
+      it 'returns the new SFTP session' do
+        session = double('session')
+        allow(remote.session.sftp).to receive(:connect) { session }
+        expect(fs.sftp).to be session
+      end
+
+      it 'memoizes the FS' do
+        allow(remote.session.sftp).to receive(:connect) { Object.new }
+        expect(fs.sftp).to be fs.sftp
+      end
+    end
+
+    # FIXME: We rely a lot on mocking net-sftp heavily, while we already use a
+    # part of net-ssh story helpers, which are more close to integration tests.
+    describe '#has_file?', :ssh do
+      let(:file_path) { "some_file_path" }
+      let(:stat)      { double('stat') }
+
+      before do
+        sftp_story
+        allow(fs.sftp).to receive(:stat!) { stat }
+      end
+
+      context 'when path given as argument exists' do
+        context 'when path is a file' do
+          before do
+            allow(stat).to receive(:file?) { true }
+          end
+
+          it 'returns true' do
+            expect(fs.has_file?(file_path)).to be true
+          end
+        end
+
+        context 'when path is not a file' do
+          before do
+            allow(stat).to receive(:file?) { false }
+          end
+
+          it 'returns false' do
+            expect(fs.has_file?(file_path)).to be false
+          end
+        end
+      end
+
+      context 'when querying the path raises a Net::SFTP::StatusException' do
+        before do
+          response = double('response', code: '42', message: '…')
+          ex = Net::SFTP::StatusException.new(response)
+          allow(stat).to receive(:file?).and_raise(ex)
+        end
+
+        it 'returns false' do
+          expect(fs.has_file?(file_path)).to be false
+        end
+      end
+    end
+  end
+end

data/spec/producer/core/remote_spec.rb

@@ -29,6 +29,24 @@ module Producer::Core
       end
     end
 
+    describe '#fs' do
+      it 'builds a new FS' do
+        expect(Remote::FS).to receive(:new)
+        remote.fs
+      end
+
+      it 'returns the new FS instance' do
+        fs = double('fs')
+        allow(Remote::FS).to receive(:new) { fs }
+        expect(remote.fs).to be fs
+      end
+
+      it 'memoizes the FS' do
+        allow(Remote::FS).to receive(:new) { Object.new }
+        expect(remote.fs).to be remote.fs
+      end
+    end
+
     describe '#execute', :ssh do
       let(:arguments) { 'some remote command' }
       let(:command)   { "echo #{arguments}" }

data/spec/producer/core/tests/has_file_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Producer::Core
+  describe Tests::HasFile do
+    let(:env)           { Env.new }
+    let(:filepath)      { 'some_file' }
+    subject(:has_file)  { Tests::HasFile.new(env, filepath) }
+
+    it 'is a kind of test' do
+      expect(has_file).to be_a Test
+    end
+
+    describe '#success?', :ssh do
+      before { sftp_story }
+
+      it 'delegates the call on remote FS' do
+        expect(env.remote.fs).to receive(:has_file?).with(filepath)
+        has_file.success?
+      end
+
+      it 'returns the file existence' do
+        existence = double('existence')
+        allow(env.remote.fs).to receive(:has_file?) { existence }
+        expect(has_file.success?).to be existence
+      end
+    end
+  end
+end

data/spec/support/net_ssh_story_helpers.rb

@@ -2,6 +2,24 @@ module NetSSHStoryHelpers
   require 'net/ssh/test'
   include Net::SSH::Test
 
+  # FIXME: must be moved elsewhere or implemented another way/form.
+  class ::Net::SSH::Test::Channel
+    def gets_packet(type, *args)
+      gets_data(sftp_packet(type, *args))
+    end
+
+    def sends_packet(type, *args)
+      sends_data(sftp_packet(type, *args))
+    end
+
+    private
+
+    def sftp_packet(type, *args)
+      data = Net::SSH::Buffer.from(*args)
+      Net::SSH::Buffer.from(:long, data.length + 1, :byte, type, :raw, data).to_s
+    end
+  end
+
   def story_with_new_channel
     story do |session|
       ch = session.opens_channel
@@ -14,4 +32,20 @@ module NetSSHStoryHelpers
   def story_completed?
     socket.script.events.empty?
   end
+
+  def sftp_story
+    story do |session|
+      ch = session.opens_channel
+      ch.sends_subsystem('sftp')
+      ch.sends_packet(
+        Net::SFTP::Constants::PacketTypes::FXP_INIT, :long,
+        Net::SFTP::Session::HIGHEST_PROTOCOL_VERSION_SUPPORTED
+      )
+      ch.gets_packet(
+        Net::SFTP::Constants::PacketTypes::FXP_VERSION, :long,
+        Net::SFTP::Session::HIGHEST_PROTOCOL_VERSION_SUPPORTED
+      )
+      yield ch if block_given?
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,12 +130,14 @@ files:
 - features/recipes/source.feature
 - features/recipes/target.feature
 - features/steps/recipe_steps.rb
+- features/steps/remote_steps.rb
 - features/support/env_aruba.rb
 - features/support/env_cucumber-doc_string.rb
 - features/support/ssh.rb
 - features/tasks/condition.feature
 - features/tasks/evaluation.feature
 - features/tests/has_env.feature
+- features/tests/has_file.feature
 - lib/producer/core.rb
 - lib/producer/core/action.rb
 - lib/producer/core/actions/echo.rb
@@ -134,10 +152,12 @@ files:
 - lib/producer/core/recipe/dsl.rb
 - lib/producer/core/remote.rb
 - lib/producer/core/remote/environment.rb
+- lib/producer/core/remote/fs.rb
 - lib/producer/core/task.rb
 - lib/producer/core/task/dsl.rb
 - lib/producer/core/test.rb
 - lib/producer/core/tests/has_env.rb
+- lib/producer/core/tests/has_file.rb
 - lib/producer/core/version.rb
 - producer-core.gemspec
 - spec/fixtures/recipes/empty.rb
@@ -153,11 +173,13 @@ files:
 - spec/producer/core/recipe/dsl_spec.rb
 - spec/producer/core/recipe_spec.rb
 - spec/producer/core/remote/environment_spec.rb
+- spec/producer/core/remote/fs_spec.rb
 - spec/producer/core/remote_spec.rb
 - spec/producer/core/task/dsl_spec.rb
 - spec/producer/core/task_spec.rb
 - spec/producer/core/test_spec.rb
 - spec/producer/core/tests/has_env_spec.rb
+- spec/producer/core/tests/has_file_spec.rb
 - spec/spec_helper.rb
 - spec/support/exit_helpers.rb
 - spec/support/fixtures_helpers.rb
@@ -186,7 +208,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: producer-core-0.1.2
+summary: producer-core-0.1.3
 test_files:
 - features/actions/echo.feature
 - features/actions/sh.feature
@@ -196,12 +218,14 @@ test_files:
 - features/recipes/source.feature
 - features/recipes/target.feature
 - features/steps/recipe_steps.rb
+- features/steps/remote_steps.rb
 - features/support/env_aruba.rb
 - features/support/env_cucumber-doc_string.rb
 - features/support/ssh.rb
 - features/tasks/condition.feature
 - features/tasks/evaluation.feature
 - features/tests/has_env.feature
+- features/tests/has_file.feature
 - spec/fixtures/recipes/empty.rb
 - spec/fixtures/recipes/throw.rb
 - spec/producer/core/action_spec.rb
@@ -215,11 +239,13 @@ test_files:
 - spec/producer/core/recipe/dsl_spec.rb
 - spec/producer/core/recipe_spec.rb
 - spec/producer/core/remote/environment_spec.rb
+- spec/producer/core/remote/fs_spec.rb
 - spec/producer/core/remote_spec.rb
 - spec/producer/core/task/dsl_spec.rb
 - spec/producer/core/task_spec.rb
 - spec/producer/core/test_spec.rb
 - spec/producer/core/tests/has_env_spec.rb
+- spec/producer/core/tests/has_file_spec.rb
 - spec/spec_helper.rb
 - spec/support/exit_helpers.rb
 - spec/support/fixtures_helpers.rb