danger-xcode_summary 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3207822c2dfeb0e69985f941835fa80d06ed3d0ae43e27576a2bcc72bfe8aea3
-  data.tar.gz: 17cb5713024a7874cf08d0f1fb1708bfacf53d865f889eaa1b76dbe2fa28342f
+  metadata.gz: e30986734f1f4563b6c7f58e5765cb2b00be9bf4cc86ae03c88485d429009e3e
+  data.tar.gz: 570891d22c3fbb5a9b2cdbb61dab1833ac8570013e0c2689886b78702cbff368
 SHA512:
-  metadata.gz: 8ee02ac8c805c7f49a739e4384b656cfe24e81c04f2ff0ae108b0e78616d4b84a5ed846fa9784af99801016254434fe027541b1f4044f26265e31363de25147d
-  data.tar.gz: ba9211234bc2a64d42fbabee964bbe55ad12e18a48b6e6f7df53d4dee15809c20bb7e4615e66cf669d49ed4e86378cd7678c2f8b3f164b101f1a1e3cafb880ea
+  metadata.gz: dac17c30dbeaf27f6b026c82f213a8d6ede70623c05bd811ab352957dde61b9a7c402ebca595146b161b8a82c3405e7cc93002c950363aa4262bee9d17267f76
+  data.tar.gz: 32db5f742803b7cc51d46be5825a644be65d40c89b790db6cfad3e15312b099f58912b7febb542767ee0dd8ef63fd703a059ae20c2b80ee1765bdea8dbdbf05b

data/.gitattributes

@@ -0,0 +1 @@
+*.xcresult binary

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
 # kind_of? is a good way to check a type
 Style/ClassCheck:
   EnforcedStyle: kind_of?

data/.travis.yml

@@ -3,9 +3,17 @@ cache:
   directories:
     - bundle
 
+os: osx
+osx_image: xcode11
+
 rvm:
   - 2.6.0
   - 2.5.3
 
+# install bundler 2.x
+before_install:
+    - gem update --system
+    - gem install bundler
+
 script:
     - bundle exec rake spec

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in danger-xcode_summary.gemspec

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    danger-xcode_summary (0.5.3)
+    danger-xcode_summary (1.0.0)
       danger-plugin-api (~> 1.0)
+      xcresult (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -137,6 +138,7 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.1.0)
     unicode-display_width (2.0.0)
+    xcresult (0.2.1)
     yard (0.9.26)
 
 PLATFORMS
@@ -156,4 +158,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.17
+   2.2.26

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A guardfile for making Danger Plugins
 # For more info see https://github.com/guard/guard#readme
 

data/README.md

@@ -6,12 +6,6 @@
 
 A [Danger](http://danger.systems) plugin that 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.
-
-**Using [danger-swift](https://github.com/danger/swift)**? You may want to take a look at [danger-swift-xcodesummary](https://github.com/f-meloni/danger-swift-xcodesummary).
-
 ## How does it look?
 
 <table>
@@ -62,24 +56,6 @@ to generate a JSON file that this plugin can read.
   </tbody>
 </table>
 
-<table>
-  <thead>
-    <tr>
-      <th width="50"></th>
-      <th width="100%">
-          1 Message
-      </th>
-     </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><g-emoji alias="book" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f4d6.png">📖</g-emoji></td>
-      <td>Executed 5 tests, with 1 failure (0 unexpected) in 0.032 (0.065) seconds</td>
-    </tr>
-      </tr>
-  </tbody>
-</table>
-
 ## Installation
 
 Add this line to your Gemfile:
@@ -93,9 +69,13 @@ gem 'danger-xcode_summary'
 Just add this line to your `Dangerfile`:
 
 ```ruby
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
+You need to pass the path of the `xcresult` generated after compiling your app.
+By default, this is inside the `DerivedData` for your project, but you can use the `-resultBundlePath`
+flag when calling `xcodebuild` to customize its path. You can read more about it in this [blog post from the folks at PSPDFKit](https://pspdfkit.com/blog/2021/deflaking-ci-tests-with-xcresults/#using-xcresult-bundles).
+
 You can also ignore warnings from certain files by setting `ignored_files`: 
 Warning: `ignored_files` patterns applied on relative paths.  
 
@@ -105,10 +85,10 @@ xcode_summary.ignored_files = 'Pods/**'
 
 # Ignoring specific warnings
 xcode_summary.ignored_results { |result|
-  result.message.start_with? 'ld' # Ignore ld_warnings
+  result.message.include? 'ld' # Ignore ld_warnings
 }
 
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
 You can use `ignores_warnings` to supress warnings and shows only errors.
@@ -123,13 +103,13 @@ When this value is enabled, each warnings and errors are commented on each lines
 ```ruby
 # Comment on each lines
 xcode_summary.inline_mode = true
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
-You can get warning and error number by calling `warning_error_count`. The return will be a JSON string contains warning and error count, e.g {"warnings":1,"errors":3}:
+You can get warning and error number by calling `warning_error_count`. The return will be a JSON string contains warning and error count, e.g `{"warnings":1,"errors":3}`:
 
 ```ruby
-result = xcode_summary.warning_error_count 'xcodebuild.json'
+result = xcode_summary.warning_error_count 'MyApp.xcresult'
 ```
 
 ## License

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/danger-xcode_summary.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'xcode_summary/gem_version.rb'
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.4.0"
 
+  spec.add_dependency 'xcresult', '~> 0.2'
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
 
   # General ruby development

data/lib/xcode_summary/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XcodeSummary
-  VERSION = '0.5.3'
+  VERSION = '1.0.0'
 end

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
@@ -107,28 +86,32 @@ module Danger
     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
@@ -139,102 +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
-      # rubocop:disable Lint/UnreachableLoop
-      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
-      # rubocop:enable Lint/UnreachableLoop
     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
+
+      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_location(input)
-      file_path, line, _column = input[:file_path].split(':')
-      file_name = relative_path(file_path)
-      Location.new(file_name, file_path, line.to_i)
+      results = (errors + test_failures).uniq.reject { |result| result.message.nil? }
+      results.delete_if(&ignored_results)
     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)
+    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(path)
+    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?
 
@@ -242,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
 
@@ -251,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)
-
-      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_warning(result)
+      return escape_reason(result.message) if result.location.nil?
 
-    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