simplecov 0.6.0 → 0.22.0

data/lib/simplecov/result_merger.rb

@@ -1,80 +1,194 @@
-require 'multi_json'
-
-#
-# Singleton that is responsible for caching, loading and merging
-# SimpleCov::Results into a single result for coverage analysis based
-# upon multiple test suites.
-#
-module SimpleCov::ResultMerger
-  class << self
-    # The path to the resultset.yml cache file
-    def resultset_path
-      File.join(SimpleCov.coverage_path, '.resultset.json')
-    end
+# frozen_string_literal: true
+
+require "json"
+
+module SimpleCov
+  #
+  # Singleton that is responsible for caching, loading and merging
+  # SimpleCov::Results into a single result for coverage analysis based
+  # upon multiple test suites.
+  #
+  module ResultMerger
+    class << self
+      # The path to the .resultset.json cache file
+      def resultset_path
+        File.join(SimpleCov.coverage_path, ".resultset.json")
+      end
+
+      def resultset_writelock
+        File.join(SimpleCov.coverage_path, ".resultset.json.lock")
+      end
+
+      def merge_and_store(*file_paths, ignore_timeout: false)
+        result = merge_results(*file_paths, ignore_timeout: ignore_timeout)
+        store_result(result) if result
+        result
+      end
+
+      def merge_results(*file_paths, ignore_timeout: false)
+        # It is intentional here that files are only read in and parsed one at a time.
+        #
+        # In big CI setups you might deal with 100s of CI jobs and each one producing Megabytes
+        # of data. Reading them all in easily produces Gigabytes of memory consumption which
+        # we want to avoid.
+        #
+        # For similar reasons a SimpleCov::Result is only created in the end as that'd create
+        # even more data especially when it also reads in all source files.
+        initial_memo = valid_results(file_paths.shift, ignore_timeout: ignore_timeout)
+
+        command_names, coverage = file_paths.reduce(initial_memo) do |memo, file_path|
+          merge_coverage(memo, valid_results(file_path, ignore_timeout: ignore_timeout))
+        end
+
+        create_result(command_names, coverage)
+      end
+
+      def valid_results(file_path, ignore_timeout: false)
+        results = parse_file(file_path)
+        merge_valid_results(results, ignore_timeout: ignore_timeout)
+      end
 
-    # Loads the cached resultset from YAML and returns it as a Hash
-    def resultset
-      if stored_data
-        MultiJson.decode(stored_data)
-      else
+      def parse_file(path)
+        data = read_file(path)
+        parse_json(data)
+      end
+
+      def read_file(path)
+        return unless File.exist?(path)
+
+        data = File.read(path)
+        return if data.nil? || data.length < 2
+
+        data
+      end
+
+      def parse_json(content)
+        return {} unless content
+
+        JSON.parse(content) || {}
+      rescue StandardError
+        warn "[SimpleCov]: Warning! Parsing JSON content of resultset file failed"
         {}
       end
-    end
 
-    # Returns the contents of the resultset cache as a string or if the file is missing or empty nil
-    def stored_data
-      if File.exist?(resultset_path) and stored_data = File.read(resultset_path) and stored_data.length >= 2
-        stored_data
-      else
-        nil
+      def merge_valid_results(results, ignore_timeout: false)
+        results = results.select { |_command_name, data| within_merge_timeout?(data) } unless ignore_timeout
+
+        command_plus_coverage = results.map do |command_name, data|
+          [[command_name], adapt_result(data.fetch("coverage"))]
+        end
+
+        # one file itself _might_ include multiple test runs
+        merge_coverage(*command_plus_coverage)
+      end
+
+      def within_merge_timeout?(data)
+        time_since_result_creation(data) < SimpleCov.merge_timeout
       end
-    end
 
-    # Gets the resultset hash and re-creates all included instances
-    # of SimpleCov::Result from that.
-    # All results that are above the SimpleCov.merge_timeout will be
-    # dropped. Returns an array of SimpleCov::Result items.
-    def results
-      results = []
-      resultset.each do |command_name, data|
-        result = SimpleCov::Result.from_hash(command_name => data)
-        # Only add result if the timeout is above the configured threshold
-        if (Time.now - result.created_at) < SimpleCov.merge_timeout
-          results << result
+      def time_since_result_creation(data)
+        Time.now - Time.at(data.fetch("timestamp"))
+      end
+
+      def create_result(command_names, coverage)
+        return nil unless coverage
+
+        command_name = command_names.reject(&:empty?).sort.join(", ")
+        SimpleCov::Result.new(coverage, command_name: command_name)
+      end
+
+      def merge_coverage(*results)
+        return [[""], nil] if results.empty?
+        return results.first if results.size == 1
+
+        results.reduce do |(memo_command, memo_coverage), (command, coverage)|
+          # timestamp is dropped here, which is intentional (we merge it, it gets a new time stamp as of now)
+          merged_coverage = Combine.combine(Combine::ResultsCombiner, memo_coverage, coverage)
+          merged_command = memo_command + command
+
+          [merged_command, merged_coverage]
         end
       end
-      results
-    end
 
-    #
-    # Gets all SimpleCov::Results from cache, merges them and produces a new
-    # SimpleCov::Result with merged coverage data and the command_name
-    # for the result consisting of a join on all source result's names
-    #
-    def merged_result
-      merged = {}
-      results.each do |result|
-        merged = result.original_result.merge_resultset(merged)
-      end
-      result = SimpleCov::Result.new(merged)
-      # Specify the command name
-      result.command_name = results.map(&:command_name).sort.join(", ")
-      result
-    end
+      #
+      # Gets all SimpleCov::Results stored in resultset, merges them and produces a new
+      # SimpleCov::Result with merged coverage data and the command_name
+      # for the result consisting of a join on all source result's names
+      def merged_result
+        # conceptually this is just doing `merge_results(resultset_path)`
+        # it's more involved to make syre `synchronize_resultset` is only used around reading
+        resultset_hash = read_resultset
+        command_names, coverage = merge_valid_results(resultset_hash)
+
+        create_result(command_names, coverage)
+      end
+
+      def read_resultset
+        resultset_content =
+          synchronize_resultset do
+            read_file(resultset_path)
+          end
+
+        parse_json(resultset_content)
+      end
 
-    # Saves the given SimpleCov::Result in the resultset cache
-    def store_result(result)
-      new_set = resultset
-      command_name, data = result.to_hash.first
-      new_set[command_name] = data
-      File.open(resultset_path, "w+") do |f|
-        if defined? ::JSON
-          f.puts JSON.pretty_generate(new_set)
+      # Saves the given SimpleCov::Result in the resultset cache
+      def store_result(result)
+        synchronize_resultset do
+          # Ensure we have the latest, in case it was already cached
+          new_resultset = read_resultset
+
+          # A single result only ever has one command_name, see `SimpleCov::Result#to_hash`
+          command_name, data = result.to_hash.first
+          new_resultset[command_name] = data
+          File.open(resultset_path, "w+") do |f_|
+            f_.puts JSON.pretty_generate(new_resultset)
+          end
+        end
+        true
+      end
+
+      # Ensure only one process is reading or writing the resultset at any
+      # given time
+      def synchronize_resultset
+        # make it reentrant
+        return yield if defined?(@resultset_locked) && @resultset_locked
+
+        begin
+          @resultset_locked = true
+          File.open(resultset_writelock, "w+") do |f|
+            f.flock(File::LOCK_EX)
+            yield
+          end
+        ensure
+          @resultset_locked = false
+        end
+      end
+
+      # We changed the format of the raw result data in simplecov, as people are likely
+      # to have "old" resultsets lying around (but not too old so that they're still
+      # considered we can adapt them).
+      # See https://github.com/simplecov-ruby/simplecov/pull/824#issuecomment-576049747
+      def adapt_result(result)
+        if pre_simplecov_0_18_result?(result)
+          adapt_pre_simplecov_0_18_result(result)
         else
-          f.puts MultiJson.encode(new_set)
+          result
+        end
+      end
+
+      # pre 0.18 coverage data pointed from file directly to an array of line coverage
+      def pre_simplecov_0_18_result?(result)
+        _key, data = result.first
+
+        data.is_a?(Array)
+      end
+
+      def adapt_pre_simplecov_0_18_result(result)
+        result.transform_values do |line_coverage_data|
+          {"lines" => line_coverage_data}
         end
       end
-      true
     end
   end
 end

data/lib/simplecov/simulate_coverage.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  #
+  # Responsible for producing file coverage metrics.
+  #
+  module SimulateCoverage
+  module_function
+
+    #
+    # Simulate normal file coverage report on
+    # ruby 2.5 and return similar hash with lines and branches keys
+    #
+    # Happens when a file wasn't required but still tracked.
+    #
+    # @return [Hash]
+    #
+    def call(absolute_path)
+      lines = File.foreach(absolute_path)
+
+      {
+        "lines" => LinesClassifier.new.classify(lines),
+        # we don't want to parse branches ourselves...
+        # requiring files can have side effects and we don't want to trigger that
+        "branches" => {}
+      }
+    end
+  end
+end

data/lib/simplecov/source_file/branch.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    #
+    # Representing single branch that has been detected in coverage report.
+    # Give us support methods that handle needed calculations.
+    class Branch
+      attr_reader :start_line, :end_line, :coverage, :type
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(start_line:, end_line:, coverage:, inline:, type:)
+        @start_line = start_line
+        @end_line   = end_line
+        @coverage   = coverage
+        @inline     = inline
+        @type       = type
+        @skipped    = false
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def inline?
+        @inline
+      end
+
+      #
+      # Return true if there is relevant count defined > 0
+      #
+      # @return [Boolean]
+      #
+      def covered?
+        !skipped? && coverage.positive?
+      end
+
+      #
+      # Check if branche missed or not
+      #
+      # @return [Boolean]
+      #
+      def missed?
+        !skipped? && coverage.zero?
+      end
+
+      # The line on which we want to report the coverage
+      #
+      # Usually we choose the line above the start of the branch (so that it shows up
+      # at if/else) because that
+      # * highlights the condition
+      # * makes it distinguishable if the first line of the branch is an inline branch
+      #   (see the nested_branches fixture)
+      #
+      def report_line
+        if inline?
+          start_line
+        else
+          start_line - 1
+        end
+      end
+
+      # Flags the branch as skipped
+      def skipped!
+        @skipped = true
+      end
+
+      # Returns true if the branch was marked skipped by virtue of nocov comments.
+      def skipped?
+        @skipped
+      end
+
+      def overlaps_with?(line_range)
+        start_line <= line_range.end && end_line >= line_range.begin
+      end
+
+      #
+      # Return array with coverage count and badge
+      #
+      # @return [Array]
+      #
+      def report
+        [type, coverage]
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/line.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    # Representation of a single line in a source file including
+    # this specific line's source code, line_number and code coverage,
+    # with the coverage being either nil (coverage not applicable, e.g. comment
+    # line), 0 (line not covered) or >1 (the amount of times the line was
+    # executed)
+    class Line
+      # The source code for this line. Aliased as :source
+      attr_reader :src
+      # The line number in the source file. Aliased as :line, :number
+      attr_reader :line_number
+      # The coverage data for this line: either nil (never), 0 (missed) or >=1 (times covered)
+      attr_reader :coverage
+      # Whether this line was skipped
+      attr_reader :skipped
+
+      # Lets grab some fancy aliases, shall we?
+      alias source src
+      alias line line_number
+      alias number line_number
+
+      def initialize(src, line_number, coverage)
+        raise ArgumentError, "Only String accepted for source" unless src.is_a?(String)
+        raise ArgumentError, "Only Integer accepted for line_number" unless line_number.is_a?(Integer)
+        raise ArgumentError, "Only Integer and nil accepted for coverage" unless coverage.is_a?(Integer) || coverage.nil?
+
+        @src         = src
+        @line_number = line_number
+        @coverage    = coverage
+        @skipped     = false
+      end
+
+      # Returns true if this is a line that should have been covered, but was not
+      def missed?
+        !never? && !skipped? && coverage.zero?
+      end
+
+      # Returns true if this is a line that has been covered
+      def covered?
+        !never? && !skipped? && coverage.positive?
+      end
+
+      # Returns true if this line is not relevant for coverage
+      def never?
+        !skipped? && coverage.nil?
+      end
+
+      # Flags this line as skipped
+      def skipped!
+        @skipped = true
+      end
+
+      # Returns true if this line was skipped, false otherwise. Lines are skipped if they are wrapped with
+      # # :nocov: comment lines.
+      def skipped?
+        skipped
+      end
+
+      # The status of this line - either covered, missed, skipped or never. Useful i.e. for direct use
+      # as a css class in report generation
+      def status
+        return "skipped" if skipped?
+        return "never" if never?
+        return "missed" if missed?
+        return "covered" if covered?
+      end
+    end
+  end
+end