slather 2.4.6 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87dc3cb198a7c6f4a3e02ab8f0494e8c65d47cc7dfcf5a6a8c683d3f2d7b6630
-  data.tar.gz: 16ead0627576c7b079f9f29ed54521a8726db794f396d5ee109ea8046c11d212
+  metadata.gz: eeaf99ed5212bdc90e8098dfde877452af7f074ecfd41fc577d46f90b1ee65eb
+  data.tar.gz: 5dbd0db5223f26990c2bfd3ab02f4ed36a15d8088a0b5c393f522a785a0176cd
 SHA512:
-  metadata.gz: b306cecaf97dece04f3c2ad147cc75dae2c2b17f5264bde4582c3815e3d310728d57ed97ecea7c0e3ab25c4d89798e328c3daf169d225e18c370aca04bed524a
-  data.tar.gz: '03703182714e4ae4bdfbf46e5c2e7fc5c1d1b24416cff13e88be6ff569d3fc3c009e28027f5d6f6163dce0f0079ce87a389adcebe1939b057b431015d1b354c7'
+  metadata.gz: 6802b4ef28cfb856bf68d214416d6a455de715723327dc7167600bc9cae705dacbdbffb0b8d154b2027dde6d5b2f6baec719f69a81e5293a437da1e260461e73
+  data.tar.gz: c6b95c762eaa1d5260da5de5910e7f429a79e45556a3b32568ba8c7c9f3ed173ed514330793c39babc767e4f021dda7fc83971750d16407d0149050286495b95

data/.gitignore

@@ -46,4 +46,8 @@ html
 *.gcno
 
 # JetBrains IDE
-.idea/
+.idea/
+
+# Test output
+report.llcov
+report.json

data/.travis.yml

@@ -1,10 +1,10 @@
 language: objective-c
 script: bundle exec rake
-osx_image: xcode9.2
+osx_image: xcode12.2
 
 before_install:
   - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
-  - gem install bundler --no-ri --no-rdoc
+  - gem install bundler -v "~> 2.0" --no-document
 
 install:
   - bundle install --without=documentation

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # CHANGELOG
 
+## 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
+  [adellibovi](https://github.com/adellibovi)
+  [#456](https://github.com/SlatherOrg/slather/pull/456)
+
+## v2.4.8
+
+* Optimize performance for many binaries
+  [cltnschlosser](https://github.com/cltnschlosser)
+  [#455](https://github.com/SlatherOrg/slather/pull/455)
+
+* Don't generate line 0 in profdata_coverage_file.rb from line with error
+  [tthbalazs](https://github.com/tthbalazs)
+  [#449](https://github.com/SlatherOrg/slather/pull/449)
+
+* coveralls dependency update
+  [GRiMe2D](https://github.com/GRiMe2D)
+  [#448](https://github.com/SlatherOrg/slather/pull/448)
+
+## v2.4.7
+
+* Update dependencies
+  [dnedrow](https://github.com/dnedrow)
+
+* Fixed errors when llvm-cov argument length exceeds ARG_MAX
+  [weibel](https://github.com/weibel)
+  [#414](https://github.com/SlatherOrg/slather/pull/414)
+
+* Show "No coverage directory found." instead of "implicit conversion nil into String"
+  [phimage](https://github.com/phimage)
+  [#381](https://github.com/SlatherOrg/slather/pull/381) [#341](https://github.com/SlatherOrg/slather/issues/341)
+
 ## v2.4.6
 
 * Fix .dSYM and .swiftmodule files filtering in find_binary_files()

data/README.md

@@ -67,6 +67,20 @@ If your configuration produces a universal binary you need to specify a specific
 $ slather coverage -s --arch x86_64 --scheme YourXcodeSchemeName --configuration YourBuildConfigurationName path/to/project.xcodeproj
 ```
 
+### For multiple modules
+
+If you want to run some modules, but not all (like modules created by CocoaPods) you can do it like this:
+
+```sh
+$ slather coverage --binary-basename module1 --binary-basename module2 path/to/project.xcodeproj
+```
+You can also add it to the `.slather.yml` file as an array:
+```yml
+binary_basename:
+  - module1
+  - module2
+```
+
 ### Setup for Xcode 5 and 6
 
 Run this command to enable the `Generate Test Coverage` and `Instrument Program Flow` flags for your project:
@@ -135,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
@@ -154,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`:
@@ -251,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/lib/slather.rb

@@ -12,6 +12,7 @@ require 'slather/coverage_service/simple_output'
 require 'slather/coverage_service/html_output'
 require 'slather/coverage_service/json_output'
 require 'slather/coverage_service/llvm_cov_output'
+require 'slather/coverage_service/sonarqube_xml_output'
 require 'cfpropertylist'
 
 module Slather

data/lib/slather/command/coverage_command.rb

@@ -8,11 +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 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"
@@ -90,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
 
@@ -124,6 +128,8 @@ class CoverageCommand < Clamp::Command
       project.show_html = show?
     elsif json?
       project.coverage_service = :json
+    elsif sonarqube_xml?
+      project.coverage_service = :sonarqube_xml
     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/sonarqube_xml_output.rb

@@ -0,0 +1,61 @@
+require 'nokogiri'
+require 'date'
+
+module Slather
+  module CoverageService
+    module SonarqubeXmlOutput
+
+      def coverage_file_class
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
+      end
+      private :coverage_file_class
+
+      def post
+        cobertura_xml_report = create_xml_report(coverage_files)
+        store_report(cobertura_xml_report)
+      end
+
+      def store_report(report)
+        output_file = 'sonarqube-generic-coverage.xml'
+        if output_directory
+          FileUtils.mkdir_p(output_directory)
+          output_file = File.join(output_directory, output_file)
+        end
+        File.write(output_file, report.to_s)
+      end
+
+      def create_xml_report(coverage_files)
+        create_empty_xml_report
+        coverage_node = @doc.root
+        coverage_node['version'] = "1"
+
+        coverage_files.each do |coverage_file|
+          file_node = Nokogiri::XML::Node.new "file", @doc
+          file_node.parent = coverage_node
+          file_node['path'] = coverage_file.source_file_pathname_relative_to_repo_root.to_s
+          coverage_file.all_lines.each do |line|
+            if coverage_file.coverage_for_line(line)
+              line_node = Nokogiri::XML::Node.new "lineToCover", @doc
+              line_node['lineNumber'] = coverage_file.line_number_in_line(line)
+              line_node['covered'] = coverage_file.coverage_for_line(line) == 0 ? "false" : "true"
+              line_node.parent = file_node
+            end
+          end
+        end
+        @doc.to_xml
+      end
+
+      def create_empty_xml_report
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.coverage
+        end
+        @doc = builder.doc
+      end
+
+    end
+  end
+end

data/lib/slather/profdata_coverage_file.rb

@@ -18,7 +18,6 @@ module Slather
     end
 
     def create_line_data
-      all_lines = source_code_lines
       line_data = Hash.new
       all_lines.each { |line| line_data[line_number_in_line(line, self.line_numbers_first)] = line }
       self.line_data = line_data
@@ -26,14 +25,20 @@ module Slather
     private :create_line_data
 
     def path_on_first_line?
-      path = self.source.split("\n")[0].sub ":", ""
-      !path.lstrip.start_with?("1|")
+      !source.lstrip.start_with?("1|")
     end
 
     def source_file_pathname
       @source_file_pathname ||= begin
         if path_on_first_line?
-          path = self.source.split("\n")[0].sub ":", ""
+          end_index = self.source.index(/:?\n/)
+          if end_index != nil
+            end_index -= 1
+            path = self.source[0..end_index]
+          else
+            # Empty file, output just contains path
+            path = self.source.sub ":", ""
+          end
           path &&= Pathname(path)
         else
           # llvm-cov was run with just one matching source file
@@ -64,7 +69,16 @@ module Slather
     end
 
     def source_code_lines
-      self.source.split("\n")[(path_on_first_line? ? 1 : 0)..-1]
+      lines = self.source.split("\n")[(path_on_first_line? ? 1 : 0)..-1]
+      ignore_error_lines(lines)
+    end
+
+    def ignore_error_lines(lines, line_numbers_first = self.line_numbers_first)
+      if line_numbers_first
+        lines.reject { |line| line.lstrip.start_with?('|', '--') }
+      else
+        lines
+      end
     end
 
     def source_data
@@ -72,10 +86,7 @@ module Slather
     end
 
     def all_lines
-      if @all_lines == nil
-        @all_lines = source_code_lines
-      end
-      @all_lines
+      @all_lines ||= source_code_lines
     end
 
     def raw_source
@@ -94,6 +105,9 @@ module Slather
 
     def line_number_in_line(line, line_numbers_first = self.line_numbers_first)
       if line_numbers_first
+        # Skip regex if the number is the first thing in the line
+        fastpath_number = line.to_i
+        return fastpath_number if fastpath_number != 0
         line =~ /^(\s*)(\d*)/
         group = $2
       else
@@ -123,7 +137,7 @@ module Slather
     end
 
     def line_coverage_data
-      source_code_lines.map do |line|
+      all_lines.map do |line|
         coverage_for_line(line, self.line_numbers_first)
       end
     end