Add Codable Unit Tests for ProductImageStatus, ProductImageAssetType and ProductOrVariationID
#15253
+387
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,86 @@ | ||||||
| import XCTest | ||||||
| import Photos | ||||||
| @testable import Networking | ||||||
|
|
||||||
| final class ProductImageAssetTypeCodableTests: XCTestCase { | ||||||
|
|
||||||
| func test_uiImage_encodes_and_decodes_correctly() throws { | ||||||
| // Given | ||||||
| let assetType = ProductImageAssetType.uiImage( | ||||||
| image: UIImage.checkmark, | ||||||
| filename: "test_image.png", | ||||||
| altText: "Test Alt Text" | ||||||
| ) | ||||||
|
|
||||||
| // When | ||||||
| let data = try JSONEncoder().encode(assetType) | ||||||
| let decodedAssetType = try JSONDecoder().decode(ProductImageAssetType.self, from: data) | ||||||
|
|
||||||
| // Then | ||||||
| if case let .uiImage(decodedImage, decodedFilename, decodedAltText) = decodedAssetType { | ||||||
| XCTAssertNotNil(decodedImage.pngData(), "Decoded image data should not be nil") | ||||||
| XCTAssertEqual(decodedFilename, "test_image.png") | ||||||
| XCTAssertEqual(decodedAltText, "Test Alt Text") | ||||||
| } else { | ||||||
| XCTFail("Decoded asset type should be .uiImage") | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func test_phAsset_decoding_fails_with_expected_error() throws { | ||||||
| // Given | ||||||
| let fakeLocalIdentifier = "this_is_a_fake_local_identifier" | ||||||
| let mockAsset = PHAssetMock(localIdentifier: fakeLocalIdentifier) | ||||||
| let assetType = ProductImageAssetType.phAsset(asset: mockAsset) | ||||||
|
|
||||||
| // Then | ||||||
| XCTAssertThrowsError(try { | ||||||
| let data = try JSONEncoder().encode(assetType) | ||||||
| _ = try JSONDecoder().decode(ProductImageAssetType.self, from: data) | ||||||
| }()) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertEqual(context.debugDescription, "No PHAsset found with localIdentifier \(fakeLocalIdentifier)") | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, got \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func test_decoding_unknown_asset_type_throwsError() throws { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| // Given | ||||||
| let jsonData = """ | ||||||
| { | ||||||
| "type": "unknownType" | ||||||
| } | ||||||
| """.data(using: .utf8)! | ||||||
|
|
||||||
| // Then | ||||||
| XCTAssertThrowsError(try JSONDecoder().decode(ProductImageAssetType.self, from: jsonData)) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertTrue(context.debugDescription.contains("Unknown type unknownType")) | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, but got: \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func test_invalid_Base64Data_for_UIImage_throwsError() throws { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| // Given | ||||||
| let jsonData = """ | ||||||
| { | ||||||
| "type": "uiImage", | ||||||
| "imageData": "INVALID_BASE64_DATA", | ||||||
| "filename": "test.png", | ||||||
| "altText": "Test Alt" | ||||||
| } | ||||||
| """.data(using: .utf8)! | ||||||
|
|
||||||
| // Then | ||||||
| XCTAssertThrowsError(try JSONDecoder().decode(ProductImageAssetType.self, from: jsonData)) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertTrue(context.debugDescription.contains("Invalid image data")) | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, got \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,169 @@ | ||||||
| // Start of Selection | ||||||
|
There was a problem hiding this comment. This should be deleted. |
||||||
| import XCTest | ||||||
| import Photos | ||||||
| @testable import Networking | ||||||
|
|
||||||
| final class ProductImageStatusCodableTests: XCTestCase { | ||||||
|
|
||||||
| func test_uploading_encodes_and_decodes_correctly() throws { | ||||||
| // Given | ||||||
| let status = ProductImageStatus.uploading( | ||||||
| asset: .uiImage(image: UIImage.checkmark, filename: "test.png", altText: "Test Alt"), | ||||||
| siteID: 12345, | ||||||
| productID: .product(id: 999) | ||||||
| ) | ||||||
|
|
||||||
| // When | ||||||
| let encodedData = try JSONEncoder().encode(status) | ||||||
| let decodedStatus = try JSONDecoder().decode(ProductImageStatus.self, from: encodedData) | ||||||
|
|
||||||
| // Then | ||||||
| guard case let .uploading(.uiImage(decodedImage, decodedFilename, decodedAltText), siteID, productID) = decodedStatus else { | ||||||
| return XCTFail("Decoded status should be .uploading with .uiImage asset") | ||||||
| } | ||||||
|
|
||||||
| XCTAssertNotNil(decodedImage.pngData(), "Decoded image data should not be nil") | ||||||
| XCTAssertEqual(decodedFilename, "test.png") | ||||||
| XCTAssertEqual(decodedAltText, "Test Alt") | ||||||
| XCTAssertEqual(siteID, 12345) | ||||||
| XCTAssertEqual(productID, .product(id: 999)) | ||||||
| } | ||||||
|
|
||||||
| func test_uploading_phAsset_decoding_fails_with_expected_error() throws { | ||||||
| // Given | ||||||
| let fakeLocalIdentifier = "4321" | ||||||
| let mockAsset = PHAssetMock(localIdentifier: fakeLocalIdentifier) | ||||||
| let status = ProductImageStatus.uploading( | ||||||
| asset: .phAsset(asset: mockAsset), | ||||||
| siteID: 11111, | ||||||
| productID: .variation(productID: 43, variationID: 55) | ||||||
| ) | ||||||
|
|
||||||
| // When | ||||||
| let encodedData = try JSONEncoder().encode(status) | ||||||
|
|
||||||
| // Then | ||||||
| XCTAssertThrowsError(try JSONDecoder().decode(ProductImageStatus.self, from: encodedData)) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertEqual(context.debugDescription, "No PHAsset found with localIdentifier \(fakeLocalIdentifier)") | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, but got: \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func test_remote_encodes_and_decodes_correctly() throws { | ||||||
| // Given | ||||||
| let testImage = ProductImage( | ||||||
| imageID: 111, | ||||||
| dateCreated: Date(), | ||||||
| dateModified: nil, | ||||||
| src: "https://example.com/image.png", | ||||||
| name: "Example Image", | ||||||
| alt: "Example Alt" | ||||||
| ) | ||||||
| let status = ProductImageStatus.remote( | ||||||
| image: testImage, | ||||||
| siteID: 98765, | ||||||
| productID: .variation(productID: 1, variationID: 2) | ||||||
| ) | ||||||
|
|
||||||
| // When | ||||||
| let encodedData = try JSONEncoder().encode(status) | ||||||
| let decodedStatus = try JSONDecoder().decode(ProductImageStatus.self, from: encodedData) | ||||||
|
|
||||||
| // Then | ||||||
| guard case let .remote(image, siteID, productID) = decodedStatus else { | ||||||
| return XCTFail("Decoded status should be .remote") | ||||||
| } | ||||||
|
|
||||||
| XCTAssertEqual(image.imageID, 111) | ||||||
| XCTAssertEqual(image.src, "https://example.com/image.png") | ||||||
| XCTAssertEqual(image.name, "Example Image") | ||||||
| XCTAssertEqual(image.alt, "Example Alt") | ||||||
| XCTAssertEqual(siteID, 98765) | ||||||
| XCTAssertEqual(productID, .variation(productID: 1, variationID: 2)) | ||||||
| } | ||||||
|
|
||||||
| func test_uploadFailure_encodes_and_decodes_correctly() throws { | ||||||
| // Given | ||||||
| let error = NSError(domain: "TestErrorDomain", code: 404, userInfo: ["info": "not found"]) | ||||||
| let status = ProductImageStatus.uploadFailure( | ||||||
| asset: .uiImage(image: UIImage.checkmark, filename: "failure.png", altText: nil), | ||||||
| error: error, | ||||||
| siteID: 55555, | ||||||
| productID: .product(id: 123) | ||||||
| ) | ||||||
|
|
||||||
| // When | ||||||
| let encodedData = try JSONEncoder().encode(status) | ||||||
| let decodedStatus = try JSONDecoder().decode(ProductImageStatus.self, from: encodedData) | ||||||
|
|
||||||
| // Then | ||||||
| guard case let .uploadFailure(.uiImage(_, decodedFilename, decodedAltText), decodedError as NSError, siteID, productID) = decodedStatus else { | ||||||
| return XCTFail("Decoded status should be .uploadFailure with .uiImage asset") | ||||||
| } | ||||||
|
|
||||||
| XCTAssertEqual(decodedFilename, "failure.png") | ||||||
| XCTAssertNil(decodedAltText) | ||||||
| XCTAssertEqual(decodedError.domain, "TestErrorDomain") | ||||||
| XCTAssertEqual(decodedError.code, 404) | ||||||
| XCTAssertEqual(decodedError.userInfo["info"] as? String, "not found") | ||||||
| XCTAssertEqual(siteID, 55555) | ||||||
| XCTAssertEqual(productID, .product(id: 123)) | ||||||
| } | ||||||
|
|
||||||
| func test_decoding_unknown_status_type_throwsError() throws { | ||||||
| // Given | ||||||
| let jsonString = """ | ||||||
| { | ||||||
| "type": "unknownType", | ||||||
| "siteID": 1234, | ||||||
| "productID": { | ||||||
| "type": "product", | ||||||
| "id": 999 | ||||||
| } | ||||||
| } | ||||||
| """ | ||||||
| let data = jsonString.data(using: .utf8)! | ||||||
|
|
||||||
| // Then | ||||||
| XCTAssertThrowsError(try JSONDecoder().decode(ProductImageStatus.self, from: data)) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertTrue(context.debugDescription.contains("Invalid type value")) | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, but got: \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func test_invalid_Base64Data_for_UIImage_throwsError() throws { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| // Given: | ||||||
| let jsonString = """ | ||||||
| { | ||||||
| "type": "uploading", | ||||||
| "asset": { | ||||||
| "type": "uiImage", | ||||||
| "imageData": "INVALID_BASE64_DATA", | ||||||
| "filename": "base64", | ||||||
| "altText": "BASE64" | ||||||
| }, | ||||||
| "siteID": 111, | ||||||
| "productID": { | ||||||
| "type": "product", | ||||||
| "id": 1 | ||||||
| } | ||||||
| } | ||||||
| """ | ||||||
| let data = jsonString.data(using: .utf8)! | ||||||
|
|
||||||
| // When / Then | ||||||
| XCTAssertThrowsError(try JSONDecoder().decode(ProductImageStatus.self, from: data)) { error in | ||||||
| if case let DecodingError.dataCorrupted(context) = error { | ||||||
| XCTAssertTrue(context.debugDescription.contains("Invalid image data")) | ||||||
| } else { | ||||||
| XCTFail("Expected dataCorrupted error, got \(error)") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not related to this PR: We should move the key string values
phAssetanduiImagefromProductImageAssetTypeinto a constant and reuse it while encoding and decoding. This will help avoid mistakingly editing these key values.The same comment applies for
ProductImageStatusandProductOrVariationIDas well.