clintegracon 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 3bdace78261ca262aa53f9124c582f7e17adbf91
+  metadata.gz: ce8b35a77767eefa0b8e5f518edd292225bbf1cb
+SHA512: 
+  data.tar.gz: 4c055116f2d3f625bd423d2f28c11ebf808eac6983ddd19a3d52f303b011489dafffac365e81afdc35326cdf560ed4c70735b0925a773b8d97e7cd2842a161ea
+  metadata.gz: daca9326fc434414d5ed63836b3b743538dd56cb5ec8f49640a4171afc69a272c0b470e3a9f96d49d83587932ad1a6b7f9f3637bf6f98ee7cc3e97473d04ae07

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.idea

data/.travis.yml

@@ -0,0 +1,12 @@
+#addons:
+# code_climate:
+#   repo_token: #TODO
+
+env:
+  - RVM_RUBY_VERSION=system
+  - RVM_RUBY_VERSION=1.8.7-p358
+
+install:
+  - bundle install --without=documentation --path ./travis_bundle_dir
+
+script: rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in CLIntegracon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marius Rackwitz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# CLIntegracon
+
+[![Gem](https://img.shields.io/gem/v/clintegracon.svg?style=flat)](http://rubygems.org/gems/clintegracon)
+[![Build Status](https://img.shields.io/travis/mrackwitz/CLIntegracon/master.svg?style=flat)](https://travis-ci.org/mrackwitz/CLIntegracon)
+[![Coverage](https://img.shields.io/codeclimate/coverage/github/mrackwitz/CLIntegracon.svg?style=flat)](https://codeclimate.com/github/mrackwitz/CLIntegracon)
+[![Code Climate](https://img.shields.io/codeclimate/github/mrackwitz/CLIntegracon.svg?style=flat)](https://codeclimate.com/github/mrackwitz/CLIntegracon)
+
+CLIntegracon allows you to build *Integration* specs for your *CLI*,
+independent if they are based on Ruby or another technology.
+It is especially useful if your command modifies the file system.
+Furthermore it provides an integration for *Bacon*.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clintegracon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clintegracon
+
+
+## Usage
+
+This description assumes the following file system layout of your CLI project.
+This is not fixed, but if yours differ, you have to change paths accordingly.
+
+```
+─┬─/ (root)
+ │
+ ├─┬─spec
+ │ ├───spec_helper.rb
+ │ └─┬─integration
+ │   ├─┬─arg1
+ │   │ ├─┬─before
+ │   │ │ ├───source.h
+ │   │ │ └───source.c
+ │   │ └─┬─after
+ │   │   ├───execution_output.txt
+ │   │   ├───source.h
+ │   │   ├───source.c
+ │   │   └───source.o
+ │   └─┬─arg2
+ │     ├─┬─before
+ │     │ …
+ │     └─┬─after
+ │       …
+ └───tmp
+```
+
+### Bacon
+
+1. Include CLIntegracon in your *spec_helper.rb*
+
+  ```ruby
+  require 'CLIntegracon'
+  ```
+
+2. Setup the basic configuration and hook into Bacon as test framework:
+
+  ```ruby
+  CLIntegracon.configure do |c|
+    c.context.spec_path = File.expand_path('../integration', __FILE__)
+    c.context.temp_path = File.expand_path('../../tmp', __FILE__)
+
+    c.hook_into :bacon
+  end
+  ```
+
+3. Describe your specs with the extended DSL:
+
+  ```ruby
+  # Ensure that all the helpers are included in this context
+  describe_cli 'coffee-maker' do
+
+    # Setup our subject
+    subject do |s|
+      # Provide a display name (optional, default would be 'subject')
+      s.name = 'coffee-maker'
+
+      # Provide the real command line (required)
+      s.executable = 'bundle exec ruby spec/fixtures/bin/coffeemaker.rb"'
+
+      # Set environments variables needed on execution
+      s.environment_vars = {
+          'COFFEE_MAKER_FILE' => 'Coffeemakerfile.yml'
+      }
+
+      # Define default arguments
+      s.default_args = [
+          '--verbose',
+          '--no-ansi'
+      ]
+
+      # Replace special paths in execution output by a placeholder, so that the
+      # compared outputs doesn't differ dependent on the absolute location where
+      # your tested CLI was executed.
+      s.has_special_path ROOT.to_s, 'ROOT'
+    end
+
+    context do |c|
+      # Ignore certain files ...
+      c.ignores '.gitkeep'
+
+      # ... or explicitly ignore all hidden files. (While the default is that they
+      # are included in the file tree diff.)
+      c.include_hidden_files = true
+    end
+
+    describe 'Brew recipes' do
+
+      describe 'without milk' do
+        # +behaves_like+ is provided by bacon.
+        # +cli_spec+ expects as first argument the directory of the spec, and
+        # as second argument the arguments passed to the subject on launch.
+        # The defined default arguments will be appended after that.
+        # If you need to append arguments after the default arguments, because
+        # of the way your command line interface is defined and how its option
+        # parser works, you can pass them as third argument to +cli_spec+.
+        behaves_like cli_spec('coffeemaker_no_milk', '--no-milk')
+
+        # Implementation details:
+        # +cli_spec+ will define on-the-fly a new shared set of expectations
+        # and will return its name and pass it to +behaves_like+, so that it
+        # will be immediately executed.
+      end
+
+      describe 'with honey as sweetner' do
+        behaves_like cli_spec('coffeemaker_sweetner_honey', '--sweetner=honey')
+      end
+
+    end
+
+    describe 'Get help' do
+      behaves_like cli_spec('coffeemaker_help', '--help')
+    end
+
+  end
+  ```
+
+4. Profit
+
+  ![Bacon Example Terminal Output](/../assets/term-output-bacon.png?raw=true)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,60 @@
+#encoding: utf-8
+
+begin
+  require 'bundler/gem_tasks'
+  require 'colored'
+
+  namespace :spec do
+
+    task :prepare do
+      verbose false
+      puts 'Prepare …'
+      sh 'mkdir -p tmp'
+      rm_rf 'tmp/*'
+    end
+
+    desc 'Run the bacon integration spec'
+    task :bacon_integration => [:prepare] do
+      verbose false
+      sh 'rake spec:bacon_integration_runner > tmp/bacon_execution_output.txt' do; end
+      puts 'Run bacon spec …'
+      sh 'diff spec/bacon/execution_output.txt tmp/bacon_execution_output.txt' do |ok, res|
+        if ok
+          puts '✓ Spec for bacon passed.'.green
+        else
+          puts '✗ Spec for bacon failed.'.red
+        end
+      end
+    end
+
+    desc 'Run the tasks for bacon integration spec verbose and without any outer expectations'
+    task :bacon_integration_runner do
+      sh [
+        'bundle exec bacon spec/bacon/spec_helper.rb',
+        'sed -e "s|$(echo $GEM_HOME)|\$GEM_HOME|g"',
+        'sed -e "s|$(dirname ~/.)|\$HOME|g"'
+      ].join " | "
+    end
+
+    desc 'Run all integration specs'
+    task :integration => [
+      'spec:bacon_integration'
+    ]
+
+    desc 'Run all unit specs'
+    task :unit do
+      sh "bundle exec bacon #{specs('unit/**/*')}"
+    end
+
+    def specs(dir)
+      FileList["spec/#{dir}_spec.rb"].shuffle.join(' ')
+    end
+
+    desc 'Run all specs'
+    task :all => [:unit, :integration]
+
+  end
+
+  desc 'Run all specs'
+  task :spec => 'spec:all'
+end

data/clintegracon.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'CLIntegracon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clintegracon"
+  spec.version       = CLIntegracon::VERSION
+  spec.authors       = ["Marius Rackwitz"]
+  spec.email         = ["git@mariusrackwitz.de"]
+  spec.homepage      = "https://github.com/mrackwitz/CLIntegracon"
+  spec.license       = "MIT"
+
+  spec.summary       = "Integration specs for your CLI"
+  spec.description   = "CLIntegracon allows you to build Integration specs for your CLI,"  \
+                       "independent if they are based on Ruby or another technology."      \
+                       "It is especially useful if your command modifies the file system." \
+                       "It provides an integration for Bacon."
+
+  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 = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", '~> 10.1.0'   # Ruby 1.8.7
+  spec.add_development_dependency "bacon"
+  spec.add_development_dependency "mocha", "~> 1.0.0"   # Ruby 1.8.7
+  spec.add_development_dependency "mocha-on-bacon"
+  spec.add_development_dependency "claide"              # Example CLI
+
+  spec.add_runtime_dependency 'colored', '~> 1.2'
+  spec.add_runtime_dependency 'diffy'
+end

data/lib/CLIntegracon.rb

@@ -0,0 +1,9 @@
+require "CLIntegracon/configuration"
+require "CLIntegracon/diff"
+require "CLIntegracon/file_tree_spec"
+require "CLIntegracon/file_tree_spec_context"
+require "CLIntegracon/subject"
+require "CLIntegracon/version"
+
+module CLIntegracon
+end

data/lib/CLIntegracon/adapter/bacon.rb

@@ -0,0 +1,208 @@
+require 'colored'
+
+# Layout structure
+module CLIntegracon
+  module Adapter
+  end
+end
+
+# Define concrete adapter
+module CLIntegracon::Adapter::Bacon
+  module Context
+
+    # Get or configure the current subject
+    #
+    # @note On first call this will create a new subject on base of the
+    #       shared configuration and store it in the ivar `@subject`.
+    #
+    # @param  [Block<(Subject) -> ()>]
+    #         This block, if given, will be evaluated on the caller.
+    #         It receives as first argument the subject itself.
+    #
+    # @return [Subject]
+    #         the subject
+    #
+    def subject &block
+      @subject ||= CLIntegracon::shared_config.subject.dup
+      return @subject if block.nil?
+      instance_exec(@subject, &block)
+    end
+
+    # Get or configure the current context
+    #
+    # @note On first call this will create a new context on base of the
+    #       shared configuration and store it in the ivar `@context`.
+    #
+    # @param  [Block<(FileTreeSpecContext) -> ()>]
+    #         This block, if given, will be evaluated on the caller.
+    #         It receives as first argument the context itself.
+    #
+    # @return [FileTreeSpecContext]
+    #         the spec context, will be lazily created if not already present.
+    #
+    def context &block
+      @context ||= CLIntegracon.shared_config.context.dup
+      return @context if block.nil?
+      instance_exec(@context, &block)
+    end
+
+    # Works like `behaves_like`, but takes arguments for the shared example
+    #
+    # @param [String] name
+    #        name of the shared context.
+    #
+    # @param [...] args
+    #        params to pass to the shared context
+    #
+    def behaves_like_a(name, *args)
+      instance_exec(*args, &Bacon::Shared[name])
+    end
+
+    # Ad-hoc defines a set of shared expectations to be consumed directly by `behaves_like`.
+    # See the following example for usage:
+    #
+    #   behaves_like cli_spec('my_spec_dir', 'install --verbose')
+    #
+    # @note    This expects that a method `context` is defined, which is returning an
+    #          instance of {FileTreeSpecContext}.
+    #
+    # @param   [String] spec_dir
+    #          the concrete directory of the spec, see {file_spec}.
+    #
+    # @param   [String] args
+    #          the additional arguments to pass on launch to {CLIntegracon::Subject}.
+    #
+    # @return  [String]
+    #          name of the set of shared expectations
+    #
+    def cli_spec(spec_dir, *args)
+      file_spec spec_dir do
+        output = subject.launch(*args)
+        status = $?
+
+        it "$ #{subject.name} #{args.join(' ')}" do
+          status.should.satisfy("Binary failed\n\n#{output}") do
+            status.success?
+          end
+        end
+      end
+    end
+
+    # Ad-hoc defines a set of shared expectations to be consumed directly by `behaves_like`.
+    # See the following example for usage:
+    #
+    #   behaves_like file_spec('my_spec_dir') do
+    #     # do some changes to the current dir
+    #   end
+    #
+    # @note    This expects that a method `context` is defined, which is returning an
+    #          instance of {FileTreeSpecContext}.
+    #
+    # @param   [String] spec_dir
+    #          the concrete directory of the spec to be passed to
+    #          {FileTreeSpecContext.spec}
+    #
+    # @param   [Block<() -> ()>] block
+    #          the block which will be executed after the before state is laid out in the
+    #          temporary directory, which normally will make modifications to file system,
+    #          which will be compare to the state given in the after directory.
+    #
+    # @return  [String]
+    #          name of the set of shared expectations
+    #
+    def file_spec(spec_dir, &block)
+      raise ArgumentError.new("Spec directory is missing!") if spec_dir.nil?
+
+      shared_name = spec_dir
+
+      shared shared_name do
+        context.spec(spec_dir).run do |spec|
+          instance_eval &block
+
+          spec.compare do |diff|
+            it diff.relative_path.to_s do
+              diff.produced.should.satisfy(spec.formatter.describe_missing_file(diff.relative_path)) do
+                diff.produced.exist?
+              end
+
+              diff.produced.should.satisfy(spec.formatter.describe_file_diff(diff)) do
+                diff.is_equal?
+              end
+            end
+          end
+
+          spec.check_unexpected_files do |files|
+            it "should not produce unexpected files" do
+              files.should.satisfy(spec.formatter.describe_unexpected_files(files)) do
+                files.size == 0
+              end
+            end
+          end
+        end
+      end
+
+      shared_name
+    end
+
+  end
+
+  # Describe a command line interface
+  # This method basically behaves like {Bacon::Context.describe}, but it provides
+  # automatically the methods #subject, #context, #cli_spec and #file_spec.
+  #
+  # @param  [String] subject_name
+  #         the subject name will be used as first argument to initialize
+  #         a new {CLIntegracon::Subject}, which will be accessible in the
+  #         spec by #subject.
+  #
+  # @param  [Hash<Symbol,String>] context_options
+  #         the options to configure this spec context, could be one or more of:
+  #         * :executable: the executable used to initialize {CLIntegracon::Subject}
+  #           if not given, will fallback to param {subject_name}.
+  #
+  # @param  [Block<() -> ()>] block
+  #         the block to provide further sub-specs or requirements, as
+  #         known from {Bacon::Context.describe}
+  #
+  def describe_cli(subject_name, context_options = {}, &block)
+    context = describe subject_name do
+      # Make Context methods available
+      # WORKAROUND: Bacon auto-inherits singleton methods to child contexts
+      # by using the runtime and won't include methods in modules included
+      # by the parent context. We have to ensure that the methods will be
+      # accessible by the child contexts by defining them as singleton methods.
+      extended = self.extend Context
+      Context.instance_methods.each do |method|
+        class << self; self end.instance_eval do
+          unbound_method = extended.method(method).unbind
+
+          send :define_method, method do |*args, &b|
+            unbound_method.bind(self).call(*args, &b)
+          end
+        end
+      end
+
+      subject do |s|
+        s.name       = subject_name
+        s.executable = context_options[:executable] || subject_name
+      end
+
+      instance_eval &block
+    end
+
+    Bacon::ErrorLog.gsub! %r{^.*lib/CLIntegracon/.*\n}, ''
+
+    context
+  end
+
+end
+
+# Make #describe_cli global available
+extend CLIntegracon::Adapter::Bacon
+
+# Patch Bacon::Context to support #describe_cli
+module Bacon
+  class Context
+    include CLIntegracon::Adapter::Bacon
+  end
+end