Add unit test on iOS #764
Add unit test on iOS #764
Conversation
ianlin-bbpos
requested review from
billfinn-stripe,
bric-stripe,
nazli-stripe,
ugochukwu-stripe,
ebarrenechea-stripe and
mshafrir-stripe
as code owners
ios/Tests/MappersTests.swift
Outdated
| @@ -19,4 +19,14 @@ final class MappersTests: XCTestCase { | |||
| XCTAssertEqual(Mappers.mapFromLocationStatus(.notSet), "notSet") | |||
| } | |||
|
|
|||
| func testCollectInputsReturnsMapper() { | |||
| let output: NSDictionary = Mappers.mapFromCollectInputsResults([]) | |||
There was a problem hiding this comment.
Hey @bric-stripe, I'm trying to add a test for checking the return data of method Mappers.mapFromCollectInputsResults, I'm block with a issue that how to mock its input param which is a CollectInputsResult array, and the class CollectInputsResult and all its subclass can't be directly instantiated. I have no idea how to create or hardcode the input params, could you give me some guidance, thanks.
There was a problem hiding this comment.
ah, this is because all the public classes are annotated as init and new being unavailable because we want to ensure the instances the SDK receives are generated from the SDK. But this means you can't simply instantiate them for tests either 😞
for result classes like this we should probably remove that restriction from the native SDK (its only important classes that are also inputs, like PaymentIntent)
the only option I can think of for now is to create mirror protocols that the Mapper class, and any others being tested, use and then the RN swift layer will declare that the SDK's class conforms to that protocol. I'll check out this branch and see if I can add an example commit to help unblock. It's going to be noisy though as we have to declare each param in the protocol 😞 I'll also bring this up with others to see if there are alternatives to consider.
There was a problem hiding this comment.
Understood! Thanks a lot for your detailed teaching. I'm also going to do some research on that.
There was a problem hiding this comment.
sorry I didn't get to this yesterday but I just pushed up a commit that does what I was thinking: 5260769
the downside is we'd have to keep the protocols in sync. But since the public classes from the native SDK are fairly stable I don't think that should be too bad. But there may be better alternatives that I'm not aware of.
There was a problem hiding this comment.
Thanks for your instructive sample codes, but there seems to be some errors😂, could you take a look at it.
There was a problem hiding this comment.
silly error, I just missed adding a new file. Pushed a new commit that includes that and should fix CI
| @@ -32,6 +32,7 @@ | |||
| "get:testbutler": "curl -f -o ./test-butler-app.apk https://repo1.maven.org/maven2/com/linkedin/testbutler/test-butler-app/2.2.1/test-butler-app-2.2.1.apk", | |||
| "docs": "npx typedoc ./src/index.tsx --out ./docs/api-reference --tsconfig ./tsconfig.json --readme none", | |||
| "unit-test:android": "cd android && ./gradlew testDebugUnitTest", | |||
| "unit-test:ios": "xcodebuild test -workspace dev-app/ios/StripeTerminalReactNativeDevApp.xcworkspace -destination 'platform=iOS Simulator,name=iPhone 15' -scheme UnitTests", | |||
There was a problem hiding this comment.
nice, thanks for adding
| extension StripeTerminal.TextResult : TextResult { | ||
| } |
There was a problem hiding this comment.
Do you know why we have this for TextResult only?
There was a problem hiding this comment.
Oops, I think I missed the others, but the compilation and testing still passed. I know that CollectInputsResult is essential. As for the other missing ones, I also wonder if it is because they already have definitions inherited from CollectInputsResult in the native sdk? let me add the missing ones.
ios/Tests/MappersTests.swift
Outdated
| XCTAssertTrue(results.contains(where: { $0[testNumericString] != nil })) | ||
| XCTAssertTrue(results.contains(where: { $0[testPhone] != nil })) | ||
| XCTAssertTrue(results.contains(where: { $0[testEmail] != nil })) | ||
| XCTAssertTrue(results.contains(where: { $0[testSelection] != nil })) | ||
| XCTAssertTrue(results.contains(where: { $0[testSignatureSvg] != nil })) |
There was a problem hiding this comment.
Can we update these checks to assert the order of each result is kept? I think we can loop through the array naively or even hardcode (eg, results[0][testNumericString] != nil)
There was a problem hiding this comment.
ok, let me improve that.
* add test func. * Example of using a mirror protocol for testing allowing a mock struct to be used in the tests * derp; I forgot to git add the Protocols.swift file * implement mapper test & add test command in bitrise.yml. * improve test method. --------- Co-authored-by: Brian Cooke <bric@stripe.com>
Summary
Add unit test on iOS for function automated testing.
Motivation
Add automated testing requested by https://bugs.bbpos.com/projects/SDK/issues/SDK-174
Testing
Documentation
Select one: