Class: Fastlane::Actions::VerifyBuildAction

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

Constant Summary

Constants inherited from Fastlane::Action

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

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, lane_context, method_missing, other_action, return_type, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.app_path(params, dir) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 20

def self.app_path(params, dir)
  build_path = params[:ipa_path] || params[:build_path] || Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] || ''
  UI.user_error!("Unable to find file '#{build_path}'") unless File.exist?(build_path)
  build_path = File.expand_path(build_path)

  case File.extname(build_path)
  when ".ipa", ".zip"
    `unzip #{build_path.shellescape} -d #{dir.shellescape} -x '__MACOSX/*' '*.DS_Store' 2>&1`
    UI.user_error!("Unable to unzip ipa") unless $? == 0
    # Adding extra ** for edge-case ipas where Payload directory is nested.
    app_path = Dir["#{dir}/**/Payload/*.app"].first
  when ".xcarchive"
    app_path = Dir["#{build_path}/Products/Applications/*.app"].first
  else
    app_path = build_path # Assume that input is an app file.
  end

  UI.user_error!("Unable to find app file") unless app_path && File.exist?(app_path)
  app_path
end

.authors ⇒ Object 



180
181
182
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 180

def self.authors
  ["CodeReaper"]
end

.available_options ⇒ Object 



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

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :provisioning_type,
                                 env_name: "FL_VERIFY_BUILD_PROVISIONING_TYPE",
                                 description: "Required type of provisioning",
                                 optional: true,
                                 verify_block: proc do |value|
                                   av = %w(distribution development)
                                   UI.user_error!("Unsupported provisioning_type, must be: #{av}") unless av.include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :provisioning_uuid,
                                 env_name: "FL_VERIFY_BUILD_PROVISIONING_UUID",
                                 description: "Required UUID of provisioning profile",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :team_identifier,
                                 env_name: "FL_VERIFY_BUILD_TEAM_IDENTIFIER",
                                 description: "Required team identifier",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 env_name: "FL_VERIFY_BUILD_TEAM_NAME",
                                 description: "Required team name",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :app_name,
                                 env_name: "FL_VERIFY_BUILD_APP_NAME",
                                 description: "Required app name",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :bundle_identifier,
                                 env_name: "FL_VERIFY_BUILD_BUNDLE_IDENTIFIER",
                                 description: "Required bundle identifier",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :ipa_path,
                                 env_name: "FL_VERIFY_BUILD_IPA_PATH",
                                 description: "Explicitly set the ipa path",
                                 conflicting_options: [:build_path],
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :build_path,
                                 env_name: "FL_VERIFY_BUILD_BUILD_PATH",
                                 description: "Explicitly set the ipa, app or xcarchive path",
                                 conflicting_options: [:ipa_path],
                                 optional: true)
  ]
end

.category ⇒ Object 



197
198
199
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 197

def self.category
  :misc
end

.description ⇒ Object 



123
124
125
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 123

def self.description
  "Able to verify various settings in ipa file"
end

.details ⇒ Object 



127
128
129
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 127

def self.details
  "Verifies that the built app was built using the expected build resources. This is relevant for people who build on machines that are used to build apps with different profiles, certificates and/or bundle identifiers to guard against configuration mistakes."
end

.evaluate(params, values) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 96

def self.evaluate(params, values)
  if params[:provisioning_type]
    UI.user_error!("Mismatched provisioning_type. Required: '#{params[:provisioning_type]}'; Found: '#{values['provisioning_type']}'") unless params[:provisioning_type] == values['provisioning_type']
  end
  if params[:provisioning_uuid]
    UI.user_error!("Mismatched provisioning_uuid. Required: '#{params[:provisioning_uuid]}'; Found: '#{values['provisioning_uuid']}'") unless params[:provisioning_uuid] == values['provisioning_uuid']
  end
  if params[:team_identifier]
    UI.user_error!("Mismatched team_identifier. Required: '#{params[:team_identifier]}'; Found: '#{values['team_identifier']}'") unless params[:team_identifier] == values['team_identifier']
  end
  if params[:team_name]
    UI.user_error!("Mismatched team_name. Required: '#{params[:team_name]}'; Found: '#{values['team_name']}'") unless params[:team_name] == values['team_name']
  end
  if params[:app_name]
    UI.user_error!("Mismatched app_name. Required: '#{params[:app_name]}'; Found: '#{values['app_name']}'") unless params[:app_name] == values['app_name']
  end
  if params[:bundle_identifier]
    UI.user_error!("Mismatched bundle_identifier. Required: '#{params[:bundle_identifier]}'; Found: '#{values['bundle_identifier']}'") unless params[:bundle_identifier] == values['bundle_identifier']
  end

  UI.success("Build is verified, have a 🍪.")
end

.example_code ⇒ Object 



188
189
190
191
192
193
194
195
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 188

def self.example_code
  [
    'verify_build(
      provisioning_type: "distribution",
      bundle_identifier: "com.example.myapp"
    )'
  ]
end

.gather_cert_info(app_path) ⇒ Object 



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

def self.gather_cert_info(app_path)
  cert_info = `codesign -vv -d #{app_path.shellescape} 2>&1`
  UI.user_error!("Unable to verify code signing") unless $? == 0

  values = {}

  parts = cert_info.strip.split(/\r?\n/)
  parts.each do |part|
    if part =~ /\AAuthority=(iPhone|iOS|Apple)\s(Distribution|Development)/
      type = part.split('=')[1].split(':')[0]
      values['provisioning_type'] = type.downcase =~ /distribution/i ? "distribution" : "development"
    end
    if part.start_with?("Authority")
      values['authority'] ||= []
      values['authority'] << part.split('=')[1]
    end
    if part.start_with?("TeamIdentifier")
      values['team_identifier'] = part.split('=')[1]
    end
    if part.start_with?("Identifier")
      values['bundle_identifier'] = part.split('=')[1]
    end
  end

  values
end

.is_supported?(platform) ⇒ Boolean

Returns:



184
185
186
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 184

def self.is_supported?(platform)
  platform == :ios
end

.output ⇒ Object 



174
175
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 174

def self.output
end

.print_values(values) ⇒ Object 



91
92
93
94
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 91

def self.print_values(values)
  FastlaneCore::PrintTable.print_values(config: values,
                                       title: "Summary for verify_build #{Fastlane::VERSION}")
end

.return_value ⇒ Object 



177
178
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 177

def self.return_value
end

.run(params) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 6

def self.run(params)
  Dir.mktmpdir do |dir|
    app_path = self.app_path(params, dir)

    values = self.gather_cert_info(app_path)

    values = self.update_with_profile_info(app_path, values)

    self.print_values(values)

    self.evaluate(params, values)
  end
end

.update_with_profile_info(app_path, values) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'fastlane/lib/fastlane/actions/verify_build.rb', line 68

def self.update_with_profile_info(app_path, values)
  provision_profile_path = "#{app_path}/embedded.mobileprovision"
  UI.user_error!("Unable to find embedded profile in #{provision_profile_path}") unless File.exist?(provision_profile_path)

  profile = `cat #{provision_profile_path.shellescape} | security cms -D`
  UI.user_error!("Unable to extract profile") unless $? == 0

  plist = Plist.parse_xml(profile)

  values['app_name'] = plist['AppIDName']
  values['provisioning_uuid'] = plist['UUID']
  values['team_name'] = plist['TeamName']
  values['team_identifier'] = plist['TeamIdentifier'].first

  application_identifier_prefix = plist['ApplicationIdentifierPrefix'][0]
  full_bundle_identifier = "#{application_identifier_prefix}.#{values['bundle_identifier']}"

  UI.user_error!("Inconsistent identifier found; #{plist['Entitlements']['application-identifier']}, found in the embedded.mobileprovision file, should match #{full_bundle_identifier}, which is embedded in the codesign identity") unless plist['Entitlements']['application-identifier'] == full_bundle_identifier
  UI.user_error!("Inconsistent identifier found") unless plist['Entitlements']['com.apple.developer.team-identifier'] == values['team_identifier']

  values
end