Class: Gym::CodeSigningMapping

Inherits:
Object
  • Object
show all
Defined in:
gym/lib/gym/code_signing_mapping.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(project: nil) ⇒ CodeSigningMapping

Returns a new instance of CodeSigningMapping.



9
10
11
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 9

def initialize(project: nil)
  self.project = project
end

Instance Attribute Details

#project ⇒ Object

Returns the value of attribute project.



7
8
9
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 7

def project
  @project
end

Instance Method Details

#app_identifier_contains?(str, contains) ⇒ Boolean

Helper method to remove “-” and “ ” and downcase app identifier and compare if an app identifier includes a certain string We do some ‘gsub`bing, because we can’t really know the profile type, so we’ll just look at the name and see if it includes the export method (which it usually does, but with different notations)

Returns:



71
72
73
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 71

def app_identifier_contains?(str, contains)
  return str.to_s.gsub("-", "").gsub(" ", "").gsub("InHouse", "enterprise").downcase.include?(contains.to_s.gsub("-", "").gsub(" ", "").downcase)
end

#detect_configuration_for_archive ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 101

def detect_configuration_for_archive
  extract_from_scheme = lambda do
    if self.project.workspace?
      available_schemes = self.project.workspace.schemes.reject { |k, v| v.include?("Pods/Pods.xcodeproj") }
      project_path = available_schemes[Gym.config[:scheme]]
    else
      project_path = self.project.path
    end

    if project_path
      scheme_path = File.join(project_path, "xcshareddata", "xcschemes", "#{Gym.config[:scheme]}.xcscheme")
      Xcodeproj::XCScheme.new(scheme_path).archive_action.build_configuration if File.exist?(scheme_path)
    end
  end

  configuration = Gym.config[:configuration]
  configuration ||= extract_from_scheme.call if Gym.config[:scheme]
  configuration ||= self.project.default_build_settings(key: "CONFIGURATION")
  return configuration
end

#detect_project_profile_mapping ⇒ Object 



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
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 122

def detect_project_profile_mapping
  provisioning_profile_mapping = {}
  specified_configuration = detect_configuration_for_archive

  self.project.project_paths.each do |project_path|
    UI.verbose("Parsing project file '#{project_path}' to find selected provisioning profiles")
    UI.verbose("Finding provision profiles for '#{specified_configuration}'") if specified_configuration

    begin
      # Storing bundle identifiers with duplicate profiles
      # for informing user later on
      bundle_identifiers_with_duplicates = []

      project = Xcodeproj::Project.open(project_path)
      project.targets.each do |target|
        target.build_configuration_list.build_configurations.each do |build_configuration|
          current = build_configuration.build_settings
          next if test_target?(current)
          sdkroot = build_configuration.resolve_build_setting("SDKROOT", target)
          next unless same_platform?(sdkroot)
          next unless specified_configuration == build_configuration.name

          # Catalyst apps will have some build settings that will have a configuration
          # that is specfic for macos so going to do our best to capture those
          #
          # There are other platform filters besides "[sdk=macosx*]" that we could use but
          # this is the default that Xcode will use so this will also be our default
          sdk_specifier = Gym.building_mac_catalyst_for_mac? ? "[sdk=macosx*]" : ""

          # Look for sdk specific bundle identifier (if set) and fallback to general configuration if none
          bundle_identifier = build_configuration.resolve_build_setting("PRODUCT_BUNDLE_IDENTIFIER#{sdk_specifier}", target)
          bundle_identifier ||= build_configuration.resolve_build_setting("PRODUCT_BUNDLE_IDENTIFIER", target)
          next unless bundle_identifier

          # Xcode prefixes "maccatalyst." if building a Catalyst app for mac and
          # if DERIVE_MACCATALYST_PRODUCT_BUNDLE_IDENTIFIER is set to YES
          if Gym.building_mac_catalyst_for_mac? && build_configuration.resolve_build_setting("DERIVE_MACCATALYST_PRODUCT_BUNDLE_IDENTIFIER", target) == "YES"
            bundle_identifier = "maccatalyst.#{bundle_identifier}"
          end

          # Look for sdk specific provisioning profile specifier (if set) and fallback to general configuration if none
          provisioning_profile_specifier = build_configuration.resolve_build_setting("PROVISIONING_PROFILE_SPECIFIER#{sdk_specifier}", target)
          provisioning_profile_specifier ||= build_configuration.resolve_build_setting("PROVISIONING_PROFILE_SPECIFIER", target)

          # Look for sdk specific provisioning profile uuid (if set) and fallback to general configuration if none
          provisioning_profile_uuid = build_configuration.resolve_build_setting("PROVISIONING_PROFILE#{sdk_specifier}", target)
          provisioning_profile_uuid ||= build_configuration.resolve_build_setting("PROVISIONING_PROFILE", target)

          has_profile_specifier = provisioning_profile_specifier.to_s.length > 0
          has_profile_uuid = provisioning_profile_uuid.to_s.length > 0

          # Stores bundle identifiers that have already been mapped to inform user
          if provisioning_profile_mapping[bundle_identifier] && (has_profile_specifier || has_profile_uuid)
            bundle_identifiers_with_duplicates << bundle_identifier
          end

          # Creates the mapping for a bundle identifier and profile specifier/uuid
          if has_profile_specifier
            provisioning_profile_mapping[bundle_identifier] = provisioning_profile_specifier
          elsif has_profile_uuid
            provisioning_profile_mapping[bundle_identifier] = provisioning_profile_uuid
          end
        end

        # Alerting user to explicitly specify a mapping if cannot be determined
        next if bundle_identifiers_with_duplicates.empty?
        UI.error("Couldn't automatically detect the provisioning profile mapping")
        UI.error("There were multiple profiles for bundle identifier(s): #{bundle_identifiers_with_duplicates.uniq.join(', ')}")
        UI.error("You need to provide an explicit mapping of what provisioning")
        UI.error("profile to use for each bundle identifier of your app")
      end
    rescue => ex
      # We catch errors here, as we might run into an exception on one included project
      # But maybe the next project actually contains the information we need
      if Helper.xcode_at_least?("9.0")
        UI.error("Couldn't automatically detect the provisioning profile mapping")
        UI.error("Since Xcode 9 you need to provide an explicit mapping of what")
        UI.error("provisioning profile to use for each target of your app")
        UI.error(ex)
        UI.verbose(ex.backtrace.join("\n"))
      end
    end
  end

  return provisioning_profile_mapping
end

#merge_profile_mapping(primary_mapping: nil, secondary_mapping: nil, export_method: nil) ⇒ Object

Parameters:

  • primary_mapping (Hash) (defaults to: nil) —

    The preferred mapping (e.g. whatever the user provided)

  • secondary_mapping (Hash) (defaults to: nil) —

    (optional) The secondary mapping (e.g. whatever is detected from the Xcode project)

  • export_method (String) (defaults to: nil) —

    The method that should be preferred in case there is a conflict



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
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 16

def merge_profile_mapping(primary_mapping: nil, secondary_mapping: nil, export_method: nil)
  final_mapping = (primary_mapping || {}).dup # for verbose output at the end of the method
  secondary_mapping ||= self.detect_project_profile_mapping # default to Xcode project

  final_mapping = Hash[final_mapping.map { |k, v| [k.to_sym, v] }]
  secondary_mapping = Hash[secondary_mapping.map { |k, v| [k.to_sym, v] }]

  # Now it's time to merge the (potentially) existing mapping
  #   (e.g. coming from `provisioningProfiles` of the `export_options` or from previous match calls)
  # with the secondary hash we just created (or was provided as parameter).
  # Both might include information about what profile to use
  # This is important as it might not be clear for the user that they have to call match for each app target
  # before adding this code, we'd only either use whatever we get from match, or what's defined in the Xcode project
  # With the code below, we'll make sure to take the best of it:
  #
  #   1) A provisioning profile is defined in the `primary_mapping`
  #   2) A provisioning profile is defined in the `secondary_mapping`
  #   3) On a conflict (app identifier assigned both in xcode and match)
  #     3.1) we'll choose whatever matches what's defined as the `export_method`
  #     3.2) If both include the right `export_method`, we'll prefer the one from `primary_mapping`
  #     3.3) If none has the right export_method, we'll use whatever is defined in the Xcode project
  #
  # To get a better sense of this, check out code_signing_spec.rb for some test cases

  secondary_mapping.each do |bundle_identifier, provisioning_profile|
    if final_mapping[bundle_identifier].nil?
      final_mapping[bundle_identifier] = provisioning_profile
    else
      if self.app_identifier_contains?(final_mapping[bundle_identifier], export_method) # 3.1 + 3.2 nothing to do in this case
      elsif self.app_identifier_contains?(provisioning_profile, export_method)
        # Also 3.1 (3.1 is "implemented" twice, as it could be either the primary, or the secondary being the one that matches)
        final_mapping[bundle_identifier] = provisioning_profile
      else
        # 3.3
        final_mapping[bundle_identifier] = provisioning_profile
      end
    end
  end

  UI.verbose("Merging provisioning profile mappings")
  UI.verbose("-------------------------------------")
  UI.verbose("Primary provisioning profile mapping:")
  UI.verbose(primary_mapping)
  UI.verbose("Secondary provisioning profile mapping:")
  UI.verbose(secondary_mapping)
  UI.verbose("Resulting in the following mapping:")
  UI.verbose(final_mapping)

  return final_mapping
end

#same_platform?(sdkroot) ⇒ Boolean

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 79

def same_platform?(sdkroot)
  destination = Gym.config[:destination].dup
  destination.slice!("generic/platform=")
  destination_sdkroot = []
  case destination
  when "macosx"
    destination_sdkroot = ["macosx"]
  when "iOS"
    destination_sdkroot = ["iphoneos", "watchos"]
  when "tvOS"
    destination_sdkroot = ["appletvos"]
  end

  # Catalyst projects will always have an "iphoneos" sdkroot
  # Need to force a same platform when trying to build as macos
  if Gym.building_mac_catalyst_for_mac?
    return true
  end

  return destination_sdkroot.include?(sdkroot)
end

#test_target?(build_settings) ⇒ Boolean

Returns:



75
76
77
 
# File 'gym/lib/gym/code_signing_mapping.rb', line 75

def test_target?(build_settings)
  return (!build_settings["TEST_TARGET_NAME"].nil? || !build_settings["TEST_HOST"].nil?)
end