fastlane-plugin-xcresult_to_junit 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1148c0c7a8073cf7e839095b600304076b3347816a4ddc4d7cb2e0a7037fdc00
-  data.tar.gz: a619ba21e9a4f6ca4d225c3c3a2da76685d40cbc1501e7b45346fca995d2652c
+  metadata.gz: 5fb16088624384792afda4ba43156a6485580ab8b0cd808baf10a04c42727f4a
+  data.tar.gz: 447f6c542dcca98230ce368e95d655e768106e7c2eeff2ed758634bed1766d24
 SHA512:
-  metadata.gz: a4eb1e3c72642ce13efbc0fc839dec2415cfe53ff50cf2d9c058995a76f7d69378d34efdda1167aa95e0ffe203a1b4ed8a26c4b3c00de682fdddbab2e887e018
-  data.tar.gz: e0971b4c44766e3f11bdb6301462a0e732cac9e87edd098122dc72390e6f96c575f7b9ab36c36317c15dc050013f8584959eac263b0c19fb60f7aac2aec61584
+  metadata.gz: a9ec29588cd4dac9e632675739885695da3b4d010a78c444212383d77dafd622e99a07dc98e954745a007c1310c6d4b0ae778761bb65867a6149cd0abd9526f0
+  data.tar.gz: 7e181a71f6b9a3a331c8b1a969c0b26e28354f5ada6630e4a8d3aa08b8242d53c492d6b68a5573dd6261a0b2e6942a1d51cacac33b8a4149b13e23d3a8a3f656

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

@@ -9,78 +9,107 @@ module Fastlane
         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|
-          if 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}
+          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 }
 
-                    if defined?(test['summaryRef']['id']['_value'])
-                      summaryRef = test['summaryRef']['id']['_value']
-                      ref = Helper::XcresultToJunitHelper.load_object(params[:xcresult_path], summaryRef)
-                      if defined?(ref['activitySummaries']['_values'])
-                        ref['activitySummaries']['_values'].each do |summary|
-                          if summary['attachments']
-                            summary['attachments']['_values'].each do |attachment|
-                              timestamp = DateTime.parse(attachment['timestamp']['_value']).to_time.to_i
-                              name = attachment['name']['_value']
-                              folder_name = "#{suite_name}.#{testcase_name}"
-                              id = attachment['payloadRef']['id']['_value']
-                              Helper::XcresultToJunitHelper.fetch_screenshot(params[:xcresult_path], "#{junit_folder}/attachments/#{folder_name}", "#{id}.png", id)
-                              map[folder_name]['files'].push({'description' => name, 'mime-type' => 'image/png', 'path' => "#{folder_name}/#{id}.png", 'timestamp' => timestamp})
-                            end
-                          end
+                  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
 
-                    if test['testStatus']['_value'] == 'Failure'
-                      failure = Helper::XcresultToJunitHelper.load_object(params[:xcresult_path], test['summaryRef']['id']['_value'])['failureSummaries']['_values'][0]
-                      filename = failure['fileName']['_value']
-                      message = failure['message']['_value']
-                      if filename == '<unknown>'
-                        testcase[:error] = message
-                      else
-                        testcase[:failure] = message
-                        testcase[:failure_location] = "#{filename}:#{failure['lineNumber']['_value']}"
+                    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
-                    suite[:cases] << testcase
                   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
-                suite[:count] = suite[:cases].size
-                suite[:failures] = suite[:cases].count { |testcase| testcase[:failure] }
-                suite[:errors] = suite[:cases].count { |testcase| testcase[:error] }
-                test_suites << suite
               end
+              suite[:count] = suite[:cases].size
+              suite[:failures] = suite[:cases].count { |testcase| testcase[:failure] }
+              suite[:errors] = suite[:cases].count { |testcase| testcase[:error] }
+              test_suites << suite
             end
-            Helper::XcresultToJunitHelper.generate_junit(junit_folder, test_suites)
-            Helper::XcresultToJunitHelper.save_screenshot_mapping(map, "#{junit_folder}/attachments/")
           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!")
       end
@@ -108,17 +137,17 @@ module Fastlane
             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)
-            ]
-          end
-          
-          def self.is_supported?(platform)
-            [:ios, :mac].include?(platform)
-          end
-        end
+          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)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
       end
     end
+  end
+end

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

@@ -8,18 +8,18 @@ module Fastlane
   module Helper
     class XcresultToJunitHelper
       def self.load_object(xcresult_path, id)
-        JSON.load FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path} --id #{id}")
+        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path} --id #{id}"))
       end
 
       def self.load_results(xcresult_path)
-        JSON.load FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path}")
+        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get --format json --path #{xcresult_path}"))
       end
 
       def self.fetch_screenshot(xcresult_path, output_path, file_name, id)
-        if !File.directory?(output_path)
-          FileUtils.mkdir output_path
+        unless File.directory?(output_path)
+          FileUtils.mkdir(output_path)
         end
-        JSON.load FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool export --path #{xcresult_path} --output-path #{output_path}/#{file_name} --id #{id} --type file")
+        FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool export --path #{xcresult_path} --output-path \"#{output_path}/#{file_name}\" --id #{id} --type file")
       end
 
       def self.save_screenshot_mapping(map_hash, output_path)
@@ -37,9 +37,8 @@ module Fastlane
         }.to_json
 
         junit_folder = "#{output_path}/ios-#{device_udid}.junit"
-        FileUtils.rm_rf junit_folder
-        FileUtils.mkdir junit_folder
-        FileUtils.mkdir "#{junit_folder}/attachments"
+        FileUtils.rm_rf(junit_folder)
+        FileUtils.mkdir_p("#{junit_folder}/attachments")
         File.open("#{junit_folder}/device.json", 'w') do |f|
           f << device_details
         end
@@ -47,52 +46,52 @@ module Fastlane
       end
 
       def self.junit_file_start
-        puts '<?xml version="1.0" encoding="UTF-8"?>'
-        puts '<testsuites>'
+        puts('<?xml version="1.0" encoding="UTF-8"?>')
+        puts('<testsuites>')
       end
 
       def self.junit_file_end
-        puts '</testsuites>'
+        puts('</testsuites>')
       end
 
       def self.junit_suite_error(suite)
-        puts "<testsuite name=#{suite[:name].encode xml: :attr} errors='1'>"
-        puts "<error>#{suite[:error].encode xml: :text}</error>"
+        puts("<testsuite name=#{suite[:name].encode(xml: :attr)} errors='1'>")
+        puts("<error>#{suite[:error].encode(xml: :text)}</error>")
       end
 
       def self.junit_suite_start(suite)
-        puts "<testsuite name=#{suite[:name].encode xml: :attr} tests='#{suite[:count]}' failures='#{suite[:failures]}' errors='#{suite[:errors]}'>"
+        puts("<testsuite name=#{suite[:name].encode(xml: :attr)} tests='#{suite[:count]}' failures='#{suite[:failures]}' errors='#{suite[:errors]}'>")
       end
 
       def self.junit_suite_end
-        puts '</testsuite>'
+        puts('</testsuite>')
       end
 
       def self.junit_testcase_start(suite, testcase)
-        print "<testcase name=#{testcase[:name].encode xml: :attr} classname=#{suite[:name].encode xml: :attr} time='#{testcase[:time]}'"
+        print("<testcase name=#{testcase[:name].encode(xml: :attr)} classname=#{suite[:name].encode(xml: :attr)} time='#{testcase[:time]}'>")
       end
 
-      def self.junit_testcase_success
-        puts '/>'
+      def self.junit_testcase_end
+        puts('</testcase>')
       end
 
       def self.junit_testcase_failure(testcase)
-        puts '>'
-        puts "<failure message=#{testcase[:failure].encode xml: :attr}>#{testcase[:failure_location].encode xml: :text}</failure>"
-        puts '</testcase>'
+        puts("<failure message=#{testcase[:failure].encode(xml: :attr)}>#{testcase[:failure_location].encode(xml: :text)}</failure>")
       end
 
       def self.junit_testcase_error(testcase)
-        puts '>'
-        puts "<error>#{testcase[:error].encode xml: :text}</error>"
-        puts '</testcase>'
+        puts("<error>#{testcase[:error].encode(xml: :text)}</error>")
+      end
+
+      def self.junit_testcase_performance(testcase)
+        puts("<system-out>#{testcase[:performance]}</system-out>")
       end
 
       def self.generate_junit(junit_folder, test_suites)
         File.open("#{junit_folder}/results.xml", 'w') do |fo|
           old_stdout = $stdout
           $stdout = fo
-          Helper::XcresultToJunitHelper.junit_file_start()
+          Helper::XcresultToJunitHelper.junit_file_start
           test_suites.each do |suite|
             if suite[:error]
               Helper::XcresultToJunitHelper.junit_suite_error(suite)
@@ -104,14 +103,16 @@ module Fastlane
                   Helper::XcresultToJunitHelper.junit_testcase_failure(testcase)
                 elsif testcase[:error]
                   Helper::XcresultToJunitHelper.junit_testcase_error(testcase)
-                else
-                  Helper::XcresultToJunitHelper.junit_testcase_success()
                 end
+                if testcase[:performance]
+                  Helper::XcresultToJunitHelper.junit_testcase_performance(testcase)
+                end
+                Helper::XcresultToJunitHelper.junit_testcase_end
               end
             end
-            Helper::XcresultToJunitHelper.junit_suite_end()
+            Helper::XcresultToJunitHelper.junit_suite_end
           end
-          Helper::XcresultToJunitHelper.junit_file_end()
+          Helper::XcresultToJunitHelper.junit_file_end
           $stdout = old_stdout
         end
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module XcresultToJunit
-    VERSION = "0.2.3"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-xcresult_to_junit
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Shane Birdsall
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.134.0
-description: 
+description:
 email: shane.birdsall@fiserv.com
 executables: []
 extensions: []
@@ -152,7 +152,7 @@ homepage: https://github.com/zanizrules/fastlane-plugin-xcresult_to_junit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,9 +167,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Produces junit xml files from Xcode 11+ xcresult files
 test_files: []