Files
container/Tests/ContainerizationOCITests/OCIPlatformTests.swift
T
Vitor Hugo 4f6df44c2a fix(Platform): make arm64 nil-variant and v8 hash identically (#764)
## Summary

`Platform.==` treats `arm64` with `nil` variant as equal to `arm64/v8`,
but `hash(into:)` used `description` which serializes them differently
(`linux/arm64` vs `linux/arm64/v8`). This violates the `Hashable`
contract — equal values must produce the same hash.

### Root cause

```swift
// == returns true for these two
let a = Platform(arch: "arm64", os: "linux", variant: nil)
let b = Platform(arch: "arm64", os: "linux", variant: "v8")
a == b // true ✓

// but hash was different — broken
a.hashValue == b.hashValue // false ✗ (before this fix)
```

This mismatch caused `Set<Platform>` and `Dictionary<Platform, ...>`
lookups to silently miss entries when one platform was decoded from JSON
(no `variant` field in the manifest) and another was created via
`Platform(from:)` or `Platform.current` (which both set `variant =
"v8"`).

### Practical consequence

In `apple/container`, this manifests as inconsistent platform-string
normalization across stages of a single `container build` — some stages
log `linux/arm64`, others `linux/arm64/v8` — which can cause `COPY
--from=<stage>` to fail to resolve the source stage under concurrent
builds. See apple/container#1542.

### Fix

`hash(into:)` now normalizes `arm64` with `nil` variant to `"v8"` before
hashing, matching the existing `==` behavior.
2026-06-16 10:06:06 -04:00

85 lines
3.5 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025-2026 Apple Inc. and the Containerization project authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
//
import Testing
@testable import ContainerizationOCI
struct OCIPlatformTests {
@Test func identicalPlatforms() {
let amd64lhs = Platform(arch: "amd64", os: "linux")
let amd64rhs = Platform(arch: "amd64", os: "linux")
#expect(amd64lhs == amd64rhs, "amd64 platforms should be equal")
let arm64lhs = Platform(arch: "arm64", os: "linux")
let arm64rhs = Platform(arch: "arm64", os: "linux")
#expect(arm64lhs == arm64rhs, "arm64 platforms should be equal")
}
@Test func differentOS() {
let lhs = Platform(arch: "arm64", os: "linux")
let rhs = Platform(arch: "arm64", os: "darwin")
#expect(lhs != rhs, "Different OS should not be equal")
}
@Test func differentArch() {
let lhs = Platform(arch: "amd64", os: "linux")
let rhs = Platform(arch: "arm64", os: "linux")
#expect(lhs != rhs, "Different arch should not be equal")
}
@Test func arm64_sameVariant() {
let lhs = Platform(arch: "arm64", os: "linux", variant: "v8")
let rhs = Platform(arch: "arm64", os: "linux", variant: "v8")
#expect(lhs == rhs, "Both OS arm64, same arch, same variant => equal")
}
@Test func arm64_nilAndV8() {
let lhs = Platform(arch: "arm64", os: "linux", variant: nil)
let rhs = Platform(arch: "arm64", os: "linux", variant: "v8")
#expect(lhs == rhs, "One variant nil and other v8 => equal under special arm64 rule")
}
@Test func arm64_nilAndV7() {
let lhs = Platform(arch: "arm64", os: "linux", variant: nil)
let rhs = Platform(arch: "arm64", os: "linux", variant: "v7")
#expect(lhs != rhs, "nil vs v7 is not covered by the special rule => not equal")
}
@Test func arm64_bothNil() {
let lhs = Platform(arch: "arm64", os: "linux", variant: nil)
let rhs = Platform(arch: "arm64", os: "linux", variant: nil)
#expect(lhs == rhs, "Both nil variants => variantEqual is true => overall equal")
}
@Test func arm64_nilAndV8_sameHashValue() {
let withoutVariant = Platform(arch: "arm64", os: "linux", variant: nil)
let withV8 = Platform(arch: "arm64", os: "linux", variant: "v8")
// Equal platforms must produce the same hash — violating this breaks Set/Dictionary lookups
#expect(withoutVariant.hashValue == withV8.hashValue, "arm64 nil variant and v8 must hash identically")
}
@Test func arm64_nilAndV8_setLookup() {
let withoutVariant = Platform(arch: "arm64", os: "linux", variant: nil)
let withV8 = Platform(arch: "arm64", os: "linux", variant: "v8")
var set = Set<Platform>()
set.insert(withoutVariant)
#expect(set.contains(withV8), "arm64/v8 must be found in a Set that contains arm64 with nil variant")
}
}