bashcov 1.8.1 → 3.0.0

data/lib/bashcov/field_stream.rb

@@ -23,7 +23,7 @@ module Bashcov
       end
     end
 
-    # Yields fields extracted from a input stream
+    # Yields fields extracted from an input stream
     # @param [String, nil] delimiter   the field separator
     # @param [Integer]     field_count the number of fields to extract
     # @param [Regexp]      start_match a +Regexp+ that, when matched against the
@@ -33,39 +33,51 @@ module Bashcov
     #   +start_match+ is matched with fewer than +field_count+ fields yielded
     #   since the last match, yields empty strings until +field_count+ is
     #   reached.
-    def each(delimiter, field_count, start_match)
+    def each(delimiter, field_count, start_match, &block)
       return enum_for(__method__, delimiter, field_count, start_match) unless block_given?
 
-      # The number of fields processed since passing the last start-of-fields
-      # match
-      seen_fields = 0
+      chunked = each_field(delimiter).chunk(&chunk_matches(start_match))
 
-      fields = each_field(delimiter)
+      yield_fields = lambda do |(_, chunk)|
+        chunk.each(&block)
+        (field_count - chunk.size).times { yield "" }
+      end
+
+      # Skip junk that might appear before the first start-of-fields match
+      begin
+        n, chunk = chunked.next
+        yield_fields.call([n, chunk]) unless n.zero?
+      rescue StopIteration
+        return
+      end
 
-      # Close over +field_count+ and +seen_fields+ to yield empty strings to
-      # the caller when we've already hit the next start-of-fields match
-      yield_remaining = -> { (field_count - seen_fields).times { yield "" } }
+      chunked.each(&yield_fields)
+    end
 
-      # Advance until the first start-of-fields match
-      loop { break if fields.next =~ start_match }
+  private
 
-      fields.each do |field|
-        # If the current field is the start-of-fields match...
-        if field =~ start_match
-          # Fill out any remaining (unparseable) fields with empty strings
-          yield_remaining.call
+    # @param [Regexp] start_match a +Regexp+ that, when matched against the
+    #   input stream, signifies the beginning of the next series of fields to
+    #   yield
+    # @return [Proc] a unary +Proc+ that returns +nil+ if the argument mathes
+    #   the +start_match+ +Regexp+, and otherwise returns the number of
+    #   start-of-fields signifiers so far encountered.
+    # @example
+    #   chunker = chunk_matches /<=>/
+    #   chunked = %w[foo fighters <=> bar none <=> baz luhrmann].chunk(&chunker)
+    #   chunked.to_a
+    #     #=> [[0, ["foo", "fighters"]], [1, ["bar", "none"]], [2, ["baz", "luhrmann"]]]
+    def chunk_matches(start_match)
+      i = 0
 
-          seen_fields = 0
-        elsif seen_fields < field_count
-          yield field
-          seen_fields += 1
+      lambda do |e|
+        if e.match?(start_match)
+          i += 1
+          nil
+        else
+          i
         end
       end
-
-      # One last filling-out of empty fields if we're at the end of the stream
-      yield_remaining.call
-
-      read.close unless read.closed?
     end
   end
 end

data/lib/bashcov/lexer.rb

@@ -27,8 +27,8 @@ module Bashcov
 
     # Process and complete initial coverage.
     # @return [void]
-    def complete_coverage # rubocop:disable Metrics/MethodLength
-      lines = IO.read(@filename).encode("utf-8", invalid: :replace).lines
+    def complete_coverage
+      lines = File.read(@filename).encode("utf-8", invalid: :replace).lines
 
       lines.each_with_index do |line, lineno|
         # multi-line arrays
@@ -41,7 +41,7 @@ module Bashcov
         # heredoc
         mark_multiline(
           lines, lineno,
-          /\A[^\n]+<<-?'?(\w+)'?\s*$.*\1/m
+          /\A[^\n]+<<-?'?(\w+)'?.*$.*\1/m
         )
 
         # multiline string concatenated with backslashes
@@ -72,7 +72,7 @@ module Bashcov
   private
 
     def mark_multiline(lines, lineno, regexp, forward: true)
-      seek_forward = lines[lineno..-1].join
+      seek_forward = lines[lineno..].join
       return unless (multiline_match = seek_forward.match(regexp))
 
       length = multiline_match.to_s.count($/)
@@ -80,6 +80,9 @@ module Bashcov
       range = (forward ? first.upto(last) : (last - 1).downto(first - 1))
       reference_lineno = (forward ? first - 1 : last)
 
+      # don't seek backward if first line is already covered
+      return if !forward && @coverage[first - 1]
+
       range.each do |sub_lineno|
         # mark related lines with the same coverage as the reference line
         @coverage[sub_lineno] ||= @coverage[reference_lineno]
@@ -92,8 +95,8 @@ module Bashcov
       @coverage[lineno] = Bashcov::Line::UNCOVERED if relevant?(line)
     end
 
-    def relevant?(line) # rubocop:disable Metrics/CyclomaticComplexity
-      line.sub!(/ #.*\Z/, "") # remove comments
+    def relevant?(line)
+      line.sub!(/\s#.*\Z/, "") # remove comments
       line.strip!
 
       relevant = true
@@ -104,7 +107,7 @@ module Bashcov
                            line.end_with?(*IGNORE_END_WITH)
 
       relevant &= false if line =~ /\A\w+\(\)/ # function declared without the `function` keyword
-      relevant &= false if line =~ /\A[^\)]+\)\Z/ # case statement selector, e.g. `--help)`
+      relevant &= false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
 
       relevant
     end

data/lib/bashcov/runner.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "tempfile"
+
+require "simplecov"
+
 require "bashcov/detective"
 require "bashcov/errors"
 require "bashcov/field_stream"
@@ -18,23 +22,40 @@ module Bashcov
     # Runs the command with appropriate xtrace settings.
     # @note Binds Bashcov +stdin+ to the program being executed.
     # @return [Process::Status] Status of the executed command
-    def run # rubocop:disable Metrics/MethodLength
+    def run
       # Clear out previous run
       @result = nil
 
       field_stream = FieldStream.new
       @xtrace = Xtrace.new(field_stream)
-
       fd = @xtrace.file_descriptor
-      env = { "PS4" => Xtrace.ps4 }
+
       options = { in: :in }
+      options[fd] = fd # bind FDs to the child process
 
       if Bashcov.options.mute
         options[:out] = "/dev/null"
         options[:err] = "/dev/null"
       end
 
-      run_xtrace(fd, env, options) do
+      env =
+        if Process.uid.zero?
+          # if running as root, Bash 4.4+ does not inherit $PS4 from the environment
+          # https://github.com/infertux/bashcov/issues/43#issuecomment-450605839
+          write_warning "running as root is NOT recommended, Bashcov may not work properly."
+
+          temp_file = Tempfile.new("bashcov_bash_env")
+          temp_file.write("export PS4='#{Xtrace.ps4}'\n")
+          temp_file.close
+
+          { "BASH_ENV" => temp_file.path }
+        else
+          { "PS4" => Xtrace.ps4 }
+        end
+
+      env["BASH_XTRACEFD"] = fd.to_s
+
+      with_xtrace_flag do
         command_pid = Process.spawn env, *@command, options # spawn the command
 
         begin
@@ -58,6 +79,8 @@ module Bashcov
         end
       end
 
+      temp_file&.unlink
+
       $?
     end
 
@@ -83,39 +106,13 @@ module Bashcov
       ].join
     end
 
-    def run_xtrace(fd, env, options)
-      # Older versions of Bash (< 4.1) don't have the BASH_XTRACEFD variable
-      if Bashcov.bash_xtracefd?
-        options[fd] = fd # bind FDs to the child process
-
-        env["BASH_XTRACEFD"] = fd.to_s
-      else
-        # Send subprocess standard error to @xtrace.file_descriptor
-        options[:err] = fd
-
-        # Don't bother issuing warning if we're silencing output anyway
-        unless Bashcov.mute
-          write_warning <<-WARNING
-            you are using a version of Bash that does not support
-            BASH_XTRACEFD. All xtrace output will print to standard error, and
-            your script's output on standard error will not be printed to the
-            console.
-          WARNING
-        end
-      end
-
-      with_xtrace_flag do
-        yield
-      end
-    end
-
     # @note +SHELLOPTS+ must be exported so we use Ruby's {ENV} variable
     # @yield [void] adds "xtrace" to +SHELLOPTS+ and then runs the provided
     #   block
     # @return [Object, ...] the value returned by the calling block
     def with_xtrace_flag
-      existing_flags_s = ENV["SHELLOPTS"]
-      existing_flags = (existing_flags_s || "").split(":")
+      existing_flags_s = ENV.fetch("SHELLOPTS", "")
+      existing_flags = existing_flags_s.split(":")
       ENV["SHELLOPTS"] = (existing_flags | ["xtrace"]).join(":")
 
       yield
@@ -126,25 +123,49 @@ module Bashcov
     # Add files which have not been executed at all (i.e. with no coverage)
     # @return [void]
     def find_bash_files!
-      return if Bashcov.skip_uncovered
+      filtered_files.each do |filename|
+        @coverage[filename] = [] if !@coverage.include?(filename) && @detective.shellscript?(filename)
+      end
+    end
 
-      Pathname.new(Bashcov.root_directory).find do |filename|
-        if !@coverage.include?(filename) && @detective.shellscript?(filename)
-          @coverage[filename] = []
-        end
+    # @return [Array<Pathname>] the list of files that should be included in
+    #   coverage results, unless filtered by one or more SimpleCov filters
+    def tracked_files
+      return @tracked_files if defined? @tracked_files
+
+      mandatory = SimpleCov.tracked_files ? Pathname.glob(SimpleCov.tracked_files) : []
+      under_root = Bashcov.skip_uncovered ? [] : Pathname.new(Bashcov.root_directory).find.to_a
+
+      @tracked_files = (mandatory + under_root).uniq
+    end
+
+    # @return [Array<Pathname>] the list of files that should be included in
+    #   coverage results
+    def filtered_files
+      return @filtered_files if defined? @filtered_files
+
+      source_files = tracked_files.map do |file|
+        SimpleCov::SourceFile.new(file.to_s, @coverage.fetch(file, []))
+      end
+
+      source_file_to_tracked_file = source_files.zip(tracked_files).to_h
+
+      @filtered_files = SimpleCov.filtered(source_files).map do |source_file|
+        source_file_to_tracked_file[source_file]
       end
     end
 
     # @return [void]
     def expunge_invalid_files!
       @coverage.each_key do |filename|
-        next if filename.file?
+        if !filename.file?
+          @coverage.delete filename
+          write_warning "#{filename} was executed but has been deleted since then - it won't be reported in coverage."
 
-        @coverage.delete filename
-        write_warning <<-WARNING
-          #{filename} was executed but has been deleted since then - it won't
-          be reported in coverage.
-        WARNING
+        elsif !@detective.shellscript?(filename)
+          @coverage.delete filename
+          write_warning "#{filename} was partially executed but has invalid Bash syntax - it won't be reported in coverage."
+        end
       end
     end
 
@@ -158,7 +179,7 @@ module Bashcov
     end
 
     def convert_coverage
-      Hash[@coverage.map { |filename, coverage| [filename.to_s, coverage] }]
+      @coverage.transform_keys(&:to_s)
     end
   end
 end

data/lib/bashcov/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Bashcov
   # Current Bashcov version
-  VERSION = "1.8.1"
+  VERSION = "3.0.0"
 end

data/lib/bashcov/xtrace.rb

@@ -24,11 +24,10 @@ module Bashcov
     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+.
+      # [String] A randomly-generated UUID used for delimiting the fields of
+      # the +PS4+.
       def delimiter
-        @delimiter ||= Bashcov.truncated_ps4? ? "\x1E" : SecureRandom.uuid
+        @delimiter ||= SecureRandom.uuid
       end
 
       # @return [String] +PS4+ variable used for xtrace output. Expands to
@@ -93,9 +92,12 @@ module Bashcov
       # 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
 
+      @read.close unless @read.closed?
+
       @files
     end
 
@@ -115,8 +117,11 @@ module Bashcov
       # 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.
-      if lineno =~ /\A\d+\z/
+      if /\A\d+\z/.match?(lineno)
         lineno = lineno.to_i
+      elsif lineno == "${LINENO-}"
+        # the variable doesn't expand on line misses so we can safely ignore it
+        return
       else
         raise XtraceError.new(
           "expected integer for LINENO, got #{lineno.inspect}", @files

data/lib/bashcov.rb

@@ -3,15 +3,12 @@
 require "optparse"
 require "pathname"
 
-require "bashcov/bash_info"
 require "bashcov/runner"
 require "bashcov/version"
 
 # Bashcov default module
 # @note Keep it short!
 module Bashcov
-  extend Bashcov::BashInfo
-
   # A +Struct+ to store Bashcov configuration
   Options = Struct.new(
     *%i[skip_uncovered mute bash_path root_directory command command_name]
@@ -55,8 +52,9 @@ module Bashcov
         VERSION,
         "with Bash #{BASH_VERSION},",
         "Ruby #{RUBY_VERSION},",
-        "and SimpleCov #{SimpleCov::VERSION}.",
-      ].join(" ")
+        "and SimpleCov #{SimpleCov::VERSION}",
+        (Process.uid.zero? ? " as root user (NOT recommended)" : nil),
+      ].compact.join(" ")
     end
 
     # @return [String] The value to use as +SimpleCov.command_name+. Uses the
@@ -65,17 +63,35 @@ module Bashcov
     #   representation of {Bashcov#command}.
     def command_name
       return @options.command_name if @options.command_name
-      return ENV["BASHCOV_COMMAND_NAME"] unless ENV.fetch("BASHCOV_COMMAND_NAME", "").empty?
+      return ENV.fetch("BASHCOV_COMMAND_NAME", nil) unless ENV.fetch("BASHCOV_COMMAND_NAME", "").empty?
+
       command.compact.join(" ")
     end
 
+    def bash_path
+      # First attempt to use the value from `options`, but ignore all exceptions.
+      # This is used early for the `BASH_VERSION` definition, so first use will likely error.
+      begin
+        return @options.bash_path if @options.bash_path
+      rescue NoMethodError; end # rubocop:disable Lint/SuppressedException
+
+      # Support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests.
+      return ENV.fetch("BASHCOV_BASH_PATH", nil) unless ENV.fetch("BASHCOV_BASH_PATH", "").empty?
+
+      # Fall back to standard Bash location.
+      "/bin/bash"
+    end
+
+    def bash_version
+      `#{bash_path} -c 'echo -n ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}'`
+    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
 
@@ -103,8 +119,8 @@ module Bashcov
       HELP
     end
 
-    def option_parser # rubocop:disable Metrics/MethodLength
-      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+    def option_parser
+      OptionParser.new do |opts|
         opts.program_name = program_name
         opts.version = Bashcov::VERSION
         opts.banner = help
@@ -119,10 +135,17 @@ module Bashcov
         end
         opts.on("--bash-path PATH", "Path to Bash executable") do |p|
           raise Errno::ENOENT, p unless File.file? p
+
           options.bash_path = p
+
+          # Redefine `BASH_VERSION` constant with upated `bash_path`.
+          # This is hacky, but a lot of code references that constant and this should only have to be done once.
+          send(:remove_const, "BASH_VERSION")
+          const_set("BASH_VERSION", bash_version.freeze)
         end
         opts.on("--root PATH", "Project root directory") do |d|
           raise Errno::ENOENT, d unless File.directory? d
+
           options.root_directory = d
         end
         opts.on("--command-name NAME", "Value to use as SimpleCov.command_name") do |c|
@@ -143,5 +166,5 @@ module Bashcov
   end
 
   # Current Bash version (e.g. 4.2)
-  BASH_VERSION = `#{bash_path} -c 'echo -n ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}'`.freeze
+  BASH_VERSION = bash_version.freeze
 end

data/test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -euo pipefail
+
+jobs=$(grep -o '^[a-z].*:$' .gitlab-ci.yml | tr -d ':' | grep -Ev '^(before_script)$')
+
+for job in $jobs; do
+    echo "Running ${job}..."
+    gitlab-runner exec docker "$job"
+done

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Cédric Félizard
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.21.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mutant-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -139,11 +153,17 @@ dependencies:
 description: Code coverage tool for Bash
 email:
 - cedric@felizard.fr
-executables:
-- bashcov
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".build.yml"
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -151,10 +171,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TESTING.md
+- USAGE.md
 - bashcov.gemspec
 - bin/bashcov
 - lib/bashcov.rb
-- lib/bashcov/bash_info.rb
 - lib/bashcov/detective.rb
 - lib/bashcov/errors.rb
 - lib/bashcov/field_stream.rb
@@ -163,11 +184,16 @@ files:
 - lib/bashcov/runner.rb
 - lib/bashcov/version.rb
 - lib/bashcov/xtrace.rb
+- test.sh
 homepage: https://github.com/infertux/bashcov
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/infertux/bashcov
+  source_code_uri: https://github.com/infertux/bashcov
+  changelog_uri: https://github.com/infertux/bashcov/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,16 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: Code coverage tool for Bash
+summary: ''
 test_files: []

data/lib/bashcov/bash_info.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Bashcov
-  # Module exposing information concerning the installed Bash version
-  # @note methods do not cache results because +bash_path+ can change at
-  #   runtime
-  # @note receiver is expected to implement +bash_path+
-  module BashInfo
-    # @return [Boolean] Whether Bash supports +BASH_XTRACEFD+
-    def bash_xtracefd?
-      BASH_VERSION >= "4.1"
-    end
-
-    # @param [Integer] length the number of bytes to test; default 128
-    # @return [Boolean] whether Bash supports a +PS4+ of at least a given
-    #   number of bytes
-    # @see https://tiswww.case.edu/php/chet/bash/CHANGES
-    # @note Item +i.+ under the +bash-4.2-release+ to +bash-4.3-alpha+ change
-    #   list notes that version 4.2 truncates +PS4+ if it is greater than 128
-    #   bytes.
-    def truncated_ps4?(length = 128)
-      ps4 = SecureRandom.base64(length)
-      !`PS4=#{ps4} #{bash_path} 2>&1 1>&- -xc 'echo hello'`.start_with?(ps4)
-    end
-  end
-end