Given/When/Then for all tests

Author: joshheald

Modules/Tests/YosemiteTests/Storage/PersistedProductTests.swift

@@ -122,6 +122,7 @@ struct PersistedProductTests {
 
     @Test("A Product's images and attributes are fetched automatically")
     func product_with_associations_fetches_related_records() throws {
+        // Given
         let grdbManager = try GRDBManager()
         let db = grdbManager.databaseConnection
 
@@ -136,15 +137,15 @@ struct PersistedProductTests {
                 siteID: 1,
                 name: "Test Product",
                 productTypeKey: "simple",
-                fullDescription: "Full description",
-                shortDescription: "Short description",
-                sku: "TEST-SKU",
-                globalUniqueID: "GID-100",
+                fullDescription: nil,
+                shortDescription: nil,
+                sku: nil,
+                globalUniqueID: nil,
                 price: "29.99",
                 downloadable: false,
                 parentID: 0,
-                manageStock: true,
-                stockQuantity: 10,
+                manageStock: false,
+                stockQuantity: nil,
                 stockStatusKey: "instock"
             )
             try product.insert(db)
@@ -190,23 +191,17 @@ struct PersistedProductTests {
             try attribute2.insert(db)
         }
 
-        // Test automatic fetching via associations
+        // When the product is fetched and converted to a POSProduct
         let fetchedProduct = try db.read { db in
             try PersistedProduct.filter(PersistedProduct.Columns.id == 100).fetchOne(db)
         }
 
         let product = try #require(fetchedProduct)
         let posProduct = try product.toPOSProduct(db: db)
 
-        // Verify product fields
+        // Then during conversion, images and attributes are populated via associations
+        // Verify product
         #expect(posProduct.productID == 100)
-        #expect(posProduct.siteID == 1)
-        #expect(posProduct.name == "Test Product")
-        #expect(posProduct.fullDescription == "Full description")
-        #expect(posProduct.shortDescription == "Short description")
-        #expect(posProduct.sku == "TEST-SKU")
-        #expect(posProduct.price == "29.99")
-        #expect(posProduct.stockQuantity == 10)
 
         // Verify images were fetched
         #expect(posProduct.images.count == 2)
@@ -235,6 +230,7 @@ struct PersistedProductTests {
 
     @Test("Product without related records has empty arrays")
     func product_without_related_records_creates_empty_arrays() throws {
+        // Given a product without any images or attributes
         let grdbManager = try GRDBManager()
         let db = grdbManager.databaseConnection
 
@@ -243,7 +239,6 @@ struct PersistedProductTests {
             let site = PersistedSite(id: 3)
             try site.insert(db)
 
-            // Insert product without any images or attributes
             let product = PersistedProduct(
                 id: 300,
                 siteID: 3,
@@ -263,20 +258,19 @@ struct PersistedProductTests {
             try product.insert(db)
         }
 
-        // Test that product with no related records returns empty arrays
+        // When we retrieve and convert the product to a POSProduct
         let fetchedProduct = try db.read { db in
             try PersistedProduct.filter(PersistedProduct.Columns.id == 300).fetchOne(db)
         }
 
         let product = try #require(fetchedProduct)
         let posProduct = try product.toPOSProduct(db: db)
 
+        // Then the POSProduct has empty arrays for images and attributes
         #expect(posProduct.productID == 300)
         #expect(posProduct.name == "Lonely Product")
         #expect(posProduct.images.isEmpty)
         #expect(posProduct.attributes.isEmpty)
-        #expect(posProduct.fullDescription == nil)
-        #expect(posProduct.shortDescription == nil)
     }
 
     @Test("PersistedProductAttribute init(from:) and toProductAttribute round-trip")

Modules/Tests/YosemiteTests/Storage/PersistedProductVariationTests.swift

@@ -112,6 +112,7 @@ struct PersistedProductVariationTests {
 
     @Test("ProductVariation with associations fetches attributes and image automatically")
     func product_variation_with_associations_fetches_related_records() throws {
+        // Given a persisted variation with associations
         let grdbManager = try GRDBManager()
         let db = grdbManager.databaseConnection
 
@@ -179,7 +180,7 @@ struct PersistedProductVariationTests {
             try attr2.insert(db)
         }
 
-        // Test automatic fetching via associations
+        // When we fetch it, specifying inclusion of image and attributes
         struct DetailedVariation: Decodable, FetchableRecord {
             var variation: PersistedProductVariation
             var image: PersistedProductVariationImage
@@ -212,6 +213,7 @@ struct PersistedProductVariationTests {
         #expect(fetchedVariation?.variation.stockQuantity == nil)
         #expect(fetchedVariation?.variation.stockStatusKey == "outofstock")
 
+        // Then the image and attributes are included in the fetched data
         // Verify image was fetched
         #expect(fetchedVariation?.image.id == 600)
         #expect(fetchedVariation?.image.src == "https://example.com/var-img.png")
@@ -229,6 +231,7 @@ struct PersistedProductVariationTests {
 
     @Test("ProductVariation without image returns nil image")
     func product_variation_without_image_returns_nil() throws {
+        // Given a persisted variation without an image
         let grdbManager = try GRDBManager()
         let db = grdbManager.databaseConnection
 
@@ -280,14 +283,15 @@ struct PersistedProductVariationTests {
             try attr.insert(db)
         }
 
-        // Test that variation with no image returns nil for image
+        // When we fetch that variation
         let fetchedVariation = try db.read { db in
             try PersistedProductVariation.filter(PersistedProductVariation.Columns.id == 700).fetchOne(db)
         }
 
         let variation = try #require(fetchedVariation)
         let posVariation = try variation.toPOSProductVariation(db: db)
 
+        // Then the image is nil
         #expect(posVariation.productVariationID == 700)
         #expect(posVariation.image == nil)
         #expect(posVariation.attributes.count == 1)