slather 2.4.9 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e8bb7fa0d1346a2a81a47272a1f55d2625a8457d8c4b88a82f2b737792aa39a
-  data.tar.gz: a375044a21453e30695adf31c20f5a9ea885091d1eb3ac6fafc3f3ef9d44d752
+  metadata.gz: 82acbc5ecfb8610c49f39cdea2ff67387d30b3c41bf78c34095a59c7b572e802
+  data.tar.gz: a1c830dddd4d52d8641665086ad6a63c294f00a7dd3370c7cd588c8c586db06e
 SHA512:
-  metadata.gz: 9a9dddfd5dcf8160cd31327f170030f3520c2a885b7c56f6f2d7d470e5442b8c49c3f30ba289664767cc43d597415c2309654699a5ac2fd59db90ac5bc796697
-  data.tar.gz: 5f67d766eb09e18df9a2bf1016f49a3a7a7f912be2bf5e05ed31c925540fb51ccaef34e53f1dffaed6aadfef827a3e69aa1c7144fa30a024f9f72a1ce2d47605
+  metadata.gz: 239d29e6e221b6119be23af3dc92a7f28d4608dd71acf3f7ed03530953878ab42942903ed3f505a81051c3aa6903ba2a167b37867274b24ab7fc948b9006f08c
+  data.tar.gz: c918c164b1da93699be34bef38291b3c43d3d43eb1d258919dc3de0bd84beb855a44318a8d6638d567543ddad7a2e647ca07a1fe12d14678b9c54bbde25a749a

data/.travis.yml

@@ -1,10 +1,12 @@
 language: objective-c
 script: bundle exec rake
-osx_image: xcode9.2
+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 "~> 1.0" --no-ri --no-rdoc
+  - gem install bundler -v "~> 2.0" --no-document
 
 install:
   - bundle install --without=documentation

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # CHANGELOG
 
+## 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
+  [martin-key](https://github.com/martin-key), [troyfontaine](https://github.com/troyfontaine)
+  [#468](https://github.com/SlatherOrg/slather/pull/468)
+
+## v2.5.0
+
+* Fixed activesupport and cocoapods dependencies
+  [daneov](https://github.com/daneov)
+  [#456](https://github.com/SlatherOrg/slather/pull/467)
+
+* Fixed typo in documentation
+  [descorp](https://github.com/descorp)
+  [#456](https://github.com/SlatherOrg/slather/pull/463)
+
 ## v2.4.9
 
 * Added support for Sonarqube output

data/README.md

@@ -149,7 +149,7 @@ ignore:
   - ProjectTestsGroup/*
 ```
 
-And then in your `.travis.yml` or `circle.yml`, call `slather` after a successful build:
+And then in your `.travis.yml` or `circle.yml` or `github-action.yml`, call `slather` after a successful build:
 
 ```yml
 # .travis.yml
@@ -168,6 +168,25 @@ test:
 
 ```
 
+```yml
+# github-action.yml
+  myjob:
+    steps:
+      - run: |
+          bundle config path vendor/bundle
+          bundle install --without=documentation --jobs 4 --retry 3
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: get_branch
+      - run: bundle exec slather
+        env:
+          GIT_BRANCH: ${{ steps.get_branch.outputs.branch }}
+          CI_PULL_REQUEST: ${{ github.event.number }}
+          COVERAGE_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+```
+
 #### Usage with Travis CI Pro
 
 To use Coveralls with Travis CI Pro (for private repos), add following lines along with other settings to `.slather.yml`:
@@ -265,3 +284,4 @@ Please make sure to follow our general coding style and add test coverage for ne
 * [@jhersh](https://github.com/jhersh), CircleCI support.
 * [@tarbrain](https://github.com/tarbrain), Cobertura support and bugfixing.
 * [@ikhsan](https://github.com/ikhsan), html support.
+* [@martin-key](https://github.com/martin-key) and [@troyfontaine](https://github.com/troyfontaine), 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/command/coverage_command.rb

@@ -8,12 +8,13 @@ class CoverageCommand < Clamp::Command
   option ["--jenkins"], :flag, "Indicate that the builds are running on Jenkins"
   option ["--buildkite"], :flag, "Indicate that the builds are running on Buildkite"
   option ["--teamcity"], :flag, "Indicate that the builds are running on TeamCity"
+  option ["--github"], :flag, "Indicate that the builds are running on Github Actions"
 
   option ["--coveralls", "-c"], :flag, "Post coverage results to coveralls"
   option ["--simple-output", "-s"], :flag, "Output coverage results to the terminal"
   option ["--gutter-json", "-g"], :flag, "Output coverage results as Gutter JSON format"
   option ["--cobertura-xml", "-x"], :flag, "Output coverage results as Cobertura XML format"
-  option ["--sonarqube-xml", "-sq"], :flag, "Output coverage results as Cobertura XML format"
+  option ["--sonarqube-xml", "-sq"], :flag, "Output coverage results as SonarQube XML format"
   option ["--llvm-cov", "-r"], :flag, "Output coverage as llvm-cov format"
   option ["--json"], :flag, "Output coverage results as simple JSON"
   option ["--html"], :flag, "Output coverage results as static html pages"
@@ -91,6 +92,8 @@ class CoverageCommand < Clamp::Command
       project.ci_service = :buildkite
     elsif teamcity?
       project.ci_service = :teamcity
+    elsif github?
+      project.ci_service = :github
     end
   end
 

data/lib/slather/coverage_file.rb

@@ -43,18 +43,23 @@ module Slather
 
     def gcov_data
       @gcov_data ||= begin
-        gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
-        # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
-        gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
+        gcov_data = ""
+
+        Dir.chdir(project.project_dir) do
+          gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
+          # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
+          gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
+
+          gcov_file_name = "./#{source_file_pathname.basename}.gcov"
+          if File.exists?(gcov_file_name)
+            gcov_data = File.new(gcov_file_name).read
+          else
+            gcov_data = ""
+          end
 
-        gcov_file_name = "./#{source_file_pathname.basename}.gcov"
-        if File.exists?(gcov_file_name)
-          gcov_data = File.new(gcov_file_name).read
-        else
-          gcov_data = ""
+          gcov_files_created.each { |file| FileUtils.rm_f(file) }
         end
 
-        gcov_files_created.each { |file| FileUtils.rm_f(file) }
         gcov_data
       end
     end

data/lib/slather/coverage_service/coveralls.rb

@@ -36,6 +36,21 @@ module Slather
       end
       private :jenkins_job_id
 
+      def github_job_id
+        ENV['GITHUB_RUN_ID']
+      end
+      private :github_job_id
+
+      def github_pull_request
+        ENV['CI_PULL_REQUEST'] || ""
+      end
+      private :github_pull_request
+
+      def github_repo_name
+        ENV['GITHUB_REPOSITORY'] || ""
+      end
+      private :github_repo_name
+
       def jenkins_branch_name
         branch_name = ENV['GIT_BRANCH'] || ENV['BRANCH_NAME']
         if branch_name.include? 'origin/'
@@ -51,6 +66,11 @@ module Slather
       end
       private :teamcity_branch_name
 
+      def github_branch_name
+        ENV['GIT_BRANCH'] || `git ls-remote --heads origin | grep $(git rev-parse HEAD) | cut -d / -f 3-`.chomp
+      end
+      private :github_branch_name
+
       def buildkite_job_id
         ENV['BUILDKITE_BUILD_NUMBER']
       end
@@ -119,6 +139,23 @@ module Slather
         "https://buildkite.com/" + ENV['BUILDKITE_PROJECT_SLUG'] + "/builds/" + ENV['BUILDKITE_BUILD_NUMBER'] + "#"
       end
 
+      def github_git_info
+        {
+          :head => {
+            :id => ENV['GITHUB_SHA'],
+            :author_name => ENV['GITHUB_ACTOR'],
+            :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => github_branch_name
+        }
+      end
+      private :github_git_info
+
+      def github_build_url
+        "https://github.com/" + ENV['GITHUB_REPOSITORY'] + "/actions/runs/" + ENV['GITHUB_RUN_ID']
+      end
+      private :github_build_url
+
       def coveralls_coverage_data
         if ci_service == :travis_ci || ci_service == :travis_pro
           if travis_job_id
@@ -206,6 +243,26 @@ module Slather
           else
             raise StandardError, "Environment variable `TC_BUILD_NUMBER` not set. Is this running on a teamcity build?"
           end
+        elsif ci_service == :github
+
+          if coverage_access_token.to_s.strip.length == 0
+            raise StandardError, "Access token is not set. Uploading coverage data for private repositories requires an access token."
+          end
+
+          if github_job_id
+            {
+              :service_job_id => github_job_id,
+              :service_name => "github",
+              :repo_token => coverage_access_token,
+              :repo_name => github_repo_name,
+              :source_files => coverage_files.map(&:as_json),
+              :service_build_url => github_build_url,
+              :service_pull_request => github_pull_request,
+              :git => github_git_info
+            }.to_json
+          else
+            raise StandardError, "Environment variable `GITHUB_RUN_ID` not set.  Is this running on github build?"
+          end
         else
           raise StandardError, "No support for ci named #{ci_service}"
         end

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
 
@@ -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|