bashcov 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format d
+--order random

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Cédric Félizard
+
+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,49 @@
+# Bashcov [![Build Status](https://secure.travis-ci.org/infertux/bashcov.png?branch=master)](https://travis-ci.org/infertux/bashcov)
+
+[bashcov] is [simplecov] for Bash.
+
+## Installation
+
+`$ gem install bashcov`
+
+## Usage
+
+`bashcov ./test_suite.sh`
+
+This will create a directory named `coverage/` containing HTML files.
+
+Example output: [demo](http://infertux.github.com/bashcov/test_app/)
+
+## Rationale
+
+I'm a big fan of both Ruby's _simplecov_ and Bash.
+_bashcov_ is my dream to have in Bash what _simplecov_ is to Ruby :).
+
+Oddly enough, I didn't find any coverage tool for Bash except [shcov] but as stated [there](http://stackoverflow.com/questions/7188081/code-coverage-tools-for-validating-the-scripts), _shcov_ is:
+
+> somewhat simplistic and doesn't handle all possible cases very well (especially when we're talking about long and complex lines)
+
+Indeed, it doesn't work very well for me.
+I have covered lines marked as uncovered and some files completely missed although executed through another script.
+
+_bashcov_ aims to be a neat and working coverage tool backed by _simplecov_ and [simplecov-html].
+
+## How does it work?
+
+Ruby has a [coverage module](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html) which computes the coverage on demand.
+Unfortunately, Bash doesn't have such niceties but we can use the [xtrace feature](http://www.gnu.org/software/bash/manual/bashref.html#index-BASH_005fXTRACEFD-178) which prints every line executed using [PS4](http://www.gnu.org/software/bash/manual/bashref.html#index-PS4).
+
+After a bit of parsing, it sends results through _simplecov_ which generates an awesome HTML report.
+
+And of course, you can take the most of _simplecov_ by adding a `.simplecov` file in your project's root (like [this](https://github.com/infertux/bashcov/blob/master/spec/test_app/.simplecov)).
+
+## License
+
+MIT
+
+
+[bashcov]: https://github.com/infertux/bashcov
+[simplecov]: https://github.com/colszowka/simplecov
+[simplecov-html]: https://github.com/colszowka/simplecov-html
+[shcov]: http://code.google.com/p/shcov/source/browse/trunk/scripts/shcov
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/TODO

@@ -0,0 +1,3 @@
+see if we could implement some features of https://en.wikipedia.org/wiki/Gcov
+tidy up things
+more comprehensive specs

data/bashcov.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bashcov/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bashcov"
+  gem.version       = Bashcov::VERSION
+  gem.authors       = ["Cédric Félizard"]
+  gem.email         = ["cedric@felizard.fr"]
+  gem.description   = %q{Code coverage tool for Bash}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/infertux/bashcov"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'simplecov'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/bin/bashcov

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bashcov'
+
+if ARGV.size != 1
+  $stderr.puts "#{File.basename(__FILE__)} takes exactly one argument."
+  exit 1
+end
+
+filename = ARGV[0]
+
+runner = Bashcov::Runner.new filename
+runner.run
+coverage = runner.result
+
+require 'simplecov'
+
+SimpleCov.command_name Bashcov.link
+# SimpleCov.filters = [] # TODO make sure default filters are okay
+SimpleCov::Result.new(coverage).format!
+

data/lib/bashcov.rb

@@ -0,0 +1,22 @@
+require "bashcov/version"
+require "bashcov/lexer"
+require "bashcov/line"
+require "bashcov/runner"
+require "bashcov/xtrace"
+
+module Bashcov
+  class << self
+    def root_directory
+      Dir.getwd
+    end
+
+    def coverage_array(filename, fill = Line::UNCOVERED)
+      lines = File.readlines(filename).size
+      [fill] * lines
+    end
+
+    def link
+      '<a href="https://github.com/infertux/bashcov">bashcov</a>'
+    end
+  end
+end

data/lib/bashcov/lexer.rb

@@ -0,0 +1,36 @@
+module Bashcov
+  class Lexer
+    def initialize filename
+      @filename = File.expand_path(filename)
+    end
+
+    def irrelevant_lines
+      lines = []
+      IO.readlines(@filename).each_with_index do |line, lineno|
+        lines << lineno if is_irrevelant? line
+      end
+      lines
+    end
+
+  private
+
+    def is_irrevelant? line
+      line.strip!
+      return true if line.empty?
+      return true if start_with.any? { |token| line.start_with? token }
+      return true if is.any? { |keyword| line =~ /\A#{keyword}\Z/ }
+      return true if line =~ /\A\w+\(\) {/ # function declared like this: "foo() {"
+      false
+    end
+
+    # Lines containing only one of these keywords are irrelevant for coverage
+    def is
+      %w(esac fi then do done else { })
+    end
+
+    # Lines starting with one of these keywords are irrelevant for coverage
+    def start_with
+      %w(# function)
+    end
+  end
+end

data/lib/bashcov/line.rb

@@ -0,0 +1,6 @@
+module Bashcov
+  module Line
+    UNCOVERED = 0
+    IGNORED = nil
+  end
+end

data/lib/bashcov/runner.rb

@@ -0,0 +1,58 @@
+require 'open3'
+
+module Bashcov
+  class Runner
+    attr_reader :output
+
+    def initialize filename
+      @filename = File.expand_path(filename)
+    end
+
+    def run
+      # SHELLOPTS must be exported so we use Ruby's ENV variable
+      ENV['SHELLOPTS'] = 'braceexpand:hashall:interactive-comments:posix:verbose:xtrace'
+
+      command = "PS4='#{Xtrace.ps4}' #{@filename}"
+      _, _, @output = Open3.popen3(command)
+    end
+
+    def result
+      # 1. Grab all bash files in project root and mark them uncovered
+      @files = find_bash_files
+
+      # 2. Add coverage information from run
+      xtraced_files = Xtrace.new(@output).files
+      xtraced_files.each do |file, lines|
+        next if file == @filename
+        lines.each_with_index do |line, index|
+          @files[file] ||= Bashcov.coverage_array(file) # non .sh files but executed though
+          @files[file][index] = line if line
+        end
+      end
+
+      # 3. Ignore irrelevant lines
+      @files.each do |filename, lines|
+        warn filename unless File.file?(filename)
+        next unless File.file?(filename)
+        lexer = Lexer.new(filename)
+        lexer.irrelevant_lines.each do |lineno|
+          @files[filename][lineno] = Bashcov::Line::IGNORED
+        end
+      end
+    end
+
+    def find_bash_files
+      files = {}
+
+      (Dir["#{Bashcov.root_directory}/**/*.sh"] - [@filename]).each do |file|
+        absolute_path = File.expand_path(file)
+        next unless File.file?(absolute_path)
+
+        files[absolute_path] = Bashcov.coverage_array(absolute_path)
+      end
+
+      files
+    end
+
+  end
+end

data/lib/bashcov/version.rb

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

data/lib/bashcov/xtrace.rb

@@ -0,0 +1,52 @@
+module Bashcov
+  class Xtrace
+    def initialize output
+      @output = output
+    end
+
+    def files
+      files = {}
+
+      @output.readlines.each do |line|
+        next unless match = line.match(Xtrace.line_regexp)
+
+        filename = File.expand_path(match[:filename], Bashcov.root_directory)
+        next unless File.file? filename
+
+        lineno = match[:lineno].to_i
+        lineno -= 1 if lineno > 0
+
+        files[filename] ||= Bashcov.coverage_array(filename)
+
+        files[filename][lineno] += 1
+      end
+
+      files
+    end
+
+    def self.ps4
+      # We use a forward slash as delimiter since it's the only forbidden
+      # character in filenames on Unix and Windows.
+
+      # http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
+      %Q{#{prefix}$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")/${LINENO} BASHCOV}
+    end
+
+  private
+
+    def self.prefix
+      # Note that the first caracter (+) will be repeated to indicate the
+      # nesting level (see depth_character).
+      '+BASHCOV> '
+    end
+
+    def self.depth_character
+      Regexp.escape(prefix[0])
+    end
+
+    def self.line_regexp
+      /\A#{depth_character}+#{prefix[1..-1]}(?<filename>.+)\/(?<lineno>\d+) BASHCOV/
+    end
+  end
+end
+

data/spec/bashcov/lexer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Bashcov::Lexer do
+  describe "#irrelevant_lines" do
+    [
+      ['simple.sh', [0, 1, 2, 3, 6, 8, 9, 11, 12]],
+      ['function.sh', [0, 1, 2, 4, 5, 6, 9, 10, 13]],
+      ['sourced.txt', [0, 1, 3]]
+
+    ].each do |filename, lines|
+      context "for #{filename}" do
+        it "returns irrelevant lines" do
+          lexer = Bashcov::Lexer.new File.join(scripts, filename)
+          lexer.irrelevant_lines.should =~ lines
+        end
+      end
+    end
+  end
+end
+

data/spec/bashcov/runner_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Bashcov::Runner do
+  before do
+    @runner ||= Bashcov::Runner.new test_suite
+  end
+
+  describe "#find_bash_files" do
+    it "returns the list of .sh files in the root directory" do
+      files = @runner.find_bash_files
+      files.class.should == Hash
+      files.values.each do |lines|
+        lines.each { |line| line.should == Bashcov::Line::UNCOVERED }
+      end
+    end
+  end
+
+  describe "#result" do
+    it "returns a valid hash" do
+      @runner.run
+      result = @runner.result
+
+      result.class.should == Hash
+      result.size.should == 8 # FIXME
+    end
+  end
+end

data/spec/bashcov/xtrace_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Bashcov::Xtrace do
+  before do
+    @runner ||= Bashcov::Runner.new test_suite
+    @runner.run
+
+    @xtrace ||= Bashcov::Xtrace.new @runner.output
+  end
+
+  describe "#files" do
+    it "returns a list of executed files" do
+      files = @xtrace.files
+      files.class.should == Hash
+      files.keys.should =~ executed_files + [test_suite]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+unless RUBY_ENGINE == 'rbx' # coverage support is broken on rbx
+  require 'simplecov'
+  SimpleCov.start do
+    minimum_coverage 98
+    add_group "Sources", "lib"
+    add_group "Tests", "spec"
+  end
+end
+
+require 'bashcov'
+
+def test_app
+  File.expand_path("../test_app", __FILE__)
+end
+
+def scripts
+  "#{test_app}/scripts"
+end
+
+def test_suite
+  "#{test_app}/test_suite.sh"
+end
+
+def executed_files
+  Dir["#{scripts}/**/*"].select { |file| File.file? file }
+end
+

data/spec/test_app/.simplecov

@@ -0,0 +1,2 @@
+SimpleCov.add_group 'Bash Scripts', '\.sh$'
+SimpleCov.add_group 'Nested scripts', '/nested'

data/spec/test_app/never_called.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "I'm never executed by any script"
+

data/spec/test_app/scripts/function.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+function f1 {
+    echo f1
+}
+
+f2() {
+    f1
+    echo f2
+}
+
+f1
+f2
+

data/spec/test_app/scripts/long_line.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+echo 1 && \
+    echo 2 \
+  && echo 3 \
+|| echo 0
+

data/spec/test_app/scripts/nested/simple.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# basic test program
+
+if true; then
+    echo 42
+else
+    echo nope
+fi
+
+echo "error on stderr" >&2
+
+

data/spec/test_app/scripts/one_liner.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+[ "one" = "two" ] && echo nah || echo yup
+
+if false
+then
+    never
+fi
+

data/spec/test_app/scripts/simple.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# basic test program
+
+if true; then
+    echo 42
+else
+    echo nope
+fi
+
+echo "error on stderr" >&2
+
+

data/spec/test_app/scripts/source.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "I'm sourcing sourced.txt"
+
+. $(dirname $0)/sourced.txt
+

data/spec/test_app/scripts/sourced.txt

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "I'm sourced.txt"
+

data/spec/test_app/test_suite.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cd $(dirname $0)
+find scripts -name "*.sh" -exec "{}" \;
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: bashcov
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cédric Félizard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Code coverage tool for Bash
+email:
+- cedric@felizard.fr
+executables:
+- bashcov
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bashcov.gemspec
+- bin/bashcov
+- lib/bashcov.rb
+- lib/bashcov/lexer.rb
+- lib/bashcov/line.rb
+- lib/bashcov/runner.rb
+- lib/bashcov/version.rb
+- lib/bashcov/xtrace.rb
+- spec/bashcov/lexer_spec.rb
+- spec/bashcov/runner_spec.rb
+- spec/bashcov/xtrace_spec.rb
+- spec/spec_helper.rb
+- spec/test_app/.simplecov
+- spec/test_app/never_called.sh
+- spec/test_app/scripts/function.sh
+- spec/test_app/scripts/long_line.sh
+- spec/test_app/scripts/nested/simple.sh
+- spec/test_app/scripts/one_liner.sh
+- spec/test_app/scripts/simple.sh
+- spec/test_app/scripts/source.sh
+- spec/test_app/scripts/sourced.txt
+- spec/test_app/test_suite.sh
+homepage: https://github.com/infertux/bashcov
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Code coverage tool for Bash
+test_files:
+- spec/bashcov/lexer_spec.rb
+- spec/bashcov/runner_spec.rb
+- spec/bashcov/xtrace_spec.rb
+- spec/spec_helper.rb
+- spec/test_app/.simplecov
+- spec/test_app/never_called.sh
+- spec/test_app/scripts/function.sh
+- spec/test_app/scripts/long_line.sh
+- spec/test_app/scripts/nested/simple.sh
+- spec/test_app/scripts/one_liner.sh
+- spec/test_app/scripts/simple.sh
+- spec/test_app/scripts/source.sh
+- spec/test_app/scripts/sourced.txt
+- spec/test_app/test_suite.sh