ProductImageStatusStorage unit tests
#15257
Conversation
…es, and renamed it)
📝 WalkthroughWalkthroughThe changes add a new test file, Changes
Sequence Diagram(s)sequenceDiagram
participant T as Test Case
participant S as ProductImageStatusStorage
participant UD as UserDefaults
T->>S: initialize()
S->>UD: load statuses
UD-->>S: return current statuses
S->>T: emit statuses via statusesPublisher
T->>S: addStatus(status)
S->>UD: persist status
S->>T: emit updated statuses via statusesPublisher
T->>S: trigger external update (modify UserDefaults)
UD-->>S: notify change
S->>T: emit updated statuses via statusesPublisher
Note over S,T: Error handling test flow
S->>T: emit error via errorsPublisher
Suggested labels
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
pmusolino
changed the base branch from
trunk
to
feat/save-product-image-upload-statuses-in-user-defaults-part-3
|
|
…s-part-3' into feat/save-product-image-upload-statuses-in-user-defaults-part-4
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
Networking/NetworkingTests/ProductImageInBackground/ProductImageStatusStorageTests.swift (1)
340-344: Streamline asset type verificationThe code used to verify the asset type uses an if-case pattern which is more verbose than necessary and doesn't directly assert the expected value.
Consider simplifying the asset type verification to a more direct assertion:
- if case .uiImage = errorInfo.assetType! { - // Asset type is uiImage as expected - } else { - XCTFail("Asset type is not uiImage") - } + XCTAssertTrue(errorInfo.assetType.map { if case .uiImage = $0 { return true } else { return false } } ?? false, "Asset type is not uiImage")Or even better:
- if case .uiImage = errorInfo.assetType! { - // Asset type is uiImage as expected - } else { - XCTFail("Asset type is not uiImage") - } + guard let assetType = errorInfo.assetType else { + XCTFail("Asset type is nil") + return + } + XCTAssertTrue(case .uiImage = assetType, "Asset type is not uiImage")
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Networking/Networking.xcodeproj/project.pbxproj(5 hunks)Networking/NetworkingTests/ProductImageInBackground/ProductImageStatusStorageTests.swift(1 hunks)
🔇 Additional comments (12)
Networking/Networking.xcodeproj/project.pbxproj (5)
463-463: The new test file is properly included in the build.The
ProductImageStatusStorageTests.swiftfile has been correctly added to the Sources build phase, ensuring it will be compiled and run as part of the test suite.
1682-1682: File reference is properly defined.The file reference for
ProductImageStatusStorageTests.swiftis correctly added to the project structure with appropriate file type specification.
2702-2709: Good organization with dedicated test group.Creating a dedicated
ProductImageInBackgroundgroup for these tests demonstrates good project organization practices, keeping related tests together and making the project structure easier to navigate.
2986-2986: Proper group placement within project hierarchy.The
ProductImageInBackgroundgroup is correctly placed within the NetworkingTests directory, maintaining a logical project structure.
5760-5760: Test compilation is properly configured.The test file is correctly included in the Sources compilation phase, ensuring it will be built and executed as part of the test suite.
Networking/NetworkingTests/ProductImageInBackground/ProductImageStatusStorageTests.swift (7)
1-14: Well-structured test class setupThe test class is properly organized with clear imports, well-defined properties, and test constants. The use of
@testable import Networkingcorrectly gives access to internal elements needed for testing.
15-25: Good test lifecycle managementThe
setUpandtearDownmethods correctly initialize and clean up the test environment. Using a unique key for UserDefaults and cleaning it up after each test ensures proper isolation between test cases.
29-31: Appropriate initialization testThis test verifies the basic contract that a newly created storage starts with empty state. Simple but essential test.
68-94: Well-implemented publisher test with async supportThis test correctly verifies that the statusesPublisher emits updates when changes occur. The use of waitForExpectation properly handles the asynchronous nature of publishers.
96-156: Comprehensive external update testThe test thoroughly validates that external changes made directly to UserDefaults are properly detected and reflected within the storage. This is an important test as it verifies the resilience of the system to external modifications.
311-349: Good error publisher verificationThe test properly verifies the errorsPublisher functionality by checking that it emits the correct error information when an upload failure occurs. All aspects of the error are verified, including site ID, product ID, asset type, and error details.
1-387: Overall excellent test coverageThe test suite provides comprehensive coverage of the
ProductImageStatusStorageclass, testing initialization, addition, removal, updating of statuses, handling of external changes via UserDefaults, and error emissions through publishers. The tests follow a clear Given/When/Then pattern and are well-organized.
Part 4 of the changes needed for product image upload in the background.
Before merging this PR, make sure to merge this one.
Description
After the introduction of
ProductImageStatusStorageclass in this PR, this class implements the unit tests. Part of a different PR, given their size.Testing information
Unit tests should pass ✅
RELEASE-NOTES.txtif necessary.Reviewer (or Author, in the case of optional code reviews):
Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement: