fastlane-plugin-xcresult_to_junit_fork 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87712d914f0288a505e7e088508dddb0dd8fa3a7353673c0e18a647709f44587
+  data.tar.gz: c8d64c5c6055df94bac0cb57d71dbe619a160457d1e5ee55e626e2ede112c785
+SHA512:
+  metadata.gz: dc22eafeef1ce220a5a6fd389d5d5e9a09170dd28d17225737934b3d74d438a1cde5c0074d549428a1bba73177720f8abc4e3fe322e65ea0d8b85fb3137a0e9f
+  data.tar.gz: db65c89d49cf4431cdcce3a89c29ca68744c270e7b23de8676a573d3b9d338c3d1a3130a5bf7c1f618e3a490116a925dd24e21ab95fe44347cdb4a4816547ffb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shane Birdsall <shane.birdsall@fiserv.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# xcresult_to_junit plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-xcresult_to_junit)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-xcresult_to_junit`, add it to your project by running:
+
+```bash
+fastlane add_plugin xcresult_to_junit
+```
+
+## About xcresult_to_junit
+
+This plugin produces junit xml files from Xcode 11+ xcresult files.
+
+This tool is not designed to work with result files produced with xcode versions older than xcode 11.
+
+My main motivation behind creating my own solution was to have a plugin that works in a variety of testing scenarios.
+The below table captures the current requirements this plugin meets. If you have a requirement that is not met by this plugin and would like to contribute then please feel free :metal:
+
+| Requirement                           | Status             |
+|---------------------------------------|--------------------|
+| Works against one iOS device          | :white_check_mark: |
+| Works against multiple iOS device     | :white_check_mark: |
+| Generates one junit report per target | :white_check_mark: |
+| Works with modern formats (Xcode 11+) | :white_check_mark: |
+
+## Example
+
+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
+    # My test_output folder would ideally have been cleaned before this test run to avoid old results
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```bash
+rake
+```
+
+To automatically fix many of the styling issues, use
+
+```bash
+rubocop -A
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/xcresult_to_junit.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'fastlane/plugin/xcresult_to_junit_fork/version'
+
+module Fastlane
+  module XcresultToJunit
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::XcresultToJunit.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'fastlane/action'
+require_relative '../helper/xcresult_to_junit_helper'
+
+module Fastlane
+  module Actions
+    class XcresultToJunitAction < Action
+      def self.run(params)
+        UI.message('The xcresult_to_junit plugin has started!')
+        result = Helper::XcresultToJunitHelper.fetch_tests(params[:xcresult_path])
+
+        devices = result['devices']
+        test_plans = result['testNodes']
+
+        devices.each do |device|
+          map = {}
+          junit_folder = Helper::XcresultToJunitHelper.save_device_details_to_file(params[:output_path], [device])
+          test_suites = []
+
+          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
+                    testcase[:failure] ||= []
+                    testcase[:failure_location] ||= []
+                    test_case['children'].each do |failure|
+                      if failure['nodeType'] == 'Repetition'
+                        failure['children'].each do |retry_failure|
+                          testcase[:failure] << retry_failure['name']
+                          testcase[:failure_location] << failure['name']
+                        end
+                      elsif failure['nodeType'] == 'Failure Message'
+                        testcase[:failure] << failure['name']
+                        testcase[:failure_location] << failure['name'].split(': ')[0]
+                      end
+                    end
+                  end
+                  test_cases << testcase
+                  map["#{suite_name}.#{full_testcase_name}"] = { 'files' => [], 'tags' => tags }
+                end
+                suite = { name: suite_name.to_s, count: count, failures: failed, errors: 0, cases: test_cases }
+                test_suites << suite
+              end
+            end
+          end
+
+          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'].reverse().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' => [] }
+              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)
+        end
+        UI.message('The xcresult_to_junit plugin has finished!')
+      end
+
+      def self.description
+        'Produces junit xml files from Xcode 11+ xcresult files'
+      end
+
+      def self.authors
+        ['Shane Birdsall']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      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'
+      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),
+          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)
+        %i[ios mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'fastlane_core/ui/ui'
+require 'json'
+require 'fileutils'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
+
+  module Helper
+    class XcresultToJunitHelper
+      def self.fetch_tests(xcresult_path)
+        JSON.parse(FastlaneCore::CommandExecutor.execute(command: "xcrun xcresulttool get test-results tests --path #{xcresult_path}"))
+      end
+
+      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_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)
+        File.open("#{output_path}/map.json", 'w') do |f|
+          f << map_hash.to_json
+        end
+      end
+
+      def self.save_device_details_to_file(output_path, devices)
+        device = devices[0]
+        device_details = {
+          '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['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
+        junit_folder
+      end
+
+      def self.junit_file_start
+        puts('<?xml version="1.0" encoding="UTF-8"?>')
+        puts('<testsuites>')
+      end
+
+      def self.junit_file_end
+        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>")
+      end
+
+      def self.junit_suite_start(suite)
+        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>')
+      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]}'>")
+      end
+
+      def self.junit_testcase_end
+        puts('</testcase>')
+      end
+
+      def self.junit_testcase_failure(testcase)
+        if testcase[:failure].length != testcase[:failure_location].length
+          raise "Mismatch in lengths: testcase[:failure] and testcase[:failure_location] must have the same length."
+        end
+        for index in 0...testcase[:failure].length
+          failure = testcase[:failure][index]
+          failure_location = testcase[:failure_location][index]
+          puts("<failure message=#{failure.encode(xml: :attr)}>#{failure_location.encode(xml: :text)}</failure>")
+        end
+      end
+
+      def self.junit_testcase_error(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
+          test_suites.each do |suite|
+            if suite[:error]
+              Helper::XcresultToJunitHelper.junit_suite_error(suite)
+            else
+              Helper::XcresultToJunitHelper.junit_suite_start(suite)
+              suite[:cases].each do |testcase|
+                Helper::XcresultToJunitHelper.junit_testcase_start(suite, testcase)
+                if testcase[:failure]
+                  Helper::XcresultToJunitHelper.junit_testcase_failure(testcase)
+                elsif testcase[:error]
+                  Helper::XcresultToJunitHelper.junit_testcase_error(testcase)
+                end
+                Helper::XcresultToJunitHelper.junit_testcase_performance(testcase) if testcase[:performance]
+                Helper::XcresultToJunitHelper.junit_testcase_end
+              end
+            end
+            Helper::XcresultToJunitHelper.junit_suite_end
+          end
+          Helper::XcresultToJunitHelper.junit_file_end
+          $stdout = old_stdout
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fastlane
+  module XcresultToJunit
+    VERSION = '0.4.4'
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-xcresult_to_junit_fork
+version: !ruby/object:Gem::Version
+  version: 0.4.4
+platform: ruby
+authors:
+- Jack Hosking
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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:
+email: jack.hosking@fiserv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/xcresult_to_junit.rb
+- lib/fastlane/plugin/xcresult_to_junit_fork/actions/xcresult_to_junit_action.rb
+- lib/fastlane/plugin/xcresult_to_junit_fork/helper/xcresult_to_junit_helper.rb
+- lib/fastlane/plugin/xcresult_to_junit_fork/version.rb
+homepage: https://github.com/zanizrules/fastlane-plugin-xcresult_to_junit
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: 'A Fork of fastlane-plugin-xcresult_to_junit: Produces junit xml files from
+  Xcode 11+ xcresult files'
+test_files: []