Class: Match::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/match/runner.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#changes_to_commit ⇒ Object

Returns the value of attribute changes_to_commit.



3
4
5
 
# File 'lib/match/runner.rb', line 3

def changes_to_commit
  @changes_to_commit
end

#spaceship ⇒ Object

Returns the value of attribute spaceship.



4
5
6
 
# File 'lib/match/runner.rb', line 4

def spaceship
  @spaceship
end

Instance Method Details

#device_count_different?(profile: nil) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/match/runner.rb', line 157

def device_count_different?(profile: nil)
  if profile
    parsed = FastlaneCore::ProvisioningProfile.parse(profile)
    uuid = parsed["UUID"]
    portal_profile = Spaceship.provisioning_profile.all.detect { |i| i.uuid == uuid }

    if portal_profile
      profile_device_count = portal_profile.devices.count
      portal_device_count = Spaceship.device.all.count
      return portal_device_count != profile_device_count
    end
  end
  return false
end

#fetch_certificate(params: nil) ⇒ Object 



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
 
# File 'lib/match/runner.rb', line 64

def fetch_certificate(params: nil)
  cert_type = Match.cert_type_sym(params[:type])

  certs = Dir[File.join(params[:workspace], "certs", cert_type.to_s, "*.cer")]
  keys = Dir[File.join(params[:workspace], "certs", cert_type.to_s, "*.p12")]

  if certs.count == 0 or keys.count == 0
    UI.important "Couldn't find a valid code signing identity in the git repo for #{cert_type}... creating one for you now"
    UI.crash!("No code signing identity found and can not create a new one because you enabled `readonly`") if params[:readonly]
    cert_path = Generator.generate_certificate(params, cert_type)
    self.changes_to_commit = true
  else
    cert_path = certs.last
    UI.message "Installing certificate..."

    if FastlaneCore::CertChecker.installed?(cert_path)
      UI.verbose "Certificate '#{File.basename(cert_path)}' is already installed on this machine"
    else
      Utils.import(cert_path, params[:keychain_name], password: params[:keychain_password])
    end

    # Import the private key
    # there seems to be no good way to check if it's already installed - so just install it
    Utils.import(keys.last, params[:keychain_name], password: params[:keychain_password])

    # Get and print info of certificate
    info = Utils.get_cert_info(cert_path)
    TablePrinter.print_certificate_info(cert_info: info)
  end

  return File.basename(cert_path).gsub(".cer", "") # Certificate ID
end

#fetch_provisioning_profile(params: nil, certificate_id: nil, app_identifier: nil) ⇒ String

Returns The UUID of the provisioning profile so we can verify it with the Apple Developer Portal.

Returns:

  • (String) —

    The UUID of the provisioning profile so we can verify it with the Apple Developer Portal



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
 
# File 'lib/match/runner.rb', line 98

def fetch_provisioning_profile(params: nil, certificate_id: nil, app_identifier: nil)
  prov_type = Match.profile_type_sym(params[:type])

  profile_name = [Match::Generator.profile_type_name(prov_type), app_identifier].join("_").gsub("*", '\*') # this is important, as it shouldn't be a wildcard
  base_dir = File.join(params[:workspace], "profiles", prov_type.to_s)
  profiles = Dir[File.join(base_dir, "#{profile_name}.mobileprovision")]

  # Install the provisioning profiles
  profile = profiles.last

  if params[:force_for_new_devices] && !params[:readonly]
    params[:force] = device_count_different?(profile: profile) unless params[:force]
  end

  if profile.nil? or params[:force]
    if params[:readonly]
      all_profiles = Dir.entries(base_dir).reject { |f| f.start_with? "." }
      UI.error "No matching provisioning profiles found for '#{profile_name}'"
      UI.error "A new one cannot be created because you enabled `readonly`"
      UI.error "Provisioning profiles in your repo for type `#{prov_type}`:"
      all_profiles.each { |p| UI.error "- '#{p}'" }
      UI.error "If you are certain that a profile should exist, double-check the recent changes to your match repository"
      UI.user_error! "No matching provisioning profiles found and can not create a new one because you enabled `readonly`. Check the output above for more information."
    end
    profile = Generator.generate_provisioning_profile(params: params,
                                                   prov_type: prov_type,
                                              certificate_id: certificate_id,
                                              app_identifier: app_identifier)
    self.changes_to_commit = true
  end

  FastlaneCore::ProvisioningProfile.install(profile)

  parsed = FastlaneCore::ProvisioningProfile.parse(profile)
  uuid = parsed["UUID"]

  if spaceship && !spaceship.profile_exists(username: params[:username], uuid: uuid)
    # This profile is invalid, let's remove the local file and generate a new one
    File.delete(profile)
    self.changes_to_commit = true
    return nil
  end

  Utils.fill_environment(Utils.environment_variable_name(app_identifier: app_identifier,
                                                                   type: prov_type),
                         uuid)

  # TeamIdentifier is returned as an array, but we're not sure why there could be more than one
  Utils.fill_environment(Utils.environment_variable_name_team_id(app_identifier: app_identifier,
                                                                           type: prov_type),
                         parsed["TeamIdentifier"].first)

  Utils.fill_environment(Utils.environment_variable_name_profile_name(app_identifier: app_identifier,
                                                                                type: prov_type),
                         parsed["Name"])

  return uuid
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
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
 
# File 'lib/match/runner.rb', line 6

def run(params)
  FastlaneCore::PrintTable.print_values(config: params,
                                     hide_keys: [:workspace],
                                         title: "Summary for match #{Match::VERSION}")

  UI.error("Enterprise profiles are currently not officially supported in _match_, you might run into issues") if Match.enterprise?

  params[:workspace] = GitHelper.clone(params[:git_url], params[:shallow_clone], skip_docs: params[:skip_docs], branch: params[:git_branch])
  self.spaceship = SpaceshipEnsure.new(params[:username]) unless params[:readonly]

  if params[:app_identifier].kind_of?(Array)
    app_identifiers = params[:app_identifier]
  else
    app_identifiers = params[:app_identifier].to_s.split(/\s*,\s*/).uniq
  end

  # Verify the App ID (as we don't want 'match' to fail at a later point)
  if spaceship
    app_identifiers.each do |app_identifier|
      spaceship.bundle_identifier_exists(username: params[:username], app_identifier: app_identifier)
    end
  end

  # Certificate
  cert_id = fetch_certificate(params: params)
  spaceship.certificate_exists(username: params[:username], certificate_id: cert_id) if spaceship

  # Provisioning Profiles
  app_identifiers.each do |app_identifier|
    loop do
      break if fetch_provisioning_profile(params: params,
                                  certificate_id: cert_id,
                                  app_identifier: app_identifier)
    end
  end

  # Done
  if self.changes_to_commit and !params[:readonly]
    message = GitHelper.generate_commit_message(params)
    GitHelper.commit_changes(params[:workspace], message, params[:git_url], params[:git_branch])
  end

  # Print a summary table for each app_identifier
  app_identifiers.each do |app_identifier|
    TablePrinter.print_summary(app_identifier: app_identifier, type: params[:type])
  end

  UI.success "All required keys, certificates and provisioning profiles are installed 🙌".green
rescue Spaceship::Client::UnexpectedResponse, Spaceship::Client::InvalidUserCredentialsError, Spaceship::Client::NoUserCredentialsError => ex
  UI.error("An error occured while verifying your certificates and profiles with the Apple Developer Portal.")
  UI.error("If you already have your certificates stored in git, you can run `match` in readonly mode")
  UI.error("to just install the certificates and profiles without accessing the Dev Portal.")
  UI.error("To do so, just pass `readonly: true` to your match call.")
  raise ex
ensure
  GitHelper.clear_changes
end