slather 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e27d1218948f82525f0b2ed8a6a98204b717fc1
-  data.tar.gz: bbaffb2b00075ab13a568ae40992d1cb09138e0f
+  metadata.gz: 0b3fb54ecb063ddb137572a81d78d071c3abe64c
+  data.tar.gz: 7f18e0dce826e19e5929eff17d02368e5d0b27cc
 SHA512:
-  metadata.gz: 751fde31c23722c6c143ac0a1bd04421dcb9be6ef3074c97209667ac6e6da393b02dae0457ba36b9223f5d785657be191cba67336d9a960861a0089619bcd43c
-  data.tar.gz: 31953c5059db5e6197f6fc61fd2b7b1c6173f6c9a77a7dadd4888cf45cca8c88c7bb460271aa8529655c519bd8b90cba15ab84044d041245ac6a9c28b12d1606
+  metadata.gz: 47ae378522e002970dea520e193b5de1bed30ed69a259cc1ddc492a54b703a796295faba7535c5749dc5323e18a3f583b1674700ca893a3d6082b0cb2f73b1cd
+  data.tar.gz: b87f45afcafb2d8add2baff4b01eaa21e45ed1ae630c017aff8447b6c9703197019e531420e5507a7013acebec6f73059b4e2ab26feb3ad9e92024d9c23a8d15

data/.travis.yml

@@ -1,6 +1,6 @@
 language: objective-c
 script: bundle exec rake
-osx_image: xcode7.3
+osx_image: xcode8.3
 
 # Sets Travis to run the Ruby specs on OS X machines which are required to
 # build the native extensions of Xcodeproj.

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 ## master
 
+## v2.4.0
+
+* Xcode 8.3 support.
+  [ksuther](https://github.com/ksuther)
+  [#291](https://github.com/SlatherOrg/slather/pull/291)
+
+* Automatically ignore headers in Xcode platform SDKs.  
+  [ksuther](https://github.com/ksuther)
+  [#286](https://github.com/SlatherOrg/slather/pull/286)
+
+* Automatically handle schemes with multiple build or test targets  
+  [serges147](https://github.com/serges147)
+  [#275](https://github.com/SlatherOrg/slather/pull/275)
+
+* Added TeamCity as a CI service option  
+  [joshrlesch](https://github.com/joshrlesch)
+  [#279](https://github.com/SlatherOrg/slather/pull/279)
+
+* Handle UTF-8 characters correctly in HTML reports  
+  [0xced](https://github.com/0xced)
+  [#259](https://github.com/SlatherOrg/slather/pull/259)
+
+* Fix hanging `xcodebuild` invocation when getting derived data path.  
+  [arthurtoper](https://github.com/arthurtoper)
+  [#238](https://github.com/SlatherOrg/slather/pull/238), [#197](https://github.com/SlatherOrg/slather/issues/197), [#212](https://github.com/SlatherOrg/slather/issues/212), [#234](https://github.com/SlatherOrg/slather/issues/234)
+
 ## v2.3.0
 
 * Fixes broken fallback value of `input_format` inside `configure_input_format`  

data/README.md

@@ -91,7 +91,7 @@ before_install: rvm use $RVM_RUBY_VERSION
 install: bundle install --without=documentation --path ../travis_bundle_dir
 after_success: 
   - slather
-  - bash <(curl -s https://codecov.io/bash) -f path/to/xml_report/cobertura.xml
+  - bash <(curl -s https://codecov.io/bash) -f path/to/xml_report/cobertura.xml -X coveragepy -X gcov -X xcode
 ```
 
 ```yml
@@ -100,7 +100,7 @@ after_success:
 test:
   post:
     - bundle exec slather
-    - bash <(curl -s https://codecov.io/bash)
+    - bash <(curl -s https://codecov.io/bash) -f path/to/xml_report/cobertura.xml -X coveragepy -X gcov -X xcode
 ```
 
 > Private repo? Add `-t :uuid-repo-token` to the codecov uploader. Read more about uploading report to Codecov [here](https://github.com/codecov/codecov-bash)

data/lib/slather/coverage_service/coveralls.rb

@@ -26,6 +26,11 @@ module Slather
       end
       private :circleci_pull_request
 
+      def teamcity_job_id
+        ENV['TC_BUILD_NUMBER']
+      end
+      private :teamcity_job_id
+
       def jenkins_job_id
         ENV['BUILD_ID']
       end
@@ -41,6 +46,11 @@ module Slather
       end
       private :jenkins_branch_name
 
+      def teamcity_branch_name
+        ENV['GIT_BRANCH'] || `git ls-remote --heads origin | grep $(git rev-parse HEAD) | cut -d / -f 3-`.chomp
+      end
+      private :teamcity_branch_name
+
       def buildkite_job_id
         ENV['BUILDKITE_BUILD_NUMBER']
       end
@@ -63,6 +73,19 @@ module Slather
       end
       private :jenkins_git_info
 
+      def teamcity_git_info
+        {
+          head: {
+            :id => (`git log --format=%H -n 1 HEAD`.chomp || ""),
+            :author_name => (`git log --format=%an -n 1 HEAD`.chomp || ""),
+            :author_email => (`git log --format=%ae -n 1 HEAD`.chomp || ""),
+            :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => teamcity_branch_name
+        }
+      end
+      private :teamcity_git_info
+
       def circleci_build_url
         "https://circleci.com/gh/" + ENV['CIRCLE_PROJECT_USERNAME'] || "" + "/" + ENV['CIRCLE_PROJECT_REPONAME'] || "" + "/" + ENV['CIRCLE_BUILD_NUM'] || ""
       end
@@ -171,6 +194,18 @@ module Slather
           else
             raise StandardError, "Environment variable `BUILDKITE_BUILD_NUMBER` not set. Is this running on a buildkite build?"
           end
+        elsif ci_service == :teamcity
+          if teamcity_job_id
+            {
+              :service_job_id => teamcity_job_id,
+              :service_name => "teamcity",
+              :repo_token => coverage_access_token,
+              :source_files => coverage_files.map(&:as_json),
+              :git => teamcity_git_info
+            }.to_json
+          else
+            raise StandardError, "Environment variable `TC_BUILD_NUMBER` not set. Is this running on a teamcity build?"
+          end
         else
           raise StandardError, "No support for ci named #{ci_service}"
         end

data/lib/slather/coverage_service/html_output.rb

@@ -157,13 +157,12 @@ module Slather
 
           cov.table(:class => "source_code") {
             cleaned_gcov_lines.each do |line|
-              data = line.split(line_number_separator, 3)
 
-              line_number = data[1].to_i
+              line_number = coverage_file.line_number_in_line(line)
               next unless line_number > 0
 
-              coverage_data = data[0].strip
-              line_data = [line_number, data[2], hits_for_coverage_line(coverage_file, line)]
+              line_source = line.split(line_number_separator, 3)[2]
+              line_data = [line_number, line_source, hits_for_coverage_line(coverage_file, line)]
               classes = ["num", "src", "coverage"]
 
               cov.tr(:class => class_for_coverage_line(coverage_file,line)) {

data/lib/slather/profdata_coverage_file.rb

@@ -1,5 +1,6 @@
 require 'slather/coverage_info'
 require 'slather/coveralls_coverage'
+require 'digest/md5'
 
 module Slather
   class ProfdataCoverageFile
@@ -7,31 +8,50 @@ module Slather
     include CoverageInfo
     include CoverallsCoverage
 
-    attr_accessor :project, :source, :line_data
+    attr_accessor :project, :source, :line_numbers_first, :line_data
 
-    def initialize(project, source)
+    def initialize(project, source, line_numbers_first)
       self.project = project
       self.source = source
+      self.line_numbers_first = line_numbers_first
       create_line_data
     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)] = line }
+      all_lines.each { |line| line_data[line_number_in_line(line, self.line_numbers_first)] = line }
       self.line_data = line_data
     end
     private :create_line_data
 
     def path_on_first_line?
       path = self.source.split("\n")[0].sub ":", ""
-      !path.include?("1|//")
+      !path.include?("|//")
     end
 
     def source_file_pathname
       @source_file_pathname ||= begin
-        path = self.source.split("\n")[0].sub ":", ""
-        path &&= Pathname(path)
+        if path_on_first_line?
+          path = self.source.split("\n")[0].sub ":", ""
+          path &&= Pathname(path)
+        else
+          # llvm-cov was run with just one matching source file
+          # It doesn't print the source path in this case, so we have to find it ourselves
+          # This is slow because we read every source file and compare it, but this should only happen if there aren't many source files
+          digest = Digest::MD5.digest(self.raw_source)
+          path = nil
+
+          project.find_source_files.each do |file|
+            file_digest = Digest::MD5.digest(File.read(file).strip)
+
+            if digest == file_digest
+              path = file
+            end
+          end
+
+          path
+        end
       end
     end
 
@@ -58,6 +78,12 @@ module Slather
       @all_lines
     end
 
+    def raw_source
+      self.source.lines.map do |line|
+        line.split('|').last
+      end.join
+    end
+
     def cleaned_gcov_data
       source_data
     end
@@ -66,10 +92,17 @@ module Slather
       self.source
     end
 
-    def line_number_in_line(line)
-      line =~ /^(\s*)(\d*)\|(\s*)(\d+)\|/
-      if $4 != nil
-        match = $4.strip
+    def line_number_in_line(line, line_numbers_first = self.line_numbers_first)
+      if line_numbers_first
+        line =~ /^(\s*)(\d*)/
+        group = $2
+      else
+        line =~ /^(\s*)(\d*)\|(\s*)(\d+)\|/
+        group = $4
+      end
+
+      if group != nil
+        match = group.strip
         case match
           when /[0-9]+/
             return match.to_i
@@ -91,28 +124,43 @@ module Slather
 
     def line_coverage_data
       source_code_lines.map do |line|
-        coverage_for_line(line)
+        coverage_for_line(line, self.line_numbers_first)
       end
     end
 
-    def coverage_for_line(line)
+    def coverage_for_line(line, line_numbers_first = self.line_numbers_first)
       line = line.gsub(":", "|")
-      line =~ /^(\s*)(\d*)\|/
 
-      if $2 == nil
+      if line_numbers_first
+        line =~ /^(\s*)(\d*)\|(\s*)(\d+)\|/
+        group = $4
+      else
+        line =~ /^(\s*)(\d*)\|/
+        group = $2
+      end
+
+      if group == nil
         # Check for thousands or millions (llvm-cov outputs hit counts as 25.3k or 3.8M)
-        did_match = line =~ /^(\s*)(\d+\.\d+)(k|M)\|/
+        if line_numbers_first
+          did_match = line =~ /^(\s*)(\d+)\|(\s*)(\d+\.\d+)(k|M)\|/
+          group = $4
+          units_group = $5
+        else
+          did_match = line =~ /^(\s*)(\d+\.\d+)(k|M)\|/
+          group = $2
+          units_group = $3
+        end
 
         if did_match
-          count = $2.strip
-          units = $3 == 'k' ? 1000 : 1000000
+          count = group.strip
+          units = units_group == 'k' ? 1000 : 1000000
 
           (count.to_f * units).to_i
         else
           return nil
         end
       else
-        match = $2.strip
+        match = group.strip
         case match
         when /[0-9]+/
           match.to_i
@@ -144,24 +192,16 @@ module Slather
     private :supported_file_extensions
 
     def ignored?
-      ignore = false
-      platform_ignore_list.map do |ignore_suffix|
-        ignore = source_file_pathname.to_s.end_with? ignore_suffix
-        if ignore
-          break
-        end
+      # This indicates a llvm-cov coverage warning (occurs if a passed in source file 
+      # is not covered or with ccache in some cases).
+      ignore = source_file_pathname.to_s.end_with? "isn't covered."
+
+      if !ignore
+        # Ignore source files inside of platform SDKs
+        ignore = (/Xcode.*\.app\/Contents\/Developer\/Platforms/ =~ source_file_pathname.to_s) != nil
       end
-      ignore ? ignore : super
-    end
 
-    def platform_ignore_list
-      ["MacOSX.platform/Developer/Library/Frameworks/XCTest.framework/Headers/XCTestAssertionsImpl.h",
-        "MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk/usr/include/objc/objc.h",
-        "MacOSX.platform/Developer/Library/Frameworks/XCTest.framework/Headers/XCTestAssertions.h",
-        # This indicates a llvm-cov coverage warning (occurs if a passed in source file 
-        # is not covered or with ccache in some cases).
-        "isn't covered."]
+      ignore ? ignore : super
     end
-    private :platform_ignore_list
   end
 end

data/lib/slather/project.rb

@@ -52,7 +52,7 @@ module Slather
 
     attr_accessor :build_directory, :ignore_list, :ci_service, :coverage_service, :coverage_access_token, :source_directory,
       :output_directory, :xcodeproj, :show_html, :verbose_mode, :input_format, :scheme, :workspace, :binary_file, :binary_basename, :source_files,
-      :decimals
+      :decimals, :llvm_version
 
     alias_method :setup_for_coverage, :slather_setup_for_coverage
 
@@ -84,7 +84,7 @@ module Slather
       end
 
       # redirect stderr to avoid xcodebuild errors being printed.
-      build_settings = `xcodebuild #{projectOrWorkspaceArgument} #{schemeArgument} -showBuildSettings #{buildAction} 2>&1`
+      build_settings = `xcodebuild #{projectOrWorkspaceArgument} #{schemeArgument} -showBuildSettings #{buildAction} CODE_SIGNING_ALLOWED=NO CODE_SIGNING_REQUIRED=NO 2>&1`
 
       if build_settings
         derived_data_path = build_settings.match(/ OBJROOT = (.+)/)
@@ -126,13 +126,14 @@ module Slather
     def profdata_coverage_files
       coverage_files = []
       source_files = find_source_files || []
+      line_numbers_first = Gem::Version.new(self.llvm_version) >= Gem::Version.new('8.1.0')
 
       if self.binary_file
         self.binary_file.each do |binary_path|
           files = profdata_llvm_cov_output(binary_path, source_files).split("\n\n")
 
           coverage_files.concat(files.map do |source|
-            coverage_file = coverage_file_class.new(self, 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 = source_files.first if source_files.count == 1
             !coverage_file.ignored? ? coverage_file : nil
@@ -208,7 +209,8 @@ module Slather
     private :unsafe_profdata_llvm_cov_output
 
     def profdata_llvm_cov_output(binary_path, source_files)
-      unsafe_profdata_llvm_cov_output(binary_path, source_files).encode!('UTF-8', 'binary', :invalid => :replace, undef: :replace)
+      output = unsafe_profdata_llvm_cov_output(binary_path, source_files)
+      output.valid_encoding? ? output : output.encode!('UTF-8', 'binary', :invalid => :replace, undef: :replace)
     end
     private :profdata_llvm_cov_output
 
@@ -239,6 +241,8 @@ module Slather
         configure_input_format
         configure_binary_file
         configure_decimals
+
+        self.llvm_version = `xcrun llvm-cov --version`.match(/Apple LLVM version ([\d\.]+)/).captures[0]
       rescue => e
         puts e.message
         puts failure_help_string
@@ -391,20 +395,9 @@ module Slather
 
         xcscheme = Xcodeproj::XCScheme.new(xcscheme_path)
 
-        begin
-          buildable_name = xcscheme.build_action.entries[0].buildable_references[0].buildable_name
-        rescue
-          # xcodeproj will raise an exception if there are no entries in the build action
-        end
-
-        if buildable_name == nil or buildable_name.end_with? ".a"
-          # Can't run code coverage on static libraries, look for an associated test bundle
-          buildable_name = xcscheme.test_action.testables[0].buildable_references[0].buildable_name
-        end
-
         configuration = xcscheme.test_action.build_configuration
 
-        search_list = binary_basename || [buildable_name]
+        search_list = binary_basename || find_buildable_names(xcscheme)
 
         search_list.each do |search_for|
           found_product = Dir["#{profdata_coverage_dir}/Products/#{configuration}*/#{search_for}*"].sort { |x, y|
@@ -461,6 +454,37 @@ module Slather
       found_binaries.map { |binary| File.expand_path(binary) }
     end
 
+    def find_buildable_names(xcscheme)
+      found_buildable_names = []
+
+      # enumerate build action entries
+      begin
+        xcscheme.build_action.entries.each do |entry|
+          buildable_name = entry.buildable_references[0].buildable_name
+
+          if !buildable_name.end_with? ".a"
+            # Can't run code coverage on static libraries
+            found_buildable_names.push(buildable_name)
+          end
+        end
+      rescue
+        # xcodeproj will raise an exception if there are no entries in the build action
+      end
+
+      # enumerate test action entries
+      begin
+        xcscheme.test_action.testables.each do |entry|
+          buildable_name = entry.buildable_references[0].buildable_name
+          found_buildable_names.push(buildable_name)
+        end
+      rescue
+        # just in case if there are no entries in the test action
+      end
+
+      # some items are both buildable and testable, so return only unique ones
+      found_buildable_names.uniq
+    end
+
     def find_source_files
       source_files = load_option_array("source_files")
       return if source_files.nil?

data/lib/slather/version.rb

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