fastlane-plugin-xcresult_to_junit 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb16088624384792afda4ba43156a6485580ab8b0cd808baf10a04c42727f4a
-  data.tar.gz: 447f6c542dcca98230ce368e95d655e768106e7c2eeff2ed758634bed1766d24
+  metadata.gz: 26d80a12ddd11ffb1a610f03fbe2b553e429e50318230aab292e05a7af7c562d
+  data.tar.gz: ead5297fa4ef5adcf6225ba13229202143a51ae2b0194f45d1452fcd1c878cef
 SHA512:
-  metadata.gz: a9ec29588cd4dac9e632675739885695da3b4d010a78c444212383d77dafd622e99a07dc98e954745a007c1310c6d4b0ae778761bb65867a6149cd0abd9526f0
-  data.tar.gz: 7e181a71f6b9a3a331c8b1a969c0b26e28354f5ada6630e4a8d3aa08b8242d53c492d6b68a5573dd6261a0b2e6942a1d51cacac33b8a4149b13e23d3a8a3f656
+  metadata.gz: 889460cd463ecfabf20d363fcb1cd8940eb2e9390950403fcd5409d3a9e566b0dee6aa3200cba0b0869776c87063da9af3a78a4418c0a435c04a8b7fe16fda97
+  data.tar.gz: 0f69ba041ff93232e524f11039b8e703ec06d0d1a26dc3a92132749f81613a4f036afaa8acd74249108d53af3608e9e7eee2ca8ff7139a30969a22a1b4ab78b5

data/README.md

@@ -31,17 +31,20 @@ The below table captures the current requirements this plugin meets. If you have
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
 Ensure you specify the following when you call scan
+
 ```ruby
         fail_build: false, # Allows to continue after scan
         result_bundle: true # Generate xcresult in output directory
 ```
 
 After scan you can call the plugin, which will look something like this
+
 ```ruby
     xcresult_to_junit(xcresult_path: './fastlane/test_output/MyScheme.test_result.xcresult', output_path: './fastlane/test_output/')
 ```
 
 We can get a list of the junit reports generated by doing something like so
+
 ```ruby
     junit_reports = Dir['./test_output/*.junit']
     # Now we can iterate over the reports and send them where they need to go
@@ -52,13 +55,14 @@ We can get a list of the junit reports generated by doing something like so
 
 To run both the tests, and code style validation, run
 
-```
+```bash
 rake
 ```
 
 To automatically fix many of the styling issues, use
-```
-rubocop -a
+
+```bash
+rubocop -A
 ```
 
 ## Issues and Feedback

data/lib/fastlane/plugin/xcresult_to_junit/actions/xcresult_to_junit_action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'fastlane/action'
 require_relative '../helper/xcresult_to_junit_helper'
@@ -6,120 +8,79 @@ module Fastlane
   module Actions
     class XcresultToJunitAction < Action
       def self.run(params)
-        UI.message("The xcresult_to_junit plugin has started!")
-        all_results = Helper::XcresultToJunitHelper.load_results(params[:xcresult_path])['actions']['_values']
-        all_results.each do |test_run|
-          next unless test_run['actionResult']['testsRef'] # Skip if section has no testRef data as this means its not a test run
-          map = {}
-          junit_folder = Helper::XcresultToJunitHelper.save_device_details_to_file(params[:output_path], test_run['runDestination'])
-          test_run_id = test_run['actionResult']['testsRef']['id']['_value']
-          all_tests = Helper::XcresultToJunitHelper.load_object(params[:xcresult_path], test_run_id)['summaries']['_values'][0]['testableSummaries']['_values']
-          test_suites = []
-          all_tests.each do |target|
-            target_name = target['targetName']['_value']
-            unless target['tests']
-              failure_summary = target['failureSummaries']['_values'][0]
-              test_suites << { name: target_name, error: failure_summary['message']['_value'] }
-              next
-            end
-            test_classes = []
-            if defined?(target['tests']['_values'][0]['subtests']['_values'][0]['subtests']['_values'])
-              test_classes = target['tests']['_values'][0]['subtests']['_values'][0]['subtests']['_values']
-            end
-            test_classes.each do |test_class|
-              suite_name = "#{target_name}.#{test_class['name']['_value']}"
-              suite = { name: suite_name, cases: [] }
-              if test_class['subtests']
-                test_class['subtests']['_values'].each do |test|
-                  duration = 0
-                  duration = test['duration']['_value'] if test['duration']
-                  testcase_name = test['name']['_value'].tr('()', '')
-                  tags = testcase_name.split('_')[1..-1]
-                  testcase_name = testcase_name.split('_').first
-                  testcase = { name: testcase_name, time: duration }
-                  map["#{suite_name}.#{testcase_name}"] = { 'files' => [], 'tags' => tags }
+        UI.message('The xcresult_to_junit plugin has started!')
+        result = Helper::XcresultToJunitHelper.fetch_tests(params[:xcresult_path])
 
-                  if defined?(test['summaryRef']['id']['_value'])
-                    summary_ref = test['summaryRef']['id']['_value']
-                    ref = Helper::XcresultToJunitHelper.load_object(params[:xcresult_path], summary_ref)
-                    if defined?(ref['activitySummaries']['_values'])
-                      ref['activitySummaries']['_values'].each do |summary|
-                        next unless summary['attachments']
-                        summary['attachments']['_values'].each do |attachment|
-                          name = attachment['name']['_value']
-                          next unless name != 'kXCTAttachmentLegacyDiagnosticReportData'
-                          timestamp = DateTime.parse(attachment['timestamp']['_value']).to_time.to_i
-                          filename = attachment['filename']['_value']
-                          folder_name = "#{suite_name}.#{testcase_name}"
-                          id = attachment.dig('payloadRef', 'id', '_value')
-                          next if id.nil?
-                          Helper::XcresultToJunitHelper.fetch_screenshot(params[:xcresult_path], "#{junit_folder}/attachments/#{folder_name}", filename.to_s, id) 
-                          map[folder_name]['files'].push({ 'description' => name, 'mime-type' => 'image/png', 'path' => "#{folder_name}/#{filename}", 'timestamp' => timestamp })
-                        end
-                      end
-                    end
+        devices = result['devices']
+        test_plans = result['testNodes']
+        map = {}
+        junit_folder = Helper::XcresultToJunitHelper.save_device_details_to_file(params[:output_path], devices)
+        test_suites = []
 
-                    if defined?(ref['performanceMetrics']['_value'])
-                      performancemetrics = ""
-                      ref['performanceMetrics']['_values'].each do |metric|
-                        metricname = metric['displayName']['_value']
-                        if defined?(metric['baselineAverage']['_value'])
-                          metricbaseline = metric['baselineAverage']['_value']
-                        else
-                          metricbaseline = 0
-                        end
-                        metricmaxdev = metric['maxPercentRelativeStandardDeviation']['_value']
-                        metricunit = metric['unitOfMeasurement']['_value']
-                        metricave = 0
-                        measurecount = 0
-                        metric['measurements']['_values'].each do |measure|
-                          metricave += measure['_value'].to_f
-                          measurecount += 1
-                        end
-                        metricave = (metricave / measurecount).round(2)
-                        if metricbaseline != 0
-                          metricresult = (((metricbaseline.to_f - metricave) / metricbaseline.to_f) * 100).round(2)
-                        else
-                          metricresult = 0
-                        end
-                        performancemetric = "\nMetric: #{metricname}\nResult: #{metricresult}%\nAverage: #{metricave}#{metricunit}\nBaseline: #{metricbaseline}#{metricunit}\nMax Deviation: #{metricmaxdev}%\n\n"
-                        performancemetrics << performancemetric
-                      end
-                      testcase[:performance] = performancemetrics
-                    end
+        test_plans.each do |test_plan|
+          test_plan['children'].each do |test_bundle|
+            test_bundle['children'].each do |test_suite|
+              suite_name = test_suite['name']
+              count = 0
+              passed = 0
+              failed = 0
+              test_cases = []
+              test_suite['children'].each do |test_case|
+                duration = 0.0
+                duration = test_case['duration'].sub('s', '').to_f if test_case['duration']
+                full_testcase_name = test_case['name'].sub('()', '')
+                tags = full_testcase_name.split('_')[1..]
+                testcase = { name: full_testcase_name, time: duration }
+                count += 1
+                if test_case['result'] == 'Passed'
+                  passed += 1
+                elsif test_case['result'] == 'Failed'
+                  failed += 1
+                  test_case['children'].each do |failure|
+                    testcase[:failure] = failure['name'].split(': ')[1]
+                    testcase[:failure_location] = failure['name'].split(': ')[0]
                   end
-                  if test['testStatus']['_value'] == 'Failure'
-                    failure = Helper::XcresultToJunitHelper.load_object(params[:xcresult_path], test['summaryRef']['id']['_value'])['failureSummaries']['_values'][0]
-                    filename = failure.dig('fileName', '_value')
-                    message = failure['message']['_value']
-                    if filename == '<unknown>' || filename.nil?
-                      testcase[:error] = message
-                    else
-                      testcase[:failure] = message
-                      testcase[:failure_location] = "#{filename}:#{failure['lineNumber']['_value']}"
-                    end
-                  end
-                  suite[:cases] << testcase
                 end
+                test_cases << testcase
+                map["#{suite_name}.#{full_testcase_name}"] = { 'files' => [], 'tags' => tags }
               end
-              suite[:count] = suite[:cases].size
-              suite[:failures] = suite[:cases].count { |testcase| testcase[:failure] }
-              suite[:errors] = suite[:cases].count { |testcase| testcase[:error] }
+              suite = { name: suite_name.to_s, count: count, failures: failed, errors: 0, cases: test_cases }
               test_suites << suite
             end
           end
-          Helper::XcresultToJunitHelper.generate_junit(junit_folder, test_suites)
-          Helper::XcresultToJunitHelper.save_screenshot_mapping(map, "#{junit_folder}/attachments/")
         end
-        UI.message("The xcresult_to_junit plugin has finished!")
+
+        Helper::XcresultToJunitHelper.generate_junit(junit_folder, test_suites)
+        attachments_folder = "#{junit_folder}/attachments"
+        Helper::XcresultToJunitHelper.save_attachments(params[:xcresult_path], attachments_folder)
+
+        test_attachments = Helper::XcresultToJunitHelper.fetch_attachment_manifest(attachments_folder)
+
+        test_attachments.each do |test_attachment|
+          test_identifier = test_attachment['testIdentifier']
+          folder_name = test_identifier.sub('()', '').sub('/', '.')
+
+          test_attachment['attachments'].each do |attachment|
+            name = attachment['suggestedHumanReadableName']
+            filename = attachment['exportedFileName']
+            mime_type = 'image/png'
+            mime_type = 'text/plain' if filename.end_with?('.txt')
+            timestamp = attachment['timestamp']
+            map[folder_name]['files'].push({ 'description' => name, 'mime-type' => mime_type, 'path' => filename,
+                                             'timestamp' => timestamp })
+          end
+        end
+
+        Helper::XcresultToJunitHelper.save_screenshot_mapping(map, attachments_folder)
+        UI.message('The xcresult_to_junit plugin has finished!')
       end
 
       def self.description
-        "Produces junit xml files from Xcode 11+ xcresult files"
+        'Produces junit xml files from Xcode 11+ xcresult files'
       end
 
       def self.authors
-        ["Shane Birdsall"]
+        ['Shane Birdsall']
       end
 
       def self.return_value
@@ -127,26 +88,26 @@ module Fastlane
       end
 
       def self.details
-        "By using the xcresulttool this plugin parses xcresult files and generates junit reports to be used with other tools to display iOS test results"
+        'By using the xcresulttool this plugin parses xcresult files and generates junit reports to be used with other tools to display iOS test results'
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :xcresult_path,
-            env_name: "XCRESULT_TO_JUNIT_XCRESULT_PATH",
-            description: "The path to the xcresult file",
-            optional: false,
-            type: String),
+                                       env_name: 'XCRESULT_TO_JUNIT_XCRESULT_PATH',
+                                       description: 'The path to the xcresult file',
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :output_path,
-            env_name: "XCRESULT_TO_JUNIT_OUTPUT_PATH",
-            description: "The path where the output will be placed",
-            optional: false,
-            type: String)
+                                       env_name: 'XCRESULT_TO_JUNIT_OUTPUT_PATH',
+                                       description: 'The path where the output will be placed',
+                                       optional: false,
+                                       type: String)
         ]
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include?(platform)
+        %i[ios mac].include?(platform)
       end
     end
   end

data/lib/fastlane/plugin/xcresult_to_junit/helper/xcresult_to_junit_helper.rb

@@ -1,25 +1,25 @@
+# frozen_string_literal: true
+
 require 'fastlane_core/ui/ui'
 require 'json'
 require 'fileutils'
 
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
 
   module Helper
     class XcresultToJunitHelper
-      def self.load_object(xcresult_path, id)
-        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path} --id #{id}"))
+      def self.fetch_tests(xcresult_path)
+        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get test-results tests --path #{xcresult_path}"))
       end
 
-      def self.load_results(xcresult_path)
-        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path}"))
+      def self.save_attachments(xcresult_path, output_path)
+        FileUtils.mkdir(output_path) unless File.directory?(output_path)
+        FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool export attachments --path #{xcresult_path} --output-path #{output_path}")
       end
 
-      def self.fetch_screenshot(xcresult_path, output_path, file_name, id)
-        unless File.directory?(output_path)
-          FileUtils.mkdir(output_path)
-        end
-        FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool export --path #{xcresult_path} --output-path \"#{output_path}/#{file_name}\" --id #{id} --type file")
+      def self.fetch_attachment_manifest(attachments_folder)
+        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "cat #{attachments_folder}/manifest.json"))
       end
 
       def self.save_screenshot_mapping(map_hash, output_path)
@@ -28,21 +28,24 @@ module Fastlane
         end
       end
 
-      def self.save_device_details_to_file(output_path, device_destination)
-        device_udid = device_destination['targetDeviceRecord']['identifier']['_value']
+      def self.save_device_details_to_file(output_path, devices)
+        device = devices[0]
         device_details = {
-          'udid' => device_udid,
-          'name' => device_destination['targetDeviceRecord']['modelName']['_value'],
-          'os' => device_destination['targetDeviceRecord']['operatingSystemVersion']['_value']
+          'architecture' => device['architecture'],
+          'udid' => device['deviceId'],
+          'name' => device['deviceName'],
+          'model' => device['modelName'],
+          'os' => device['osVersion'],
+          'platform' => device['platform']
         }.to_json
 
-        junit_folder = "#{output_path}/ios-#{device_udid}.junit"
+        junit_folder = "#{output_path}/ios-#{device['deviceId']}.junit"
         FileUtils.rm_rf(junit_folder)
         FileUtils.mkdir_p("#{junit_folder}/attachments")
         File.open("#{junit_folder}/device.json", 'w') do |f|
           f << device_details
         end
-        return junit_folder
+        junit_folder
       end
 
       def self.junit_file_start
@@ -104,9 +107,7 @@ module Fastlane
                 elsif testcase[:error]
                   Helper::XcresultToJunitHelper.junit_testcase_error(testcase)
                 end
-                if testcase[:performance]
-                  Helper::XcresultToJunitHelper.junit_testcase_performance(testcase)
-                end
+                Helper::XcresultToJunitHelper.junit_testcase_performance(testcase) if testcase[:performance]
                 Helper::XcresultToJunitHelper.junit_testcase_end
               end
             end

data/lib/fastlane/plugin/xcresult_to_junit/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Fastlane
   module XcresultToJunit
-    VERSION = "0.3.1"
+    VERSION = '0.4.0'
   end
 end

data/lib/fastlane/plugin/xcresult_to_junit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fastlane/plugin/xcresult_to_junit/version'
 
 module Fastlane

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-xcresult_to_junit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Shane Birdsall
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fastlane
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.134.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.134.0
 description:
 email: shane.birdsall@fiserv.com
 executables: []
@@ -167,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Produces junit xml files from Xcode 11+ xcresult files