Feat: Propagate global properties into variants (#248)

* fix: remove path config from old installation method

* feat: make custom global properties available to all variants

* chore: bump nokogiri version

* fix: unit tests

* fix: linter errors

* chore: add unit test for global and variant custom properties

Author: GMinucci

Gemfile.lock

@@ -189,9 +189,15 @@ GEM
     nanaimo (0.4.0)
     naturally (2.2.1)
     nkf (0.2.0)
-    nokogiri (1.15.7)
+    nokogiri (1.18.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    nokogiri (1.18.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.2-x86_64-linux-gnu)
+      racc (~> 1.4)
     optparse (0.6.0)
     os (1.1.4)
     plist (3.7.2)

Sources/VariantsCore/Custom Types/Project/iOSProject.swift

@@ -101,7 +101,6 @@ class iOSProject: Project {
 
                 var customProperties: [CustomProperty] = (variant.custom ?? []) + (configuration.custom ?? [])
                 customProperties.append(variant.destinationProperty)
-                
                 // Create 'variants_params.rb' with parameters whose
                 // destination are set as '.fastlane'
                 try? storeFastlaneParams(customProperties)
@@ -129,11 +128,12 @@ class iOSProject: Project {
                 // destination are set as '.project'
                 let configPath = Path(spec).absolute().parent()
                 do {
-                    try configFactory.createConfig(with: target,
-                                                   variant: defaultVariant,
-                                                   xcodeProj: configuration.xcodeproj,
-                                                   configPath: configPath,
-                                                   addToXcodeProj: true)
+                    try configFactory.createConfig(
+                        with: target,
+                        variant: defaultVariant,
+                        xcodeProj: configuration.xcodeproj,
+                        configPath: configPath,
+                        addToXcodeProj: true)
                 } catch {
                     Logger.shared.logFatal(item: error.localizedDescription)
                 }

Sources/VariantsCore/Custom Types/TemplateDirectory.swift

@@ -15,7 +15,6 @@ struct TemplateDirectory {
 
     init(
         directories: [String] = [
-            "/usr/local/lib/variants/templates",
             "~/.local/lib/variants/templates",
             "./Templates"
         ]

Sources/VariantsCore/Custom Types/UtilsDirectory.swift

@@ -15,7 +15,6 @@ struct UtilsDirectory {
 
     init(
         directories: [String] = [
-            "/usr/local/lib/variants/utils",
             "~/.local/lib/variants/utils",
             "./utils"
         ]

Sources/VariantsCore/Factory/iOS/VariantsFileFactory.swift

@@ -24,19 +24,15 @@ class VariantsFileFactory {
             let path = try TemplateDirectory().path
             guard let variantsGybTemplatePath = try? path.safeJoin(path: Path("ios/"))
             else { return }
-            let secrets = variant.custom?.secrets() ?? []
-            let configurationValues = variant.custom?.configurationValues() ?? []
+
             let context = [
-                "secrets": secrets,
-                "configurationValues": configurationValues
+                "secrets": variant.custom?.projectSecretConfigurationValues ?? [],
+                "configurationValues": variant.custom?.projectConfigurationValues ?? []
             ] as [String: Any]
             let environment = Environment(loader: FileSystemLoader(paths: [variantsGybTemplatePath.absolute()]))
-            let rendered = try environment.renderTemplate(name: StaticPath.Template.variantsSwiftGybFileName,
+            let content = try environment.renderTemplate(name: StaticPath.Template.variantsSwiftGybFileName,
                                                           context: context)
-            // Replace multiple empty lines by one only
-            let lines = rendered.split(whereSeparator: \.isNewline)
-            let content = lines.joined(separator: "\n")
-            
+
             try write(Data(content.utf8), using: configFilePath.parent().absolute())
             let variantsGybFile = try configFilePath.parent().absolute()
                 .safeJoin(path: Path(StaticPath.Xcode.variantsGybFileName))
@@ -71,17 +67,17 @@ class VariantsFileFactory {
             fileContent == data
         else { return }
 
+        let variantsOutputFilePath = "\(variantsGybFile.parent().absolute().string)/Variants.swift"
         let gybStdErr = try Bash(gybExecutablePath.absolute().description,
                  arguments:
                     "--line-directive",
                     "",
                     "-o",
-                    "Variants.swift",
+                    variantsOutputFilePath,
                     variantsGybFile.absolute().description
         ).capture(stream: .stderr)
-        let variantsFilePath = "\(variantsGybFile.parent().abbreviate().string)/Variants.swift"
-        handleGybErrors(message: gybStdErr, variantsFilePath: variantsFilePath)
-        logger.logInfo("⚙️  ", item: "'\(variantsFilePath)' has been generated with success", color: .green)
+        handleGybErrors(message: gybStdErr, variantsFilePath: variantsOutputFilePath)
+        logger.logInfo("⚙️  ", item: "'\(variantsOutputFilePath)' has been generated with success", color: .green)
     }
 
     private func handleGybErrors(message: String?, variantsFilePath: String) {
@@ -118,20 +114,3 @@ class VariantsFileFactory {
 
     let logger: Logger
 }
-
-fileprivate extension Sequence where Iterator.Element == CustomProperty {
-    func secrets() -> [CustomProperty] {
-        return self
-            .filter({ $0.destination == .project && $0.isEnvironmentVariable })
-            .map { (property) -> CustomProperty in
-                return CustomProperty(name: property.name,
-                                      value: "os.environ.get('"+property.environmentValue+"')",
-                                      destination: property.destination)
-            }
-    }
-    
-    func configurationValues() -> [CustomProperty] {
-        return self
-            .filter({ $0.destination == .project && !$0.isEnvironmentVariable })
-    }
-}

Sources/VariantsCore/Factory/iOS/XCConfigFactory.swift

@@ -111,7 +111,7 @@ class XCConfigFactory: XCFactory {
         let infoPath = target.value.source.info
         let infoPlistPath = Path("\(configPath)/\(infoPath)")
         updateInfoPlist(with: target.value, configFile: infoPlistPath, variant: variant)
-        
+
         /*
          * Add custom properties whose values should be read from environment variables
          * to `Variants.Secret` as encrypted secrets.

Sources/VariantsCore/Schemas/Configuration.swift

@@ -75,3 +75,19 @@ extension CustomProperty {
         }
     }
 }
+
+extension Sequence where Iterator.Element == CustomProperty {
+    var projectConfigurationValues: [CustomProperty] {
+        self.filter({ $0.destination == .project && !$0.isEnvironmentVariable })
+    }
+
+    var projectSecretConfigurationValues: [CustomProperty] {
+        self
+            .filter({ $0.destination == .project && $0.isEnvironmentVariable })
+            .map {
+                CustomProperty(name: $0.name,
+                               value: "os.environ.get('" + $0.environmentValue + "')",
+                               destination: $0.destination)
+        }
+    }
+}

Sources/VariantsCore/Schemas/iOS/iOSConfiguration.swift

@@ -23,24 +23,28 @@ public struct iOSConfiguration: Codable {
     private let signing: iOSSigning?
 
     var pbxproj: String {
-        return xcodeproj+"/project.pbxproj"
+        return xcodeproj + "/project.pbxproj"
     }
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         self.xcodeproj = try container.decode(String.self, forKey: .xcodeproj)
         self.targets = try container.decode([String: iOSTarget].self, forKey: .targets)
-        self.custom = try? container.decode([CustomProperty].self, forKey: .custom)
-        
+
+        let globalCustomProperties = try? container.decode([CustomProperty].self, forKey: .custom)
+        self.custom = globalCustomProperties
+
         let globalPostSwitchScript = try container.decodeIfPresent(String.self, forKey: .postSwitchScript)
         let globalSigning = try container.decodeIfPresent(iOSSigning.self, forKey: .signing)
         let variantsDict = try container.decode([String: UnnamediOSVariant].self, forKey: .variants)
 
         self.postSwitchScript = globalPostSwitchScript
         self.signing = globalSigning
         self.variants = try variantsDict
-            .map { try iOSVariant(from: $1, name: $0, globalSigning: globalSigning, globalPostSwitchScript: globalPostSwitchScript) }
+            .map { 
+                try iOSVariant(from: $1, name: $0, globalCustomProperties: globalCustomProperties,
+                    globalSigning: globalSigning, globalPostSwitchScript: globalPostSwitchScript) }
     }
 }
 

Sources/VariantsCore/Schemas/iOS/iOSVariant.swift

@@ -21,7 +21,7 @@ public struct iOSVariant: Variant {
     let postSwitchScript: String?
 
     private let bundleNamingOption: BundleNamingOption
-     
+
     public var title: String { name }
 
     var configName: String {
@@ -38,8 +38,10 @@ public struct iOSVariant: Variant {
     }
 
     init(
-        name: String, versionName: String, versionNumber: Int, appIcon: String?, appName: String?, storeDestination: String?,
-        custom: [CustomProperty]?, idSuffix: String?, bundleID: String?, variantSigning: iOSSigning?, globalSigning: iOSSigning?,
+        name: String, versionName: String, versionNumber: Int, appIcon: String?, appName: String?,
+        storeDestination: String?, idSuffix: String?, bundleID: String?,
+        globalCustomProperties: [CustomProperty]?, variantCustomProperties: [CustomProperty]?,
+        globalSigning: iOSSigning?, variantSigning: iOSSigning?,
         globalPostSwitchScript: String?, variantPostSwitchScript: String?)
     throws {
         self.name = name
@@ -49,7 +51,7 @@ public struct iOSVariant: Variant {
         self.appName = appName
         self.storeDestination = try Self.parseDestination(name: name, destination: storeDestination) ?? .appStore
         self.signing = try Self.parseSigning(name: name, variantSigning: variantSigning, globalSigning: globalSigning)
-        self.custom = custom
+        self.custom = Self.parseCustomProperties(variantCustom: variantCustomProperties, globalCustom: globalCustomProperties)
         self.bundleNamingOption = try Self.parseBundleConfiguration(name: name, idSuffix: idSuffix, bundleID: bundleID)
         self.postSwitchScript = Self.parsePostSwitchScript(globalScript: globalPostSwitchScript,
                                                            variantScript: variantPostSwitchScript)
@@ -78,14 +80,11 @@ public struct iOSVariant: Variant {
         if signing?.matchURL != nil, let exportMethod = signing?.exportMethod {
             customDictionary["V_MATCH_PROFILE"] = "\(exportMethod.prefix) \(makeBundleID(for: target))"
         }
-        
-        custom?
-            .filter { $0.destination == .project && !$0.isEnvironmentVariable }
-            .forEach { customDictionary[$0.name] = $0.value }
-        
+        (custom?.projectConfigurationValues ?? []).forEach { customDictionary[$0.name] = $0.value }
+
         return customDictionary.sorted(by: {$0.key < $1.key})
     }
-    
+
     private static func parseDestination(name: String, destination: String?) throws -> Destination? {
         guard let destinationString = destination else { return nil }
 
@@ -116,7 +115,13 @@ public struct iOSVariant: Variant {
             return nil
         }
     }
-    
+
+    private static func parseCustomProperties(variantCustom: [CustomProperty]?, globalCustom: [CustomProperty]?) -> [CustomProperty] {
+        let variantCustomProperties = variantCustom ?? []
+        let globalMinusOverrideProperties = (globalCustom ?? []).filter { !variantCustomProperties.contains($0) }
+        return globalMinusOverrideProperties + variantCustomProperties
+    }
+
     private static func parsePostSwitchScript(globalScript: String?, variantScript: String?) -> String? {
         if let globalScript = globalScript, let variantScript = variantScript {
             return "\(globalScript) && \(variantScript)"
@@ -207,19 +212,22 @@ extension UnnamediOSVariant {
 }
 
 extension iOSVariant {
-    init(from unnamediOSVariant: UnnamediOSVariant, name: String, globalSigning: iOSSigning?, globalPostSwitchScript: String?) throws {
+    init(from unnamediOSVariant: UnnamediOSVariant, name: String, globalCustomProperties: [CustomProperty]?,
+         globalSigning: iOSSigning?, globalPostSwitchScript: String?)
+    throws {
         try self.init(
             name: name,
             versionName: unnamediOSVariant.versionName,
             versionNumber: unnamediOSVariant.versionNumber,
             appIcon: unnamediOSVariant.appIcon,
             appName: unnamediOSVariant.appName,
             storeDestination: unnamediOSVariant.storeDestination,
-            custom: unnamediOSVariant.custom,
             idSuffix: unnamediOSVariant.idSuffix,
             bundleID: unnamediOSVariant.bundleID,
-            variantSigning: unnamediOSVariant.signing,
+            globalCustomProperties: globalCustomProperties,
+            variantCustomProperties: unnamediOSVariant.custom,
             globalSigning: globalSigning,
+            variantSigning: unnamediOSVariant.signing,
             globalPostSwitchScript: globalPostSwitchScript,
             variantPostSwitchScript: unnamediOSVariant.postSwitchScript)
     }

Templates/ios/Variants.swift.template.gyb

@@ -8,7 +8,6 @@ def encode(string, cipher):
     bytes = string.encode("UTF-8")
     return [ord(bytes[i]) ^ cipher[i % len(cipher)] for i in range(0, len(bytes))]
 }%
-
 //
 //  Variants
 //
@@ -29,15 +28,14 @@ public struct Variants {
     // MARK: - ConfigurationValueKey
     /// Custom configuration values coming from variants.yml as enum cases
 
-    public enum ConfigurationValueKey: String {
-    {% for confValue in configurationValues %}
+    public enum ConfigurationValueKey: String { {% for confValue in configurationValues %}
         case {{ confValue.name }}{% endfor %}
     }
 
     static func configurationValue(for key: ConfigurationValueKey) -> Any? {
         return Self.configuration[key.rawValue]
-    }{% endif %}
-    {% if secrets %}
+    }
+    {% endif %}{% if secrets %}
     // MARK: - Secrets
     /// Encrypted secrets coming from variants.yml as environment variables
 
@@ -49,8 +47,7 @@ public struct Variants {
             ${"".join(["0x%02x, " % byte for byte in chunk])}
         % end
         ]
-
-    {% for secret in secrets %}
+        {% for secret in secrets %}
         static var {{ secret.name }}: String {
             let encoded: [UInt8] = [
             % for chunk in chunks(encode({{ secret.value }}, salt), 8):
@@ -60,13 +57,11 @@ public struct Variants {
 
             return decode(encoded, cipher: salt)
         }
-    {% endfor %}
-
+        {% endfor %}
         private static func decode(_ encoded: [UInt8], cipher: [UInt8]) -> String {
             String(decoding: encoded.enumerated().map { (offset, element) in
                 element ^ cipher[offset % cipher.count]
             }, as: UTF8.self)
         }
-    }
-    {% endif %}
+    }{% endif %}
 }