rspec-command 1.0.0

data/lib/rspec_command/rake.rb

@@ -0,0 +1,120 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rake'
+require 'rspec'
+
+require 'rspec_command'
+
+
+module RSpecCommand
+  # An RSpec helper module for testing Rake tasks without running them in a
+  # full subprocess. This improves test speed while still giving you most of
+  # the benefits of integration testing.
+  #
+  # @api public
+  # @since 1.0.0
+  # @example
+  #   RSpec.configure do |config|
+  #     config.include RSpecCommand::Rake
+  #   end
+  # @example Enable for a single example group
+  #   describe 'mytask' do
+  #     rakefile <<-EOH
+  #       ...
+  #     EOH
+  #     rake_task 'mytask'
+  #     its(:stdout) { it_expected.to include('1.0.0') }
+  #   end
+  module Rake
+    # @!classmethods
+    module ClassMethods
+      # Run a Rake task as the subject of this example group. The subject will
+      # be a string returned by {#capture_output}.
+      #
+      # @param name [String] Name of the task to execute.
+      # @param args [Array<Object>] Arguments to pass to the task.
+      # @return [void]
+      # @example
+      #   describe 'mytask' do
+      #     rakefile 'require "myapp/rake_tasks"'
+      #     rake_task 'mytask'
+      #     its(:stdout) { is_expected.to include 'Complete!' }
+      #   end
+      def rake_task(name, *args)
+        metadata[:rake] = true
+        subject do
+          exitstatus = []
+          capture_output do
+            Process.waitpid fork {
+              # This has to be nocov because simplecov doesn't track across fork.
+              # :nocov:
+              # Defang SimpleCov so it doesn't print its stuff. Can be removed
+              # when https://github.com/colszowka/simplecov/pull/377 is in a
+              # released version.
+              if defined?(SimpleCov)
+                SimpleCov.at_exit { SimpleCov.instance_variable_set(:@result, nil) }
+              end
+              # Because #init reads from ARGV and will try to parse rspec's flags.
+              ARGV.replace([])
+              Dir.chdir(temp_path)
+              ENV.update(_environment)
+              rake = ::Rake::Application.new.tap do |rake|
+                ::Rake.application = rake
+                rake.init
+                rake.load_rakefile
+              end
+              rake[name].invoke(*args)
+            }
+            exitstatus << $?.exitstatus
+            # :nocov:
+          end.tap do |output|
+            output.define_singleton_method(:exitstatus) { exitstatus.first }
+          end
+        end
+      end
+
+      # Write out a Rakefile to the temporary directory for this example group.
+      # Content can be passed as either a string or a block.
+      #
+      # @param content [String] Rakefile content.
+      # @param block [Proc] Optional block to return the Rakefile content.
+      # @return [void]
+      # @example
+      #   describe 'mytask' do
+      #     rakefile <<-EOH
+      #   task 'mytask' do
+      #     ...
+      #   end
+      #   EOH
+      #     rake_task 'mytask'
+      #     its(:stdout) { is_expected.to include 'Complete!' }
+      #   end
+      def rakefile(content=nil, &block)
+        file('Rakefile', content, &block)
+      end
+
+      def included(klass)
+        super
+        # Pull this in as a dependency.
+        klass.send(:include, RSpecCommand)
+        klass.extend ClassMethods
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/rspec_command/version.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+module RSpecCommand
+  # RSpec-command gem version.
+  VERSION = '1.0.0'
+end

data/rspec-command.gemspec

@@ -0,0 +1,48 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_command/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rspec-command'
+  spec.version = RSpecCommand::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = 'An RSpec helper module for testing command-line tools.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/coderanger/rspec-command'
+  spec.license = 'Apache 2.0'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency 'rspec', '~> 3.2'
+  spec.add_dependency 'rspec-its', '~> 1.2'
+  spec.add_dependency 'mixlib-shellout', '~> 2.0'
+
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'yard-classmethods', '~> 1.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  spec.add_development_dependency 'codecov', '~> 0.0', '>= 0.0.2'
+  spec.add_development_dependency 'pry'
+end

data/spec/command_spec.rb

@@ -0,0 +1,301 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe RSpecCommand do
+  def read_temp(path)
+    IO.read(File.join(temp_path, path))
+  end
+
+  describe '#command' do
+    context 'true' do
+      command 'true'
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context true
+
+    context 'false' do
+      command 'false'
+      it { expect { subject }.to raise_error(Mixlib::ShellOut::ShellCommandFailed) }
+    end # /context false
+
+    context 'with a block' do
+      command { 'true' }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with a block
+
+    context 'with allow_error' do
+      command 'false', allow_error: true
+      its(:exitstatus) { is_expected.to eq 1 }
+    end # /context with allow_error
+
+    context 'with input' do
+      command 'cat', input: "I'm a little teapot"
+      its(:stdout) { is_expected.to eq "I'm a little teapot" }
+    end # /context with input
+
+    context 'check gemfile' do
+      command 'env'
+      its(:stdout) { is_expected.to include("BUNDLE_GEMFILE=#{File.expand_path('../../Gemfile', __FILE__)}") }
+    end # /context check gemfile
+
+    context 'echo * with shell' do
+      command 'echo *'
+      before { IO.write(File.join(temp_path, 'file'), '') }
+      its(:stdout) { is_expected.to eq "file\n" }
+    end # /context echo * with shell
+
+    context 'echo * without shell' do
+      command %w{echo *}
+      before { IO.write(File.join(temp_path, 'file'), '') }
+      its(:stdout) { is_expected.to eq "*\n" }
+    end # /context echo * without shell
+
+    context 'without a Gemfile' do
+      command 'env'
+      before { allow(self).to receive(:find_file).and_return(nil) }
+      around do |example|
+        begin
+          old_gemfile = ENV.delete('BUNDLE_GEMFILE')
+          example.run
+        ensure
+          ENV['BUNDLE_GEMFILE'] = old_gemfile if old_gemfile
+        end
+      end
+      its(:stdout) { is_expected.to_not include('BUNDLE_GEMFILE') }
+    end # /context without a Gemfile
+  end # /describe #command
+
+  describe '#file' do
+    context 'with a simple file' do
+      file 'data', 'Short and stout'
+      subject { read_temp('data') }
+      it { is_expected.to eq 'Short and stout' }
+    end # /context with a simple file
+
+    context 'with a block' do
+      file 'data' do
+        'Here is my handle'
+      end
+      subject { read_temp('data') }
+      it { is_expected.to eq 'Here is my handle' }
+    end # /context with a block
+
+    context 'with a subfolder' do
+      file 'sub/data', 'Here is my spout'
+      subject { read_temp('sub/data') }
+      it { is_expected.to eq 'Here is my spout' }
+    end # /context with a subfolder
+
+    context 'with an absolute path' do
+      it { expect { self.class.file('/data', '') }.to raise_error }
+    end # /context with an absolute path
+  end # /describe #file
+
+  describe '#fixture_file' do
+    context 'with a single file fixture' do
+      fixture_file 'data.txt'
+      subject { read_temp('data.txt') }
+      it { is_expected.to eq "Fixture data.\n" }
+    end # /context with a single file fixture
+
+    context 'with a directory fixture' do
+      fixture_file 'sub'
+      it { expect(read_temp('sub1.txt')).to eq "Subfixture 1.\n" }
+      it { expect(read_temp('sub2.txt')).to eq "Subfixture 2.\n" }
+    end # /context with a directory fixture
+
+    context 'with a different dest' do
+      fixture_file 'sub', 'other'
+      it { expect(read_temp('other/sub1.txt')).to eq "Subfixture 1.\n" }
+      it { expect(read_temp('other/sub2.txt')).to eq "Subfixture 2.\n" }
+    end # /context with a different dest
+
+    context 'with an absolute path' do
+      it { expect { self.class.fixture_file('/data', '') }.to raise_error }
+    end # /context with an absolute path
+
+    context 'with a nested directory fixture' do
+      fixture_file 'sub_nested'
+      it { expect(read_temp('sub_nested.txt')).to eq "Subfixture nested.\n" }
+      it { expect(read_temp('sub_inner/sub_inner1.txt')).to eq "Subfixture inner 1.\n" }
+      it { expect(read_temp('sub_inner/sub_inner2.txt')).to eq "Subfixture inner 2.\n" }
+    end # /context with a nested directory fixture
+  end # /describe #fixture_file
+
+  describe '#environment' do
+    context 'with a single variable' do
+      environment MY_KEY: 'true'
+      command 'env'
+      its(:stdout) { is_expected.to include("MY_KEY=true") }
+    end # /context with a single variable
+
+    context 'with a two variables' do
+      environment MY_KEY: 'true'
+      environment OTHER_KEY: '1'
+      command 'env'
+      its(:stdout) { is_expected.to include("MY_KEY=true") }
+      its(:stdout) { is_expected.to include("OTHER_KEY=1") }
+    end # /context with a two variables
+  end # /describe #environment
+
+  describe '#temp_path' do
+    subject { temp_path }
+    it { is_expected.to be_a(String) }
+  end # /describe #temp_path
+
+  describe '#fixture_root' do
+    let(:fixture_root) { 'fixtures/sub' }
+    fixture_file 'sub1.txt'
+    subject { read_temp('sub1.txt') }
+    it { is_expected.to eq "Subfixture 1.\n" }
+  end # /describe #fixture_root
+
+  describe '#find_file' do
+    context 'with Gemfile' do
+      subject { find_file(__FILE__, 'Gemfile') }
+      it { is_expected.to eq File.expand_path('../../Gemfile', __FILE__) }
+    end # /context with Gemfile
+
+    context 'with a block' do
+      subject { find_file(__FILE__) {|p| p } }
+      it { is_expected.to eq File.dirname(__FILE__) }
+    end # /context with a block
+
+    context 'with a non-existant file' do
+      subject { find_file(__FILE__, 'NOPE.GIF') }
+      it { is_expected.to be_nil }
+    end # /context with a non-existant file
+
+    # This is important to check because otherwise the backstop test might be a
+    # false negative.
+    context 'with the gem root' do
+      subject { find_file(__FILE__, 'rspec-command') }
+      it { is_expected.to eq File.expand_path('../..', __FILE__) }
+    end # /context with the gem root
+
+    context 'with a backstop' do
+      subject { find_file(__FILE__, 'rspec-command', File.expand_path('..', __FILE__)) }
+      it { is_expected.to be_nil }
+    end # /context with a backstop
+  end # /describe #find_file
+
+  describe '#find_gem_base' do
+    subject { find_gem_base(__FILE__) }
+    it { is_expected.to eq File.expand_path('../..', __FILE__) }
+  end # /describe #find_gem_base
+
+  describe '#find_fixture' do
+    context 'with a fixture file' do
+      subject { find_fixture(__FILE__, 'data.txt') }
+      it { is_expected.to eq File.expand_path('../fixtures/data.txt', __FILE__) }
+    end # /context with a fixture file
+
+    context 'with no fixture path' do
+      subject { find_fixture(__FILE__) }
+      it { is_expected.to eq File.expand_path('../fixtures', __FILE__) }
+    end # /context with no fixture path
+  end # /describe #find_fixture
+
+  describe '#capture_output' do
+    context 'with puts' do
+      subject do
+        capture_output { puts 'test' }
+      end
+      it { is_expected.to eq "test\n" }
+      its(:stdout) { is_expected.to eq "test\n" }
+      its(:stderr) { is_expected.to eq '' }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with puts
+
+    context 'with STDERR.puts' do
+      subject do
+        capture_output { STDERR.puts 'test' }
+      end
+      it { is_expected.to eq '' }
+      its(:stdout) { is_expected.to eq '' }
+      its(:stderr) { is_expected.to eq "test\n" }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with STDERR.puts
+
+    context 'with $stderr.puts' do
+      subject do
+        capture_output { $stderr.puts 'test' }
+      end
+      it { is_expected.to eq '' }
+      its(:stdout) { is_expected.to eq '' }
+      its(:stderr) { is_expected.to eq "test\n" }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with $stderr.puts
+
+    context 'with a subproc' do
+      subject do
+        capture_output do
+          # Can't use `` because that already captures stdout
+          if pid = Process.fork
+            Process.waitpid(pid)
+          else
+            exec('echo test')
+          end
+        end
+      end
+      it { is_expected.to eq "test\n" }
+      its(:stdout) { is_expected.to eq "test\n" }
+      its(:stderr) { is_expected.to eq '' }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with a subproc
+
+    context 'with a subproc to stderr' do
+      subject do
+        capture_output { `echo test >&2` }
+      end
+      it { is_expected.to eq '' }
+      its(:stdout) { is_expected.to eq '' }
+      its(:stderr) { is_expected.to eq "test\n" }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context with a subproc
+
+    context 'with a block that raises an exception' do
+      subject do
+        capture_output do
+          puts 'before'
+          raise 'OMG'
+          puts 'after'
+        end
+      end
+      it { expect { subject }.to raise_error }
+      it do
+        begin
+          subject
+        rescue Exception => e
+          expect(e).to respond_to(:output_so_far)
+          expect(e.output_so_far).to eq "before\n"
+        else
+          raise 'Subject did not raise exception'
+        end
+      end
+    end # /context with a block that raises an exception
+  end # /describe #capture_output
+
+  describe RSpecCommand::OutputString do
+    subject { described_class.new('testout', 'testerr') }
+    it { is_expected.to be_a String }
+    it { is_expected.to eq 'testout' }
+    its(:stdout) { is_expected.to eq 'testout' }
+    its(:stderr) { is_expected.to eq 'testerr' }
+    its(:exitstatus) { is_expected.to eq 0 }
+  end # /describe RSpecCommand::OutputString
+end