slather 1.8.3 → 2.0.0

data/lib/slather/coverage_service/html_output.rb

@@ -5,7 +5,11 @@ module Slather
     module HtmlOutput
 
       def coverage_file_class
-        Slather::CoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class
 
@@ -46,6 +50,11 @@ module Slather
         FileUtils.rm_rf(directory_path) if Dir.exist?(directory_path)
         FileUtils.mkdir_p(directory_path)
 
+        FileUtils.cp(File.join(gem_root_path, "docs/logo.jpg"), directory_path)
+        FileUtils.cp(File.join(gem_root_path, "assets/slather.css"), directory_path)
+        FileUtils.cp(File.join(gem_root_path, "assets/highlight.pack.js"), directory_path)
+        FileUtils.cp(File.join(gem_root_path, "assets/list.min.js"), directory_path)
+
         reports.each do |name, doc|
           html_file = File.join(directory_path, "#{name}.html")
           File.write(html_file, doc.to_html)
@@ -141,18 +150,20 @@ module Slather
             next
           end
 
+          line_number_separator = coverage_file.line_number_separator
+
           cov.table(:class => "source_code") {
             cleaned_gcov_lines.each do |line|
-              data = line.split(':', 3)
+              data = line.split(line_number_separator, 3)
 
               line_number = data[1].to_i
               next unless line_number > 0
 
               coverage_data = data[0].strip
-              line_data = [line_number, data[2], hits_for_coverage_data(coverage_data)]
+              line_data = [line_number, data[2], hits_for_coverage_line(coverage_file, line)]
               classes = ["num", "src", "coverage"]
 
-              cov.tr(:class => class_for_coverage_data(coverage_data)) {
+              cov.tr(:class => class_for_coverage_line(coverage_file,line)) {
                 line_data.each_with_index { |line, idx|
                   if idx != 1
                     cov.td(line, :class => classes[idx])
@@ -171,10 +182,10 @@ module Slather
       end
 
       def generate_html_template(title, is_index, is_file_empty)
-        logo_path = File.join(gem_root_path, "docs/logo.jpg")
-        css_path = File.join(gem_root_path, "assets/slather.css")
-        highlight_js_path = File.join(gem_root_path, "assets/highlight.pack.js")
-        list_js_path = File.join(gem_root_path, "assets/list.min.js")
+        logo_path = "logo.jpg"
+        css_path = "slather.css"
+        highlight_js_path = "highlight.pack.js"
+        list_js_path = "list.min.js"
 
         builder = Nokogiri::HTML::Builder.new do |doc|
           doc.html {
@@ -191,7 +202,7 @@ module Slather
               doc.div(:class => "row") { doc.div(:id => "reports") }
               doc.footer {
                 doc.div(:class => "row") {
-                  doc.p { doc.a("Fork me on Github", :href => "https://github.com/venmo/slather") }
+                  doc.p { doc.a("Fork me on Github", :href => "https://github.com/SlatherOrg/slather") }
                   doc.p("© #{Date.today.year} Slather")
                 }
               }
@@ -215,19 +226,21 @@ module Slather
         File.expand_path File.join(File.dirname(__dir__), "../..")
       end
 
-      def class_for_coverage_data(coverage_data)
-        case coverage_data
-        when /\d/ then "covered"
-        when /#/ then "missed"
-        else "never"
+      def class_for_coverage_line(coverage_file, coverage_line)
+        hits = coverage_file.coverage_for_line(coverage_line)
+        case
+        when hits == nil then "never"
+        when hits > 0 then "covered"
+        else "missed"
         end
       end
 
-      def hits_for_coverage_data(coverage_data)
-        case coverage_data
-        when /\d/ then (coverage_data.to_i > 0) ? "#{coverage_data}x" : ""
-        when /#/ then "!"
-        else ""
+      def hits_for_coverage_line(coverage_file, coverage_line)
+        hits = coverage_file.coverage_for_line(coverage_line)
+        case
+        when hits == nil then ""
+        when hits > 0 then "#{hits}x"
+        else "!"
         end
       end
 

data/lib/slather/coverage_service/simple_output.rb

@@ -3,7 +3,11 @@ module Slather
     module SimpleOutput
 
       def coverage_file_class
-        Slather::CoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class
 

data/lib/slather/{coveralls_coverage_file.rb → coveralls_coverage.rb}

@@ -1,5 +1,5 @@
 module Slather
-  class CoverallsCoverageFile < CoverageFile
+  module CoverallsCoverage
 
     def as_json
       {

data/lib/slather/profdata_coverage_file.rb

@@ -0,0 +1,130 @@
+require 'slather/coverage_info'
+require 'slather/coveralls_coverage'
+
+module Slather
+  class ProfdataCoverageFile
+
+    include CoverageInfo
+    include CoverallsCoverage
+
+    attr_accessor :project, :source, :line_data
+
+    def initialize(project, source)
+      self.project = project
+      self.source = source
+      create_line_data
+    end
+
+    def create_line_data
+      all_lines = self.source.split("\n")[1..-1]
+      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 source_file_pathname
+      @source_file_pathname ||= begin
+        path = self.source.split("\n")[0].sub ":", ""
+        path &&= Pathname(path)
+      end
+    end
+
+    def source_file
+      File.new(source_file_pathname)
+    end
+
+    def source_data
+      all_lines.join("\n")
+    end
+
+    def all_lines
+      if @all_lines == nil
+        @all_lines = self.source.split("\n")[1..-1]
+      end
+      @all_lines
+    end
+
+    def cleaned_gcov_data
+      source_data
+    end
+
+    def raw_data
+      self.source
+    end
+
+    def line_number_in_line(line)
+      line =~ /^(\s*)(\d*)\|(\s*)(\d+)\|/
+      if $4 != nil
+        match = $4.strip
+        case match
+          when /[0-9]+/
+            return match.to_i
+        end
+      end
+      0
+    end
+
+    def line_coverage_data
+      self.source.split("\n")[1..-1].map do |line|
+        coverage_for_line(line)
+      end
+    end
+
+    def coverage_for_line(line)
+      line = line.gsub(":", "|")
+      line =~ /^(\s*)(\d*)\|/
+
+      if $2 == nil
+        return nil
+      end
+
+      match = $2.strip
+      case match
+      when /[0-9]+/
+        match.to_i
+      when /#+/
+        0
+      when "-"
+        nil
+      end
+    end
+
+    def branch_coverage_data
+      @branch_coverage_data ||= begin
+        Hash.new
+      end
+    end
+
+    def source_file_basename
+      File.basename(source_file_pathname, '.swift')
+    end
+
+    def line_number_separator
+      "|"
+    end
+
+    def supported_file_extensions
+      ["swift"]
+    end
+    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
+      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"]
+    end
+    private :platform_ignore_list
+  end
+end

data/lib/slather/project.rb

@@ -2,14 +2,45 @@ require 'fileutils'
 require 'xcodeproj'
 require 'json'
 require 'yaml'
+require 'shellwords'
 
 module Xcodeproj
+
   class Project
 
-    def slather_setup_for_coverage
+    def slather_setup_for_coverage(format = :auto)
+      unless [:gcov, :clang, :auto].include?(format)
+        raise StandardError, "Only supported formats for setup are gcov, clang or auto"
+      end
+      if format == :auto
+        format = Slather.xcode_version[0] < 7 ? :gcov : :clang
+      end
+
       build_configurations.each do |build_configuration|
-        build_configuration.build_settings["GCC_INSTRUMENT_PROGRAM_FLOW_ARCS"] = "YES"
-        build_configuration.build_settings["GCC_GENERATE_TEST_COVERAGE_FILES"] = "YES"
+        if format == :clang
+          build_configuration.build_settings["CLANG_ENABLE_CODE_COVERAGE"] = "YES"
+        else
+          build_configuration.build_settings["GCC_INSTRUMENT_PROGRAM_FLOW_ARCS"] = "YES"
+          build_configuration.build_settings["GCC_GENERATE_TEST_COVERAGE_FILES"] = "YES"
+        end
+      end
+
+      # Patch xcschemes too
+      if format == :clang
+        if Gem::Requirement.new('~> 0.27') =~ Gem::Version.new(Xcodeproj::VERSION)
+          # @todo This will require to bump the xcodeproj dependency to ~> 0.27
+          # (which would require to bump cocoapods too)
+          schemes_path = Xcodeproj::XCScheme.shared_data_dir(self.path)
+          Xcodeproj::Project.schemes(self.path).each do |scheme_name|
+            xcscheme_path = "#{schemes_path + scheme_name}.xcscheme"
+            xcscheme = Xcodeproj::XCScheme.new(xcscheme_path)
+            xcscheme.test_action.xml_element.attributes['codeCoverageEnabled'] = 'YES'
+            xcscheme.save_as(self.path, scheme_name)
+          end
+        else
+          # @todo In the meantime, simply inform the user to do it manually
+          puts %Q(Ensure you enabled "Gather coverage data" in each of your scheme's Test action)
+        end
       end
     end
 
@@ -19,27 +50,32 @@ end
 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
+    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, :binary_file, :binary_basename
 
     alias_method :setup_for_coverage, :slather_setup_for_coverage
 
     def self.open(xcodeproj)
       proj = super
-      proj.configure_from_yml
       proj.xcodeproj = xcodeproj
       proj
     end
 
-    def derived_data_dir
+    def derived_data_path
       File.expand_path('~') + "/Library/Developer/Xcode/DerivedData/"
     end
-    private :derived_data_dir
+    private :derived_data_path
 
-    def build_directory
-      @build_directory || derived_data_dir
+    def coverage_files
+      if self.input_format == "profdata"
+        profdata_coverage_files
+      else
+        gcov_coverage_files
+      end
     end
+    private :coverage_files
 
-    def coverage_files
+    def gcov_coverage_files
       coverage_files = Dir["#{build_directory}/**/*.gcno"].map do |file|
         coverage_file = coverage_file_class.new(self, file)
         # If there's no source file for this gcno, it probably belongs to another project.
@@ -52,7 +88,79 @@ module Slather
         dedupe(coverage_files)
       end
     end
-    private :coverage_files
+    private :gcov_coverage_files
+
+    def profdata_coverage_files
+      files = profdata_llvm_cov_output.split("\n\n")
+
+      files.map do |source|
+        coverage_file = coverage_file_class.new(self, source)
+        !coverage_file.ignored? ? coverage_file : nil
+      end.compact
+    end
+    private :profdata_coverage_files
+
+    def profdata_coverage_dir
+      raise StandardError, "The specified build directory (#{self.build_directory}) does not exist" unless File.exists?(self.build_directory)
+      dir = nil
+      if self.scheme
+        dir = Dir["#{build_directory}/**/CodeCoverage/#{self.scheme}"].first
+      else
+        dir = Dir["#{build_directory}/**/#{self.products.first.name}"].first
+      end
+
+      raise StandardError, "No coverage directory found. Are you sure your project is setup for generating coverage files? Try `slather setup your/project.xcodeproj`" unless dir != nil
+      dir
+    end
+
+    def profdata_file
+      profdata_coverage_dir = self.profdata_coverage_dir
+      if profdata_coverage_dir == nil
+        raise StandardError, "No coverage directory found. Please make sure the \"Code Coverage\" checkbox is enabled in your scheme's Test action or the build_directory property is set."
+      end
+
+      file =  Dir["#{profdata_coverage_dir}/**/Coverage.profdata"].first
+      unless file != nil
+        return nil
+      end
+      return File.expand_path(file)
+    end
+    private :profdata_file
+
+    def find_binary_file_for_app(app_bundle_file)
+      app_bundle_file_name_noext = Pathname.new(app_bundle_file).basename.to_s.gsub(".app", "")
+      Dir["#{app_bundle_file}/**/#{app_bundle_file_name_noext}"].first
+    end
+
+    def find_binary_file_for_dynamic_lib(framework_bundle_file)
+      framework_bundle_file_name_noext = Pathname.new(framework_bundle_file).basename.to_s.gsub(".framework", "")
+      "#{framework_bundle_file}/#{framework_bundle_file_name_noext}"
+    end
+
+    def find_binary_file_for_static_lib(xctest_bundle_file)
+      xctest_bundle_file_name_noext = Pathname.new(xctest_bundle_file).basename.to_s.gsub(".xctest", "")
+      Dir["#{xctest_bundle_file}/**/#{xctest_bundle_file_name_noext}"].first
+    end
+
+    def unsafe_profdata_llvm_cov_output
+      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
+        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}`
+    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)
+    end
+    private :profdata_llvm_cov_output
 
     def dedupe(coverage_files)
       coverage_files.group_by(&:source_file_pathname).values.map { |cf_array| cf_array.max_by(&:percentage_lines_tested) }
@@ -67,45 +175,73 @@ module Slather
       @yml ||= File.exist?(yml_filename) ? YAML.load_file(yml_filename) : {}
     end
 
-    def configure_from_yml
-      configure_build_directory_from_yml
-      configure_ignore_list_from_yml
-      configure_ci_service_from_yml
-      configure_coverage_access_token_from_yml
-      configure_coverage_service_from_yml
-      configure_source_directory_from_yml
-      configure_output_directory_from_yml
+    def configure
+      configure_build_directory
+      configure_ignore_list
+      configure_ci_service
+      configure_coverage_access_token
+      configure_coverage_service
+      configure_source_directory
+      configure_output_directory
+      configure_input_format
+      configure_scheme
+      configure_binary_file
+
+      if self.verbose_mode
+        puts "\nProcessing coverage file: #{profdata_file}"
+        puts "Against binary file: #{self.binary_file}\n\n"
+      end
     end
 
-    def configure_build_directory_from_yml
-      self.build_directory = self.class.yml["build_directory"] if self.class.yml["build_directory"] && !@build_directory
+    def configure_build_directory
+      self.build_directory ||= self.class.yml["build_directory"] || derived_data_path
     end
 
-    def configure_source_directory_from_yml
+    def configure_source_directory
       self.source_directory ||= self.class.yml["source_directory"] if self.class.yml["source_directory"]
     end
 
-    def configure_output_directory_from_yml
+    def configure_output_directory
       self.output_directory ||= self.class.yml["output_directory"] if self.class.yml["output_directory"]
     end
 
-    def configure_ignore_list_from_yml
+    def configure_ignore_list
       self.ignore_list ||= [(self.class.yml["ignore"] || [])].flatten
     end
 
-    def configure_ci_service_from_yml
+    def configure_ci_service
       self.ci_service ||= (self.class.yml["ci_service"] || :travis_ci)
     end
 
+    def configure_input_format
+      self.input_format ||= self.class.yml["input_format"] || input_format
+    end
+
+    def input_format=(format)
+      format ||= "auto"
+      unless %w(gcov profdata auto).include?(format)
+        raise StandardError, "Only supported input formats are gcov, profdata or auto"
+      end
+      if format == "auto"
+        @input_format = Slather.xcode_version[0] < 7 ? "gcov" : "profdata"
+      else
+        @input_format = format
+      end
+    end
+
+    def configure_scheme
+      self.scheme ||= self.class.yml["scheme"] if self.class.yml["scheme"]
+    end
+
     def ci_service=(service)
       @ci_service = service && service.to_sym
     end
 
-    def configure_coverage_service_from_yml
+    def configure_coverage_service
       self.coverage_service ||= (self.class.yml["coverage_service"] || :terminal)
     end
 
-    def configure_coverage_access_token_from_yml
+    def configure_coverage_access_token
       self.coverage_access_token ||= (ENV["COVERAGE_ACCESS_TOKEN"] || self.class.yml["coverage_access_token"] || "")
     end
 
@@ -128,5 +264,33 @@ module Slather
       end
       @coverage_service = service
     end
+
+    def configure_binary_file
+      if self.input_format == "profdata"
+        self.binary_file ||= self.class.yml["binary_file"] || File.expand_path(find_binary_file)
+      end
+    end
+
+    def find_binary_file
+      xctest_bundle = Dir["#{profdata_coverage_dir}/**/*.xctest"].reject { |bundle|
+        bundle.include? "-Runner.app/PlugIns/"
+      }.first
+      raise StandardError, "No product binary found in #{profdata_coverage_dir}. Are you sure your project is setup for generating coverage files? Try `slather setup your/project.xcodeproj`" unless xctest_bundle != nil
+
+      # Find the matching binary file
+      search_for = self.binary_basename || self.class.yml["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
+
+      if app_bundle != nil
+        find_binary_file_for_app(app_bundle)
+      elsif dynamic_lib_bundle != nil
+        find_binary_file_for_dynamic_lib(dynamic_lib_bundle)
+      else
+        find_binary_file_for_static_lib(xctest_bundle)
+      end
+    end
+
   end
 end

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = "1.8.3"
+  VERSION = "2.0.0"
 end

data/lib/slather.rb

@@ -1,7 +1,9 @@
 require 'slather/version'
 require 'slather/project'
+require 'slather/coverage_info'
 require 'slather/coverage_file'
-require 'slather/coveralls_coverage_file'
+require 'slather/coveralls_coverage'
+require 'slather/profdata_coverage_file'
 require 'slather/coverage_service/cobertura_xml_output'
 require 'slather/coverage_service/coveralls'
 require 'slather/coverage_service/hardcover'
@@ -17,4 +19,10 @@ module Slather
     Pod::UI.warn("[Slather] prepare_pods is now deprecated. The call to prepare_pods in your Podfile can simply be ommitted.")
   end
 
+  def self.xcode_version
+    xcode_path = `xcode-select -p`.strip
+    xcode_version = `mdls -name kMDItemVersion -raw #{xcode_path.shellescape}/../..`.strip
+    xcode_version.split('.').map(&:to_i)
+  end
+
 end

data/slather.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Mark Larsen"]
   spec.email         = ["mark@venmo.com"]
   spec.summary       = %q{Test coverage reports for Xcode projects}
-  spec.homepage      = "https://github.com/venmo/slather"
+  spec.homepage      = "https://github.com/SlatherOrg/slather"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "cocoapods", "~> 0.39.0"
+  spec.add_development_dependency "cocoapods", ">= 0.39.0", "< 1.1.0"
   spec.add_development_dependency "json_spec", "~> 1.1.4"
   spec.add_development_dependency "equivalent-xml", "~> 0.5.1"
 
   spec.add_dependency "clamp", "~> 0.6"
-  spec.add_dependency "xcodeproj", "~> 0.28.0"
+  spec.add_dependency "xcodeproj", ">= 0.28.2", "< 1.1.0"
   spec.add_dependency "nokogiri", "~> 1.6.3"
 end