bashcov 1.2.1 → 1.3.0

data/lib/bashcov/xtrace.rb

@@ -1,32 +1,70 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "securerandom"
+
+require "bashcov/errors"
+
 module Bashcov
   # This class manages +xtrace+ output.
   #
   # @see Runner
   class Xtrace
-    # Prefix used for PS4.
-    # @note The first caracter ('+') will be repeated to indicate the nesting
-    #   level.
-    PREFIX = "+BASHCOV> "
-
-    # [String] +PS4+ variable used for xtrace output
-    # @see http://www.gnu.org/software/bash/manual/bashref.html#index-PS4
-    # @see http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
-    # @note We use a forward slash as delimiter since it's the only forbidden
-    #   character in filenames on Unix and Windows.
-    GET_ABS_DIR = "$(cd $(dirname ${BASH_SOURCE[0]}); pwd)"
-    GET_BASE = "$(basename ${BASH_SOURCE[0]})"
-    PS4 = %(#{PREFIX}#{GET_ABS_DIR}/#{GET_BASE}/${LINENO}: )
-
-    # Regexp to match xtrace elements.
-    LINE_REGEXP = %r{\A#{Regexp.escape(PREFIX[0])}+#{PREFIX[1..-1]}(?<filename>.+)\/(?<lineno>\d+): }
-
-    # @return [Hash] Coverage of executed files
-    attr_reader :coverage
-
-    # Creates a temporary file for xtrace output.
-    # @see http://stackoverflow.com/questions/6977561/pipe-vs-temporary-file
-    def initialize
+    # [String] Character that will be used to indicate the nesting level of
+    #   +xtrace+d instructions
+    DEPTH_CHAR = "+"
+
+    # [String] Prefix used in +PS4+ to identify relevant output
+    PREFIX = "BASHCOV>"
+
+    # [Array<String>] A collection of Bash internal variables to expand in the
+    #   {PS4}
+    FIELDS = %w(${LINENO} ${BASH_SOURCE} ${PWD} ${OLDPWD}).freeze
+
+    class << self
+      attr_writer :delimiter, :ps4
+
+      # [String] A randomly-generated UUID or the ASCII RS (record separator)
+      #   character, depending on whether the current Bash suffers from the
+      #   truncated +PS4+ bug. Used for delimiting the fields of the +PS4+.
+      def delimiter
+        @delimiter ||= Bashcov.truncated_ps4? ? "\x1E" : SecureRandom.uuid
+      end
+
+      # @return [String] +PS4+ variable used for xtrace output. Expands to
+      #   internal Bash variables +BASH_SOURCE+, +PWD+, +OLDPWD+, and +LINENO+,
+      #   delimited by {delimiter}.
+      # @see http://www.gnu.org/software/bash/manual/bashref.html#index-PS4
+      def ps4
+        @ps4 ||= make_ps4(*FIELDS)
+      end
+
+      # @return [String] a {delimiter}-separated +String+ suitable for use as
+      #   +PS4+
+      def make_ps4(*fields)
+        fields.reduce(DEPTH_CHAR + PREFIX) do |memo, field|
+          memo + delimiter + field
+        end + delimiter
+      end
+    end
+
+    # Regexp to match the beginning of the {.ps4}. {DEPTH_CHAR} will be
+    # repeated in proportion to the level of Bash call nesting.
+    PS4_START_REGEXP = /#{Regexp.escape(DEPTH_CHAR)}+#{Regexp.escape(PREFIX)}$/m
+
+    # Creates a pipe for xtrace output.
+    # @see http://stackoverflow.com/questions/6977562/pipe-vs-temporary-file
+    def initialize(field_stream)
+      @field_stream = field_stream
+
       @read, @write = IO.pipe
+
+      # Tracks coverage for each file under test
+      @files ||= {}
+
+      # Stacks for updating working directory changes
+      @pwd_stack ||= []
+      @oldpwd_stack ||= []
     end
 
     # @return [Fixnum] File descriptor of the write end of the pipe
@@ -40,24 +78,101 @@ module Bashcov
       @write.close
     end
 
-    # Parses xtrace output and computes coverage.
-    # @return [Hash] Hash of executed files with coverage information
+    # Read fields extracted from Bash's debugging output
+    # @return [Hash<Pathname, Array<Integer, nil>>] A hash mapping Bash scripts
+    #   to Simplecov-style coverage stats
     def read
-      @files = {}
-
-      @read.each_line do |line|
-        match = line.match(LINE_REGEXP)
-        next if match.nil? # garbage line from multiline instruction
+      @field_stream.read = @read
 
-        filename = File.expand_path(match[:filename], Bashcov.root_directory)
+      field_count = FIELDS.length
+      fields = @field_stream.each(
+        self.class.delimiter, field_count, PS4_START_REGEXP
+      )
 
-        lineno = match[:lineno].to_i - 1
-        @files[filename] ||= []
-        @files[filename][lineno] ||= 0
-        @files[filename][lineno] += 1
+      # +take(field_count)+ would be more natural here, but doesn't seem to
+      # play nicely with +Enumerator+s backed by +IO+ objects.
+      loop do
+        break if (hit = (1..field_count).map { fields.next }).empty?
+        parse_hit!(*hit)
       end
 
       @files
     end
+
+  private
+
+    # Parses the expanded {ps4} fields and updates the coverage-tracking
+    # {@files} hash
+    # @overload parse_hit!(lineno, bash_source, pwd, oldpwd)
+    #   @param [String]  lineno       expanded +LINENO+
+    #   @param [Pathname] bash_source expanded +BASH_SOURCE+
+    #   @param [Pathname] pwd         expanded +PWD+
+    #   @param [Pathname] oldpwd      expanded +OLDPWD+
+    # @return [void]
+    # @raise [XtraceError] when +lineno+ is not composed solely of digits,
+    #   indicating that something has gone wrong with parsing the +PS4+ fields
+    def parse_hit!(lineno, *paths)
+      # If +LINENO+ isn't a series of digits, something has gone wrong. Add
+      # +@files+ to the exception in order to propagate the existing coverage
+      # data back to the {Bashcov::Runner} instance.
+      unless lineno =~ /\A\d+\z/
+        lineno_err = lineno.empty? ? nil : lineno
+
+        raise XtraceError.new(
+          "expected integer for LINENO, got `#{lineno_err.inspect}'", @files
+        )
+      end
+
+      # The next three fields will be $BASH_SOURCE, $PWD, $OLDPWD, and $LINENO
+      bash_source, pwd, oldpwd = paths.map { |p| Pathname.new(p) }
+
+      update_wd_stacks!(pwd, oldpwd)
+
+      script = find_script(bash_source)
+
+      # For one-liners, +LINENO+ == 0. Do this to avoid an +IndexError+;
+      # one-liners will be culled from the coverage results later on.
+      index = (lineno_i = lineno.to_i) > 1 ? lineno_i - 1 : 0
+
+      @files[script] ||= []
+      @files[script][index] ||= 0
+      @files[script][index] += 1
+    end
+
+    # Scans entries in the +PWD+ stack, checking whether +entry/$BASH_SOURCE+
+    # refers to an existing file. Scans the stack in reverse on the assumption
+    # that more-recent entries are more plausible candidates for base
+    # directories from which +BASH_SOURCE+ can be reached.
+    # @param [Pathname] bash_source expanded +BASH_SOURCE+
+    # @return [Pathname] the resolved path to +bash_source+, if it exists;
+    #   otherwise, +bash_source+ cleaned of redundant slashes and dots
+    def find_script(bash_source)
+      script = @pwd_stack.reverse.map { |wd| wd + bash_source }.find(&:file?)
+      script.nil? ? bash_source.cleanpath : script.realpath
+    end
+
+    # Updates the stacks that track the history of values for +PWD+ and
+    # +OLDPWD+
+    # @param [Pathname] pwd     expanded +PWD+
+    # @param [Pathname] oldpwd  expanded +OLDPWD+
+    # @return [void]
+    def update_wd_stacks!(pwd, oldpwd)
+      @pwd_stack[0] ||= pwd
+      @oldpwd_stack[0] ||= oldpwd unless oldpwd.to_s.empty?
+
+      # We haven't changed working directories; short-circuit.
+      return if pwd == @pwd_stack[-1]
+
+      # If the current +pwd+ is identical to the top of the +@oldpwd_stack+ and
+      # the current +oldpwd+ is identical to the second-to-top entry, then a
+      # previous cd/pushd has been undone.
+      if pwd == @oldpwd_stack[-1] && oldpwd == @oldpwd_stack[-2]
+        @pwd_stack.pop
+        @oldpwd_stack.pop
+      else # New cd/pushd
+        @pwd_stack << pwd
+        @oldpwd_stack << oldpwd
+      end
+    end
   end
 end

data/lib/bashcov.rb

@@ -1,29 +1,27 @@
+# frozen_string_literal: true
+
 require "optparse"
-require "ostruct"
-require "bashcov/version"
-require "bashcov/lexer"
-require "bashcov/line"
+require "pathname"
+
+require "bashcov/bash_info"
 require "bashcov/runner"
-require "bashcov/xtrace"
+require "bashcov/version"
 
 # Bashcov default module
 # @note Keep it short!
 module Bashcov
-  class << self
-    # @return [OpenStruct] Bashcov settings
-    attr_reader :options
+  extend Bashcov::BashInfo
 
-    # @return [String] The project's root directory
-    def root_directory
-      @root_directory ||= Dir.pwd
-    end
+  # A +Struct+ to store Bashcov configuration
+  Options = Struct.new(
+    *%i(skip_uncovered mute bash_path root_directory command)
+  )
 
-    # Sets default options overriding any existing ones.
-    # @return [void]
-    def set_default_options!
-      @options ||= OpenStruct.new
-      @options.skip_uncovered = false
-      @options.mute = false
+  class << self
+    # @return [Struct] The +Struct+ object representing Bashcov configuration
+    def options
+      set_default_options! unless defined?(@options)
+      @options
     end
 
     # Parses the given CLI arguments and sets +options+.
@@ -31,24 +29,54 @@ module Bashcov
     # @raise [SystemExit] if invalid arguments are given
     # @return [void]
     def parse_options!(args)
-      option_parser.parse!(args)
+      begin
+        option_parser.parse!(args)
+      rescue OptionParser::ParseError, Errno::ENOENT => e
+        abort "#{option_parser.program_name}: #{e.message}"
+      end
 
       if args.empty?
         abort("You must give exactly one command to execute.")
       else
-        @options.command = args.join(" ")
+        options.command = args.unshift(bash_path)
       end
     end
 
+    # @return [String] Program name
+    def program_name
+      "bashcov"
+    end
+
     # @return [String] Program name including version for easy consistent output
-    def name
-      "bashcov v#{VERSION}"
+    # @note +fullname+ instead of name to avoid clashing with +Module.name+
+    def fullname
+      "#{program_name} v#{VERSION}"
+    end
+
+    # Wipe the current options and reset default values
+    def set_default_options!
+      @options = Options.new
+
+      @options.skip_uncovered   = false
+      @options.mute             = false
+      @options.bash_path        = "/bin/bash"
+      @options.root_directory   = Dir.getwd
     end
 
   private
 
-    def help(program_name)
-      <<-HELP.gsub!(/^ +/, "").gsub!("\t", " " * 4)
+    # Passes off +respond_to?+ to {options} for missing methods
+    def respond_to_missing?(*args)
+      options.respond_to?(*args)
+    end
+
+    # Dispatches missing methods to {options}
+    def method_missing(method_name, *args, &block)
+      options.public_send(method_name, *args, &block)
+    end
+
+    def help
+      <<-HELP.gsub(/^ +/, "").gsub("\t", " " * 4)
         Usage: #{program_name} [options] [--] <command> [options]
         Examples:
         \t#{program_name} ./script.sh
@@ -60,17 +88,25 @@ module Bashcov
 
     def option_parser
       OptionParser.new do |opts|
-        opts.program_name = "bashcov"
+        opts.program_name = program_name
         opts.version = Bashcov::VERSION
-        opts.banner = help opts.program_name
+        opts.banner = help
 
         opts.separator "\nSpecific options:"
 
         opts.on("-s", "--skip-uncovered", "Do not report uncovered files") do |s|
-          @options.skip_uncovered = s
+          options.skip_uncovered = s
         end
         opts.on("-m", "--mute", "Do not print script output") do |m|
-          @options.mute = m
+          options.mute = m
+        end
+        opts.on("--bash-path PATH", "Path to Bash executable") do |p|
+          raise Errno::ENOENT, p unless File.file? p
+          options.bash_path = p
+        end
+        opts.on("--root PATH", "Project root directory") do |d|
+          raise Errno::ENOENT, d unless File.directory? d
+          options.root_directory = d
         end
 
         opts.separator "\nCommon options:"
@@ -86,6 +122,3 @@ module Bashcov
     end
   end
 end
-
-# Make sure default options are set
-Bashcov.set_default_options!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -144,10 +144,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -158,35 +154,14 @@ files:
 - bashcov.gemspec
 - bin/bashcov
 - lib/bashcov.rb
+- lib/bashcov/bash_info.rb
+- lib/bashcov/errors.rb
+- lib/bashcov/field_stream.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_spec.rb
-- spec/spec_helper.rb
-- spec/support/common.rb
-- spec/support/test_app.rb
-- spec/test_app/.simplecov
-- spec/test_app/README.md
-- spec/test_app/never_called.sh
-- spec/test_app/scripts/README.md
-- spec/test_app/scripts/case.sh
-- spec/test_app/scripts/delete.sh
-- spec/test_app/scripts/executable
-- spec/test_app/scripts/exit_non_zero.sh
-- spec/test_app/scripts/function.sh
-- spec/test_app/scripts/long_line.sh
-- spec/test_app/scripts/multiline.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/scripts/unicode.sh
-- spec/test_app/test_suite.sh
 homepage: https://github.com/infertux/bashcov
 licenses:
 - MIT
@@ -207,33 +182,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Code coverage tool for Bash
-test_files:
-- spec/bashcov/lexer_spec.rb
-- spec/bashcov/runner_spec.rb
-- spec/bashcov_spec.rb
-- spec/spec_helper.rb
-- spec/support/common.rb
-- spec/support/test_app.rb
-- spec/test_app/.simplecov
-- spec/test_app/README.md
-- spec/test_app/never_called.sh
-- spec/test_app/scripts/README.md
-- spec/test_app/scripts/case.sh
-- spec/test_app/scripts/delete.sh
-- spec/test_app/scripts/executable
-- spec/test_app/scripts/exit_non_zero.sh
-- spec/test_app/scripts/function.sh
-- spec/test_app/scripts/long_line.sh
-- spec/test_app/scripts/multiline.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/scripts/unicode.sh
-- spec/test_app/test_suite.sh
+test_files: []
 has_rdoc: 

data/.gitignore

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

data/.rspec

@@ -1,4 +0,0 @@
---color
---format d
---order random
---profile

data/.rubocop.yml

@@ -1,27 +0,0 @@
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 120
-  Exclude: [spec/**/*]
-
-Style/AccessModifierIndentation:
-  EnforcedStyle: outdent
-
-Style/AndOr:
-  EnforcedStyle: conditionals
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/TrailingComma:
-  Enabled: false

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-after_script:
-  - cane
-  - yard stats --list-undoc
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - ruby-head
-  - rbx
-  - rbx-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx
-    - rvm: rbx-head
-notifications:
-  email:
-    on_success: always
-    on_failure: always

data/spec/bashcov/lexer_spec.rb

@@ -1,11 +0,0 @@
-require "spec_helper"
-
-describe Bashcov::Lexer do
-  describe "#initialize" do
-    it "raises if the file is invalid" do
-      expect do
-        Bashcov::Lexer.new "inexistent_file.exe", nil
-      end.to raise_error ArgumentError
-    end
-  end
-end

data/spec/bashcov/runner_spec.rb

@@ -1,98 +0,0 @@
-require "spec_helper"
-require "benchmark"
-
-describe Bashcov::Runner do
-  let(:runner) { Bashcov::Runner.new "bash #{test_suite}" }
-
-  before :all do
-    Dir.chdir File.dirname(test_suite)
-  end
-
-  describe "#run" do
-    it "finds commands in $PATH" do
-      expect(Bashcov::Runner.new("ls -l").run).to be_success
-    end
-
-    it "is fast", speed: :slow do
-      ratio = 0
-
-      3.times do |iteration|
-        t0 = Benchmark.realtime do
-          pid = Process.spawn test_suite, out: "/dev/null", err: "/dev/null"
-          Process.wait pid
-        end
-        expect($?).to be_success
-
-        run = nil
-        t1 = Benchmark.realtime { run = Bashcov::Runner.new(test_suite).run }
-        expect(run).to be_success
-
-        ratio = (ratio * iteration + t1 / t0) / (iteration + 1)
-      end
-
-      puts "#{ratio} times longer with Bashcov"
-      # XXX no proper assertion - just outputs the ratio
-    end
-
-    context "without a SHELLOPTS variable" do
-      before do
-        ENV["SHELLOPTS"] = nil
-      end
-
-      it "adds the flags" do
-        runner.run
-        expect(ENV["SHELLOPTS"]).to eq("xtrace")
-      end
-    end
-
-    context "with an existing SHELLOPTS variable" do
-      before do
-        ENV["SHELLOPTS"] = "posix"
-      end
-
-      it "merges the flags" do
-        runner.run
-        expect(ENV["SHELLOPTS"]).to eq("posix:xtrace")
-      end
-    end
-  end
-
-  describe "#result" do
-    it "returns the expected coverage hash" do
-      runner.run
-      expect(runner.result).to eq expected_coverage
-    end
-
-    it "returns the correct coverage hash" do
-      runner.run
-
-      pending # TODO: need a context-aware lexer to parse multiline instructions
-      expect(runner.result).to eq correct_coverage
-    end
-
-    context "with options.skip_uncovered = true" do
-      before do
-        Bashcov.options.skip_uncovered = true
-      end
-
-      it "does not include uncovered files" do
-        runner.run
-        expect(runner.result.keys & uncovered_files).to be_empty
-      end
-    end
-
-    context "with options.mute = true" do
-      before do
-        Bashcov.options.mute = true
-      end
-
-      it "does not print the command output" do
-        [$stdout, $stderr].each do |io|
-          expect(io).not_to receive :write
-        end
-
-        runner.run
-      end
-    end
-  end
-end