ci: Verify bumped version on CI (#5268)

* ci: Verify bumped version on CI

* Print version found for each file

* Collect all errors before exiting

Author: itaybre

.github/workflows/version-bump-util.yml

@@ -14,5 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Generate Version Number
+        run: |
+          TIMESTAMP=$(date +%Y%m%d%H%M%S)
+          echo "VERSION=100.0.$TIMESTAMP" >> $GITHUB_ENV
       # We don't care which version we bump to, as long as it's a valid semver
-      - run: make bump-version TO=100.0.0
+      - run: make bump-version TO=${{ env.VERSION }}
+      - run: make verify-version TO=${{ env.VERSION }}

Makefile

@@ -119,7 +119,11 @@ build-xcframework-sample:
 # call this like `make bump-version TO=5.0.0-rc.0`
 bump-version: clean-version-bump
 	@echo "--> Bumping version from ${TO}"
-	./Utils/VersionBump/.build/debug/VersionBump ${TO}
+	./Utils/VersionBump/.build/debug/VersionBump --update ${TO}
+
+verify-version: clean-version-bump
+	@echo "--> Verifying version from ${TO}"
+	./Utils/VersionBump/.build/debug/VersionBump --verify ${TO}
 
 clean-version-bump:
 	@echo "--> Clean VersionBump"

Utils/VersionBump/main.swift

@@ -2,6 +2,38 @@ import Foundation
 import Regex
 import SwiftShell
 
+protocol ErrorHandling: Error {
+    var message: String { get }
+}
+
+enum FileError: Error, ErrorHandling {
+    case fileNotFound(String)
+    case unknownFile(String)
+    
+    var message: String {
+        switch self {
+        case .fileNotFound(let file):
+            return "File not found: \(file)"
+        case .unknownFile(let file):
+            return "Unknown file: \(file)"
+        }
+    }
+}
+
+enum VersionError: Error, ErrorHandling {
+    case versionNotFound(String)
+    case versionMismatch(String, String)
+    
+    var message: String {
+        switch self {
+        case .versionNotFound(let file):
+            return "No version found for \(file)"
+        case .versionMismatch(let file, let versionFound):
+            return "Unexpected version \(versionFound) found for file \(file)"
+        }
+    }
+}
+
 let fromVersionFile = "./Sentry.podspec"
 
 let files = [
@@ -17,7 +49,7 @@ let files = [
 // This will enable publishing apps with SDK beta version.
 let restrictFiles = [
     "./Sources/Configuration/SDK.xcconfig",
-    "./Sources/Configuration/Versioning.xcconfig", 
+    "./Sources/Configuration/Versioning.xcconfig",
     "./Sources/Configuration/SentrySwiftUI.xcconfig",
     "./Samples/Shared/Config/Versioning.xcconfig"
 ]
@@ -26,27 +58,37 @@ let args = CommandLine.arguments
 
 let semver: StaticString = "([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?"
 let regex = Regex(semver)
-if regex.firstMatch(in: args[1]) == nil {
+if regex.firstMatch(in: args[2]) == nil {
     exit(errormessage: "version number must fit x.x.x format" )
 }
 
-let fromVersionFileHandler = try open(fromVersionFile)
-let fromFileContent: String = fromVersionFileHandler.read()
+if args[1] == "--verify" {
+    let expectedVersion = args[2]
+    try verifyVersionInFiles(expectedVersion)
+} else if args[1] == "--update" {
+    try updateVersionInFiles()
+}
 
-if let match = Regex(semver, options: [.dotMatchesLineSeparators]).firstMatch(in: fromFileContent) {
-    var fromVersion = match.matchedString
-    var toVersion = args[1]
+func updateVersionInFiles() throws {
+    let fromVersionFileHandler = try open(fromVersionFile)
+    let fromFileContent: String = fromVersionFileHandler.read()
 
-    for file in files {
-        try updateVersion(file, fromVersion, toVersion)
-    }
-    
-    fromVersion = extractVersionOnly(fromVersion)
-    toVersion = extractVersionOnly(toVersion)
-    
-    for file in restrictFiles {
-        try updateVersion(file, fromVersion, toVersion)
+    if let match = Regex(semver, options: [.dotMatchesLineSeparators]).firstMatch(in: fromFileContent) {
+        var fromVersion = match.matchedString
+        var toVersion = args[2]
+
+        for file in files {
+            try updateVersion(file, fromVersion, toVersion)
+        }
+        
+        fromVersion = extractVersionOnly(fromVersion)
+        toVersion = extractVersionOnly(toVersion)
+        
+        for file in restrictFiles {
+            try updateVersion(file, fromVersion, toVersion)
+        }
     }
+    print("Successfuly updated version numbers")
 }
 
 func updateVersion(_ file: String, _ fromVersion: String, _ toVersion: String) throws {
@@ -62,3 +104,86 @@ func extractVersionOnly(_ version: String) -> String {
     guard let indexOfHypen = version.firstIndex(of: "-") else { return version }
     return String(version.prefix(upTo: indexOfHypen))
 }
+
+func verifyVersionInFiles(_ expectedVersion: String) throws {
+    var errors: [String] = []
+    let expectedVersion = args[2]
+    
+    for file in files {
+        do {
+            try verifyFile(file, expectedVersion)
+        } catch let error as ErrorHandling {
+            errors.append(error.message)
+        }
+    }
+    
+    let exactVersion = extractVersionOnly(expectedVersion)
+    for file in restrictFiles {
+        do {
+            try verifyRestrictedFile(file, expectedVersion: exactVersion)
+        } catch let error as ErrorHandling {
+            errors.append(error.message)
+        }
+    }
+    
+    if !errors.isEmpty {
+        exit(errormessage: "Could not validate all files: \n\(errors.joined(separator: "\n"))")
+    }
+    
+    print("Successfully validated files version number")
+}
+
+func verifyFile(_ file: String, _ expectedVersion: String) throws {
+    guard let fileHandler = try? open(file) else {
+        throw FileError.fileNotFound(file)
+    }
+    
+    let fileContent = fileHandler.read()
+    let regexString = try getRegexString(for: file)
+    let match = try? Regex(string: regexString, options: [.dotMatchesLineSeparators]).firstMatch(in: fileContent)
+    
+    guard let version = match?.captures[0] else {
+        throw VersionError.versionNotFound(file)
+    }
+    
+    guard version == expectedVersion else {
+        throw VersionError.versionMismatch(file, version)
+    }
+    
+    print("\(file) validated to have the correct version: \(version)")
+}
+
+func verifyRestrictedFile(_ file: String, expectedVersion: String) throws {
+    guard let fileHandler = try? open(file) else {
+        throw FileError.fileNotFound(file)
+    }
+    
+    let fileContent = fileHandler.read()
+    let marketingRegex = try? Regex(string: "MARKETING_VERSION\\s=\\s(?<version>[a-zA-z0-9\\.\\-]+)", options: [.dotMatchesLineSeparators])
+    let currentProjectRegex = try? Regex(string: "CURRENT_PROJECT_VERSION\\s=\\s(?<version>[a-zA-z0-9\\.\\-]+)", options: [.dotMatchesLineSeparators])
+    let match = marketingRegex?.firstMatch(in: fileContent) ?? currentProjectRegex?.firstMatch(in: fileContent)
+    
+    guard let version = match?.captures[0] else {
+        throw VersionError.versionNotFound(file)
+    }
+    
+    guard version == expectedVersion else {
+        throw VersionError.versionMismatch(file, version)
+    }
+    
+    print("\(file) validated to have the correct version: \(version)")
+}
+
+func getRegexString(for file: String) throws -> String {
+    if file.hasSuffix(".podspec") {
+        if file == "./Tests/HybridSDKTest/HybridPod.podspec" {
+            return "s\\.dependency\\s\"Sentry\\/HybridSDK\",\\s\"(?<version>[a-zA-z0-9\\.\\-]+)\""
+        }
+        return "\\ss\\.version\\s+=\\s\"(?<version>[a-zA-z0-9\\.\\-]+)\""
+    } else if file == "./Package.swift" {
+        return "https:\\/\\/github\\.com\\/getsentry\\/sentry-cocoa\\/releases\\/download\\/(?<version>[a-zA-z0-9\\.\\-]+)\\/Sentry"
+    } else if file == "./Sources/Sentry/SentryMeta.m" {
+        return "static NSString \\*versionString = @\"(?<version>[a-zA-z0-9\\.\\-]+)\""
+    }
+    throw FileError.unknownFile(file)
+}