producer-core 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6a27039a047e17f8490bd070f3906b435939441
-  data.tar.gz: 7f1c4c346f1258e97f59454a6bcf3a20c6e02288
+  metadata.gz: 1ed15ccec37cb38bc7c4ea42a911708acd30630f
+  data.tar.gz: bc36933dae78ef8311eb2e840ab22cbb2927dd11
 SHA512:
-  metadata.gz: 1b84f00106289af7baa8f57ab9aa336eaf2f4a9114a5a7553d5431e83ec8a04b8512ed37657c1599367bd75f41f8f99fabb241eada0c3bf4c9c88c2c5a88bc80
-  data.tar.gz: c3ed29fc5633c033e6f35f83d990325d0cdbce10a8a753cbc9f1e7f063795633ad9c465bc322327963ddeb096ec3e0e6c16f6919d2ffef6b753108a52016c7e9
+  metadata.gz: 9128d8070fb39fa4cc1e4a6ba1ea9a19c29ac32b2088a412d2da5b66a5560b3b6bf9332a689423d246f936eb6aa9552b0e97a131679e11670048be996f194ceb
+  data.tar.gz: 1be0962d9d254e3f33a04636b66413084f957541456d7202cf120da1085d4cd33b856dcb464532356188e9123e77127be1ffa390a22caf3e283df3afd2919d99

data/features/actions/mkdir.feature

@@ -0,0 +1,14 @@
+@sshd
+Feature: `mkdir' task action
+
+  Scenario: creates directory given as argument
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :create_some_dir do
+        mkdir 'some_directory'
+      end
+      """
+    When I successfully execute the recipe
+    Then the remote directory "some_directory" must exists

data/features/steps/remote_steps.rb

@@ -1,7 +1,15 @@
+Given /^a remote directory named "([^"]+)"$/ do |path|
+  create_dir path
+end
+
 Given /^a remote file named "([^"]+)"$/ do |file_name|
   write_file file_name, ''
 end
 
+Then /^the remote directory "([^"]+)" should exists$/ do |path|
+  check_directory_presence([path], true)
+end
+
 Then /^the remote file "([^"]+)" should contain "([^"]+)"/ do |path, content|
   check_file_content path, content, true
 end

data/features/tests/has_dir.feature

@@ -0,0 +1,23 @@
+@sshd
+Feature: `has_dir' condition keyword
+
+  Background:
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :testing_directory_existence do
+        condition { has_dir 'some_directory' }
+
+        echo 'evaluated'
+      end
+      """
+
+  Scenario: succeeds when directory exists
+    Given a remote directory named "some_directory"
+    When I successfully execute the recipe
+    Then the output must contain "evaluated"
+
+  Scenario: fails when directory does not exist
+    When I successfully execute the recipe
+    Then the output must not contain "evaluated"

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

@@ -0,0 +1,15 @@
+module Producer
+  module Core
+    module Actions
+      class Mkdir < Action
+        def apply
+          fs.mkdir path
+        end
+
+        def path
+          arguments.first
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module Producer
         end
 
         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/remote/fs.rb

@@ -14,12 +14,22 @@ module Producer
           @sftp ||= @remote.session.sftp.connect
         end
 
+        def dir?(path)
+          sftp.stat!(path).directory?
+        rescue Net::SFTP::StatusException
+          false
+        end
+
         def file?(path)
           sftp.stat!(path).file?
         rescue Net::SFTP::StatusException
           false
         end
 
+        def mkdir(path)
+          sftp.mkdir! path
+        end
+
         def file_write(path, content)
           sftp.file.open path, 'w' do |f|
             f.write content

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

@@ -13,6 +13,7 @@ module Producer
         define_action :echo,  Actions::Echo
         define_action :sh,    Actions::ShellCommand
 
+        define_action :mkdir,       Actions::Mkdir
         define_action :file_write,  Actions::FileWriter
 
         attr_reader :env, :block, :actions

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

@@ -0,0 +1,11 @@
+module Producer
+  module Core
+    module Tests
+      class HasDir < Test
+        def verify
+          fs.dir? arguments.first
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/version.rb

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

data/lib/producer/core.rb

@@ -2,10 +2,12 @@
 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_writer'
 
 # condition tests (need to be defined before the condition DSL)
 require 'producer/core/test'
+require 'producer/core/tests/has_dir'
 require 'producer/core/tests/has_env'
 require 'producer/core/tests/has_file'
 

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

@@ -2,10 +2,10 @@ 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) }
+    let(:env)         { Env.new }
+    let(:path)        { 'some_path' }
+    let(:content)     { 'some_content' }
+    subject(:writer)  { Actions::FileWriter.new(env, path, content) }
 
     describe '#apply' do
       it 'writes content to file on remote filesystem' do

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

@@ -0,0 +1,23 @@
+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) }
+
+    describe '#apply' do
+      it 'creates directory on remote filesystem' do
+        expect(mkdir.fs).to receive(:mkdir).with(path)
+        mkdir.apply
+      end
+    end
+
+    describe '#path' do
+      it 'returns the path' do
+        expect(mkdir.path).to eq path
+      end
+    end
+  end
+end
+

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 has_file].each do |test|
+    %w[has_dir 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

@@ -31,6 +31,45 @@ module Producer::Core
       end
     end
 
+    describe '#dir?' do
+      let(:sftp)  { double('sftp').as_null_object }
+      let(:path)  { 'some_directory_path' }
+      let(:stat)  { double 'stat' }
+
+      before do
+        allow(fs).to receive(:sftp) { sftp }
+        allow(sftp).to receive(:stat!).with(path) { stat }
+      end
+
+      context 'when path given as argument is a directory' do
+        before { allow(stat).to receive(:directory?) { true } }
+
+        it 'returns true' do
+          expect(fs.dir? path).to be true
+        end
+      end
+
+      context 'when path given as argument is not a directory' do
+        before { allow(stat).to receive(:directory?) { false } }
+
+        it 'returns false' do
+          expect(fs.dir? path).to be false
+        end
+      end
+
+      context 'when querying the path raises a Net::SFTP::StatusException' do
+        before do
+          response = double 'response', code: '42', message: 'some message'
+          ex = Net::SFTP::StatusException.new(response)
+          allow(sftp).to receive(:stat!).with(path).and_raise(ex)
+        end
+
+        it 'returns false' do
+          expect(fs.dir? path).to be false
+        end
+      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 '#file?', :ssh do
@@ -73,6 +112,18 @@ module Producer::Core
       end
     end
 
+    describe '#mkdir' do
+      let(:sftp)  { double 'sftp' }
+      let(:path)  { 'some_directory_path' }
+
+      before { allow(fs).to receive(:sftp) { sftp } }
+
+      it 'creates the directory' do
+        expect(sftp).to receive(:mkdir!).with(path)
+        fs.mkdir path
+      end
+    end
+
     describe '#file_write' do
       let(:sftp)    { double('sftp').as_null_object }
       let(:file)    { double('sftp').as_null_object }

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

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

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Thibault Jouan
@@ -110,10 +110,10 @@ files:
 - bin/producer
 - features/actions/echo.feature
 - features/actions/file_write.feature
+- features/actions/mkdir.feature
 - features/actions/sh.feature
 - features/cli/usage.feature
 - features/recipes/ask.feature
-- features/recipes/env.feature
 - features/recipes/evaluation.feature
 - features/recipes/macro.feature
 - features/recipes/source.feature
@@ -128,6 +128,7 @@ files:
 - features/support/ssh.rb
 - features/tasks/condition.feature
 - features/tasks/evaluation.feature
+- features/tests/has_dir.feature
 - features/tests/has_env.feature
 - features/tests/has_file.feature
 - features/tests/negated_test.feature
@@ -135,6 +136,7 @@ files:
 - lib/producer/core/action.rb
 - lib/producer/core/actions/echo.rb
 - lib/producer/core/actions/file_writer.rb
+- lib/producer/core/actions/mkdir.rb
 - lib/producer/core/actions/shell_command.rb
 - lib/producer/core/cli.rb
 - lib/producer/core/condition.rb
@@ -150,6 +152,7 @@ files:
 - lib/producer/core/task.rb
 - lib/producer/core/task/dsl.rb
 - lib/producer/core/test.rb
+- lib/producer/core/tests/has_dir.rb
 - lib/producer/core/tests/has_env.rb
 - lib/producer/core/tests/has_file.rb
 - lib/producer/core/version.rb
@@ -161,6 +164,7 @@ files:
 - spec/producer/core/action_spec.rb
 - spec/producer/core/actions/echo_spec.rb
 - spec/producer/core/actions/file_writer_spec.rb
+- spec/producer/core/actions/mkdir_spec.rb
 - spec/producer/core/actions/shell_command_spec.rb
 - spec/producer/core/cli_spec.rb
 - spec/producer/core/condition/dsl_spec.rb
@@ -175,6 +179,7 @@ files:
 - spec/producer/core/task/dsl_spec.rb
 - spec/producer/core/task_spec.rb
 - spec/producer/core/test_spec.rb
+- spec/producer/core/tests/has_dir_spec.rb
 - spec/producer/core/tests/has_env_spec.rb
 - spec/producer/core/tests/has_file_spec.rb
 - spec/producer/core/worker_spec.rb
@@ -208,10 +213,10 @@ summary: Provisioning tool
 test_files:
 - features/actions/echo.feature
 - features/actions/file_write.feature
+- features/actions/mkdir.feature
 - features/actions/sh.feature
 - features/cli/usage.feature
 - features/recipes/ask.feature
-- features/recipes/env.feature
 - features/recipes/evaluation.feature
 - features/recipes/macro.feature
 - features/recipes/source.feature
@@ -226,6 +231,7 @@ test_files:
 - features/support/ssh.rb
 - features/tasks/condition.feature
 - features/tasks/evaluation.feature
+- features/tests/has_dir.feature
 - features/tests/has_env.feature
 - features/tests/has_file.feature
 - features/tests/negated_test.feature
@@ -235,6 +241,7 @@ test_files:
 - spec/producer/core/action_spec.rb
 - spec/producer/core/actions/echo_spec.rb
 - spec/producer/core/actions/file_writer_spec.rb
+- spec/producer/core/actions/mkdir_spec.rb
 - spec/producer/core/actions/shell_command_spec.rb
 - spec/producer/core/cli_spec.rb
 - spec/producer/core/condition/dsl_spec.rb
@@ -249,6 +256,7 @@ test_files:
 - spec/producer/core/task/dsl_spec.rb
 - spec/producer/core/task_spec.rb
 - spec/producer/core/test_spec.rb
+- spec/producer/core/tests/has_dir_spec.rb
 - spec/producer/core/tests/has_env_spec.rb
 - spec/producer/core/tests/has_file_spec.rb
 - spec/producer/core/worker_spec.rb

data/features/recipes/env.feature

@@ -1,9 +0,0 @@
-Feature: `env' recipe keyword
-
-  Scenario: exposes the internal env object
-    Given a recipe with:
-      """
-      env
-      """
-    When I execute the recipe
-    Then the exit status must be 0