fastlane-plugin-xcresult_to_junit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5757e2a9823c97cfa45d23ac665ed098c7cae0736484b9f6c3467b9c6d94aa2
+  data.tar.gz: 591790faba5cd45cbf2d4611ed8a7b7fe9218a98bbf277e21a7cad294b542871
+SHA512:
+  metadata.gz: 50ff098a3dfa44f066d477985fedf2e138b1007648b618911c2b4c1681d7134d13d0f10524882ab17687662c370c01c282ffd356070232ea8c539c8161234859
+  data.tar.gz: c8a5783667857c1cc03e25e48df679b9e1721ff00f90d710250daea7debdb82e68b613397f0dd48e273e237a2bc1d168c62f35345f4084a0b653bd23da110bbf

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,78 @@
+# 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: './test_output/MyScheme.test_result.xcresult', output_path: './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
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+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,16 @@
+require 'fastlane/plugin/xcresult_to_junit/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/actions/xcresult_to_junit_action.rb

@@ -0,0 +1,93 @@
+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!")
+        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
+            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 = target['tests']['_values'][0]['subtests']['_values'][0]['subtests']['_values']
+              test_classes.each do |test_class|
+                suite = { name: "#{target_name}.#{test_class['name']['_value']}", 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'], time: duration }
+                    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']}"
+                      end
+                    end
+                    suite[:cases] << testcase
+                  end
+                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
+            end
+            junit_folder = Helper::XcresultToJunitHelper.save_device_details_to_file(params[:output_path], test_run['runDestination'])
+            Helper::XcresultToJunitHelper.generate_junit(junit_folder, test_suites)
+          end
+        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)
+            [:ios, :mac].include?(platform)
+          end
+        end
+      end
+    end

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

@@ -0,0 +1,106 @@
+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.load_object(xcresult_path, id)
+        JSON.load 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}")
+      end
+
+      def self.save_device_details_to_file(output_path, device_destination)
+        device_udid = device_destination['targetDeviceRecord']['identifier']['_value']
+        device_details = {
+          'udid' => device_udid,
+          'name' => device_destination['targetDeviceRecord']['modelName']['_value'],
+          'os' => device_destination['targetDeviceRecord']['operatingSystemVersion']['_value']
+        }.to_json
+
+        junit_folder = "#{output_path}/ios-#{device_udid}.junit"
+        FileUtils.rm_rf junit_folder
+        FileUtils.mkdir junit_folder
+        File.open("#{junit_folder}/device.json", 'w') do |f|
+          f << device_details
+        end
+        return 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 classname=#{suite[:name].encode xml: :attr} name=#{testcase[:name].encode xml: :attr} time='#{testcase[:time]}'"
+      end
+
+      def self.junit_testcase_success
+        puts '/>'
+      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>'
+      end
+
+      def self.junit_testcase_error(testcase)
+        puts '>'
+        puts "<error>#{testcase[:error].encode xml: :text}</error>"
+        puts '</testcase>'
+      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)
+                else
+                  Helper::XcresultToJunitHelper.junit_testcase_success()
+                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/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module XcresultToJunit
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-xcresult_to_junit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shane Birdsall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-13 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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: 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'
+- !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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/xcresult_to_junit.rb
+- lib/fastlane/plugin/xcresult_to_junit/actions/xcresult_to_junit_action.rb
+- lib/fastlane/plugin/xcresult_to_junit/helper/xcresult_to_junit_helper.rb
+- lib/fastlane/plugin/xcresult_to_junit/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.0.2
+signing_key: 
+specification_version: 4
+summary: Produces junit xml files from Xcode 11+ xcresult files
+test_files: []