trainer 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e3f70b7df496d9fabd93521f0570b31c8246c65
-  data.tar.gz: 5b905c28029b08d09b4c76784669b422c971843c
+SHA256:
+  metadata.gz: 370827f7984bc0877d6426ec99391c75fa14c28d028a695655511a5c3951c410
+  data.tar.gz: 26c93c9a62005c206a051f2608c1ef9d9e74a1779449120b7ffd70b5832167e2
 SHA512:
-  metadata.gz: 6f99d9bc8d6c6cd851d40d576edb4bebb5d1aa8928642c78ac66981b928e6fd6e8f9d2a404109344dfa205ef03aae389ce18e46240a79e36f760a2d52e2f46ad
-  data.tar.gz: e4b784d44beedac35cb637e08bebf9e674f8f91f19b4afaed9d2cb81b1d53c3d89ed8525d70e12365b7375d3f3fe28ba567f8a2edfad29adff88913e78d2bf27
+  metadata.gz: 5c2e6b31d8e060c805f75b7a19872dedd815f4d27803bbfde54903371e6a6fae2f8730355fd1ef4f224eb94128506465e3278e49a54c1860b3fd9cb302344142
+  data.tar.gz: 51ba7341dae7de6a368008537de7015bcf77be703c4062ac68e89b27c47c113732208878b8a9dc94af8d1dfb799730778655ca8e92375866df079e0a74a1903f

data/README.md

@@ -4,7 +4,7 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/trainer/blob/master/LICENSE)
 [![Gem](https://img.shields.io/gem/v/trainer.svg?style=flat)](http://rubygems.org/gems/trainer)
 
-This is an alternative approach to generate JUnit files for your CI (e.g. Jenkins) without parsing the `xcodebuild` output, but using the Xcode `plist` files instead.
+This is an alternative approach to generate JUnit files for your CI (e.g. Jenkins) without parsing the `xcodebuild` output, but using the Xcode `plist` or `xcresult` files instead.
 
 Some Xcode versions has a known issue around not properly closing `stdout` ([Radar](https://openradar.appspot.com/27447948)), so you [can't use xcpretty](https://github.com/supermarin/xcpretty/issues/227).
 
@@ -81,13 +81,13 @@ cd [project]
 fastlane scan --derived_data_path "output_dir"
 ```
 
-#### Convert the plist files to junit
+#### Convert the plist or xcresult files to junit
 
 ```
 trainer
 ```
 
-You can also pass a custom directory containing the plist files
+You can also pass a custom directory containing the plist or xcresult files
 
 ```
 trainer --path ./something

data/lib/trainer.rb

@@ -4,6 +4,7 @@ require 'trainer/version'
 require 'trainer/options'
 require 'trainer/test_parser'
 require 'trainer/junit_generator'
+require 'trainer/xcresult'
 
 module Trainer
   ROOT = File.expand_path('..', __dir__)

data/lib/trainer/test_parser.rb

@@ -22,9 +22,14 @@ module Trainer
       files += Dir["#{containing_dir}/Test/*.xcresult/TestSummaries.plist"]
       files += Dir["#{containing_dir}/*.xcresult/TestSummaries.plist"]
       files += Dir[containing_dir] if containing_dir.end_with?(".plist") # if it's the exact path to a plist file
+      # Xcode 11
+      files += Dir["#{containing_dir}/**/Logs/Test/*.xcresult"]
+      files += Dir["#{containing_dir}/Test/*.xcresult"]
+      files += Dir["#{containing_dir}/*.xcresult"]
+      files << containing_dir if File.extname(containing_dir) == ".xcresult"
 
       if files.empty?
-        UI.user_error!("No test result files found in directory '#{containing_dir}', make sure the file name ends with 'TestSummaries.plist'")
+        UI.user_error!("No test result files found in directory '#{containing_dir}', make sure the file name ends with 'TestSummaries.plist' or '.xcresult'")
       end
 
       return_hash = {}
@@ -34,7 +39,12 @@ module Trainer
           filename = File.basename(path).gsub(".plist", config[:extension])
           to_path = File.join(config[:output_directory], filename)
         else
-          to_path = path.gsub(".plist", config[:extension])
+          # Remove .xcresult or .plist extension
+          if path.end_with?(".xcresult")
+            to_path = path.gsub(".xcresult", config[:extension])
+          else
+            to_path = path.gsub(".plist", config[:extension])
+          end
         end
 
         tp = Trainer::TestParser.new(path, config)
@@ -50,12 +60,17 @@ module Trainer
       path = File.expand_path(path)
       UI.user_error!("File not found at path '#{path}'") unless File.exist?(path)
 
-      self.file_content = File.read(path)
-      self.raw_json = Plist.parse_xml(self.file_content)
-      return if self.raw_json["FormatVersion"].to_s.length.zero? # maybe that's a useless plist file
+      if File.directory?(path) && path.end_with?(".xcresult")
+        parse_xcresult(path)
+      else
+        self.file_content = File.read(path)
+        self.raw_json = Plist.parse_xml(self.file_content)
+
+        return if self.raw_json["FormatVersion"].to_s.length.zero? # maybe that's a useless plist file
 
-      ensure_file_valid!
-      parse_content(config[:xcpretty_naming])
+        ensure_file_valid!
+        parse_content(config[:xcpretty_naming])
+      end
     end
 
     # Returns the JUnit report as String
@@ -120,6 +135,90 @@ module Trainer
       return group, name
     end
 
+    def execute_cmd(cmd)
+      output = `#{cmd}`
+      raise "Failed to execute - #{cmd}" unless $?.success?
+      return output
+    end
+
+    def parse_xcresult(path)
+      # Executes xcresulttool to get JSON format of the result bundle object
+      result_bundle_object_raw = execute_cmd("xcrun xcresulttool get --format json --path #{path}")
+      result_bundle_object = JSON.parse(result_bundle_object_raw)
+
+      # Parses JSON into ActionsInvocationRecord to find a list of all ids for ActionTestPlanRunSummaries
+      actions_invocation_record = Trainer::XCResult::ActionsInvocationRecord.new(result_bundle_object)
+      test_refs = actions_invocation_record.actions.map do |action|
+        action.action_result.tests_ref
+      end.compact
+      ids = test_refs.map(&:id)
+
+      # Maps ids into ActionTestPlanRunSummaries by executing xcresulttool to get JSON
+      # containing specific information for each test summary,
+      summaries = ids.map do |id|
+        raw = execute_cmd("xcrun xcresulttool get --format json --path #{path} --id #{id}")
+        json = JSON.parse(raw)
+        Trainer::XCResult::ActionTestPlanRunSummaries.new(json)
+      end
+
+      # Converts the ActionTestPlanRunSummaries to data for junit generator
+      failures = actions_invocation_record.issues.test_failure_summaries || []
+      summaries_to_data(summaries, failures)
+    end
+
+    def summaries_to_data(summaries, failures)
+      # Gets flat list of all ActionTestableSummary
+      all_summaries = summaries.map(&:summaries).flatten
+      testable_summaries = all_summaries.map(&:testable_summaries).flatten
+
+      # Maps ActionTestableSummary to rows for junit generator
+      rows = testable_summaries.map do |testable_summary|
+        all_tests = testable_summary.all_tests.flatten
+
+        test_rows = all_tests.map do |test|
+          test_row = {
+            identifier: "#{test.parent.name}.#{test.name}",
+            name: test.name,
+            duration: test.duration,
+            status: test.test_status,
+            test_group: test.parent.name,
+
+            # These don't map to anything but keeping empty strings
+            guid: ""
+          }
+
+          # Set failure message if failure found
+          failure = test.find_failure(failures)
+          if failure
+            test_row[:failures] = [{
+              file_name: "",
+              line_number: 0,
+              message: "",
+              performance_failure: {},
+              failure_message: failure.failure_message
+            }]
+          end
+
+          test_row
+        end
+
+        row = {
+          project_path: testable_summary.project_relative_path,
+          target_name: testable_summary.target_name,
+          test_name: testable_summary.name,
+          duration: all_tests.map(&:duration).inject(:+),
+          tests: test_rows
+        }
+
+        row[:number_of_tests] = row[:tests].count
+        row[:number_of_failures] = row[:tests].find_all { |a| (a[:failures] || []).count > 0 }.count
+
+        row
+      end
+
+      self.data = rows
+    end
+
     # Convert the Hashes and Arrays in something more useful
     def parse_content(xcpretty_naming)
       self.data = self.raw_json["TestableSummaries"].collect do |testable_summary|

data/lib/trainer/version.rb

@@ -1,4 +1,4 @@
 module Trainer
-  VERSION = "0.8.2"
-  DESCRIPTION = "Convert xcodebuild plist files to JUnit reports"
+  VERSION = "0.9.0"
+  DESCRIPTION = "Convert xcodebuild plist and xcresult files to JUnit reports"
 end

data/lib/trainer/xcresult.rb

@@ -0,0 +1,403 @@
+module Trainer
+  module XCResult
+    # Model attributes and relationships taken from running the following command:
+    # xcrun xcresulttool formatDescription
+
+    class AbstractObject
+      attr_accessor :type
+      def initialize(data)
+        self.type = data["_type"]["_name"]
+      end
+
+      def fetch_value(data, key)
+        return (data[key] || {})["_value"]
+      end
+
+      def fetch_values(data, key)
+        return (data[key] || {})["_values"] || []
+      end
+    end
+
+    # - ActionTestPlanRunSummaries
+    #   * Kind: object
+    #   * Properties:
+    #     + summaries: [ActionTestPlanRunSummary]
+    class ActionTestPlanRunSummaries < AbstractObject
+      attr_accessor :summaries
+      def initialize(data)
+        self.summaries = fetch_values(data, "summaries").map do |summary_data|
+          ActionTestPlanRunSummary.new(summary_data)
+        end
+        super
+      end
+    end
+
+    # - ActionAbstractTestSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + name: String?
+    class ActionAbstractTestSummary < AbstractObject
+      attr_accessor :name
+      def initialize(data)
+        self.name = fetch_value(data, "name")
+        super
+      end
+    end
+
+    # - ActionTestPlanRunSummary
+    #   * Supertype: ActionAbstractTestSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + testableSummaries: [ActionTestableSummary]
+    class ActionTestPlanRunSummary < ActionAbstractTestSummary
+      attr_accessor :testable_summaries
+      def initialize(data)
+        self.testable_summaries = fetch_values(data, "testableSummaries").map do |summary_data|
+          ActionTestableSummary.new(summary_data)
+        end
+        super
+      end
+    end
+
+    # - ActionTestableSummary
+    #   * Supertype: ActionAbstractTestSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + projectRelativePath: String?
+    #     + targetName: String?
+    #     + testKind: String?
+    #     + tests: [ActionTestSummaryIdentifiableObject]
+    #     + diagnosticsDirectoryName: String?
+    #     + failureSummaries: [ActionTestFailureSummary]
+    #     + testLanguage: String?
+    #     + testRegion: String?
+    class ActionTestableSummary < ActionAbstractTestSummary
+      attr_accessor :project_relative_path
+      attr_accessor :target_name
+      attr_accessor :test_kind
+      attr_accessor :tests
+      def initialize(data)
+        self.project_relative_path = fetch_value(data, "projectRelativePath")
+        self.target_name = fetch_value(data, "targetName")
+        self.test_kind = fetch_value(data, "testKind")
+        self.tests = fetch_values(data, "tests").map do |tests_data|
+          ActionTestSummaryIdentifiableObject.create(tests_data, self)
+        end
+        super
+      end
+
+      def all_tests
+        return tests.map(&:all_subtests).flatten
+      end
+    end
+
+    # - ActionTestSummaryIdentifiableObject
+    #   * Supertype: ActionAbstractTestSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + identifier: String?
+    class ActionTestSummaryIdentifiableObject < ActionAbstractTestSummary
+      attr_accessor :identifier
+      attr_accessor :parent
+      def initialize(data, parent)
+        self.identifier = fetch_value(data, "identifier")
+        self.parent = parent
+        super(data)
+      end
+
+      def all_subtests
+        raise "Not overridden"
+      end
+
+      def self.create(data, parent)
+        type = data["_type"]["_name"]
+        if type == "ActionTestSummaryGroup"
+          return ActionTestSummaryGroup.new(data, parent)
+        elsif type == "ActionTestMetadata"
+          return ActionTestMetadata.new(data, parent)
+        else
+          raise "Unsupported type: #{type}"
+        end
+      end
+    end
+
+    # - ActionTestSummaryGroup
+    #   * Supertype: ActionTestSummaryIdentifiableObject
+    #   * Kind: object
+    #   * Properties:
+    #     + duration: Double
+    #     + subtests: [ActionTestSummaryIdentifiableObject]
+    class ActionTestSummaryGroup < ActionTestSummaryIdentifiableObject
+      attr_accessor :duration
+      attr_accessor :subtests
+      def initialize(data, parent)
+        self.duration = fetch_value(data, "duration").to_f
+        self.subtests = fetch_values(data, "subtests").map do |subtests_data|
+          ActionTestSummaryIdentifiableObject.create(subtests_data, self)
+        end
+        super(data, parent)
+      end
+
+      def all_subtests
+        return subtests.map(&:all_subtests).flatten
+      end
+    end
+
+    # - ActionTestMetadata
+    #   * Supertype: ActionTestSummaryIdentifiableObject
+    #   * Kind: object
+    #   * Properties:
+    #     + testStatus: String
+    #     + duration: Double?
+    #     + summaryRef: Reference?
+    #     + performanceMetricsCount: Int
+    #     + failureSummariesCount: Int
+    #     + activitySummariesCount: Int
+    class ActionTestMetadata < ActionTestSummaryIdentifiableObject
+      attr_accessor :test_status
+      attr_accessor :duration
+      attr_accessor :performance_metrics_count
+      attr_accessor :failure_summaries_count
+      attr_accessor :activity_summaries_count
+      def initialize(data, parent)
+        self.test_status = fetch_value(data, "testStatus")
+        self.duration = fetch_value(data, "duration").to_f
+        self.performance_metrics_count = fetch_value(data, "performanceMetricsCount")
+        self.failure_summaries_count = fetch_value(data, "failureSummariesCount")
+        self.activity_summaries_count = fetch_value(data, "activitySummariesCount")
+        super(data, parent)
+      end
+
+      def all_subtests
+        return [self]
+      end
+
+      def find_failure(failures)
+        if self.test_status == "Failure"
+          # Tries to match failure on test case name
+          # Example TestFailureIssueSummary:
+          #   producingTarget: "TestThisDude"
+          #   test_case_name: "TestThisDude.testFailureJosh2()" (when Swift)
+          #     or "-[TestThisDudeTests testFailureJosh2]" (when Objective-C)
+          # Example ActionTestMetadata
+          #   identifier: "TestThisDude/testFailureJosh2()" (when Swift)
+          #     or identifier: "TestThisDude/testFailureJosh2" (when Objective-C)
+
+          found_failure = failures.find do |failure|
+            # Clean test_case_name to match identifier format
+            # Sanitize for Swift by replacing "." for "/"
+            # Sanitize for Objective-C by removing "-", "[", "]", and replacing " " for ?/
+            sanitized_test_case_name = failure.test_case_name
+                                              .tr(".", "/")
+                                              .tr("-", "")
+                                              .tr("[", "")
+                                              .tr("]", "")
+                                              .tr(" ", "/")
+            self.identifier == sanitized_test_case_name
+          end
+          return found_failure
+        else
+          return nil
+        end
+      end
+    end
+
+    # - ActionsInvocationRecord
+    #   * Kind: object
+    #   * Properties:
+    #     + metadataRef: Reference?
+    #     + metrics: ResultMetrics
+    #     + issues: ResultIssueSummaries
+    #     + actions: [ActionRecord]
+    #     + archive: ArchiveInfo?
+    class ActionsInvocationRecord < AbstractObject
+      attr_accessor :actions
+      attr_accessor :issues
+      def initialize(data)
+        self.actions = fetch_values(data, "actions").map do |action_data|
+          ActionRecord.new(action_data)
+        end
+        self.issues = ResultIssueSummaries.new(data["issues"])
+        super
+      end
+    end
+
+    # - ActionRecord
+    #   * Kind: object
+    #   * Properties:
+    #     + schemeCommandName: String
+    #     + schemeTaskName: String
+    #     + title: String?
+    #     + startedTime: Date
+    #     + endedTime: Date
+    #     + runDestination: ActionRunDestinationRecord
+    #     + buildResult: ActionResult
+    #     + actionResult: ActionResult
+    class ActionRecord < AbstractObject
+      attr_accessor :scheme_command_name
+      attr_accessor :scheme_task_name
+      attr_accessor :title
+      attr_accessor :build_result
+      attr_accessor :action_result
+      def initialize(data)
+        self.scheme_command_name = fetch_value(data, "schemeCommandName")
+        self.scheme_task_name = fetch_value(data, "schemeTaskName")
+        self.title = fetch_value(data, "title")
+        self.build_result = ActionResult.new(data["buildResult"])
+        self.action_result = ActionResult.new(data["actionResult"])
+        super
+      end
+    end
+
+    # - ActionResult
+    #   * Kind: object
+    #   * Properties:
+    #     + resultName: String
+    #     + status: String
+    #     + metrics: ResultMetrics
+    #     + issues: ResultIssueSummaries
+    #     + coverage: CodeCoverageInfo
+    #     + timelineRef: Reference?
+    #     + logRef: Reference?
+    #     + testsRef: Reference?
+    #     + diagnosticsRef: Reference?
+    class ActionResult < AbstractObject
+      attr_accessor :result_name
+      attr_accessor :status
+      attr_accessor :issues
+      attr_accessor :timeline_ref
+      attr_accessor :log_ref
+      attr_accessor :tests_ref
+      attr_accessor :diagnostics_ref
+      def initialize(data)
+        self.result_name = fetch_value(data, "resultName")
+        self.status = fetch_value(data, "status")
+        self.issues = ResultIssueSummaries.new(data["issues"])
+
+        self.timeline_ref = Reference.new(data["timelineRef"]) if data["timelineRef"]
+        self.log_ref = Reference.new(data["logRef"]) if data["logRef"]
+        self.tests_ref = Reference.new(data["testsRef"]) if data["testsRef"]
+        self.diagnostics_ref = Reference.new(data["diagnosticsRef"]) if data["diagnosticsRef"]
+        super
+      end
+    end
+
+    # - Reference
+    #   * Kind: object
+    #   * Properties:
+    #     + id: String
+    #     + targetType: TypeDefinition?
+    class Reference < AbstractObject
+      attr_accessor :id
+      attr_accessor :target_type
+      def initialize(data)
+        self.id = fetch_value(data, "id")
+        self.target_type = TypeDefinition.new(data["targetType"]) if data["targetType"]
+        super
+      end
+    end
+
+    # - TypeDefinition
+    #   * Kind: object
+    #   * Properties:
+    #     + name: String
+    #     + supertype: TypeDefinition?
+    class TypeDefinition < AbstractObject
+      attr_accessor :name
+      attr_accessor :supertype
+      def initialize(data)
+        self.name = fetch_value(data, "name")
+        self.supertype = TypeDefinition.new(data["supertype"]) if data["supertype"]
+        super
+      end
+    end
+
+    # - DocumentLocation
+    #   * Kind: object
+    #   * Properties:
+    #     + url: String
+    #     + concreteTypeName: String
+    class DocumentLocation < AbstractObject
+      attr_accessor :url
+      attr_accessor :concrete_type_name
+      def initialize(data)
+        self.url = fetch_value(data, "url")
+        self.concrete_type_name = data["concreteTypeName"]["_value"]
+        super
+      end
+    end
+
+    # - IssueSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + issueType: String
+    #     + message: String
+    #     + producingTarget: String?
+    #     + documentLocationInCreatingWorkspace: DocumentLocation?
+    class IssueSummary < AbstractObject
+      attr_accessor :issue_type
+      attr_accessor :message
+      attr_accessor :producing_target
+      attr_accessor :document_location_in_creating_workspace
+      def initialize(data)
+        self.issue_type = fetch_value(data, "issueType")
+        self.message = fetch_value(data, "message")
+        self.producing_target = fetch_value(data, "producingTarget")
+        self.document_location_in_creating_workspace = DocumentLocation.new(data["documentLocationInCreatingWorkspace"]) if data["documentLocationInCreatingWorkspace"]
+        super
+      end
+    end
+
+    # - ResultIssueSummaries
+    #   * Kind: object
+    #   * Properties:
+    #     + analyzerWarningSummaries: [IssueSummary]
+    #     + errorSummaries: [IssueSummary]
+    #     + testFailureSummaries: [TestFailureIssueSummary]
+    #     + warningSummaries: [IssueSummary]
+    class ResultIssueSummaries < AbstractObject
+      attr_accessor :analyzer_warning_summaries
+      attr_accessor :error_summaries
+      attr_accessor :test_failure_summaries
+      attr_accessor :warning_summaries
+      def initialize(data)
+        self.analyzer_warning_summaries = fetch_values(data, "analyzerWarningSummaries").map do |summary_data|
+          IssueSummary.new(summary_data)
+        end
+        self.error_summaries = fetch_values(data, "errorSummaries").map do |summary_data|
+          IssueSummary.new(summary_data)
+        end
+        self.test_failure_summaries = fetch_values(data, "testFailureSummaries").map do |summary_data|
+          TestFailureIssueSummary.new(summary_data)
+        end
+        self.warning_summaries = fetch_values(data, "warningSummaries").map do |summary_data|
+          IssueSummary.new(summary_data)
+        end
+        super
+      end
+    end
+
+    # - TestFailureIssueSummary
+    #   * Supertype: IssueSummary
+    #   * Kind: object
+    #   * Properties:
+    #     + testCaseName: String
+    class TestFailureIssueSummary < IssueSummary
+      attr_accessor :test_case_name
+      def initialize(data)
+        self.test_case_name = fetch_value(data, "testCaseName")
+        super
+      end
+
+      def failure_message
+        new_message = self.message
+        if self.document_location_in_creating_workspace
+          file_path = self.document_location_in_creating_workspace.url.gsub("file://", "")
+          new_message += " (#{file_path})"
+        end
+
+        return new_message
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trainer
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -106,15 +106,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.38.0
-description: Convert xcodebuild plist files to JUnit reports
+        version: 0.49.0
+description: Convert xcodebuild plist and xcresult files to JUnit reports
 email:
 - fastlane@krausefx.com
 executables:
@@ -132,6 +132,7 @@ files:
 - lib/trainer/options.rb
 - lib/trainer/test_parser.rb
 - lib/trainer/version.rb
+- lib/trainer/xcresult.rb
 homepage: https://fastlane.tools
 licenses:
 - MIT
@@ -151,9 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Convert xcodebuild plist files to JUnit reports
+summary: Convert xcodebuild plist and xcresult files to JUnit reports
 test_files: []