bashcov 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0747d5303e019390aac25da832f145d0fe434ca0990ce68b11124423f6cf1f7
-  data.tar.gz: daed283089aa39da826552a98178c59916e215e30552113ebf094103388cae5b
+  metadata.gz: e79dc939af127bef6f99cd953e085033f167a5221e332a133951e476f9b63f6e
+  data.tar.gz: 0aaf4dfc8062e7a14efa1b7ccfd1f2dc8ac7e86b53f79c31500019cfae3ab97d
 SHA512:
-  metadata.gz: 8e04f898757e9fd035eac7f5da81e5de7a93a2d492f3039a6c97c2b88610fcce1f86af7c3ddc734ae941f6cfcebe05361dfe442826f7dcf792d0d6cb9a88b542
-  data.tar.gz: 9446b060debec76ebb08765cb7c16b8c16bb1d17b50d85da3543631ab2c5c9c32671033bdfd9bd811cda0d735c454a2a2e803f30ad812aebb7ea253e7e8cc2d2
+  metadata.gz: f04d9cf50ddd7a95843676be55deb850201dea08ac7ef33bc6e7adfc17befe7e8ef14cc79a7899a2e529e058beea1930895344dfba915f6c3b8063f0faca5d49
+  data.tar.gz: 43ff857b123ca2c5fa85bb03dc707ea4a52c0601bfc3eab1fc94863136298a12614315b2b369569c74071e97ab88525599780bbaa344a862d43a0b285c0da004

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v4.0.1...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v4.0.2...master))
 
   * TBD
 
+## v4.0.2, 2026-11-04 ([changes](https://github.com/infertux/bashcov/compare/v4.0.1...v4.0.2))
+
+  * [BUGFIX]  Keep xtrace writes blocking so coverage records are not dropped (fixes #113)
+  * [BUGFIX]  Skip malformed xtrace records instead of aborting coverage (fixes #112)
+
 ## v4.0.1, 2026-10-26 ([changes](https://github.com/infertux/bashcov/compare/v4.0.0...v4.0.1))
 
   * [BUGFIX]  Fix coverage of multiline strings on Bash < 5.3 (fixes #108)

data/Gemfile.nix.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bashcov (4.0.1)
+    bashcov (4.0.2)
       simplecov (~> 1.1)
 
 GEM

data/flake.nix

@@ -206,7 +206,7 @@
               pname = "bashcov";
               gemdir = self;
               lockfile = ./Gemfile.nix.lock;
-              version = "4.0.1";
+              version = "4.0.2";
               postBuild = ''
                 for gem in $out/${ruby.gemPath}/bundler/gems/*; do
                   ln -sfrT "$gem" $out/${ruby.gemPath}/gems/"''${gem##*/}"

data/gemset.nix

@@ -38,7 +38,7 @@
       path = ./.;
       type = "path";
     };
-    version = "4.0.1";
+    version = "4.0.2";
   };
   benchmark = {
     groups = ["development"];

data/lib/bashcov/field_stream.rb

@@ -29,17 +29,19 @@ module Bashcov
     # @param [Regexp]      start_match a +Regexp+ that, when matched against the
     #   input stream, signifies the beginning of the next series of fields to
     #   yield
-    # @yieldparam [String] field each field extracted from the stream. If
-    #   +start_match+ is matched with fewer than +field_count+ fields yielded
-    #   since the last match, yields empty strings until +field_count+ is
-    #   reached.
+    # @yieldparam [String] field each field extracted from the stream. Exactly
+    #   +field_count+ fields are yielded for each +start_match+ match: if fewer
+    #   fields follow the match, yields empty strings until +field_count+ is
+    #   reached; if more follow (e.g. a traced command that contains the
+    #   delimiter), the extra fields are dropped so the next series of fields
+    #   stays aligned.
     def each(delimiter, field_count, start_match, &block)
       return enum_for(__method__, delimiter, field_count, start_match) unless block_given?
 
       chunked = each_field(delimiter).chunk(&chunk_matches(start_match))
 
       yield_fields = lambda do |(_, chunk)|
-        chunk.each(&block)
+        chunk.first(field_count).each(&block)
         (field_count - chunk.size).times { yield "" }
       end
 

data/lib/bashcov/runner.rb

@@ -57,25 +57,16 @@ module Bashcov
       with_xtrace_flag do
         command_pid = Process.spawn env, *@command, options # spawn the command
 
-        begin
-          # start processing the xtrace output
-          xtrace_thread = Thread.new { @xtrace.read }
+        # start processing the xtrace output
+        xtrace_thread = Thread.new { @xtrace.read }
 
-          Process.wait command_pid
+        Process.wait command_pid
 
-          @xtrace.close
+        @xtrace.close
 
-          @coverage = xtrace_thread.value # wait for the thread to return
-        rescue XtraceError => e
-          write_warning <<-WARNING
-            encountered an error parsing Bash's output (error was:
-            #{e.message}). This can occur if your script or its path contains
-            the sequence #{Xtrace.delimiter.inspect}, or if your script unsets
-            LINENO. Aborting early; coverage report will be incomplete.
-          WARNING
+        @coverage = xtrace_thread.value # wait for the thread to return
 
-          @coverage = e.files
-        end
+        warn_skipped_records
       end
 
       temp_file&.unlink
@@ -97,6 +88,19 @@ module Bashcov
 
   private
 
+    def warn_skipped_records
+      return if @xtrace.skipped_count.zero?
+
+      write_warning <<-WARNING
+        skipped #{@xtrace.skipped_count} malformed line(s) in Bash's output
+        (first error was: #{@xtrace.first_skip_reason}). This can occur if your
+        script prints its own PS4 (e.g. with `declare -p` or `set`), if your
+        script or its path contains the sequence #{Xtrace.delimiter.inspect},
+        or if your script unsets LINENO. Coverage of the affected lines may be
+        incomplete.
+      WARNING
+    end
+
     def write_warning(message)
       warn [
         Bashcov.program_name,

data/lib/bashcov/version.rb

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

data/lib/bashcov/xtrace.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "io/nonblock"
 require "pathname"
 require "securerandom"
 
@@ -57,6 +58,8 @@ module Bashcov
       @field_stream = field_stream
 
       @read, @write = IO.pipe
+      # Keep Bash's xtrace writes blocking so records are not dropped when the pipe fills.
+      @write.nonblock = false
 
       # Tracks coverage for each file under test
       @files ||= {}
@@ -64,22 +67,35 @@ module Bashcov
       # Stacks for updating working directory changes
       @pwd_stack ||= []
       @oldpwd_stack ||= []
+
+      @skipped_count = 0
     end
 
+    # [Integer] Number of malformed +PS4+ records skipped by {#read}
+    attr_reader :skipped_count
+
+    # [String, nil] Why the first malformed +PS4+ record was skipped
+    attr_reader :first_skip_reason
+
     # @return [Fixnum] File descriptor of the write end of the pipe
     def file_descriptor
       @write.fileno
     end
 
-    # Closes the pipe for writing.
+    # Closes the parent's write end after the command exits, also ending any
+    # error-recovery drain without waiting for inherited background writers.
     # @return [void]
     def close
       @write.close
+      @read.close if @draining
     end
 
     # Read fields extracted from Bash's debugging output
     # @return [Hash<Pathname, Array<Integer, nil>>] A hash mapping Bash scripts
     #   to Simplecov-style coverage stats
+    # @raise [StandardError] any error while parsing, raised only after
+    #   draining until the command exits or the pipe reaches EOF. Malformed
+    #   records are skipped (see {#skipped_count}) rather than raised.
     def read
       @field_stream.read = @read
 
@@ -96,36 +112,44 @@ module Bashcov
         parse_hit!(*hit)
       end
 
-      @read.close unless @read.closed?
-
       @files
+    rescue StandardError
+      # Keep draining so Bash's blocking xtrace writes cannot fill the pipe and
+      # hang the run, or hit a closed pipe and die of SIGPIPE. #close ends the
+      # drain once the command exits, so background writers are not waited on.
+      @draining = true
+      begin
+        nil while !@write.closed? && @read.read(65_536)
+      rescue IOError
+        raise unless @write.closed? # Only ignore closure after the command exits.
+      end
+      raise
+    ensure
+      @read.close unless @read.closed?
     end
 
   private
 
     # Parses the expanded {ps4} fields and updates the coverage-tracking
-    # {@files} hash
+    # {@files} hash. A record whose +LINENO+ is not composed solely of digits
+    # is skipped: it is usually text that merely looks like the start of a
+    # {ps4}, such as the output of +declare -p+ or +set+ being traced, and
+    # {FieldStream#each} resynchronizes on the next start of a {ps4}.
     # @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, add +@files+ to the exception in
-      # order to propagate the existing coverage data back to the
-      # {Bashcov::Runner} instance
       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,
-        )
+        skip_record!("expected integer for LINENO, got #{lineno.inspect}")
+        return
       end
 
       bash_source, pwd, oldpwd = paths.map { |p| Pathname.new(p) }
@@ -143,6 +167,14 @@ module Bashcov
       @files[script][index] += 1
     end
 
+    # Records that a malformed record was skipped
+    # @param [String] reason why the record was skipped
+    # @return [void]
+    def skip_record!(reason)
+      @skipped_count += 1
+      @first_skip_reason = reason if @skipped_count == 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Cédric Félizard
@@ -268,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.22
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Code coverage tool for Bash
 test_files: []