Merge pull request #3307 from SwiftPackageIndex/fix-collection-tests

Update base image, tests

Author: finestructure

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM registry.gitlab.com/finestructure/spi-base:1.0.1
+FROM registry.gitlab.com/finestructure/spi-base:1.0.2
 
 # Install SPM build dependencies
 RUN apt-get update && apt-get install -y curl git make unzip \

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     container:
-      image: registry.gitlab.com/finestructure/spi-base:1.0.1
+      image: registry.gitlab.com/finestructure/spi-base:1.0.2
       options: --privileged
     services:
       postgres:

.github/workflows/query-performance.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: true
     container:
-      image: registry.gitlab.com/finestructure/spi-base:1.0.1
+      image: registry.gitlab.com/finestructure/spi-base:1.0.2
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

Dockerfile

@@ -18,7 +18,7 @@
 # ================================
 # Build image
 # ================================
-FROM registry.gitlab.com/finestructure/spi-base:1.0.1 as build
+FROM registry.gitlab.com/finestructure/spi-base:1.0.2 as build
 
 # Set up a build area
 WORKDIR /build
@@ -61,7 +61,7 @@ RUN [ -d /build/Resources ] && { mv /build/Resources ./Resources && chmod -R a-w
 # ================================
 # Run image
 # ================================
-FROM registry.gitlab.com/finestructure/spi-base:1.0.1
+FROM registry.gitlab.com/finestructure/spi-base:1.0.2
 
 # NB sas 2022-09-23: We're not using a dedicated `vapor` user to run the executable, because it
 # makes managing the data in the checkouts volume difficult. See

LOCAL_DEVELOPMENT_SETUP.md

@@ -218,7 +218,7 @@ The trickiest part of this is to ensure the test or app container can connect to
 So, in order to run the tests in a Linux container run:
 
 ```
-docker run --rm -v "$PWD":/host -w /host --add-host=host.docker.internal:host-gateway registry.gitlab.com/finestructure/spi-base:1.0.1 swift test
+docker run --rm -v "$PWD":/host -w /host --add-host=host.docker.internal:host-gateway registry.gitlab.com/finestructure/spi-base:1.0.2 swift test
 ```
 
 Make sure you use the most recent `spi-base` image. You can find the latest image name in the `test-docker` target, which also provides a convenient way to run all all tests in a docker container.

Makefile

@@ -68,7 +68,7 @@ test-docker:
 	@# run tests inside a docker container
 	docker run --rm -v "$(PWD)":/host -w /host \
 	  --add-host=host.docker.internal:host-gateway \
-	  registry.gitlab.com/finestructure/spi-base:1.0.1 \
+	  registry.gitlab.com/finestructure/spi-base:1.0.2 \
 	  make test
 
 test-e2e: db-reset reconcile ingest analyze

Tests/AppTests/ApiTests.swift

@@ -414,10 +414,12 @@ class ApiTests: AppTestCase {
         // setup
         Current.builderToken = { "secr3t" }
         let p = try savePackage(on: app.db, "1")
-        let originalPackageUpdate = p.updatedAt
+        let originalPackageUpdate = try XCTUnwrap(p.updatedAt)
         let v = try Version(package: p, latest: .defaultBranch)
         try await v.save(on: app.db)
         let versionId = try v.requireID()
+        // Sleep for 1ms to ensure we can detect a difference between update times.
+        try await Task.sleep(nanoseconds: UInt64(1e6))
 
         // MUT
         let dto: API.PostBuildReportDTO = .init(
@@ -448,7 +450,22 @@ class ApiTests: AppTestCase {
             afterResponse: { res async throws in
                 // validation
                 let p = try await XCTUnwrapAsync(await Package.find(p.id, on: app.db))
-                XCTAssertEqual(p.updatedAt, originalPackageUpdate)
+#if os(Linux)
+                if p.updatedAt == originalPackageUpdate {
+                    logWarning()
+                    // When this triggers, remove Task.sleep above and the validtion below until // TEMPORARY - END
+                    // and replace with original assert:
+                    //      XCTAssertEqual(p.updatedAt, originalPackageUpdate)
+                }
+#endif
+                let updatedAt = try XCTUnwrap(p.updatedAt)
+                // Comaring the dates directly fails due to tiny rounding differences with the new swift-foundation types on Linux
+                // E.g.
+                // 1724071056.5824609
+                // 1724071056.5824614
+                // By testing only to accuracy 10e-5 and delaying by 10e-3 we ensure we properly detect if the value was changed.
+                XCTAssertEqual(updatedAt.timeIntervalSince1970, originalPackageUpdate.timeIntervalSince1970, accuracy: 10e-5)
+                // TEMPORARY - END
             })
     }
 
@@ -1086,3 +1103,10 @@ extension String {
         return try s.generateToken(for: "", contact: "", tier: tier)
     }
 }
+
+
+private func logWarning(filePath: StaticString = #filePath,
+                        lineNumber: UInt = #line,
+                        testName: String = #function) {
+    print("::error file=\(filePath),line=\(lineNumber),title=\(testName)::Direct comparison of updatedAt is working again, replace comparison with the Task.sleep delay.")
+}

Tests/AppTests/HomeIndexModelTests.swift

@@ -33,24 +33,55 @@ class HomeIndexModelTests: AppTestCase {
                               reference: .tag(.init(1, 2, 3))).save(on: app.db)
         try await RecentPackage.refresh(on: app.db)
         try await RecentRelease.refresh(on: app.db)
+        // Sleep for 1ms to ensure we can detect a difference between update times.
+        try await Task.sleep(nanoseconds: UInt64(1e6))
 
         // MUT
         let m = try await HomeIndex.Model.query(database: app.db)
 
         // validate
         let createdAt = try XCTUnwrap(pkg.createdAt)
-        XCTAssertEqual(m.recentPackages, [
+#if os(Linux)
+        if m.recentPackages == [
             .init(
                 date: createdAt,
                 link: .init(label: "Package", url: "/foo/1")
             )
-        ])
+        ] {
+            logWarning()
+            // When this triggers, remove Task.sleep above and the validtion below until // TEMPORARY - END
+            // and replace with original assert:
+            //     XCTAssertEqual(m.recentPackages, [
+            //         .init(
+            //             date: createdAt,
+            //             link: .init(label: "Package", url: "/foo/1")
+            //         )
+            //     ])
+        }
+#endif
+        XCTAssertEqual(m.recentPackages.count, 1)
+        let recent = try XCTUnwrap(m.recentPackages.first)
+        // Comaring the dates directly fails due to tiny rounding differences with the new swift-foundation types on Linux
+        // E.g.
+        // 1724071056.5824609
+        // 1724071056.5824614
+        // By testing only to accuracy 10e-5 and delaying by 10e-3 we ensure we properly detect if the value was changed.
+        XCTAssertEqual(recent.date.timeIntervalSince1970, createdAt.timeIntervalSince1970, accuracy: 10e-5)
+        XCTAssertEqual(recent.link, .init(label: "Package", url: "/foo/1"))
         XCTAssertEqual(m.recentReleases, [
             .init(packageName: "Package",
                   version: "1.2.3",
                   date: "\(date: Date(timeIntervalSince1970: 0), relativeTo: Current.date())",
                   url: "/foo/1"),
         ])
+        // TEMPORARY - END
     }
 
 }
+
+
+private func logWarning(filePath: StaticString = #filePath,
+                        lineNumber: UInt = #line,
+                        testName: String = #function) {
+    print("::error file=\(filePath),line=\(lineNumber),title=\(testName)::Direct comparison of recentPackages is working again, replace by-property comparison with the Task.sleep delay.")
+}

Tests/AppTests/__Snapshots__/PackageCollectionControllerTests/test_owner_request.1.json

@@ -51,8 +51,8 @@
           },
           "signer" : {
             "commonName" : "Swift Package Index",
-            "organizationalUnitName" : "Swift Package Index",
             "organizationName" : "Swift Package Index",
+            "organizationalUnitName" : "Swift Package Index",
             "type" : "ADP"
           },
           "verifiedCompatibility" : [

Tests/AppTests/__Snapshots__/PackageCollectionTests/test_generate_for_owner.1.json

@@ -59,8 +59,8 @@
           },
           "signer" : {
             "commonName" : "Swift Package Index",
-            "organizationalUnitName" : "Swift Package Index",
             "organizationName" : "Swift Package Index",
+            "organizationalUnitName" : "Swift Package Index",
             "type" : "ADP"
           },
           "verifiedCompatibility" : [
@@ -123,8 +123,8 @@
           },
           "signer" : {
             "commonName" : "Swift Package Index",
-            "organizationalUnitName" : "Swift Package Index",
             "organizationName" : "Swift Package Index",
+            "organizationalUnitName" : "Swift Package Index",
             "type" : "ADP"
           },
           "verifiedCompatibility" : [