slather 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f63502fe53f807b2802d7cd0676e199f040b311
-  data.tar.gz: 9516ad8c703aa3d40f22e796e1c3a64a8dc780ca
+  metadata.gz: eeb8cebaec1537b632d62c19245da2c00af5730e
+  data.tar.gz: 0b7ca2c1e79d283e9899b969012f943d611ed0be
 SHA512:
-  metadata.gz: 2ced3c9407d4dd0e50150361f9870a3c211eda077667d5a4cca1287e5d685b4327c9be2a9a23b4b774ff99e2ef4e3826ccee1f5034fe93980a88fa69c3d3fd2e
-  data.tar.gz: ed0d9167ca9b8f9a7001d00a09b4c53a6c7b16c18653abac0a7c41c9ce81b1ddbd3a3cedfc8ce9537497d6d99da38192c825629e7ab034065215be92842b422f
+  metadata.gz: 81c1fd17cba7d152635a93aaf546bd1cfa9fc1040dd92da8b690486a913178e254ce28ae753200d2bc171cad0d586f2304a4b21d6683e364cc321bb77c88f0e0
+  data.tar.gz: 3f0a80e2845b883f7ed3867a68f5717da9d85ea62bfa07442195017b735e21e667a244cf90924cb99a43193d8256d2293f48bc6f5aa9cef6570d856537c3befd

data/CHANGELOG.md

@@ -3,6 +3,36 @@
 ## master
 
 
+## v2.2.0
+
+* Fix nil crash in `project.rb` derived_data_path  
+  [bootstraponline](https://github.com/bootstraponline)
+  [#203](https://github.com/SlatherOrg/slather/pull/203)
+
+* Fix for correct line number for lines that are hit thousands or millions of time in llvm-cov.  
+  [Mihai Parv](https://github.com/mihaiparv)
+  [#202](https://github.com/SlatherOrg/slather/pull/202), [#196](https://github.com/SlatherOrg/slather/issues/196)
+
+* Generate coverate for multiple binaries by passing multiple `--binary-basename` or `--binary-file` arguments, or by using an array in `.slather.yml`  
+  [Kent Sutherland](https://github.com/ksuther)
+  [#188](https://github.com/SlatherOrg/slather/pull/188)
+
+* Support for specifying source file patterns using the `--source-files` option or the source_files key in `.slather.yml`  
+  [Matej Bukovinski](https://github.com/matej)
+  [#201](https://github.com/SlatherOrg/slather/pull/201)
+
+* Improve getting schemes. Looks for user scheme in case no shared scheme is found.  
+  [Matyas Hlavacek](https://github.com/matyashlavacek)
+  [#182](https://github.com/SlatherOrg/slather/issues/182)
+
+* Search Xcode workspaces for schemes. Workspaces are checked if no matching scheme is found in the project.  
+  [Kent Sutherland](https://github.com/ksuther)
+  [#193](https://github.com/SlatherOrg/slather/pull/193), [#191](https://github.com/SlatherOrg/slather/issues/191)
+
+* Fix for hit counts in thousands or millions being output as floats intead of integers  
+  [Carl Hill-Popper](https://github.com/chillpop)
+  [#190](https://github.com/SlatherOrg/slather/pull/190)
+
 ## v2.1.0
 
 * Support for Xcode workspaces. Define `workspace` configuration in `.slather.yml` or use the `--workspace` argument if you build in a workspace.

data/README.md

@@ -55,7 +55,7 @@ If you use a workspace in Xcode you need to specify it:
 $ slather coverage -s --scheme YourXcodeSchemeName --workspace path/to/workspace.xcworkspace path/to/project.xcodeproj
 ```
 
-### Setup for Xode 5 and 6
+### Setup for Xcode 5 and 6
 
 Run this command to enable the `Generate Test Coverage` and `Instrument Program Flow` flags for your project:
 

data/lib/slather/command/coverage_command.rb

@@ -24,8 +24,9 @@ class CoverageCommand < Clamp::Command
   option ["--input-format"], "INPUT_FORMAT", "Input format (gcov, profdata)"
   option ["--scheme"], "SCHEME", "The scheme for which the coverage was generated"
   option ["--workspace"], "WORKSPACE", "The workspace that the project was built in"
-  option ["--binary-file"], "BINARY_FILE", "The binary file against the which the coverage will be run"
-  option ["--binary-basename"], "BINARY_BASENAME", "Basename of the file against which the coverage will be run"
+  option ["--binary-file"], "BINARY_FILE", "The binary file against the which the coverage will be run", :multivalued => true
+  option ["--binary-basename"], "BINARY_BASENAME", "Basename of the file against which the coverage will be run", :multivalued => true
+  option ["--source-files"], "SOURCE_FILES", "A Dir.glob compatible pattern used to limit the lookup to specific source files. Ignored in gcov mode.", :multivalued => true
 
   def execute
     puts "Slathering..."
@@ -42,6 +43,7 @@ class CoverageCommand < Clamp::Command
     setup_workspace
     setup_binary_file
     setup_binary_basename
+    setup_source_files
 
     project.configure
 
@@ -127,10 +129,14 @@ class CoverageCommand < Clamp::Command
   end
 
   def setup_binary_file
-    project.binary_file = binary_file
+    project.binary_file = binary_file_list if !binary_file_list.empty?
   end
 
   def setup_binary_basename
-    project.binary_basename = binary_basename
+    project.binary_basename = binary_basename_list if !binary_basename_list.empty?
+  end
+
+  def setup_source_files
+    project.source_files = source_files_list if !source_files_list.empty?
   end
 end

data/lib/slather/profdata_coverage_file.rb

@@ -16,13 +16,18 @@ module Slather
     end
 
     def create_line_data
-      all_lines = self.source.split("\n")[1..-1]
+      all_lines = source_code_lines
       line_data = Hash.new
       all_lines.each { |line| line_data[line_number_in_line(line)] = 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|//")
+    end
+
     def source_file_pathname
       @source_file_pathname ||= begin
         path = self.source.split("\n")[0].sub ":", ""
@@ -30,17 +35,25 @@ module Slather
       end
     end
 
+    def source_file_pathname= (source_file_pathname)
+        @source_file_pathname = source_file_pathname
+    end
+
     def source_file
       File.new(source_file_pathname)
     end
 
+    def source_code_lines
+      self.source.split("\n")[(path_on_first_line? ? 1 : 0)..-1]
+    end
+
     def source_data
       all_lines.join("\n")
     end
 
     def all_lines
       if @all_lines == nil
-        @all_lines = self.source.split("\n")[1..-1]
+        @all_lines = source_code_lines
       end
       @all_lines
     end
@@ -61,12 +74,23 @@ module Slather
           when /[0-9]+/
             return match.to_i
         end
+      else
+        # llvm-cov outputs hit counts as 25.3k or 3.8M, so check this pattern as well
+        did_match = line =~ /^(\s*)(\d+\.\d+)(k|M)\|(\s*)(\d+)\|/
+
+        if did_match
+          match = $5.strip
+          case match
+            when /[0-9]+/
+              return match.to_i
+          end
+        end
       end
       0
     end
 
     def line_coverage_data
-      self.source.split("\n")[1..-1].map do |line|
+      source_code_lines.map do |line|
         coverage_for_line(line)
       end
     end
@@ -83,7 +107,7 @@ module Slather
           count = $2.strip
           units = $3 == 'k' ? 1000 : 1000000
 
-          count.to_f * units
+          (count.to_f * units).to_i
         else
           return nil
         end
@@ -133,7 +157,10 @@ module Slather
     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"]
+        "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."]
     end
     private :platform_ignore_list
   end

data/lib/slather/project.rb

@@ -51,7 +51,7 @@ module Slather
   class Project < Xcodeproj::Project
 
     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
+      :output_directory, :xcodeproj, :show_html, :verbose_mode, :input_format, :scheme, :workspace, :binary_file, :binary_basename, :source_files
 
     alias_method :setup_for_coverage, :slather_setup_for_coverage
 
@@ -82,10 +82,13 @@ module Slather
         buildAction = nil
       end
 
-      build_settings = `xcodebuild #{projectOrWorkspaceArgument} #{schemeArgument} -showBuildSettings #{buildAction}`
+      # redirect stderr to avoid xcodebuild errors being printed.
+      build_settings = `xcodebuild #{projectOrWorkspaceArgument} #{schemeArgument} -showBuildSettings #{buildAction} 2>&1`
 
       if build_settings
-        derived_data_path = build_settings.match(/ OBJROOT = (.+)/)[1]
+        derived_data_path = build_settings.match(/ OBJROOT = (.+)/)
+        # when match fails derived_data_path is nil
+        derived_data_path = derived_data_path[1] if derived_data_path
       end
 
       if derived_data_path == nil
@@ -121,12 +124,28 @@ module Slather
     private :gcov_coverage_files
 
     def profdata_coverage_files
-      files = profdata_llvm_cov_output.split("\n\n")
+      coverage_files = []
+      source_files = find_source_files || []
+
+      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)
+            # 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
+          end.compact)
+
+          if !source_files.empty?
+            coverage_file_paths = coverage_files.map { |file| file.source_file_pathname }.to_set
+            source_files.select! { |path| !coverage_file_paths.include?(path) }
+          end
+        end
+      end
 
-      files.map do |source|
-        coverage_file = coverage_file_class.new(self, source)
-        !coverage_file.ignored? ? coverage_file : nil
-      end.compact
+      coverage_files
     end
     private :profdata_coverage_files
 
@@ -173,23 +192,23 @@ module Slather
     end
     private :profdata_file
 
-    def unsafe_profdata_llvm_cov_output
+    def unsafe_profdata_llvm_cov_output(binary_path, source_files)
       profdata_file_arg = profdata_file
       if profdata_file_arg == nil
         raise StandardError, "No Coverage.profdata files found. Please make sure the \"Code Coverage\" checkbox is enabled in your scheme's Test action or the build_directory property is set."
       end
 
-      if self.binary_file == nil
+      if binary_path == nil
         raise StandardError, "No binary file found."
       end
 
-      llvm_cov_args = %W(show -instr-profile #{profdata_file_arg} #{self.binary_file})
-      `xcrun llvm-cov #{llvm_cov_args.shelljoin}`
+      llvm_cov_args = %W(show -instr-profile #{profdata_file_arg} #{binary_path})
+      `xcrun llvm-cov #{llvm_cov_args.shelljoin} #{source_files.shelljoin}`
     end
     private :unsafe_profdata_llvm_cov_output
 
-    def profdata_llvm_cov_output
-      unsafe_profdata_llvm_cov_output.encode!('UTF-8', 'binary', :invalid => :replace, undef: :replace)
+    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)
     end
     private :profdata_llvm_cov_output
 
@@ -228,7 +247,11 @@ module Slather
 
       if self.verbose_mode
         puts "\nProcessing coverage file: #{profdata_file}"
-        puts "Against binary file: #{self.binary_file}\n\n"
+        puts "Against binary files:"
+        self.binary_file.each do |binary_file|
+          puts "\t#{binary_file}"
+        end
+        puts "\n"
       end
     end
 
@@ -311,24 +334,46 @@ module Slather
 
     def configure_binary_file
       if self.input_format == "profdata"
-        self.binary_file ||= self.class.yml["binary_file"] || File.expand_path(find_binary_file)
+        self.binary_file = load_option_array("binary_file") || find_binary_files
       end
     end
 
     def find_binary_file_in_bundle(bundle_file)
-      bundle_file_noext = File.basename(bundle_file, File.extname(bundle_file))
-      Dir["#{bundle_file}/**/#{bundle_file_noext}"].first
+      if File.directory? bundle_file
+        bundle_file_noext = File.basename(bundle_file, File.extname(bundle_file))
+        Dir["#{bundle_file}/**/#{bundle_file_noext}"].first
+      else
+        bundle_file
+      end
     end
 
-    def find_binary_file
-      binary_basename = self.binary_basename || self.class.yml["binary_basename"] || nil
+    def find_binary_files
+      binary_basename = load_option_array("binary_basename")
+      found_binaries = []
 
       # Get scheme info out of the xcodeproj
       if self.scheme
         schemes_path = Xcodeproj::XCScheme.shared_data_dir(self.path)
         xcscheme_path = "#{schemes_path + self.scheme}.xcscheme"
 
-        raise StandardError, "No shared scheme named '#{self.scheme}' found in #{self.path}" unless File.exists? xcscheme_path
+        # Try to look inside 'xcuserdata' if the scheme is not found in 'xcshareddata'
+        if !File.file?(xcscheme_path)
+          schemes_path = Xcodeproj::XCScheme.user_data_dir(self.path)
+          xcscheme_path = "#{schemes_path + self.scheme}.xcscheme"
+        end
+
+        if self.workspace and !File.file?(xcscheme_path)
+          # No scheme was found in the xcodeproj, check the workspace
+          schemes_path = Xcodeproj::XCScheme.shared_data_dir(self.workspace)
+          xcscheme_path = "#{schemes_path + self.scheme}.xcscheme"
+
+          if !File.file?(xcscheme_path)
+            schemes_path = Xcodeproj::XCScheme.user_data_dir(self.workspace)
+            xcscheme_path = "#{schemes_path + self.scheme}.xcscheme"
+          end
+        end
+
+        raise StandardError, "No scheme named '#{self.scheme}' found in #{self.path}" unless File.exists? xcscheme_path
 
         xcscheme = Xcodeproj::XCScheme.new(xcscheme_path)
 
@@ -345,19 +390,26 @@ module Slather
 
         configuration = xcscheme.test_action.build_configuration
 
-        search_for = binary_basename || buildable_name
-        found_product = Dir["#{profdata_coverage_dir}/Products/#{configuration}*/#{search_for}*"].sort { |x, y|
-          # Sort the matches without the file extension to ensure better matches when there are multiple candidates
-          # For example, if the binary_basename is Test then we want Test.app to be matched before Test Helper.app
-          File.basename(x, File.extname(x)) <=> File.basename(y, File.extname(y))
-        }.reject { |path|
-          path.end_with? ".dSYM"
-        }.first
+        search_list = binary_basename || [buildable_name]
+
+        search_list.each do |search_for|
+          found_product = Dir["#{profdata_coverage_dir}/Products/#{configuration}*/#{search_for}*"].sort { |x, y|
+            # Sort the matches without the file extension to ensure better matches when there are multiple candidates
+            # For example, if the binary_basename is Test then we want Test.app to be matched before Test Helper.app
+            File.basename(x, File.extname(x)) <=> File.basename(y, File.extname(y))
+          }.reject { |path|
+            path.end_with? ".dSYM"
+          }.first
+
+          if found_product and File.directory? found_product
+            found_binary = find_binary_file_in_bundle(found_product)
+          else
+            found_binary = found_product
+          end
 
-        if found_product and File.directory? found_product
-          found_binary = find_binary_file_in_bundle(found_product)
-        else
-          found_binary = found_product
+          if found_binary
+            found_binaries.push(found_binary)
+          end
         end
       else
         xctest_bundle = Dir["#{profdata_coverage_dir}/**/*.xctest"].reject { |bundle|
@@ -366,26 +418,62 @@ module Slather
         }.first
 
         # Find the matching binary file
-        search_for = binary_basename || '*'
-        xctest_bundle_file_directory = Pathname.new(xctest_bundle).dirname
-        app_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.app"].first
-        dynamic_lib_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.framework"].first
-        matched_xctest_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.xctest"].first
+        search_list = binary_basename || ['*']
+
+        search_list.each do |search_for|
+          xctest_bundle_file_directory = Pathname.new(xctest_bundle).dirname
+          app_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.app"].first
+          matched_xctest_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.xctest"].first
+          dynamic_lib_bundle = Dir["#{xctest_bundle_file_directory}/#{search_for}.{framework,dylib}"].first
 
-        if app_bundle != nil
+          if app_bundle != nil
             found_binary = find_binary_file_in_bundle(app_bundle)
-        elsif dynamic_lib_bundle != nil
-            found_binary = find_binary_file_in_bundle(dynamic_lib_bundle)
-        elsif matched_xctest_bundle != nil
+          elsif matched_xctest_bundle != nil
             found_binary = find_binary_file_in_bundle(matched_xctest_bundle)
-        else
+          elsif dynamic_lib_bundle != nil
+            found_binary = find_binary_file_in_bundle(dynamic_lib_bundle)
+          else
             found_binary = find_binary_file_in_bundle(xctest_bundle)
+          end
+
+          if found_binary
+            found_binaries.push(found_binary)
+          end
         end
       end
 
-      raise StandardError, "No product binary found in #{profdata_coverage_dir}." unless found_binary != nil
+      raise StandardError, "No product binary found in #{profdata_coverage_dir}." unless found_binaries.count > 0
 
-      found_binary
+      found_binaries.map { |binary| File.expand_path(binary) }
+    end
+
+    def find_source_files
+      source_files = load_option_array("source_files")
+      return if source_files.nil?
+
+      current_dir = Pathname("./").realpath
+      paths = source_files.flat_map { |pattern| Dir.glob(pattern) }.uniq
+
+      paths.map do |path|
+        source_file_absolute_path = Pathname(path).realpath
+        source_file_relative_path = source_file_absolute_path.relative_path_from(current_dir)
+        self.ignore_list.any? { |ignore| File.fnmatch(ignore, source_file_relative_path) } ? nil : source_file_absolute_path
+      end.compact
+    end
+
+    def load_option_array(option)
+      value = self.send(option.to_sym)
+      # Only load if a value is not already set
+      if !value
+        value_yml = self.class.yml[option]
+        # Need to check the type in the config file because it can be a string or array
+        if value_yml and value_yml.is_a? Array
+          value = value_yml
+        elsif value_yml
+          value = [value_yml]
+        end
+      end
+      value
     end
   end
 end