Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix unstable reads for XCSchemeManagement #758

Merged
merged 1 commit into from
Apr 24, 2023
Merged

Fix unstable reads for XCSchemeManagement #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions Fixtures/Schemes/xcschememanagement.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,36 @@
<dict>
<key>SchemeUserState</key>
<dict>
<key>App.xcscheme</key>
<dict>
<key>isShown</key>
<false/>
<key>orderHint</key>
<integer>0</integer>
</dict>
<key>Test 0.xcscheme</key>
<dict>
<key>orderHint</key>
<integer>3</integer>
</dict>
<key>Test 1.xcscheme</key>
<dict>
<key>isShown</key>
<false/>
<key>orderHint</key>
<integer>4</integer>
</dict>
<key>Tuist.xcscheme_^#shared#^_</key>
<dict>
<key>isShown</key>
<true/>
<key>orderHint</key>
<integer>0</integer>
<integer>1</integer>
</dict>
<key>XcodeProj.xcscheme</key>
<dict>
<key>orderHint</key>
<integer>1</integer>
<integer>2</integer>
</dict>
</dict>
<key>SuppressBuildableAutocreation</key>
Expand Down
4 changes: 3 additions & 1 deletion Sources/XcodeProj/Scheme/XCSchemeManagement.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,9 @@ public struct XCSchemeManagement: Codable, Equatable, Writable {
let container = try decoder.container(keyedBy: CodingKeys.self)
self.suppressBuildableAutocreation = try container.decodeIfPresent(.suppressBuildableAutocreation)
if let schemeUserStateDictionary = try container.decodeIfPresent([String: Any].self, forKey: .schemeUserState) {
self.schemeUserState = try schemeUserStateDictionary.compactMap({ (key, value) -> XCSchemeManagement.UserStateScheme? in
self.schemeUserState = try schemeUserStateDictionary
.sorted(by: { $0.key < $1.key })
.compactMap({ (key, value) -> XCSchemeManagement.UserStateScheme? in
var name = key
guard var valueDictionary = value as? [String: Any] else { return nil }
if key.contains("_^#shared#^_") {
Expand Down
52 changes: 36 additions & 16 deletions Tests/XcodeProjTests/Scheme/XCSchemeManagementTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,37 @@ final class XCSchemeManagementTests: XCTestCase {
let got = try XCSchemeManagement.init(path: path)

// Then
let autocreationTarget = try XCTUnwrap(got.suppressBuildableAutocreation?["E525238B16245A900012E2BA"])
XCTAssertEqual(autocreationTarget.primary, true)

let tuistScheme = try XCTUnwrap(got.schemeUserState?.first(where: {$0.name == "Tuist.xcscheme"}))
XCTAssertEqual(tuistScheme.name, "Tuist.xcscheme")
XCTAssertTrue(tuistScheme.shared)
XCTAssertEqual(tuistScheme.isShown, true)
XCTAssertEqual(tuistScheme.orderHint, 0)

let xcodeprojScheme = try XCTUnwrap(got.schemeUserState?.first(where: {$0.name == "XcodeProj.xcscheme"}))
XCTAssertEqual(xcodeprojScheme.name, "XcodeProj.xcscheme")
XCTAssertFalse(xcodeprojScheme.shared)
XCTAssertNil(xcodeprojScheme.isShown)
XCTAssertEqual(xcodeprojScheme.orderHint, 1)
XCTAssertEqual(got.suppressBuildableAutocreation, [
"E525238B16245A900012E2BA": .init(primary: true),
])

XCTAssertEqual(got.schemeUserState, [
.init(name: "App.xcscheme", shared: false, orderHint: 0, isShown: false),
.init(name: "Test 0.xcscheme", shared: false, orderHint: 3, isShown: nil),
.init(name: "Test 1.xcscheme", shared: false, orderHint: 4, isShown: false),
.init(name: "Tuist.xcscheme", shared: true, orderHint: 1, isShown: true),
.init(name: "XcodeProj.xcscheme", shared: false, orderHint: 2, isShown: nil),
])
}

func test_read_write_produces_no_diff() throws {
try testReadWriteProducesNoDiff(from: xcschememanagementPath, initModel: XCSchemeManagement.init(path:))
}

func test_read_is_stable() throws {
// Given
let path = xcschememanagementPath

// When
let reads = try (0..<10).map { _ in
try XCSchemeManagement(path: path)
}

// Then
let unstableReads = reads.dropFirst().filter { $0 != reads.first }
XCTAssertTrue(unstableReads.isEmpty)
}

func test_write_produces_no_diff() throws {
let tmpDir = try Path.uniqueTemporary()
defer {
Expand All @@ -42,8 +53,17 @@ final class XCSchemeManagementTests: XCTestCase {
try tmpDir.chdir {
// Write
let plistPath = tmpDir + "xcschememanagement.plist"
let subject = XCSchemeManagement(schemeUserState: [.init(name: "Test.xcscheme", shared: true, orderHint: 0, isShown: true)],
suppressBuildableAutocreation: ["E525238B16245A900012E2BA": .init(primary: true)])
let subject = XCSchemeManagement(
schemeUserState: [
.init(name: "Test 0.xcscheme", shared: true, orderHint: 0, isShown: true),
.init(name: "Test 1.xcscheme", shared: true, orderHint: 1, isShown: true),
.init(name: "Test 2.xcscheme", shared: true, orderHint: 2, isShown: false),
.init(name: "Test 3.xcscheme", shared: true, orderHint: 3, isShown: true),
],
suppressBuildableAutocreation: [
"E525238B16245A900012E2BA": .init(primary: true),
]
)
try subject.write(path: plistPath, override: true)

// Create a commit
Expand Down