danger-xcode_summary 0.5.1 → 1.0.1

data/lib/xcode_summary/plugin.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'xcresult'
 
 module Danger
   # Shows all build errors, warnings and unit tests results generated from `xcodebuild`.
-  # You need to use [xcpretty](https://github.com/supermarin/xcpretty)
-  # with [xcpretty-json-formatter](https://github.com/marcelofabri/xcpretty-json-formatter)
-  # to generate a JSON file that this plugin can read.
+  # You need to use the `xcresult` produced by Xcode 11. It's located in the Derived Data folder.
   # @example Showing summary
   #
-  #          xcode_summary.report 'xcodebuild.json'
+  #          xcode_summary.report 'build.xcresult'
   #
   # @example Filtering warnings in Pods
   #
   #          xcode_summary.ignored_files = '**/Pods/**'
-  #          xcode_summary.report 'xcodebuild.json'
+  #          xcode_summary.report 'build.xcresult'
   #
   # @see  diogot/danger-xcode_summary
   # @tags xcode, xcodebuild, format
@@ -44,18 +43,6 @@ module Danger
     # @return   [Block]
     attr_accessor :ignored_results
 
-    # Defines if the test summary will be sticky or not.
-    # Defaults to `false`.
-    # @param    [Boolean] value
-    # @return   [Boolean]
-    attr_accessor :sticky_summary
-
-    # Defines if the build summary is shown or not.
-    # Defaults to `true`.
-    # @param    [Boolean] value
-    # @return   [Boolean]
-    attr_accessor :test_summary
-
     # Defines if using inline comment or not.
     # Defaults to `false`.
     # @param    [Boolean] value
@@ -83,14 +70,6 @@ module Danger
       @ignored_results ||= block
     end
 
-    def sticky_summary
-      @sticky_summary || false
-    end
-
-    def test_summary
-      @test_summary.nil? ? true : @test_summary
-    end
-
     def inline_mode
       @inline_mode || false
     end
@@ -98,30 +77,41 @@ module Danger
     def ignores_warnings
       @ignores_warnings || false
     end
+
+    # Pick a Dangerfile plugin for a chosen request_source and cache it
+    # based on https://github.com/danger/danger/blob/master/lib/danger/plugin_support/plugin.rb#L31
+    def plugin
+      plugins = Plugin.all_plugins.select { |plugin| Dangerfile.essential_plugin_classes.include? plugin }
+      @plugin ||= plugins.select { |p| p.method_defined? :html_link }.map { |p| p.new(@dangerfile) }.compact.first
+    end
     # rubocop:enable Lint/DuplicateMethods
 
-    # Reads a file with JSON Xcode summary and reports it.
+    # Reads a `.xcresult` and reports it.
     #
-    # @param    [String] file_path Path for Xcode summary in JSON format.
+    # @param    [String] file_path Path for xcresult bundle.
     # @return   [void]
     def report(file_path)
-      if File.file?(file_path)
-        xcode_summary = JSON.parse(File.read(file_path), symbolize_names: true)
+      if File.exist?(file_path)
+        xcode_summary = XCResult::Parser.new(path: file_path)
         format_summary(xcode_summary)
       else
         fail 'summary file not found'
       end
     end
 
-    # Reads a file with JSON Xcode summary and reports its warning and error count.
+    # Reads a `.xcresult` and reports its warning and error count.
     #
-    # @param    [String] file_path Path for Xcode summary in JSON format.
+    # @param    [String] file_path Path for xcresult bundle.
     # @return   [String] JSON string with warningCount and errorCount
     def warning_error_count(file_path)
-      if File.file?(file_path)
-        xcode_summary = JSON.parse(File.read(file_path), symbolize_names: true)
-        warning_count = warnings(xcode_summary).count
-        error_count = errors(xcode_summary).count
+      if File.exist?(file_path)
+        xcode_summary = XCResult::Parser.new(path: file_path)
+        warning_count = 0
+        error_count = 0
+        xcode_summary.actions_invocation_record.actions.each do |action|
+          warning_count += warnings(action).count
+          error_count += errors(action).count
+        end
         result = { warnings: warning_count, errors: error_count }
         result.to_json
       else
@@ -132,104 +122,83 @@ module Danger
     private
 
     def format_summary(xcode_summary)
-      messages(xcode_summary).each { |s| message(s, sticky: sticky_summary) }
-      warnings(xcode_summary).each do |result|
-        if inline_mode && result.location
-          warn(result.message, sticky: false, file: result.location.file_name, line: result.location.line)
-        else
-          warn(result.message, sticky: false)
+      xcode_summary.actions_invocation_record.actions.each do |action|
+        warnings(action).each do |result|
+          if inline_mode && result.location
+            warn(result.message, sticky: false, file: result.location.file_path, line: result.location.line)
+          else
+            warn(result.message, sticky: false)
+          end
         end
-      end
-      errors(xcode_summary).each do |result|
-        if inline_mode && result.location
-          fail(result.message, sticky: false, file: result.location.file_name, line: result.location.line)
-        else
-          fail(result.message, sticky: false)
+        # rubocop:disable Lint/UnreachableLoop
+        errors(action).each do |result|
+          if inline_mode && result.location
+            fail(result.message, sticky: false, file: result.location.file_path, line: result.location.line)
+          else
+            fail(result.message, sticky: false)
+          end
         end
+        # rubocop:enable Lint/UnreachableLoop
       end
     end
 
-    def messages(xcode_summary)
-      if test_summary
-        [
-          xcode_summary[:tests_summary_messages]
-        ].flatten.uniq.compact.map(&:strip)
-      else
-        []
-      end
-    end
-
-    def warnings(xcode_summary)
-      if ignores_warnings
-        return []
-      end
+    def warnings(action)
+      return [] if ignores_warnings
 
       warnings = [
-        xcode_summary.fetch(:warnings, []).map { |message| Result.new(message, nil) },
-        xcode_summary.fetch(:ld_warnings, []).map { |message| Result.new(message, nil) },
-        xcode_summary.fetch(:compile_warnings, {}).map do |h|
-          Result.new(format_compile_warning(h), parse_location(h))
-        end
-      ].flatten.uniq.compact.reject { |result| result.message.nil? }
+        action.action_result.issues.warning_summaries,
+        action.build_result.issues.warning_summaries
+      ].flatten.compact.map do |summary|
+        result = Result.new(summary.message, parse_location(summary.document_location_in_creating_workspace))
+        Result.new(format_warning(result), result.location)
+      end
+      warnings = warnings.uniq.reject { |result| result.message.nil? }
       warnings.delete_if(&ignored_results)
     end
 
-    def errors(xcode_summary)
+    def errors(action)
       errors = [
-        xcode_summary.fetch(:errors, []).map { |message| Result.new(message, nil) },
-        xcode_summary.fetch(:compile_errors, {}).map do |h|
-          Result.new(format_compile_warning(h), parse_location(h))
-        end,
-        xcode_summary.fetch(:file_missing_errors, {}).map do |h|
-          Result.new(format_format_file_missing_error(h), parse_location(h))
-        end,
-        xcode_summary.fetch(:undefined_symbols_errors, {}).map do |h|
-          Result.new(format_undefined_symbols(h), nil)
-        end,
-        xcode_summary.fetch(:duplicate_symbols_errors, {}).map do |h|
-          Result.new(format_duplicate_symbols(h), nil)
-        end,
-        xcode_summary.fetch(:tests_failures, {}).map do |test_suite, failures|
-          failures.map do |failure|
-            Result.new(format_test_failure(test_suite, failure), parse_test_location(failure))
-          end
-        end
-      ].flatten.uniq.compact.reject { |result| result.message.nil? }
-      errors.delete_if(&ignored_results)
-    end
+        action.action_result.issues.error_summaries,
+        action.build_result.issues.error_summaries
+      ].flatten.compact.map do |summary|
+        result = Result.new(summary.message, parse_location(summary.document_location_in_creating_workspace))
+        Result.new(format_warning(result), result.location)
+      end
 
-    def parse_location(input)
-      file_path, line, _column = input[:file_path].split(':')
-      Location.new(input[:file_name], file_path, line.to_i)
-    end
+      test_failures = [
+        action.action_result.issues.test_failure_summaries,
+        action.build_result.issues.test_failure_summaries
+      ].flatten.compact.map do |summary|
+        result = Result.new(summary.message, parse_location(summary.document_location_in_creating_workspace))
+        Result.new(format_test_failure(result, summary.producing_target, summary.test_case_name),
+                   result.location)
+      end
 
-    def parse_test_location(failure)
-      path, line = failure[:file_path].split(':')
-      file_name = relative_path(path)
-      Location.new(file_name, path, line.to_i)
+      results = (errors + test_failures).uniq.reject { |result| result.message.nil? }
+      results.delete_if(&ignored_results)
     end
 
-    def format_path(path)
-      # Pick a Dangerfile plugin for a chosen request_source
-      # based on https://github.com/danger/danger/blob/master/lib/danger/plugin_support/plugin.rb#L31
-      plugins = Plugin.all_plugins.select { |plugin| Dangerfile.essential_plugin_classes.include? plugin }
-      plugin = plugins.select { |p| p.method_defined? :html_link }.map { |p| p.new(@dangerfile) }.compact.first
+    def parse_location(document_location)
+      return nil if document_location.nil?
+
+      file_path = document_location.url.gsub('file://', '').split('#').first
+      file_name = file_path.split('/').last
+      fragment = document_location.url.split('#').last
+      params = CGI.parse(fragment).transform_values(&:first)
+      line = params['StartingLineNumber'].to_i + 1 # StartingLineNumber is 0-based, but we need a 1-based value
+      Location.new(file_name, relative_path(file_path), line)
+    end
 
+    def format_path(file_path, line)
       if plugin
-        clean_path, line = parse_filename(path)
-        path = clean_path + '#L' + line if clean_path && line
+        path = file_path
+        path += "#L#{line}" if line
         plugin.html_link(path)
       else
-        path
+        file_path
       end
     end
 
-    def parse_filename(path)
-      regex = /^(.*?):(\d*):?\d*$/
-      match = path.match(regex)
-      match&.captures
-    end
-
     def relative_path(path)
       return nil if project_root.nil?
 
@@ -237,8 +206,6 @@ module Danger
     end
 
     def should_ignore_warning?(path)
-      parsed = parse_filename(path)
-      path = parsed.first || path
       ignored_files.any? { |pattern| File.fnmatch(pattern, path) }
     end
 
@@ -246,44 +213,22 @@ module Danger
       reason.gsub('>', '\>').gsub('<', '\<')
     end
 
-    def format_compile_warning(input)
-      path = relative_path(input[:file_path])
-      return nil if should_ignore_warning?(path)
-
-      path_link = format_path(path)
+    def format_warning(result)
+      return escape_reason(result.message) if result.location.nil?
 
-      warning = "**#{path_link}**: #{escape_reason(input[:reason])}  <br />"
-      if input[:line] && !input[:line].empty?
-        "#{warning}" \
-          "```\n" \
-          "#{input[:line]}\n" \
-          '```'
-      else
-        warning
-      end
-    end
-
-    def format_format_file_missing_error(input)
-      path = relative_path(input[:file_path])
-      path_link = format_path(path)
-      "**#{escape_reason(input[:reason])}**: #{path_link}"
-    end
+      path = result.location.file_path
+      return nil if should_ignore_warning?(path)
 
-    def format_undefined_symbols(input)
-      "#{input[:message]}  <br />" \
-        "> Symbol: #{input[:symbol]}  <br />" \
-        "> Referenced from: #{input[:reference]}"
-    end
+      path_link = format_path(path, result.location.line)
 
-    def format_duplicate_symbols(input)
-      "#{input[:message]}  <br />" \
-        "> #{input[:file_paths].map { |path| path.split('/').last }.join('<br /> ')}"
+      "**#{path_link}**: #{escape_reason(result.message)}"
     end
 
-    def format_test_failure(suite_name, failure)
-      path = relative_path(failure[:file_path])
-      path_link = format_path(path)
-      "**#{suite_name}**: #{failure[:test_case]}, #{escape_reason(failure[:reason])}  <br />  #{path_link}"
+    def format_test_failure(result, producing_target, test_case_name)
+      path = result.location.file_path
+      path_link = format_path(path, result.location.line)
+      suite_name = "#{producing_target}.#{test_case_name}"
+      "**#{suite_name}**: #{escape_reason(result.message)}  <br />  #{path_link}"
     end
   end
 end

data/spec/fixtures/build_error.xcresult/Data/data.0~M95TCFtTnRKHBi17FlVGNc2kRMfbb_nRcsKPCf3ttPQyiTHHtDZhXhZ7cyeQ_qQ4zMKPS6y7I0oN4BKz0S4Uwg==

@@ -0,0 +1 @@
+[{"name":"scheduling.log","type":1}]

data/spec/fixtures/build_error.xcresult/Data/data.0~YHIIkYp8-XSCi9oQYeEXZLa8EYpvUizVzEQGN5YmnJtTfJ4ujBdfy2EVAk8cUl8jtQskdFE84I-7eu59N9_pLA==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-717D31B2-998D-443A-9732-83EBCBA9820A","type":2}]

data/spec/fixtures/build_error.xcresult/Info.plist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>dateCreated</key>
+	<date>2019-09-27T07:22:32Z</date>
+	<key>externalLocations</key>
+	<array/>
+	<key>rootId</key>
+	<dict>
+		<key>hash</key>
+		<string>0~sMF2ys5sALLwuAv5pBXjiul46mqlgymNeLHDD_y99cE5gPqv8vL-IHIBlpnlNYSO4VvKHlaNafxanp-NDJTh-A==</string>
+	</dict>
+	<key>storage</key>
+	<dict>
+		<key>backend</key>
+		<string>fileBacked2</string>
+		<key>compression</key>
+		<string>standard</string>
+	</dict>
+	<key>version</key>
+	<dict>
+		<key>major</key>
+		<integer>3</integer>
+		<key>minor</key>
+		<integer>21</integer>
+	</dict>
+</dict>
+</plist>

data/spec/fixtures/pr_json.json

@@ -1,8 +1,8 @@
 {
   "head": {
     "repo": {
-      "html_url": "https://github.com/diogot/danger-xcode_summary"
+      "html_url": "https://github.com/realm/SwiftLint"
     },
-    "sha": "129jef029jf029fj2039fj203f92"
+    "sha": "f211694e7def13785ff62047386437534541d7b3"
   }
 }

data/spec/fixtures/swiftlint.xcresult/Data/data.0~0-xWm2AiZ5I3ekRhpAO8g4-GGm1rZIaTIaO2e60GD8nRSProBd-a_Yc1i7HKUd7bcVhfz2trCFFjRoELo2Srsw==

@@ -0,0 +1 @@
+[{"name":"tmp","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~0S6H6SLQKxWYgRYf_D_1IY-6QHDo-BsTnbSwsmikZV81avlhu5M1VAH-NOUVMY64xcmrqOJTvhE3NuQQTem2Cw==

@@ -0,0 +1 @@
+[{"name":"3F900B69-F5EC-478D-BA29-87F9FB623201","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~4ybc14a0wWeJTE6Wyco_E5GMC4AV1uhumwDmYN_qe_Xatx7ngcL09_ef5aIBySSqpNNu4zcclYpHn9GrlNRuFQ==

@@ -0,0 +1 @@
+[{"name":"F9CCDEE8-4362-4C21-B875-F7B8F18F3544","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~6gayYzI1pf7Ae5plNUTUjxPN56sJMCVjiFgbL47tofr0MkqR24pCBQ_WR8ObwxOF1d0CMgO6xzegongDrChlJg==

@@ -0,0 +1 @@
+[{"name":"remote-container","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~8sQuTfDcyJlc0Fi-_NLh3a8jvYBs_okTaD87IqdKyCzN32fu0jp6ApVWBgFD38xL2_Q87YDxQ6IxUZv7NNvqow==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-3F900B69-F5EC-478D-BA29-87F9FB623201.xctestconfiguration","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~E-76cUuxKNsc00En6QiGIdNWgUkhPKWbzbY-g7Xs1I8QHEMM8XUyKPxeMCp0ZXs_s4n1v1-sgg4Cr_BgvCBB6Q==

@@ -0,0 +1 @@
+[{"name":"tmp","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~LpdFNGBXQ0G_AiEBUv6jWVmPykDLvumWlLqe9FOU9Sautm_uAIUhkdYsC3Ai7CHCV6Ec_A9EgLa5dzbuBuSm0Q==

@@ -0,0 +1 @@
+[{"name":"remote-container","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~OZKuCYOwI0z3jDNmJQ-bb0OUCKuFWw1iz9Na6m-M3pOyVRqP09YONvdvG1ezCE57EI5b8Ym9g8hX1ZVZJg124w==

@@ -0,0 +1 @@
+[{"name":"testmanagerd.log","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~PgE51YCf92l9xvNpSiVbHOmsnaRpxz_zGezAUjflsYK7nfGH7YRTDdb1jnNn0WlHUlme8-fO8fPQRJ9n51hfPg==

@@ -0,0 +1 @@
+[{"name":"tmp","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~QLGQgkmvGM1G0GFHWwBAJoAn881RCWKI51niXWwchH2k_1ahgBUMANJWO98yUC5HwqptnBQLC0aoD4GE7Zb3Yg==

@@ -0,0 +1 @@
+[{"name":"77498EA3-2A59-44A5-B19F-A0C57B3EC49F","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~Vo-bwGSGWiUUFgBwAGdskHUHwVQh0q8hYJmYmmyHI4AVhbtLsMeJQyYvHOuTuPmJcJsX_4bDig3Mg1GPwE9oWw==

@@ -0,0 +1 @@
+[{"name":"tmp","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~YBV5ZYd3le3PYE4Xz7kCb4sj6ZJ25X18ArIVKxMOCZHZ479XzQByz07m8qpm3hIL3oUPozbag-zRSomHuRfKLQ==

@@ -0,0 +1 @@
+[{"name":"E93E260B-423F-4759-8BD9-2AE47867F8DD","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~bC3ChphZGxwicYgFPaTJhJvXLOQJmKnAxXU_qdERqu-B1727kHJX61TfzqMUqRiPUwu5E9r_5RH_xoRYJ2L6gQ==

@@ -0,0 +1 @@
+[{"name":"remote-container","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~fg_OE_1GIKhnHZVCf6vX3IBffLrmbWUH4AsgsdCfNDOxp0B_FS01mzFt8QUR8SFpl0wzqzGZLqQjyYhO6RevrQ==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-F9CCDEE8-4362-4C21-B875-F7B8F18F3544.xctestconfiguration","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~j4nemHY9VBZOlHsEur0YydlrsprTU9r-MZEFaCsZ71qzr_Y2j_wX_zeb8BIyCfQq6WCHDuJGwCvDxYGxFHFKJQ==

@@ -0,0 +1 @@
+[{"name":"remote-container","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~jLxEh4TDlOXovDeeA90ahrPFfK6KWCWAM1RveDzpglwOI01s2gFfzKcZ5uuMA4PDXedeCvNf2DqCdKJIcgHnVQ==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-71CB433F-92ED-404B-8661-635EAA88242D.xctestconfiguration","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~oRai0E4F38qqrWTBu_VggauLdzUNvBJ9uOpjjW4rdru1cdBUSmJsWp7wGRoTaegMas7lrFfF7hqYW76UAkN_Aw==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-77498EA3-2A59-44A5-B19F-A0C57B3EC49F.xctestconfiguration","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~qvKb6_pMbXLkop24YkPLBvBGPB0vTCJVE1x5_F3lvNeXSrkS-aTEVLcbm50ypOEDTvq5lWbE3WCTmiwTrycTtA==

@@ -0,0 +1 @@
+[{"name":"remote-container","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~ryOJ0LA52DIkg1NBt38A9g4laq_cWjst7WaY2GqaYbfcPtErYNGwwseRWOUJ888fdbPpei28zwb3FQmyyY0P7A==

@@ -0,0 +1 @@
+[{"name":"71CB433F-92ED-404B-8661-635EAA88242D","type":2}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~xgcJ3zOq4tRMu41EmxgQwt9WxpLQm2v2wbY1e8CAQ8EEYhNYnBcMTAFjYWFgIg4LKguSsH1Djbu9dtiDJ6ZXww==

@@ -0,0 +1 @@
+[{"name":"SwiftLintFrameworkTests-E93E260B-423F-4759-8BD9-2AE47867F8DD.xctestconfiguration","type":1}]

data/spec/fixtures/swiftlint.xcresult/Data/data.0~ygm24RJKzu1R3AxMJebgBRXDXv1XqRs_UZUYB9XNRQlwNRqHlLdmUDM2A0c5MZ0rM9Rzk8J6DVpUtgbXCqdEig==

@@ -0,0 +1 @@
+[{"name":"tmp","type":2}]