Auto-Mocking with Sourcery (#597)

* work in progress, was able to generate a mock for the RoomProxyProtocol, I'll try if I can swap the mock we have with this one

* removing swiftformat from generated

* added the disable of swiftlint directly into the .stencil

* testing if danger still complains

* improved the stencil

* session verification controller proxy using auto mockable

* BugReport mocks and tests added

* changelog

* fixing a typo

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>

* fix typo in the test

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>

* removing the Protocol word from the type if present

* using extension in place of a subclass

* removed unused imports

* improved the yielding code

* moved Sourcery files

* stencil master

---------

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
This commit is contained in:
Mauro
2023-03-08 17:04:31 +01:00
committed by GitHub
parent 7d35876753
commit c67c4e362e
20 changed files with 554 additions and 148 deletions
@@ -19,7 +19,13 @@ import Foundation
import XCTest
class BugReportServiceTests: XCTestCase {
let bugReportService = MockBugReportService()
var bugReportService: BugReportServiceMock!
override func setUpWithError() throws {
bugReportService = BugReportServiceMock()
bugReportService.underlyingCrashedLastRun = false
bugReportService.submitBugReportProgressListenerReturnValue = SubmitBugReportResponse(reportUrl: "https://www.example.com/123")
}
func testInitialStateWithMockService() {
XCTAssertFalse(bugReportService.crashedLastRun)
@@ -20,8 +20,12 @@ import XCTest
@MainActor
class BugReportViewModelTests: XCTestCase {
enum TestError: Error {
case testError
}
func testInitialState() {
let viewModel = BugReportViewModel(bugReportService: MockBugReportService(),
let viewModel = BugReportViewModel(bugReportService: BugReportServiceMock(),
userID: "@mock.client.com",
deviceID: nil,
screenshot: nil,
@@ -34,7 +38,7 @@ class BugReportViewModelTests: XCTestCase {
}
func testClearScreenshot() async throws {
let viewModel = BugReportViewModel(bugReportService: MockBugReportService(),
let viewModel = BugReportViewModel(bugReportService: BugReportServiceMock(),
userID: "@mock.client.com",
deviceID: nil,
screenshot: UIImage.actions,
@@ -47,7 +51,7 @@ class BugReportViewModelTests: XCTestCase {
}
func testAttachScreenshot() async throws {
let viewModel = BugReportViewModel(bugReportService: MockBugReportService(),
let viewModel = BugReportViewModel(bugReportService: BugReportServiceMock(),
userID: "@mock.client.com",
deviceID: nil,
screenshot: nil, isModallyPresented: false)
@@ -57,4 +61,54 @@ class BugReportViewModelTests: XCTestCase {
try await Task.sleep(nanoseconds: 100_000_000)
XCTAssert(context.viewState.screenshot == UIImage.actions)
}
func testSendReportWithSuccess() async throws {
let mockService = BugReportServiceMock()
mockService.submitBugReportProgressListenerReturnValue = SubmitBugReportResponse(reportUrl: "https://test.test")
let viewModel = BugReportViewModel(bugReportService: mockService,
userID: "@mock.client.com",
deviceID: nil,
screenshot: nil, isModallyPresented: false)
let context = viewModel.context
var isSuccess = false
viewModel.callback = { result in
switch result {
case .submitFinished:
isSuccess = true
default: break
}
}
context.send(viewAction: .submit)
try await Task.sleep(for: .milliseconds(100))
XCTAssert(mockService.submitBugReportProgressListenerCallsCount == 1)
XCTAssert(mockService.submitBugReportProgressListenerReceivedArguments?.bugReport == BugReport(userID: "@mock.client.com", deviceID: nil, text: "", includeLogs: true, includeCrashLog: true, githubLabels: [], files: []))
XCTAssertTrue(isSuccess)
}
func testSendReportWithError() async throws {
let mockService = BugReportServiceMock()
mockService.submitBugReportProgressListenerClosure = { _, _ in
throw TestError.testError
}
let viewModel = BugReportViewModel(bugReportService: mockService,
userID: "@mock.client.com",
deviceID: nil,
screenshot: nil, isModallyPresented: false)
let context = viewModel.context
var isFailure = false
viewModel.callback = { result in
switch result {
case .submitFailed:
isFailure = true
default: break
}
}
context.send(viewAction: .submit)
try await Task.sleep(for: .milliseconds(100))
XCTAssert(mockService.submitBugReportProgressListenerCallsCount == 1)
XCTAssert(mockService.submitBugReportProgressListenerReceivedArguments?.bugReport == BugReport(userID: "@mock.client.com", deviceID: nil, text: "", includeLogs: true, includeCrashLog: true, githubLabels: [], files: []))
XCTAssertTrue(isFailure)
}
}
@@ -39,11 +39,11 @@ class SessionVerificationStateMachineTests: XCTestCase {
stateMachine.processEvent(.didStartSasVerification)
XCTAssertEqual(stateMachine.state, .sasVerificationStarted)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.didReceiveChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
stateMachine.processEvent(.acceptChallenge)
XCTAssertEqual(stateMachine.state, .acceptingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .acceptingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
stateMachine.processEvent(.didAcceptChallenge)
XCTAssertEqual(stateMachine.state, .verified)
@@ -61,11 +61,11 @@ class SessionVerificationStateMachineTests: XCTestCase {
stateMachine.processEvent(.didStartSasVerification)
XCTAssertEqual(stateMachine.state, .sasVerificationStarted)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.didReceiveChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
stateMachine.processEvent(.declineChallenge)
XCTAssertEqual(stateMachine.state, .decliningChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .decliningChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
stateMachine.processEvent(.didCancel)
XCTAssertEqual(stateMachine.state, .cancelled)
@@ -102,8 +102,8 @@ class SessionVerificationStateMachineTests: XCTestCase {
stateMachine.processEvent(.didStartSasVerification)
XCTAssertEqual(stateMachine.state, .sasVerificationStarted)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.didReceiveChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
stateMachine.processEvent(.cancel)
XCTAssertEqual(stateMachine.state, .cancelling)
@@ -23,22 +23,22 @@ import XCTest
class SessionVerificationViewModelTests: XCTestCase {
var viewModel: SessionVerificationViewModelProtocol!
var context: SessionVerificationViewModelType.Context!
var sessionVerificationController: SessionVerificationControllerProxyProtocol!
var sessionVerificationController: SessionVerificationControllerProxyMock!
@MainActor
override func setUpWithError() throws {
sessionVerificationController = MockSessionVerificationControllerProxy()
sessionVerificationController = SessionVerificationControllerProxyMock.configureMock()
viewModel = SessionVerificationViewModel(sessionVerificationControllerProxy: sessionVerificationController)
context = viewModel.context
}
func testRequestVerification() async {
func testRequestVerification() async throws {
XCTAssertEqual(context.viewState.verificationState, .initial)
context.send(viewAction: .requestVerification)
await Task.yield()
try await Task.sleep(for: .milliseconds(100))
XCTAssert(sessionVerificationController.requestVerificationCallsCount == 1)
XCTAssertEqual(context.viewState.verificationState, .requestingVerification)
}
@@ -53,7 +53,7 @@ class SessionVerificationViewModelTests: XCTestCase {
XCTAssertEqual(context.viewState.verificationState, .cancelling)
try await Task.sleep(nanoseconds: 100_000_000)
try await Task.sleep(for: .milliseconds(100))
XCTAssertEqual(context.viewState.verificationState, .cancelled)
@@ -62,6 +62,9 @@ class SessionVerificationViewModelTests: XCTestCase {
await Task.yield()
XCTAssertEqual(context.viewState.verificationState, .initial)
XCTAssert(sessionVerificationController.requestVerificationCallsCount == 1)
XCTAssert(sessionVerificationController.cancelVerificationCallsCount == 1)
}
func testReceiveChallenge() {
@@ -93,6 +96,7 @@ class SessionVerificationViewModelTests: XCTestCase {
wait(for: [waitForAcceptance], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .verified)
XCTAssert(sessionVerificationController.approveVerificationCallsCount == 1)
}
func testDeclineChallenge() {
@@ -120,6 +124,7 @@ class SessionVerificationViewModelTests: XCTestCase {
wait(for: [expectation], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .cancelled)
XCTAssert(sessionVerificationController.declineVerificationCallsCount == 1)
}
// MARK: - Private
@@ -157,6 +162,9 @@ class SessionVerificationViewModelTests: XCTestCase {
XCTAssertEqual(context.viewState.verificationState, .sasVerificationStarted)
wait(for: [verificationDataReceivalExpectation], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(context.viewState.verificationState, .showingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
XCTAssert(sessionVerificationController.requestVerificationCallsCount == 1)
XCTAssert(sessionVerificationController.startSasVerificationCallsCount == 1)
}
}
@@ -40,9 +40,9 @@ final class UserSessionTests: XCTestCase {
}
.store(in: &cancellables)
let controller = MockSessionVerificationControllerProxy(callbacks: PassthroughSubject<SessionVerificationControllerProxyCallback, Never>(),
isVerified: false,
requestDelay: .zero)
let controller = SessionVerificationControllerProxyMock.configureMock(callbacks: PassthroughSubject<SessionVerificationControllerProxyCallback, Never>(),
isVerified: false,
requestDelay: .zero)
clientProxy.sessionVerificationControllerProxyResult = .success(controller)
clientProxy.callbacks.send(.receivedSyncUpdate)
waitForExpectations(timeout: 1.0)
@@ -50,9 +50,9 @@ final class UserSessionTests: XCTestCase {
func test_whenUserSessionReceivesSyncUpdateAndSessionIsVerified_didVerifySessionEventReceived() throws {
let expectation = expectation(description: "DidVerifySessionEvent expectation")
let controller = MockSessionVerificationControllerProxy(callbacks: PassthroughSubject<SessionVerificationControllerProxyCallback, Never>(),
isVerified: false,
requestDelay: .zero)
let controller = SessionVerificationControllerProxyMock.configureMock(callbacks: PassthroughSubject<SessionVerificationControllerProxyCallback, Never>(),
isVerified: false,
requestDelay: .zero)
clientProxy.sessionVerificationControllerProxyResult = .success(controller)
controller.callbacks.sink { value in