slather 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65797ce8dfbfe5637c983ce35e07296cf3948e054b84db165536643e6fa7bd2f
-  data.tar.gz: 77ee9800d1f2845739563b06932037409499b07c9d7524a1e15e8c709453aeda
+  metadata.gz: d6388d4f62571f927f845978e5383f2508b98e7e3ba0205aaf546b5a54d465f5
+  data.tar.gz: 837f82512416a6f57cb9c4510dcc7bd9524a4aeeaa05f42bdd841f18cf4fa1d9
 SHA512:
-  metadata.gz: 9e14157b010048c0d03876f2aed5107821e2c533ddc0b48e1eaa8cc5e177c7346b23d92c0fa6c4b0393c63c921036f8e65f2574374aa6c655bf4c1ff79dffe2b
-  data.tar.gz: 51d9746ef872aa49cf26ad6b03e78d61d6a4e99a87551f54f99bee6714ce4401002fe83ccf609a86233f50560b4e181ee8412fb122bf59f026a184a3289a75d3
+  metadata.gz: 2b1af2387a7475860aeb3666883c5fd8d2e2b9be020680452140e71fa5bbb3ff057eb3b23b0ddb1c02d6fd55478aafceda18f5527ed2bd086b49d0d89a06e75b
+  data.tar.gz: 0b464fbffa5722ed27fa157e429427387889e9e5c641ed2d2d2663a90ccc6f815163e19687a21fac2078dbb6c9c8c8baf9745ff1b55266e38f220aed6258c66f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v2.7.0
+
+* Add Branch Coverage data for ProfData coverage files
+  [hborawski](https://github.com/hborawski)
+  [#477](https://github.com/SlatherOrg/slather/pull/477)
+
+* Fixed 'Argument list too long' when running 'xcrun llvm-cov'
+  [samuelsainz](https://github.com/samuelsainz)
+  [#476](https://github.com/SlatherOrg/slather/pull/476)
+
 ## v2.6.1
 
 * Update nokogiri to 1.11

data/assets/slather.css

@@ -74,6 +74,7 @@ table.source_code {
 table.source_code td {
   padding-bottom: 0.3em;
 }
+code.missed { background-color: rgba(255, 73, 76, 0.3); }
 table.source_code tr.missed td { background-color: rgba(248, 103, 105, 0.2); }
 table.source_code tr.covered td { background-color: rgba(103, 207, 124, 0.2); }
 table.source_code td.num {
@@ -124,7 +125,7 @@ footer p, footer a {
 Syntax Highlighting using highlight.js (https://highlightjs.org)
 ------------------------------------------------------------- */
 .hljs {
-  display: block;
+  display: inline-block;
   overflow-x: auto;
   -webkit-text-size-adjust: none;
 }

data/lib/slather/coverage_service/html_output.rb

@@ -70,9 +70,14 @@ module Slather
 
         total_relevant_lines = 0
         total_tested_lines = 0
+        total_relevant_branches = 0
+        total_branches_tested = 0
         coverage_files.each { |coverage_file|
           total_tested_lines += coverage_file.num_lines_tested
           total_relevant_lines += coverage_file.num_lines_testable
+
+          total_relevant_branches += coverage_file.num_branches_testable
+          total_branches_tested += coverage_file.num_branches_tested
         }
 
         builder = Nokogiri::HTML::Builder.with(template.at('#reports')) { |cov|
@@ -84,6 +89,12 @@ module Slather
             cov.span decimal_f(percentage) + '%', :class => class_for_coverage_percentage(percentage), :id => "total_coverage"
           }
 
+          cov.h4 {
+            percentage = (total_branches_tested / total_relevant_branches.to_f) * 100.0
+            cov.span "Total Branch Coverage : "
+            cov.span decimal_f(percentage) + '%', :class => class_for_coverage_percentage(percentage), :id => "total_coverage"
+          }
+
           cov.input(:class => "search", :placeholder => "Search")
 
           cov.table(:class => "coverage_list", :cellspacing => 0,  :cellpadding => 0) {
@@ -133,6 +144,7 @@ module Slather
         filepath = coverage_file.source_file_pathname_relative_to_repo_root
         filename = File.basename(filepath)
         percentage = coverage_file.percentage_lines_tested
+        branch_percentage = coverage_file.rate_branches_tested * 100
 
         cleaned_gcov_lines = coverage_file.cleaned_gcov_data.split("\n")
         is_file_empty = (cleaned_gcov_lines.count <= 0)
@@ -142,7 +154,10 @@ module Slather
         builder = Nokogiri::HTML::Builder.with(template.at('#reports')) { |cov|
           cov.h2(:class => "cov_title") {
             cov.span("Coverage for \"#{filename}\"" + (!is_file_empty ? " : " : ""))
+            cov.span("Lines: ") unless is_file_empty
             cov.span("#{decimal_f(percentage)}%", :class => class_for_coverage_percentage(percentage)) unless is_file_empty
+            cov.span(" Branches: ") unless is_file_empty
+            cov.span("#{decimal_f(branch_percentage)}%", :class => class_for_coverage_percentage(branch_percentage)) unless is_file_empty
           }
 
           cov.h4("(#{coverage_file.num_lines_tested} of #{coverage_file.num_lines_testable} relevant lines covered)", :class => "cov_subtitle")
@@ -157,8 +172,9 @@ module Slather
 
           cov.table(:class => "source_code") {
             cleaned_gcov_lines.each do |line|
-
               line_number = coverage_file.line_number_in_line(line)
+              missed_regions = coverage_file.branch_region_data[line_number]
+              hits = coverage_file.coverage_for_line(line)
               next unless line_number > 0
 
               line_source = line.split(line_number_separator, 3)[2]
@@ -171,7 +187,30 @@ module Slather
                     cov.td(line, :class => classes[idx])
                   else
                     cov.td(:class => classes[idx]) {
-                      cov.pre { cov.code(line, :class => "objc") }
+                      cov.pre {
+                        # If the line has coverage and missed regions, split up
+                        # the line to show regions that weren't covered
+                        if missed_regions != nil && hits != nil && hits > 0
+                          regions = missed_regions.map do |region|
+                            region_start, region_length = region
+                            if region_length != nil
+                              line[region_start, region_length]
+                            else
+                              line[region_start, line.length - region_start]
+                            end
+                          end
+                          current_line = line
+                          regions.each do |region|
+                            covered, remainder = current_line.split(region)
+                            cov.code(covered, :class => "objc")
+                            cov.code(region, :class => "objc missed")
+                            current_line = remainder
+                          end
+                          cov.code(current_line, :class => "objc")
+                        else
+                          cov.code(line, :class => "objc")
+                        end
+                      }
                     }
                   end
                 }

data/lib/slather/profdata_coverage_file.rb

@@ -8,7 +8,7 @@ module Slather
     include CoverageInfo
     include CoverallsCoverage
 
-    attr_accessor :project, :source, :line_numbers_first, :line_data
+    attr_accessor :project, :source, :segments, :line_numbers_first, :line_data
 
     def initialize(project, source, line_numbers_first)
       self.project = project
@@ -188,7 +188,47 @@ module Slather
 
     def branch_coverage_data
       @branch_coverage_data ||= begin
-        Hash.new
+        branch_coverage_data = Hash.new
+
+        self.segments.each do |segment|
+          line, col, hits, has_count, *rest = segment
+          next if !has_count
+          if branch_coverage_data.key?(line)
+            branch_coverage_data[line] = branch_coverage_data[line] + [hits]
+          else
+            branch_coverage_data[line] = [hits]
+          end
+        end
+
+        branch_coverage_data
+      end
+    end
+
+    def branch_region_data
+      @branch_region_data ||= begin
+        branch_region_data = Hash.new
+        region_start = nil
+        current_line = 0
+        @segments ||= []
+        @segments.each do |segment|
+          line, col, hits, has_count, *rest = segment
+          # Make column 0 based index
+          col = col - 1
+          if hits == 0 && has_count
+            current_line = line
+            region_start = col
+          elsif region_start != nil && hits > 0 && has_count
+            # if the region wrapped to a new line before ending, put nil to indicate it didnt end on this line
+            region_end = line == current_line ? col - region_start : nil
+            if branch_region_data.key?(current_line)
+              branch_region_data[current_line] = branch_region_data[current_line] + [region_start, region_end]
+            else
+              branch_region_data[current_line] = [[region_start, region_end]]
+            end
+            region_start = nil
+          end
+        end
+        branch_region_data
       end
     end
 

data/lib/slather/project.rb

@@ -135,7 +135,7 @@ module Slather
       coverage_json = JSON.parse(coverage_json_string)
       coverage_json["data"].reduce([]) do |result, chunk|
         result.concat(chunk["files"].map do |file|
-          Pathname(file["filename"]).realpath
+          {"filename" => Pathname(file["filename"]).realpath, "segments" => file["segments"]}
         end)
       end
     end
@@ -162,13 +162,24 @@ module Slather
     end
     private :create_coverage_files_for_binary
 
-    def create_coverage_files(binary_path, pathnames)
+    def create_coverage_files(binary_path, path_objects)
       line_numbers_first = Gem::Version.new(self.llvm_version) >= Gem::Version.new('8.1.0')
+      # get just file names from the path objects
+      pathnames = path_objects.map { |path_obj| path_obj["filename"] }.compact
+      # Map of path name => segment array
+      paths_to_segments = path_objects.reduce(Hash.new) do |hash, path_obj|
+        hash[path_obj["filename"]] = path_obj["segments"]
+        hash
+      end
       files = create_profdata(binary_path, pathnames)
       files.map do |source|
         coverage_file = coverage_file_class.new(self, source, line_numbers_first)
         # If a single source file is used, the resulting output does not contain the file name.
         coverage_file.source_file_pathname = pathnames.first if pathnames.count == 1
+        # if there is segment data for the given path, add it to the coverage_file
+        if paths_to_segments.key?(coverage_file.source_file_pathname)
+          coverage_file.segments = paths_to_segments[coverage_file.source_file_pathname]
+        end
         !coverage_file.ignored? ? coverage_file : nil
       end.compact
     end
@@ -277,7 +288,10 @@ module Slather
       if self.arch
         llvm_cov_args << "--arch" << self.arch
       end
-      `xcrun llvm-cov #{llvm_cov_args.shelljoin} #{source_files.shelljoin}`
+
+      # POSIX systems have an ARG_MAX for the maximum total length of the command line, so the command may fail with an error message of "Argument list too long".
+      # Using the xargs command we can break the list of source_files into sublists small enough to be acceptable.
+      `printf '%s\\0' #{source_files.shelljoin} | xargs -0 xcrun llvm-cov #{llvm_cov_args.shelljoin}`
     end
     private :unsafe_profdata_llvm_cov_output
 

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = '2.6.1' unless defined?(Slather::VERSION)
+  VERSION = '2.7.0' unless defined?(Slather::VERSION)
 end

data/spec/slather/coverage_service/html_output_spec.rb

@@ -185,8 +185,8 @@ describe Slather::CoverageService::HtmlOutput do
       end
 
       allow(fixtures_project).to receive(:input_format).and_return("profdata")
-      allow(fixtures_project).to receive(:profdata_llvm_cov_output).and_return("./spec/fixtures/fixtures/other_fixtures.m:
-    1|     |//
+      allow(fixtures_project).to receive(:pathnames_per_binary).and_return([{"filename" => Pathname.new("./spec/fixtures/fixtures/other_fixtures.m"), "segments" => []}])
+      allow(fixtures_project).to receive(:profdata_llvm_cov_output).and_return("1|     |//
     2|     |//  other_fixtures.m
     3|     |//  fixtures
     4|     |//

data/spec/slather/profdata_coverage_spec.rb

@@ -157,6 +157,18 @@ describe Slather::ProfdataCoverageFile do
     end
   end
 
+  describe "#branch_coverage_data" do
+    it "should have branch data for line 19" do
+      # these segments correspond to the only statement on line 19
+      profdata_coverage_file.segments = [[19, 9, 0, true, false], [19, 20, 1, true, false]]
+      expect(profdata_coverage_file.branch_coverage_data[19]).to eq([0,1])
+    end
+    it "should have missing region data for line 19" do
+      profdata_coverage_file.segments = [[19, 9, 0, true, false], [19, 20, 1, true, false]]
+      expect(profdata_coverage_file.branch_region_data[19]).to eq([[8,11]])
+    end
+  end
+
   describe "#ignored" do
 
     before(:each) {

data/spec/slather/project_spec.rb

@@ -664,10 +664,12 @@ describe Slather::Project do
               {
                  "files":[
                     {
-                       "filename":"spec/fixtures/fixtures/fixtures.m"
+                       "filename":"spec/fixtures/fixtures/fixtures.m",
+                       "segments": []
                     },
                     {
-                       "filename":"spec/fixtures/fixturesTwo/fixturesTwo.m"
+                       "filename":"spec/fixtures/fixturesTwo/fixturesTwo.m",
+                       "segments": []
                     }
                  ]
               }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Mark Larsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler