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
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
117
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
# File 'lib/xcov/options.rb', line 7
def self.available_options
containing = self.containing_folder
return [
FastlaneCore::ConfigItem.new(
key: :workspace,
short_option: "-w",
env_name: "XCOV_WORKSPACE",
optional: true,
description: "Path the workspace file",
verify_block: proc do |value|
v = File.expand_path(value.to_s)
raise "Workspace file not found at path '#{v}'".red unless File.exist?(v)
raise "Workspace file invalid".red unless File.directory?(v)
raise "Workspace file is not a workspace, must end with .xcworkspace".red unless v.include?(".xcworkspace")
end
),
FastlaneCore::ConfigItem.new(
key: :project,
short_option: "-p",
optional: true,
env_name: "XCOV_PROJECT",
description: "Path the project file",
verify_block: proc do |value|
v = File.expand_path(value.to_s)
raise "Project file not found at path '#{v}'".red unless File.exist?(v)
raise "Project file invalid".red unless File.directory?(v)
raise "Project file is not a project file, must end with .xcodeproj".red unless v.include?(".xcodeproj")
end
),
FastlaneCore::ConfigItem.new(
key: :scheme,
short_option: "-s",
optional: true,
env_name: "XCOV_SCHEME",
description: "The project's scheme. Make sure it's marked as `Shared`"
),
FastlaneCore::ConfigItem.new(
key: :configuration,
short_option: "-q",
env_name: "XCOV_CONFIGURATION",
description: "The configuration used when building the app. Defaults to 'Release'",
optional: true
),
FastlaneCore::ConfigItem.new(
key: :source_directory,
short_option: "-r",
optional: true,
env_name: "XCOV_SOURCE_DIRECTORY",
description: "The path to project's root directory",
verify_block: proc do |value|
v = File.expand_path(value.to_s)
raise "Specified source directory does not exist".red unless File.exist?(v)
raise "Invalid source directory path, it must point to a directory".red unless File.directory?(v)
end
),
FastlaneCore::ConfigItem.new(
key: :derived_data_path,
short_option: "-j",
env_name: "XCOV_DERIVED_DATA_PATH",
description: "The directory where build products and other derived data will go",
optional: true,
verify_block: proc do |value|
v = File.expand_path(value.to_s)
raise "Specified derived data directory does not exist".red unless File.exist?(v)
raise "Invalid derived data path, it must point to a directory".red unless File.directory?(v)
end
),
FastlaneCore::ConfigItem.new(
key: :output_directory,
short_option: "-o",
env_name: "XCOV_OUTPUT_DIRECTORY",
description: "The directory in which all reports will be stored",
default_value: File.join(containing, "xcov_report"),
default_value_dynamic: true
),
FastlaneCore::ConfigItem.new(
key: :html_report,
env_name: "XCOV_HTML_REPORT",
description: "Produce an HTML report",
optional: true,
is_string: false,
default_value: true
),
FastlaneCore::ConfigItem.new(
key: :markdown_report,
env_name: "XCOV_MARKDOWN_REPORT",
description: "Produce a Markdown report",
optional: true,
is_string: false,
default_value: false
),
FastlaneCore::ConfigItem.new(
key: :json_report,
env_name: "XCOV_JSON_REPORT",
description: "Produce a JSON report",
optional: true,
is_string: false,
default_value: false
),
FastlaneCore::ConfigItem.new(
key: :minimum_coverage_percentage,
short_option: "-m",
env_name: "XCOV_MINIMUM_COVERAGE_PERCENTAGE",
description: "Raise exception if overall coverage percentage is under this value (ie. 75)",
type: Float,
default_value: 0
),
FastlaneCore::ConfigItem.new(
key: :slack_url,
short_option: "-i",
env_name: "SLACK_URL",
description: "Create an Incoming WebHook for your Slack group to post results there",
optional: true,
verify_block: proc do |value|
raise "Invalid URL, must start with https://" unless value.start_with? "https://"
end
),
FastlaneCore::ConfigItem.new(
key: :slack_channel,
short_option: "-e",
env_name: "XCOV_SLACK_CHANNEL",
description: "#channel or @username",
optional: true
),
FastlaneCore::ConfigItem.new(
key: :skip_slack,
description: "Don't publish to slack, even when an URL is given",
is_string: false,
default_value: false
),
FastlaneCore::ConfigItem.new(
key: :slack_username,
description: "The username which is used to publish to slack",
default_value: "xcov",
optional: true
),
FastlaneCore::ConfigItem.new(
key: :slack_message,
description: "The message which is published together with a successful report",
default_value: "Your *xcov* coverage report",
optional: true
),
FastlaneCore::ConfigItem.new(
key: :ignore_file_path,
short_option: "-x",
env_name: "XCOV_IGNORE_FILE_PATH",
description: "Relative or absolute path to the file containing the list of ignored files",
default_value: File.join(containing, ".xcovignore"),
default_value_dynamic: true
),
FastlaneCore::ConfigItem.new(
key: :include_test_targets,
env_name: "XCOV_INCLUDE_TEST_TARGETS",
description: "Enables coverage reports for .xctest targets",
is_string: false,
default_value: false
),
FastlaneCore::ConfigItem.new(
key: :exclude_targets,
optional: true,
conflicting_options: [:include_targets, :only_project_targets],
description: "Comma separated list of targets to exclude from coverage report"
),
FastlaneCore::ConfigItem.new(
key: :include_targets,
optional: true,
conflicting_options: [:exclude_targets, :only_project_targets],
description: "Comma separated list of targets to include in coverage report. If specified then exlude_targets will be ignored"
),
FastlaneCore::ConfigItem.new(
key: :only_project_targets,
optional: true,
conflicting_options: [:exclude_targets, :include_targets],
description: "Display the coverage only for main project targets (e.g. skip Pods targets)",
is_string: false,
default_value: false
),
FastlaneCore::ConfigItem.new(
key: :disable_coveralls,
env_name: "DISABLE_COVERALLS",
default_value: false,
is_string: false,
optional: true,
description: "Add this flag to disable automatic submission to Coveralls"
),
FastlaneCore::ConfigItem.new(
key: :coveralls_service_name,
env_name: "COVERALLS_SERVICE_NAME",
optional: true,
conflicting_options: [:coveralls_repo_token],
description: "Name of the CI service compatible with Coveralls. i.e. travis-ci. This option must be defined along with coveralls_service_job_id"
),
FastlaneCore::ConfigItem.new(
key: :coveralls_service_job_id,
env_name: "COVERALLS_SERVICE_JOB_ID",
optional: true,
conflicting_options: [:coveralls_repo_token],
description: "Name of the current job running on a CI service compatible with Coveralls. This option must be defined along with coveralls_service_name"
),
FastlaneCore::ConfigItem.new(
key: :coveralls_repo_token,
env_name: "COVERALLS_REPO_TOKEN",
optional: true,
conflicting_options: [:coveralls_service_name, :coveralls_service_job_id],
description: "Repository token to be used by integrations not compatible with Coveralls"
),
FastlaneCore::ConfigItem.new(
key: :xcconfig,
env_name: "XCOV_XCCONFIG",
description: "Use an extra XCCONFIG file to build your app",
optional: true,
verify_block: proc do |value|
UI.user_error!("File not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
end
),
FastlaneCore::ConfigItem.new(
key: :ideFoundationPath,
env_name: "XCOV_IDE_FOUNDATION_PATH",
description: "Absolute path to the IDEFoundation.framework binary",
optional: true,
default_value: File.join(`/usr/bin/xcode-select -p`.delete!("\n"), "../Frameworks/IDEFoundation.framework/Versions/A/IDEFoundation"),
default_value_dynamic: true
),
FastlaneCore::ConfigItem.new(
key: :legacy_support,
env_name: "XCOV_LEGACY_SUPPORT",
description: "Whether xcov should parse a xccoverage file instead on xccovreport",
optional: true,
is_string: false,
default_value: false
)
]
end
|