Class: Fastlane::Actions::RunTestsAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/run_tests.rb

Direct Known Subclasses

ScanAction

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, lane_context, method_missing, other_action, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorObject


57
58
59
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 57

def self.author
  "KrauseFx"
end

.available_optionsObject


61
62
63
64
65
66
67
68
69
70
71
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 61

def self.available_options
  require 'scan'

  FastlaneCore::CommanderGenerator.new.generate(Scan::Options.available_options) + [
    FastlaneCore::ConfigItem.new(key: :fail_build,
                                 env_name: "SCAN_FAIL_BUILD",
                                 description: "Should this step stop the build if the tests fail? Set this to false if you're using trainer",
                                 is_string: false,
                                 default_value: true)
  ]
end

.categoryObject


126
127
128
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 126

def self.category
  :testing
end

.descriptionObject


49
50
51
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 49

def self.description
  "Easily run tests of your iOS app (via _scan_)"
end

.detailsObject


53
54
55
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 53

def self.details
  "More information: https://docs.fastlane.tools/actions/scan/"
end

.example_codeObject


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 100

def self.example_code
  [
    'run_tests',
    'scan # alias for "run_tests"',
    'run_tests(
      workspace: "App.xcworkspace",
      scheme: "MyTests",
      clean: false
    )',
    '# Build For Testing
    run_tests(
       derived_data_path: "my_folder",
       build_for_testing: true
    )',
    '# run tests using derived data from prev. build
    run_tests(
       derived_data_path: "my_folder",
       test_without_building: true
    )',
    '# or run it from an existing xctestrun package
    run_tests(
       xctestrun: "/path/to/mytests.xctestrun"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


82
83
84
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 82

def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end

.outputObject


73
74
75
76
77
78
79
80
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 73

def self.output
  [
    ['SCAN_DERIVED_DATA_PATH', 'The path to the derived data'],
    ['SCAN_GENERATED_PLIST_FILE', 'The generated plist file'],
    ['SCAN_GENERATED_PLIST_FILES', 'The generated plist files'],
    ['SCAN_ZIP_BUILD_PRODUCTS_PATH', 'The path to the zipped build products']
  ]
end

.run(values) ⇒ Object


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
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 11

def self.run(values)
  require 'scan'
  plist_files_before = []

  begin
    destination = values[:destination] # save destination value which can be later overridden
    Scan.config = values # we set this here to auto-detect missing values, which we need later on
    unless values[:derived_data_path].to_s.empty?
      plist_files_before = test_summary_filenames(values[:derived_data_path])
    end

    values[:destination] = destination # restore destination value
    Scan::Manager.new.work(values)

    zip_build_products_path = Scan.cache[:zip_build_products_path]
    Actions.lane_context[SharedValues::SCAN_ZIP_BUILD_PRODUCTS_PATH] = zip_build_products_path if zip_build_products_path

    return true
  rescue FastlaneCore::Interface::FastlaneBuildFailure => ex
    # Specifically catching FastlaneBuildFailure to prevent build/compile errors from being
    # silenced when :fail_build is set to false
    # :fail_build should only suppress testing failures
    raise ex
  rescue => ex
    if values[:fail_build]
      raise ex
    end
  ensure
    unless values[:derived_data_path].to_s.empty?
      Actions.lane_context[SharedValues::SCAN_DERIVED_DATA_PATH] = values[:derived_data_path]
      plist_files_after = test_summary_filenames(values[:derived_data_path])
      all_test_summaries = (plist_files_after - plist_files_before)
      Actions.lane_context[SharedValues::SCAN_GENERATED_PLIST_FILES] = all_test_summaries
      Actions.lane_context[SharedValues::SCAN_GENERATED_PLIST_FILE] = all_test_summaries.last
    end
  end
end

.test_summary_filenames(derived_data_path) ⇒ Object


88
89
90
91
92
93
94
95
96
97
98
# File 'fastlane/lib/fastlane/actions/run_tests.rb', line 88

def self.test_summary_filenames(derived_data_path)
  files = []

  # Xcode < 10
  files += Dir["#{derived_data_path}/**/Logs/Test/*TestSummaries.plist"]

  # Xcode 10
  files += Dir["#{derived_data_path}/**/Logs/Test/*.xcresult/TestSummaries.plist"]

  return files
end