Class: Fastlane::Actions::SuppressTestsAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



164
165
166
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 164

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

.available_options ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 67

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :xcodeproj,
      env_name: "FL_SUPPRESS_TESTS_XCODE_PROJECT",
      optional: true,
      description: "The file path to the Xcode project file to modify",
      verify_block: proc do |path|
        UI.user_error!("Error: Xcode project file path not given!") unless path and !path.empty?
        UI.user_error!("Error: Xcode project '#{path}' not found!") unless Dir.exist?(path)
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :workspace,
      env_name: "FL_SUPPRESS_TESTS_XCODE_WORKSPACE",
      optional: true,
      description: "The file path to the Xcode workspace file to modify",
      verify_block: proc do |value|
        v = File.expand_path(value.to_s)
        UI.user_error!("Workspace file not found at path '#{v}'") unless Dir.exist?(v)
        UI.user_error!("Workspace file invalid") unless File.directory?(v)
        UI.user_error!("Workspace file is not a workspace, must end with .xcworkspace") unless v.include?(".xcworkspace")
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :tests,
      env_name: "FL_SUPPRESS_TESTS_TESTS_TO_SUPPRESS",
      description: "A list of tests to suppress",
      verify_block: proc do |tests|
        UI.user_error!("Error: no tests were given to suppress!") unless tests and !tests.empty?
        tests.each do |test_identifier|
          is_valid_test_identifier = %r{^[a-zA-Z][a-zA-Z0-9]+\/[a-zA-Z][a-zA-Z0-9]+(\/test[a-zA-Z0-9]+)?$} =~ test_identifier
          unless is_valid_test_identifier
            UI.user_error!("Error: invalid test identifier '#{test_identifier}'. It must be in the format of 'Testable/TestSuiteToSuppress' or 'Testable/TestSuiteToSuppress/testToSuppress'")
          end
        end
      end,
      type: Array
    ),
    FastlaneCore::ConfigItem.new(
      key: :scheme,
      optional: true,
      env_name: "FL_SUPPRESS_TESTS_SCHEME_TO_UPDATE",
      description: "The Xcode scheme where the tests should be suppressed",
      verify_block: proc do |scheme_name|
        UI.user_error!("Error: Xcode Scheme '#{scheme_name}' is not valid!") if scheme_name and scheme_name.empty?
      end
    )
  ]
end

.category ⇒ Object 



168
169
170
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 168

def self.category
  :testing
end

.description ⇒ Object

:nocov:



63
64
65
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 63

def self.description
  "Suppresses specific tests in a specific or all Xcode Schemes in a given project"
end

.example_code ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 118

def self.example_code
  [
    "
    UI.important(
      'example: ' \\
      'suppress some tests in all Schemes for a Project'
    )
    suppress_tests(
      xcodeproj: 'AtomicBoy/AtomicBoy.xcodeproj',
      tests: [
        'AtomicBoyUITests/HappyNapperTests/testBeepingNonExistentFriendDisplaysError',
        'AtomicBoyUITests/GrumpyWorkerTests'
      ]
    )
    ",
    "
    UI.important(
      'example: ' \\
      'suppress some tests in one Scheme for a Project'
    )
    suppress_tests(
      xcodeproj: 'AtomicBoy/AtomicBoy.xcodeproj',
      tests: [
        'AtomicBoyUITests/HappyNapperTests/testBeepingNonExistentFriendDisplaysError',
        'AtomicBoyUITests/GrumpyWorkerTests'
      ],
      scheme: 'Professor'
    )
    ",
    "
    UI.important(
      'example: ' \\
      'suppress some tests in one Scheme from a workspace'
    )
    suppress_tests(
      workspace: 'AtomicBoy/AtomicBoy.xcworkspace',
      tests: [
        'AtomicBoyUITests/HappyNapperTests/testBeepingNonExistentFriendDisplaysError',
        'AtomicBoyUITests/GrumpyWorkerTests'
      ],
      scheme: 'Professor'
    )
    "
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 172

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

.run(params) ⇒ Object 



6
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
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 6

def self.run(params)
  all_tests_to_skip = params[:tests]
  scheme = params[:scheme]

  scheme_filepaths = schemes_from_project(params[:xcodeproj], scheme) || schemes_from_workspace(params[:workspace], scheme)
  if scheme_filepaths.length.zero?
    UI.user_error!("Error: cannot find any scheme named #{scheme}") unless scheme.nil?
    UI.user_error!("Error: cannot find any schemes in the Xcode project") if params[:xcodeproj]
    UI.user_error!("Error: cannot find any schemes in the Xcode workspace") if params[:workspace]
  end

  scheme_filepaths.each do |scheme_filepath|
    is_dirty = false
    xcscheme = Xcodeproj::XCScheme.new(scheme_filepath)
    xcscheme.test_action.testables.each do |testable|
      buildable_name = File.basename(testable.buildable_references[0].buildable_name, '.xctest')

      tests_to_skip = all_tests_to_skip.select { |test| test.start_with?(buildable_name) }
                                       .map { |test| test.sub("#{buildable_name}/", '') }

      tests_to_skip.each do |test_to_skip|
        skipped_test = Xcodeproj::XCScheme::TestAction::TestableReference::SkippedTest.new
        skipped_test.identifier = test_to_skip
        testable.add_skipped_test(skipped_test)
        is_dirty = true
      end
    end
    xcscheme.save! if is_dirty
  end
  nil
end

.schemes_from_project(project_path, scheme) ⇒ Object 



38
39
40
41
42
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 38

def self.schemes_from_project(project_path, scheme)
  return nil unless project_path

  Dir.glob("#{project_path}/{xcshareddata,xcuserdata}/**/xcschemes/#{scheme || '*'}.xcscheme")
end

.schemes_from_workspace(workspace_path, scheme) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/fastlane/plugin/test_center/actions/suppress_tests.rb', line 44

def self.schemes_from_workspace(workspace_path, scheme)
  return nil unless workspace_path

  xcworkspace = Xcodeproj::Workspace.new_from_xcworkspace(workspace_path)
  scheme_filepaths = []
  xcworkspace.file_references.each do |file_reference|
    next if file_reference.path.include?('Pods/Pods.xcodeproj')

    project_path = file_reference.absolute_path(File.dirname(workspace_path))
    scheme_filepaths.concat(schemes_from_project(project_path, scheme))
  end
  scheme_filepaths
end