xcov 1.7.4 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32dea765a1ab454e9c7cfe52e0b2c811ed95cdd298824a9d13d88d678591ac0
-  data.tar.gz: 2f36b292854842a4eaa5b5d1229c5c7fcc4df8c92bd8e51d2cbea0bea306c619
+  metadata.gz: 8f9fd23056fe7c21f3e20fb62814b10715e4dbcea016c57114b54f7ebbcf904b
+  data.tar.gz: f29f43359b5fdfdb72b33760341b61e3dc51293d84d207cace704c669be639ab
 SHA512:
-  metadata.gz: 6ec5ec18d4ca35b5ed61f9f17ab1cd6f402f2e31e7f0d5c8a37710892884fefed6173fcd7af5ecae48c51563a28fee57d2ac93c970af5aac20313b6a8b0f1b4e
-  data.tar.gz: fefa702e5ea8344912cc37d191e6a4567d41ce50537c2456aab472fdfc6fa59efc5ffcd9ec6d754118ea4b660a3f8591df26a2a5a54fe3f3b50a971d30970cda
+  metadata.gz: 74424f15672e083e2936c0a42b46be69e02f6f556766a98b9fc786118bcb45eb6b5c621c8c9f457b3cb84b6e53a9707a44b050edb80c6ffaa44c4c869daa856e
+  data.tar.gz: c1b3101eabaf8ddb241fa7da1019c3d53b0111d207c08f997ec30c9b0eff4084e5e5bfd159251bbeb3901700d78297172af375ad0870e30e971334d7678fe583

data/README.md

@@ -61,6 +61,7 @@ xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 * `--source_directory` `-r`: The path to project's root directory (optional).
 * `--derived_data_path` `-j`: Path of your project `Derived Data` folder (optional).
 * `--xccov_file_direct_path` `-f`: Direct path to the xccoverage/xccovreport file to parse to generate code coverage (optional).
+* `--cloned_source_packages_path` `-C`: Sets a custom path for Swift Package Manager dependencies (optional).
 * `--minimum_coverage_percentage` `-m`: Raise exception if overall coverage percentage is under this value (ie. 75.0).
 * `--include_test_targets`: Enables coverage reports for `.xctest` targets.
 * `--ignore_file_path` `-x`: Relative or absolute path to the file containing the list of ignored files.
@@ -79,7 +80,10 @@ xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 * `--coveralls_repo_token`: Repository token to be used by integrations not compatible with Coveralls (optional).
 * `--slack_username`: The username which is used to publish to slack (optional).
 * `--slack_message`: The message which is published together with a successful report (optional).
+* `--xcconfig`: Use an extra XCCONFIG file to build your app (optional).
+* `--ideFoundationPath`: Absolute path to the IDEFoundation.framework binary (optional).
 * `--legacy_support`: Enables parsing coverage reports generated by Xcode 9.2 or previous versions.
+* `--is_swift_package`: Enables generating coverage reports for Package.swift derived projects.
 
 _**Note:** All paths you provide should be absolute and unescaped_
 

data/lib/xcov/manager.rb

@@ -17,8 +17,10 @@ module Xcov
       Xcov.config = options
 
       # Set project options
-      FastlaneCore::Project.detect_projects(options)
-      Xcov.project = FastlaneCore::Project.new(options)
+      if !Xcov.config[:is_swift_package]
+        FastlaneCore::Project.detect_projects(options)
+        Xcov.project = FastlaneCore::Project.new(options)
+      end
 
       # Set ignored files handler
       Xcov.ignore_handler = IgnoreHandler.new
@@ -47,13 +49,15 @@ module Xcov
 
       # Find .xccoverage file
       # If no xccov direct path, use the old derived data path method
-      if xccov_file_direct_paths.nil?
+      if xccov_file_direct_paths.empty?
         extension = Xcov.config[:legacy_support] ? "xccoverage" : "xccovreport"
+        
         test_logs_path = derived_data_path + "Logs/Test/"
-        xccoverage_files = Dir["#{test_logs_path}*.#{extension}", "#{test_logs_path}*.xcresult/*/action.#{extension}"].sort_by { |filename| File.mtime(filename) }.reverse
-
+        UI.important("Derived content from #{Dir["#{test_logs_path}/*"]}")
+        
+        xccoverage_files = Dir["#{test_logs_path}*.#{extension}", "#{test_logs_path}*.xcresult/*/action.#{extension}"]
         if xccoverage_files.empty?
-          xcresult_paths = Dir["#{test_logs_path}*.xcresult"].sort_by { |filename| File.mtime(filename) }.reverse
+          xcresult_paths = Dir["#{test_logs_path}*.xcresult"]
           xcresult_paths.each do |xcresult_path|
             xcresults_to_parse_and_export << xcresult_path
           end
@@ -77,6 +81,7 @@ module Xcov
       # Iterates over xcresults
       # Exports .xccovarchives
       # Exports .xccovreports and collects the paths
+      # Merge .xccovreports if multiple exists and return merged report
       unless xcresults_to_parse_and_export.empty?
         xccoverage_files = process_xcresults!(xcresults_to_parse_and_export)
       end
@@ -88,6 +93,7 @@ module Xcov
 
       # Convert .xccoverage file to json
       ide_foundation_path = Xcov.config[:legacy_support] ? nil : Xcov.config[:ideFoundationPath]
+      xccoverage_files = xccoverage_files.sort_by {|filename| File.mtime(filename)}.reverse
       json_report = Xcov::Core::Parser.parse(xccoverage_files.first, Xcov.config[:output_directory], ide_foundation_path)
       ErrorHandler.handle_error("UnableToParseXccoverageFile") if json_report.nil?
 
@@ -154,6 +160,11 @@ module Xcov
       report.targets.each do |target|
         table_rows << [target.name, target.displayable_coverage]
       end
+
+      if report.targets.count > 0 
+        table_rows << ["Average Coverage", "#{"%.2f%%" % (report.coverage*100)}"]
+      end
+
       puts Terminal::Table.new({
         title: "xcov Coverage Report".green,
         rows: table_rows
@@ -194,40 +205,76 @@ module Xcov
     def xccov_file_direct_paths
       # If xccov_file_direct_path was supplied, return
       if Xcov.config[:xccov_file_direct_path].nil?
-          return nil
+          return []
       end
 
-      path = Xcov.config[:xccov_file_direct_path]
-      return [Pathname.new(path).to_s]
+      paths = Xcov.config[:xccov_file_direct_path]
+      return paths.map { |path| Pathname.new(path).to_s }
     end
 
     def process_xcresults!(xcresult_paths)
       output_path = Xcov.config[:output_directory]
       FileUtils.mkdir_p(output_path)
-
-      return xcresult_paths.flat_map do |xcresult_path|
+      
+      result_path = ""
+      index = 0
+      
+      xcresult_paths.flat_map do |xcresult_path|
         begin
           parser = XCResult::Parser.new(path: xcresult_path)
-
+          
           # Exporting to same directory as xcresult
-          archive_paths = parser.export_xccovarchives(destination: output_path)
-          report_paths = parser.export_xccovreports(destination: output_path)
-
-          # Informating user of export paths
-          archive_paths.each do |path|
-            UI.important("Copying .xccovarchive to #{path}") 
-          end
-          report_paths.each do |path|
-            UI.important("Copying .xccovreport to #{path}") 
+          tmp_archive_paths = parser.export_xccovarchives(destination: output_path)
+          tmp_report_paths = parser.export_xccovreports(destination: output_path)
+
+          # Rename each file with global index
+          tmp_report_paths.each_with_index do |item, i|
+            File.rename(tmp_archive_paths[i], "#{output_path}/xccovarchive-#{index + i}.xccovarchive")
+            File.rename(item, "#{output_path}/xccovreport-#{index + i}.xccovreport")
+            index += 1
           end
-
-          report_paths
         rescue
           UI.error("Error occured while exporting xccovreport from xcresult '#{xcresult_path}'")
           UI.error("Make sure you have both Xcode 11 selected and pointing to the correct xcresult file")
           UI.crash!("Failed to export xccovreport from xcresult'")
         end
       end
+      
+      # Grab paths from the directory instead of parser
+      report_paths = Dir["#{output_path}/*.xccovreport"]
+      archive_paths = Dir["#{output_path}/*.xccovarchive"]
+          
+      # Merge coverage reports
+      if report_paths.length > 1 then 
+        # Creating array of paths for merging
+        paths = ""
+        for i in 0..report_paths.length
+          paths += " #{report_paths[i]} #{archive_paths[i]}"
+        end
+            
+        UI.important("Merging multiple coverage reports with #{paths}") 
+        if system ( "xcrun xccov merge --outReport #{output_path}/out.xccovreport --outArchive #{output_path}/out.xccovarchive #{paths}" ) then
+          result_path = "#{output_path}/out.xccovreport"
+        else
+          UI.error("Error occured during merging multiple coverage reports")
+        end
+      end
+
+      if result_path == "" then
+        # Informating user of export paths
+        archive_paths.each do |path|
+          UI.important("Copying .xccovarchive to #{path}") 
+        end
+        report_paths.each do |path|
+          UI.important("Copying .xccovreport to #{path}") 
+        end
+            
+        # Return array of report_paths if coverage reports were not merged
+        return report_paths
+      else
+        # Return merged xccovreport
+        return [result_path]
+      end
     end
   end
 end

data/lib/xcov/model/report.rb

@@ -58,6 +58,10 @@ module Xcov
       # Create target objects
       targets = targets.map { |target| Target.map(target) }.sort { |lhs, rhs| lhs.name <=> rhs.name }
 
+      if !Xcov.config[:include_zero_targets]
+         targets = targets.select { |target| target.coverage > 0 }
+      end
+
       Report.new(targets)
     end
 
@@ -73,7 +77,9 @@ module Xcov
         filtered_targets = filtered_targets.select { |target| self.included_targets.include?(target["name"])}
       end
 
-      supported_targets = Xcov.project.targets
+      filtered_targets = filtered_targets.select { |target| !target["files"].empty? }
+
+      supported_targets = Xcov.config[:is_swift_package] ? [] : Xcov.project.targets
       if Xcov.config[:only_project_targets] && !supported_targets.empty?
         filtered_targets = filtered_targets.select do |target|
           name = target["name"]

data/lib/xcov/options.rb

@@ -77,12 +77,16 @@ module Xcov
           key: :xccov_file_direct_path,
           short_option: "-f",
           env_name: "XCOV_FILE_DIRECT_PATH",
-          description: "The path to the xccoverage/xccovreport/xcresult file to parse to generate code coverage",
+          description: "The path or array of paths to the xccoverage/xccovreport/xcresult files to parse to generate code coverage",
+          type: Array,
           optional: true,
           verify_block: proc do |value|
-            v = File.expand_path(value.to_s)
-            raise "xccoverage/xccovreport/xcresult file does not exist".red unless File.exist?(v)
-            raise "Invalid xccov file type (must be xccoverage, xccovreport, xcresult)".red unless value.end_with? "xccoverage" or value.end_with? "xccovreport" or value.end_with? "xcresult"
+            values = value.is_a?(String) ? [value] : value
+            values.each do |value|
+              v = File.expand_path(value.to_s)
+              raise "xccoverage/xccovreport/xcresult file does not exist".red unless File.exist?(v)
+              raise "Invalid xccov file type (must be xccoverage, xccovreport, xcresult)".red unless value.end_with? "xccoverage" or value.end_with? "xccovreport" or value.end_with? "xcresult"
+            end
           end
         ),
         FastlaneCore::ConfigItem.new(
@@ -101,6 +105,22 @@ module Xcov
           type: String,
           optional: true
         ),
+        FastlaneCore::ConfigItem.new(
+          key: :use_system_scm,
+          env_name: "XCOV_USE_SYSTEM_SCM",
+          description: "Lets xcodebuild use system's scm configuration",
+          optional: true,
+          is_string: false,
+          default_value: false
+        ),
+        FastlaneCore::ConfigItem.new(
+          key: :is_swift_package,
+          env_name: "XCOV_IS_SWIFT_PACKAGE",
+          description: "Enables generating coverage reports for Package.swift derived projects",
+          optional: true,
+          is_string: false,
+          default_value: false
+        ),
 
         # Report options
         FastlaneCore::ConfigItem.new(
@@ -189,6 +209,13 @@ module Xcov
           is_string: false,
           default_value: false
         ),
+        FastlaneCore::ConfigItem.new(
+          key: :include_zero_targets,
+          env_name: "XCOV_INCLUDE_ZERO_TARGETS",
+          description: "Final report will include target even if the coverage is 0%",
+          is_string: false,
+          default_value: true
+        ),
         FastlaneCore::ConfigItem.new(
           key: :exclude_targets,
           optional: true,

data/lib/xcov/version.rb

@@ -1,6 +1,6 @@
 module Xcov
 
-  VERSION = "1.7.4"
+  VERSION = "1.8.1"
   DESCRIPTION = "xcov is a friendly visualizer for Xcode's code coverage files"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcov
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.8.1
 platform: ruby
 authors:
 - Carlos Vidal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: xcov is a friendly visualizer for Xcode's code coverage files
 email:
 - nakioparkour@gmail.com
@@ -209,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: xcov is a friendly visualizer for Xcode's code coverage files