cli_tester 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96b04015e8e4ba1f7f601ce673e7992c4e0e0921
+  data.tar.gz: 6734dbd213f3ff50f53c1cb3d17e3c79f8fb0775
+SHA512:
+  metadata.gz: 721c3c34801cc2b0b7862cfc78c510bec00bd228dcd3456b7615bddf4eaca4107067c4b3ffbcf3a8ded3e3be2e2651080ff3c1c19525e9463a68b5699ac02010
+  data.tar.gz: 5c92c09ffe28f8ea36df8de8e40ed20f596c5d78e79db91a946d917c582e28237327885f8d961530fe2a1767abf2daa9c669a15ea043c78607ee6e39e5b01828

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Cornelius Schumacher <schumacher@kde.org>
+
+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,12 @@
+CliTester is a simple set of helpers for testing command line interfaces with
+RSpec. It provides a method to run command line applications and a way to check
+the output and exit codes.
+
+Use it in combination with
+[GivenFilesystem](https://github.com/cornelius/given_filesystem) for convenient
+testing of command line applications.
+
+CliTester is licensed under the MIT license.
+
+If you have questions or comments, please get in touch with Cornelius Schumacher
+<schumacher@kde.org>.

data/bin/cli_tester

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+if ARGV == ["help"] || ARGV == [] || ARGV == ["--help"]
+  puts "Commands:"
+  exit 0
+elsif ARGV == ["help", "list"]
+  puts "inqlude list"
+  exit 0
+elsif ARGV == ["--xxx"]
+  STDERR.puts "Unknown option"
+  exit 0
+elsif ARGV == ["list"]
+  puts "one"
+  puts "two"
+  exit 0
+elsif ARGV == ["ls"]
+  puts Dir.entries(Dir.pwd).sort
+  exit 0
+else
+  STDERR.puts "Unrecognized arguments: #{ARGV}"
+  exit 1
+end

data/bin/the_other_one

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts "I'm the other one"

data/cli_tester.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "cli_tester"
+  s.version     = CliTester::VERSION
+  s.license     = 'MIT'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Cornelius Schumacher']
+  s.email       = ['schumacher@kde.org']
+  s.homepage    = "http://github.com/cornelius/cli_tester"
+  s.summary     = "RSpec helpers for testing command line interfaces"
+  s.description = "CliTester provides a set of RSpec helpers to test command line interfaces by running commands and checking output and exit codes."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "cli_tester"
+
+  s.add_dependency "cheetah"
+
+  s.add_development_dependency "rspec", "~>3"
+  s.add_development_dependency "given_filesystem"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/cli_tester.rb

@@ -0,0 +1,135 @@
+# Copyright (c) 2015 Cornelius Schumacher <schumacher@kde.org>
+#
+# 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.
+
+require "cheetah"
+
+module CliTester
+  def self.included(example_group)
+    example_group.extend(self)
+  end
+
+  class CommandResult
+    attr_accessor :stdout, :stderr, :exit_code, :cmd, :error
+  end
+
+  def run_command(cmd: nil, args: nil, working_directory: nil)
+    if cmd
+      path = "bin/" + cmd
+    else
+      path = "bin/" + File.basename(Dir.pwd)
+    end
+    if !File.exist?(path)
+      executable = [cmd]
+    else
+      executable = [File.expand_path(path)]
+    end
+
+    if args
+      executable += args
+    end
+
+    if working_directory
+      current_working_directory = Dir.pwd
+      Dir.chdir(working_directory)
+    end
+
+    result = CommandResult.new
+    result.cmd = executable
+    begin
+      o, e = Cheetah.run(executable, stdout: :capture, stderr: :capture )
+      result.exit_code = 0
+      result.stdout = o
+      result.stderr = e
+    rescue Cheetah::ExecutionFailed => e
+      result.error = e
+      result.exit_code = e.status.exitstatus
+      result.stdout = e.stdout
+      result.stderr = e.stderr
+    end
+
+    if working_directory
+      Dir.chdir(current_working_directory)
+    end
+
+    result
+  end
+end
+
+RSpec::Matchers.define :exit_with_success do |expected_stdout, expected_stderr|
+  match do |result|
+    return false if result.exit_code != 0
+    if expected_stderr
+      if expected_stderr.is_a?(Regexp)
+        return false if !expected_stderr.match(result.stderr)
+      else
+        return false if expected_stderr != result.stderr
+      end
+    else
+      return false if !result.stderr.empty?
+    end
+    if expected_stdout.is_a?(Regexp)
+      expected_stdout.match(result.stdout)
+    else
+      expected_stdout == result.stdout
+    end
+  end
+
+  failure_message do |result|
+    message = "ran #{result.cmd}\n"
+    if result.error
+      message += "error message: #{result.error}\n"
+    end
+    if result.exit_code != 0
+      message += "expected exit code to be zero (was #{result.exit_code})\n"
+    end
+    if expected_stderr
+      if expected_stderr.is_a?(Regexp)
+        message += "stderr didn't match #{expected_stderr.inspect}"
+        message += " (was '#{Regexp.escape(result.stderr)}')"
+      else
+        if result.stderr != expected_stderr
+          message += "expected stderr to be '#{Regexp.escape(expected_stderr)}'"
+          message += " (was '#{Regexp.escape(result.stderr)}')"
+          message += "\n\nDiff of stderr:"
+          differ = RSpec::Support::Differ.new(color: true)
+          message += differ.diff(result.stderr, expected_stderr)
+        end
+      end
+    else
+      if !result.stderr.empty?
+        message += "expected stderr to be empty"
+        message += " (was '#{Regexp.escape(result.stderr)}')\n"
+      end
+    end
+    if expected_stdout.is_a?(Regexp)
+      message += "stdout didn't match #{expected_stdout.inspect}"
+      message += " (was '#{Regexp.escape(result.stdout)}')"
+    else
+      if result.stdout != expected_stdout
+        message += "expected stdout to be '#{Regexp.escape(expected_stdout)}'"
+        message += " (was '#{Regexp.escape(result.stdout)}')"
+        message += "\n\nDiff of stdout:"
+        differ = RSpec::Support::Differ.new(color: true)
+        message += differ.diff(result.stdout, expected_stdout)
+      end
+    end
+    message
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CliTester
+  VERSION = "0.0.1"
+end

data/spec/cli_tester_spec.rb

@@ -0,0 +1,61 @@
+require_relative "spec_helper"
+
+include CliTester
+include GivenFilesystemSpecHelpers
+
+describe "Command line interface" do
+  describe "help" do
+    it "shows help when run with no args" do
+      expect(run_command).to exit_with_success(/Commands:/)
+    end
+
+    it "shows help when run with help command" do
+      expect(run_command(args: ["help"])).to exit_with_success(/Commands:/)
+    end
+
+    it "shows help when run with --help option" do
+      expect(run_command(args: ["--help"])).to exit_with_success(/Commands:/)
+    end
+
+    it "shows help for command" do
+      expect(run_command(args: ["help", "list"])).to exit_with_success(/inqlude list/)
+    end
+  end
+
+  describe "errors" do
+    it "fails with unknown option" do
+      expect(run_command(args: ["--xxx"])).to exit_with_success("", /Unknown/)
+    end
+  end
+
+  describe "list" do
+    it "lists libraries" do
+      expect(run_command(args: ["list"])).to exit_with_success("one\ntwo\n")
+    end
+  end
+end
+
+describe "options" do
+  use_given_filesystem
+
+  it "runs local cmd" do
+    result = run_command(cmd: "the_other_one")
+    expect(result).to exit_with_success("I'm the other one\n")
+  end
+
+  it "runs global cmd in specified working directory" do
+    dir = given_directory do
+      given_dummy_file("hello")
+    end
+    result = run_command(cmd: "ls", working_directory: dir)
+    expect(result).to exit_with_success("hello\n")
+  end
+
+  it "runs local cmd in specified working directory" do
+    dir = given_directory do
+      given_dummy_file("hello")
+    end
+    result = run_command(args: ["ls"], working_directory: dir)
+    expect(result).to exit_with_success(".\n..\nhello\n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'given_filesystem/spec_helpers'
+
+require_relative '../lib/cli_tester'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cli_tester
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cornelius Schumacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cheetah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: given_filesystem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CliTester provides a set of RSpec helpers to test command line interfaces
+  by running commands and checking output and exit codes.
+email:
+- schumacher@kde.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.md
+- bin/cli_tester
+- bin/the_other_one
+- cli_tester.gemspec
+- lib/cli_tester.rb
+- lib/version.rb
+- spec/cli_tester_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cornelius/cli_tester
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: cli_tester
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: RSpec helpers for testing command line interfaces
+test_files: []