Class: Fastlane::Actions::TestsFromXcresultAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



101
102
103
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 101

def self.authors
  ["lyndsey-ferguson/lyndseydf"]
end

.available_options ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 79

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :xcresult,
      env_name: "FL_TESTS_FROM_XCRESULT_XCRESULT_PATH",
      description: "The path to the xcresult bundle to retrieve the tests from",
      verify_block: proc do |path|
        UI.user_error!("Error: cannot find the xcresult bundle at '#{path}'") unless Dir.exist?(path)
        UI.user_error!("Error: cannot parse files that are not in the xcresult format") unless File.extname(path) == ".xcresult"
      end
    )
  ]
end

.category ⇒ Object 



105
106
107
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 105

def self.category
  :testing
end

.description ⇒ Object 



74
75
76
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 74

def self.description
  "☑️ Retrieves the failing, passing, skipped, and expected failing tests as reported in a xcresult bundle"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 109

def self.is_supported?(platform)
  %i[ios mac].include?(platform)
end

.return_value ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 93

def self.return_value
  "A Hash with information about the test results:\r\n" \
  "failed: an Array of the failed test identifiers\r\n" \
  "passing: an Array of the passing test identifiers\r\n" \
 "skipped: an Array of the skipped test identifiers\r\n" \
  "expected_failures: an Array of the expected failure test identifiers\r\n"
end

.run(params) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/fastlane/plugin/test_center/actions/tests_from_xcresult.rb', line 7

def self.run(params)
  unless FastlaneCore::Helper.xcode_at_least?('11.0.0')
    UI.error("Error: tests_from_xcresult requires at least Xcode 11.0")
    return {}
  end

  xcresult_path = File.absolute_path(params[:xcresult])

  # taken from the rubygem trainer, in the test_parser.rb module
  result_bundle_object_raw = sh("xcrun xcresulttool get --path #{xcresult_path.shellescape} --format json", print_command: false, print_command_output: false)
  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)
  summaries = ids.map do |id|
    raw = sh("xcrun xcresulttool get --format json --path #{xcresult_path.shellescape} --id #{id}", print_command: false, print_command_output: false)
    json = JSON.parse(raw)
    Trainer::XCResult::ActionTestPlanRunSummaries.new(json)
  end
  failures = actions_invocation_record.issues.test_failure_summaries || []
  all_summaries = summaries.map(&:summaries).flatten
  testable_summaries = all_summaries.map(&:testable_summaries).flatten
  failed = []
  passing = []
  skipped = []
  expected_failures = []
  failure_details = {}
  testable_summaries.map do |testable_summary|
    target_name = testable_summary.target_name
    all_tests = testable_summary.all_tests.flatten
    all_tests.each do |t|
      if t.test_status == 'Success'
        passing << "#{target_name}/#{t.identifier.sub('()', '')}"
      elsif t.test_status == 'Skipped'
        skipped << "#{target_name}/#{t.identifier.sub('()', '')}"
      elsif t.test_status == 'Expected Failure'
        expected_failures << "#{target_name}/#{t.identifier.sub('()', '')}"
      else
        test_identifier = "#{target_name}/#{t.identifier.sub('()', '')}"
        failed << test_identifier
        failure = t.find_failure(failures)
        if failure
          failure_details[test_identifier] = {
            message: failure.failure_message
          }
        end
      end
    end
  end
  {
    failed: failed.uniq,
    passing: passing.uniq,
    skipped: skipped.uniq,
    expected_failures: expected_failures.uniq,
    failure_details: failure_details
  }
end