capistrano-spec 0.2.2 → 0.3.0

data/Gemfile

@@ -5,4 +5,5 @@ group :test do
   gem 'rspec'
   gem 'rake'
   gem 'jeweler'
+  gem 'capistrano'
 end

data/Gemfile.lock

@@ -1,14 +1,28 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    capistrano (2.14.2)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    highline (1.6.16)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
     json (1.6.6)
+    net-scp (1.1.0)
+      net-ssh (>= 2.6.5)
+    net-sftp (2.1.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.6)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -25,6 +39,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  capistrano
   jeweler
   rake
   rspec

data/README.rdoc

@@ -73,7 +73,7 @@ Alright, we can start testing by making Capistrano::Configuration and load Capis
       @configuration = Capistrano::Configuration.new
       Capistrano::Speak.load_into(@configuration)
     end
-  
+
   end
 
 
@@ -84,7 +84,7 @@ Now, remember, if you +set+ values, you can access them using +fetch+:
   before do
     @configuration.set :foo, 'bar'
   end
-  
+
   it "should define foo" do
     @configuration.fetch(:foo).should == 'bar'
   end
@@ -96,7 +96,7 @@ You can also find and execute tasks, so you can verify if you successfully set a
     before do
       @configuration.find_and_execute_task('speak')
     end
-    
+
     it "should define message" do
       @configuration.fetch(:message).should == 'oh hai'
     end
@@ -147,6 +147,37 @@ You also test [callbacks](http://rubydoc.info/github/capistrano/capistrano/maste
     @configuration.should callback('foo:bar').before('deploy:finalize_update')
   end
 
+You can also stub requests if you need to access their output:
+
+  task :pwd do
+    set :pwd, capture('pwd')
+  end
+
+  it 'should capture working directory' do
+    @configuration.stub_command 'pwd', data: '/path/to/working/dir'
+    @configuration.fetch(:pwd).should == '/path/to/working/dir'
+  end
+
+Additional options are +channel+ and +stream+ for testing custom +run+ blocks:
+
+  task :custom do
+    invoke_command 'pwd', :via => :sudo do |ch, stream, data|
+      # magical foo
+    end
+  end
+
+As +sudo+ and +invoke_command+ use +run+ internal and +capture+ uses
++invoke_command+ they are also stub-able by specifying the exact command.
+
+  task :sudo_pwd do
+    set :pwd, capture('pwd', :via => :sudo)
+  end
+
+  it 'should capture sudo working directory' do
+    @configuration.stub_command 'sudo -p 'sudo password: ' pwd', data: '/sudo/dir'
+    @configuration.fetch(:pwd).should == '/sudo/dir'
+  end
+
 == Real world examples
 
 * [capistrano-mountaintop](https://github.com/technicalpickles/capistrano-mountaintop/blob/master/spec/capistrano-mountaintop_spec.rb)

data/Rakefile

@@ -5,13 +5,13 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "capistrano-spec"
-    gem.version = '0.2.2'
+    gem.version = '0.3.0'
 
     gem.summary = %Q{Test your capistrano recipes}
     gem.description = %Q{Helpers and matchers for testing capistrano}
     gem.email = "josh@technicalpickles.com"
     gem.homepage = "http://github.com/technicalpickles/capistrano-spec"
-    gem.authors = ["Joshua Nichols", "Karl Matthias", "Peter M Souter"]
+    gem.authors = ["Joshua Nichols", "Karl Matthias", "Peter M Souter", "Jan Graichen"]
     gem.add_development_dependency "rspec", ">= 2.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/capistrano-spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano-spec"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Joshua Nichols", "Karl Matthias", "Peter M Souter"]
-  s.date = "2013-04-02"
+  s.authors = ["Joshua Nichols", "Karl Matthias", "Peter M Souter", "Jan Graichen"]
+  s.date = "2013-04-07"
   s.description = "Helpers and matchers for testing capistrano"
   s.email = "josh@technicalpickles.com"
   s.extra_rdoc_files = [
@@ -28,11 +28,13 @@ Gem::Specification.new do |s|
     "lib/capistrano/spec.rb",
     "spec/capistrano-spec_spec.rb",
     "spec/spec.opts",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/stub_commands_spec.rb",
+    "spec/uploaded_spec.rb"
   ]
   s.homepage = "http://github.com/technicalpickles/capistrano-spec"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "1.8.25"
   s.summary = "Test your capistrano recipes"
 
   if s.respond_to? :specification_version then

data/lib/capistrano/spec.rb

@@ -11,6 +11,15 @@ module Capistrano
 
       def run(cmd, options={}, &block)
         runs[cmd] = {:options => options, :block => block}
+        if (stub = stubbed_commands[cmd])
+          raise ::Capistrano::CommandError if stub[:fail]
+          raise stub[:raise] if stub[:raise]
+
+          data = stub[:data]
+          data = stub[:with].call(cmd) if stub[:with].respond_to? :call
+
+          block.call stub[:channel], stub[:stream], data if block_given?
+        end
       end
 
       def runs
@@ -24,7 +33,15 @@ module Capistrano
       def uploads
         @uploads ||= {}
       end
-      
+
+      def stubbed_commands
+        @stubbed_commands ||= {}
+      end
+
+      def stub_command(command, options = {}, &block)
+        options[:with] = block if block_given?
+        stubbed_commands[command] = { :stream => :out, :data => '' }.merge options
+      end
     end
 
     module Helpers
@@ -124,13 +141,13 @@ module Capistrano
       end
 
       define :have_uploaded do |path|
+        @to = nil # Reset `to` because it will influence next match otherwise.
+
         match do |configuration|
-          upload = configuration.uploads[path]
-          if @to
-            upload && upload[:to] == @to
-          else
-            upload
-          end
+          uploads = configuration.uploads
+          uploads = uploads.select { |f, u| f == path } if path
+          uploads = uploads.select { |f, u| u[:to] == @to } if @to
+          uploads.any?
         end
 
         def to(to)
@@ -158,7 +175,7 @@ module Capistrano
         failure_message_for_should do |actual|
           "expected configuration to run #{cmd}, but did not"
         end
-        
+
       end
 
     end

data/spec/stub_commands_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'capistrano'
+
+describe 'Command stubbing' do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.extend Capistrano::Spec::ConfigurationExtension
+    @configuration.load do
+      def remote_pwd
+        capture 'pwd'
+      end
+
+      def remote_sudo_pwd
+        capture 'pwd', :via => :sudo
+      end
+
+      def custom_pwd
+        run 'pwd' do |ch, stream, data|
+          return "#{stream}: #{data}"
+        end
+      end
+
+      def no_block
+      	run 'pwd'
+      	nil
+      end
+    end
+  end
+
+  it 'should allow to stub command output' do
+    @configuration.stub_command 'pwd', :data => '/stubded/path'
+    @configuration.remote_pwd.should == '/stubded/path'
+  end
+
+  it 'should allow to stub sudo command output' do
+    @configuration.stub_command "sudo -p 'sudo password: ' pwd", :data => '/stubbed/path'
+    @configuration.remote_sudo_pwd.should == '/stubbed/path'
+  end
+
+  it 'should allow to stub custom command output' do
+    @configuration.stub_command 'pwd', :data => '/stubbed/path'
+    @configuration.custom_pwd.should == 'out: /stubbed/path'
+  end
+
+  it 'should allow to stub stream' do
+    @configuration.stub_command 'pwd', :data => '/stubbed/path', :stream => :err
+    @configuration.custom_pwd.should == 'err: /stubbed/path'
+  end
+
+  it 'should allow to stub commands without block' do
+    @configuration.stub_command 'pwd'
+    expect { @configuration.no_block }.to_not raise_error(NoMethodError)
+  end
+
+  it 'should allow to stub command processing' do
+    @configuration.stub_command 'pwd', with: proc { |cmd| cmd }
+    @configuration.remote_pwd.should == 'pwd'
+  end
+
+  it 'should allow to stub command processing (2)' do
+  	testvar = false
+    @configuration.stub_command 'pwd' do |cmd| testvar = true end
+    @configuration.no_block
+    testvar.should be_true
+  end
+
+  it 'should allow to stub command processing with error' do
+    @configuration.stub_command 'pwd', raise: ::Capistrano::CommandError
+    expect { @configuration.no_block }.to raise_error(::Capistrano::CommandError)
+  end
+
+  it 'should allow to stub command processing with CommandError' do
+    @configuration.stub_command 'pwd', fail: true
+    expect { @configuration.no_block }.to raise_error(::Capistrano::CommandError)
+  end
+end

data/spec/uploaded_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'capistrano'
+
+describe 'Capistrano has uploaded' do
+  include Capistrano::Spec::Matchers
+
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.extend Capistrano::Spec::ConfigurationExtension
+    @configuration.load do
+      def upload_from_to
+        upload 'source.file', 'target.file'
+      end
+
+      def upload_to
+        upload 'temp.XC3PO.file', 'target.file' # E.g. uploading generated tar
+      end
+
+      def upload_from
+        upload 'source.file', 'temp.XC3PO.file' # E.g. uploading to temp file
+      end
+    end
+  end
+
+  it 'some file' do
+    @configuration.upload 'source.file', 'target.file'
+    @configuration.should have_uploaded
+  end
+
+  it 'a specific file to a specific location' do
+    @configuration.upload_from_to
+    @configuration.should have_uploaded('source.file').to('target.file')
+  end
+
+  it 'a specific file to some location' do
+    @configuration.upload_from
+    @configuration.should have_uploaded('source.file')
+  end
+
+  it 'some file to a specific location' do
+    @configuration.upload_to
+    @configuration.should have_uploaded.to('target.file')
+  end
+end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-spec
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Joshua Nichols
 - Karl Matthias
 - Peter M Souter
+- Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -49,6 +50,8 @@ files:
 - spec/capistrano-spec_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/stub_commands_spec.rb
+- spec/uploaded_spec.rb
 homepage: http://github.com/technicalpickles/capistrano-spec
 licenses: []
 post_install_message: 
@@ -69,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Test your capistrano recipes