slather 2.6.0 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeaf99ed5212bdc90e8098dfde877452af7f074ecfd41fc577d46f90b1ee65eb
-  data.tar.gz: 5dbd0db5223f26990c2bfd3ab02f4ed36a15d8088a0b5c393f522a785a0176cd
+  metadata.gz: 6791a42172a6764126080d1fa51acce74d384c68687e3bb657bd0311e54cac0a
+  data.tar.gz: 11b47fcf1ff99baa4ea01cbe9fd202a0db9f3f9e7ad76c5b8b79b23516128cd0
 SHA512:
-  metadata.gz: 6802b4ef28cfb856bf68d214416d6a455de715723327dc7167600bc9cae705dacbdbffb0b8d154b2027dde6d5b2f6baec719f69a81e5293a437da1e260461e73
-  data.tar.gz: c6b95c762eaa1d5260da5de5910e7f429a79e45556a3b32568ba8c7c9f3ed173ed514330793c39babc767e4f021dda7fc83971750d16407d0149050286495b95
+  metadata.gz: 07bfabe0e5af2083b8aba45676989ea8d90b7e26ba276a17a64e93e184be42229e1e869b990623c0a8fa4df0306748b4e0c6b68821c90d5b18dc88109dc52ae1
+  data.tar.gz: bc8b62cc1b47b59d67f8acff77a9b2910c4b82273035257470ded7376e3ca4930146aa3105d3c8bb910c12acbb5cf36a35909d825ef4e85b593ce65a7cba99e5

data/.travis.yml

@@ -2,6 +2,8 @@ language: objective-c
 script: bundle exec rake
 osx_image: xcode12.2
 
+cache: bundler
+
 before_install:
   - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
   - gem install bundler -v "~> 2.0" --no-document

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 # CHANGELOG
 
+## v2.7.2
+
+* Update xcodeproj version
+  [adamyanalunas](https://github.com/adamyanalunas)
+  [#502](https://github.com/SlatherOrg/slather/pull/502)
+
+* Update nokogiri version
+  [jwelton](https://github.com/jwelton)
+  [#503](https://github.com/SlatherOrg/slather/pull/503)
+
+* Support alternate CI systems in coveralls output
+  [fermoyadrop](https://github.com/fermoyadrop)
+  [#504](https://github.com/SlatherOrg/slather/pull/504)
+
+* Add Bitrise support to coveralls output
+  [fermoyadrop](https://github.com/fermoyadrop)
+  [#504](https://github.com/SlatherOrg/slather/pull/505)
+
+## v2.7.1
+
+* Support generating coverage for framework targets
+  [onato](https://github.com/onato)
+  [#482](https://github.com/SlatherOrg/slather/pull/482)
+
+* Show number of lines in HTML report
+  [SiemianHS](https://github.com/SiemianHS)
+  [#494](https://github.com/SlatherOrg/slather/pull/494)
+
+* Fixed issues with HTML report generation
+  [fchiba](https://github.com/fchiba)
+  [#483](https://github.com/SlatherOrg/slather/pull/483)
+  [#484](https://github.com/SlatherOrg/slather/pull/484)
+
+* Don't fail if a source file doesn't exist
+  [chillpop](https://github.com/chillpop)
+  [#492](https://github.com/SlatherOrg/slather/pull/492)
+
+## 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
+  [ashin-omg](https://github.com/ashin-omg)
+  [#473](https://github.com/SlatherOrg/slather/pull/473)
+
 ## v2.6.0
 
 * Added GitHub actions support

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/coveralls.rb

@@ -41,6 +41,16 @@ module Slather
       end
       private :github_job_id
 
+      def bitrise_job_id
+        ENV['BITRISE_BUILD_NUMBER']
+      end
+      private :bitrise_job_id
+
+      def bitrise_pull_request
+        ENV['BITRISE_PULL_REQUEST']
+      end
+      private :bitrise_pull_request
+
       def github_pull_request
         ENV['CI_PULL_REQUEST'] || ""
       end
@@ -71,6 +81,11 @@ module Slather
       end
       private :github_branch_name
 
+      def bitrise_branch_name
+        ENV['BITRISE_GIT_BRANCH'] || `git ls-remote --heads origin | grep $(git rev-parse HEAD) | cut -d / -f 3-`.chomp
+      end
+      private :bitrise_branch_name
+
       def buildkite_job_id
         ENV['BUILDKITE_BUILD_NUMBER']
       end
@@ -151,6 +166,19 @@ module Slather
       end
       private :github_git_info
 
+      def bitrise_git_info
+        {
+          :head => {
+            :id => ENV['BITRISE_GIT_COMMIT'],
+            :committer_name => (ENV['GIT_CLONE_COMMIT_AUTHOR_NAME'] || `git log --format=%an -n 1 HEAD`.chomp || ""),
+            :committer_email => (ENV['GIT_CLONE_COMMIT_AUTHOR_EMAIL'] || `git log --format=%ae -n 1 HEAD`.chomp || ""),
+            :message => (ENV['BITRISE_GIT_MESSAGE'] || `git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => bitrise_branch_name
+        }
+      end
+      private :bitrise_git_info
+
       def github_build_url
         "https://github.com/" + ENV['GITHUB_REPOSITORY'] + "/actions/runs/" + ENV['GITHUB_RUN_ID']
       end
@@ -263,8 +291,35 @@ module Slather
           else
             raise StandardError, "Environment variable `GITHUB_RUN_ID` not set.  Is this running on github build?"
           end
+        elsif ci_service == :bitrise
+          {
+            :service_job_id => bitrise_job_id,
+            :service_name => 'bitrise',
+            :repo_token => coverage_access_token,
+            :source_files => coverage_files.map(&:as_json),
+            :service_pull_request => bitrise_pull_request,
+            :service_branch => bitrise_branch_name,
+            :git => bitrise_git_info
+          }.to_json
         else
-          raise StandardError, "No support for ci named #{ci_service}"
+          {
+            :service_job_id => ENV['CI_BUILD_NUMBER'],
+            :service_name => ENV['CI_NAME'] || ci_service,
+            :repo_token => coverage_access_token,
+            :source_files => coverage_files.map(&:as_json),
+            :service_build_url => ENV['CI_BUILD_URL'],
+            :service_pull_request => ENV['CI_PULL_REQUEST'],
+            :service_branch => ENV['CI_BRANCH'],
+            :git => {
+              :head => {
+                :id => ENV['CI_COMMIT'],
+                :committer_name => (`git log --format=%an -n 1 HEAD`.chomp || ""),
+                :committer_email => (`git log --format=%ae -n 1 HEAD`.chomp || ""),
+                :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+              },
+              :branch => ENV['CI_BRANCH']
+            }
+          }.to_json
         end
       end
       private :coveralls_coverage_data

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|
@@ -82,6 +87,22 @@ module Slather
             percentage = (total_tested_lines / total_relevant_lines.to_f) * 100.0
             cov.span "Total Coverage : "
             cov.span decimal_f(percentage) + '%', :class => class_for_coverage_percentage(percentage), :id => "total_coverage"
+            cov.span " ("
+            cov.span total_tested_lines, :id => "total_tested_lines"
+            cov.span " of "
+            cov.span total_relevant_lines, :id => "total_relevant_lines"
+            cov.span " lines)"
+          }
+
+          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.span " ("
+            cov.span total_branches_tested, :id => "total_branches_tested"
+            cov.span " of "
+            cov.span total_relevant_branches, :id => "total_relevant_branches"
+            cov.span " lines)"
           }
 
           cov.input(:class => "search", :placeholder => "Search")
@@ -133,6 +154,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 +164,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 +182,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 +197,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, 2)
+                            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] << [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,12 @@ 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 = file["filename"]
+          path = Pathname(filename)
+          # Don't crash if the file doesn't exist on disk.
+          # This may happen for autogenerated files that have been deleted.
+          filename = path.exist? ? path.realpath : filename
+          {"filename" => filename, "segments" => file["segments"]}
         end)
       end
     end
@@ -162,13 +167,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 +293,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
 
@@ -356,7 +375,7 @@ module Slather
     end
 
     def configure_ci_service
-      self.ci_service ||= (self.class.yml["ci_service"] || :travis_ci)
+      self.ci_service ||= (ENV["CI_SERVICE"] || self.class.yml["ci_service"] || :other)
     end
 
     def configure_input_format
@@ -568,6 +587,19 @@ module Slather
     def find_buildable_names(xcscheme)
       found_buildable_names = []
 
+      # enumerate code coverage targets
+      begin
+        code_coverage_targets = xcscheme.test_action.xml_element.elements['CodeCoverageTargets']
+        targets = code_coverage_targets.map do |node|
+          Xcodeproj::XCScheme::BuildableReference.new(node) if node.is_a?(REXML::Element)
+        end.compact
+        buildable_names = targets.each do |target|
+          found_buildable_names.push(target.buildable_name)
+        end
+      rescue
+        # just in case if there are no entries in the test action
+      end
+
       # enumerate build action entries
       begin
         xcscheme.build_action.entries.each do |entry|

data/lib/slather/version.rb

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

data/slather.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'equivalent-xml', '~> 0.6'
 
   spec.add_dependency 'clamp', '~> 1.3'
-  spec.add_dependency 'xcodeproj', '~> 1.7'
-  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'xcodeproj', '~> 1.21'
+  spec.add_dependency 'nokogiri', '~> 1.12'
   spec.add_dependency 'CFPropertyList', '>= 2.2', '< 4'
 
   spec.add_runtime_dependency 'activesupport'

data/spec/fixtures/FixtureFramework/FixtureFramework.h

@@ -0,0 +1,19 @@
+//
+//  FixtureFramework.h
+//  FixtureFramework
+//
+//  Created by Stephen Williams on 11/03/21.
+//  Copyright © 2021 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+//! Project version number for FixtureFramework.
+FOUNDATION_EXPORT double FixtureFrameworkVersionNumber;
+
+//! Project version string for FixtureFramework.
+FOUNDATION_EXPORT const unsigned char FixtureFrameworkVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <FixtureFramework/PublicHeader.h>
+
+

data/spec/fixtures/FixtureFramework/FlashExperiment.swift

@@ -0,0 +1,7 @@
+import Foundation
+
+public struct FlashExperiment {
+    public let isAwesome = true
+    
+    public init() {}
+}

data/spec/fixtures/FixtureFramework/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSHumanReadableCopyright</key>
+	<string>Copyright © 2021 marklarr. All rights reserved.</string>
+</dict>
+</plist>

data/spec/fixtures/FixtureFrameworkTests/FixtureFrameworkTests.swift

@@ -0,0 +1,34 @@
+//
+//  FixtureFrameworkTests.swift
+//  FixtureFrameworkTests
+//
+//  Created by Stephen Williams on 11/03/21.
+//  Copyright © 2021 marklarr. All rights reserved.
+//
+
+import XCTest
+@testable import FixtureFramework
+
+class FixtureFrameworkTests: XCTestCase {
+
+    override func setUpWithError() throws {
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+
+    override func tearDownWithError() throws {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+    }
+
+    func testExample() throws {
+        // This is an example of a functional test case.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+    }
+
+    func testPerformanceExample() throws {
+        // This is an example of a performance test case.
+        self.measure {
+            // Put the code you want to measure the time of here.
+        }
+    }
+
+}

data/spec/fixtures/FixtureFrameworkTests/FlashExperimentTests.swift

@@ -0,0 +1,9 @@
+import XCTest
+import FixtureFramework
+
+class FlashExperimentTests: XCTestCase {
+    func testExample() throws {
+        let sut = FlashExperiment()
+        XCTAssertTrue(sut.isAwesome, "Your flash experiment isn't awesome!")
+    }
+}

data/spec/fixtures/FixtureFrameworkTests/Info.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>