chore: adds some tests #13
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on enhancing test coverage, improving testability of APIClient through URLSession injection, and refining SonarQube configuration for a more accurate static analysis.
- Improved flexibility of APIClient by making URLSession injectable.
- Expanded unit tests for APIClient, UpdateQueue, and API endpoints.
- Updated sonar.coverage.exclusions to omit specified files from analysis.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sonar-project.properties | Updated exclusions to include HTTPStatusCode.swift and EncodableRequest.swift. |
| Tests/FormbricksSDKTests/Networking/UpdateQueueTests.swift | Added comprehensive tests for UpdateQueue behavior. |
| Tests/FormbricksSDKTests/Networking/ClientAPIEndpointsTests.swift | Introduced tests for GetEnvironmentRequest and PostUserRequest initialization. |
| Tests/FormbricksSDKTests/Networking/APIClientTests.swift | Added various tests to validate APIClient’s handling of responses and errors. |
| Sources/FormbricksSDK/Networking/Base/APIClient.swift | Refactored APIClient to accept an injectable URLSession. |
|
mattinannt
approved these changes
May 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces several updates to the
FormbricksSDKcodebase, focusing on improving test coverage, enhancing the flexibility of theAPIClient, and refining the SonarQube configuration. The most notable changes include making theURLSessioninjectable for testing, adding comprehensive unit tests forAPIClientand other components, and updating SonarQube exclusions.Enhancements to
APIClient:URLSessioninjectable by adding asessionparameter to theAPIClientinitializer, defaulting to.shared. This change improves testability by allowing the use of mock sessions during testing. (Sources/FormbricksSDK/Networking/Base/APIClient.swift, Sources/FormbricksSDK/Networking/Base/APIClient.swiftL5-R11)Expanded Test Coverage:
APIClientTeststest suite with multiple test cases for various scenarios, including successful responses, API errors, invalid URLs, decoding errors, and network errors. AMockURLSessionwas introduced to simulate network requests. (Tests/FormbricksSDKTests/Networking/APIClientTests.swift, Tests/FormbricksSDKTests/Networking/APIClientTests.swiftR1-R383)GetEnvironmentRequestandPostUserRequest, to validate their initialization and properties. (Tests/FormbricksSDKTests/Networking/ClientAPIEndpointsTests.swift, Tests/FormbricksSDKTests/Networking/ClientAPIEndpointsTests.swiftR1-R18)UpdateQueueTeststo verify the behavior of theUpdateQueueclass, including debouncing, attribute updates, and state resets, using aMockUserManagerfor assertions. (Tests/FormbricksSDKTests/Networking/UpdateQueueTests.swift, Tests/FormbricksSDKTests/Networking/UpdateQueueTests.swiftR1-R136)SonarQube Configuration:
sonar.coverage.exclusionsto exclude additional files (HTTPStatusCode.swiftandEncodableRequest.swift) from coverage analysis, ensuring a more focused code quality assessment. (sonar-project.properties, sonar-project.propertiesL18-R18)