vector-im/element-x-ios/issues/31 - Implement simple SaS sesson verification

* vector-im/element-x-ios/issues/31 - Session verification unit and UI tests
* Fix ImageAnonymizer tests when running on Apple Silicon
* Rename SessionVerification to SessionVerificationScreen
This commit is contained in:
Stefan Ceriu
2022-07-01 13:56:52 +03:00
committed by GitHub
parent 266ca656fc
commit a6f9d1ba89
30 changed files with 1604 additions and 98 deletions
@@ -0,0 +1,94 @@
//
// SessionVerificationStateMachineTests.swift
// UnitTests
//
// Created by Stefan Ceriu on 28/06/2022.
// Copyright © 2022 Element. All rights reserved.
//
import XCTest
@testable import ElementX
@MainActor
class SessionVerificationStateMachineTests: XCTestCase {
private var stateMachine: SessionVerificationStateMachine!
@MainActor
override func setUpWithError() throws {
stateMachine = SessionVerificationStateMachine()
}
func testAcceptChallenge() {
XCTAssertEqual(stateMachine.state, .initial)
stateMachine.processEvent(.requestVerification)
XCTAssertEqual(stateMachine.state, .requestingVerification)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.acceptChallenge)
XCTAssertEqual(stateMachine.state, .acceptingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.didAcceptChallenge)
XCTAssertEqual(stateMachine.state, .verified)
}
func testDeclineChallenge() {
XCTAssertEqual(stateMachine.state, .initial)
stateMachine.processEvent(.requestVerification)
XCTAssertEqual(stateMachine.state, .requestingVerification)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.declineChallenge)
XCTAssertEqual(stateMachine.state, .decliningChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.didCancel)
XCTAssertEqual(stateMachine.state, .cancelled)
stateMachine.processEvent(.restart)
XCTAssertEqual(stateMachine.state, .initial)
}
func testCancellation() {
XCTAssertEqual(stateMachine.state, .initial)
stateMachine.processEvent(.requestVerification)
XCTAssertEqual(stateMachine.state, .requestingVerification)
stateMachine.processEvent(.cancel)
XCTAssertEqual(stateMachine.state, .cancelling)
stateMachine.processEvent(.didCancel)
XCTAssertEqual(stateMachine.state, .cancelled)
// This duplication is intentional
stateMachine.processEvent(.didCancel)
XCTAssertEqual(stateMachine.state, .cancelled)
stateMachine.processEvent(.restart)
XCTAssertEqual(stateMachine.state, .initial)
stateMachine.processEvent(.requestVerification)
XCTAssertEqual(stateMachine.state, .requestingVerification)
stateMachine.processEvent(.didReceiveChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
XCTAssertEqual(stateMachine.state, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
stateMachine.processEvent(.cancel)
XCTAssertEqual(stateMachine.state, .cancelling)
stateMachine.processEvent(.didCancel)
XCTAssertEqual(stateMachine.state, .cancelled)
stateMachine.processEvent(.restart)
XCTAssertEqual(stateMachine.state, .initial)
stateMachine.processEvent(.restart)
XCTAssertEqual(stateMachine.state, .initial)
}
}
@@ -0,0 +1,154 @@
//
// Copyright 2021 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import XCTest
import Combine
@testable import ElementX
@MainActor
class SessionVerificationViewModelTests: XCTestCase {
var viewModel: SessionVerificationViewModelProtocol!
var context: SessionVerificationViewModelType.Context!
var sessionVerificationController: SessionVerificationControllerProxyProtocol!
@MainActor
override func setUpWithError() throws {
sessionVerificationController = MockSessionVerificationControllerProxy()
viewModel = SessionVerificationViewModel(sessionVerificationControllerProxy: sessionVerificationController)
context = viewModel.context
}
func testRequestVerification() async {
XCTAssertEqual(context.viewState.verificationState, .initial)
context.send(viewAction: .start)
await Task.yield()
XCTAssertEqual(context.viewState.verificationState, .requestingVerification)
}
func testVerificationCancellation() async {
XCTAssertEqual(context.viewState.verificationState, .initial)
context.send(viewAction: .start)
context.send(viewAction: .cancel)
await Task.yield()
XCTAssertEqual(context.viewState.verificationState, .cancelling)
await Task.yield()
XCTAssertEqual(context.viewState.verificationState, .cancelled)
context.send(viewAction: .restart)
await Task.yield()
XCTAssertEqual(context.viewState.verificationState, .initial)
}
func testReceiveChallenge() {
setupChallengeReceived()
}
func testAcceptChallenge() {
setupChallengeReceived()
let waitForAcceptance = XCTestExpectation(description: "Wait for acceptance")
let cancellable = sessionVerificationController.callbacks
.debounce(for: .seconds(2.0), scheduler: DispatchQueue.main)
.sink { callback in
switch callback {
case .finished:
waitForAcceptance.fulfill()
default:
XCTFail("Unexpected session verification controller callback")
}
}
defer {
cancellable.cancel()
}
context.send(viewAction: .accept)
wait(for: [waitForAcceptance], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .verified)
}
func testDeclineChallenge() {
setupChallengeReceived()
let expectation = XCTestExpectation(description: "Wait for cancellation")
let cancellable = sessionVerificationController.callbacks
.debounce(for: .seconds(2.0), scheduler: DispatchQueue.main)
.sink { callback in
switch callback {
case .cancelled:
expectation.fulfill()
default:
XCTFail("Unexpected session verification controller callback")
}
}
defer {
cancellable.cancel()
}
context.send(viewAction: .decline)
wait(for: [expectation], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .cancelled)
}
// MARK: - Private
private func setupChallengeReceived() {
let expectation = XCTestExpectation(description: "Wait for challenge")
let cancellable = sessionVerificationController.callbacks
.debounce(for: .seconds(2.0), scheduler: DispatchQueue.main)
.sink { callback in
switch callback {
case .receivedVerificationData:
expectation.fulfill()
default:
break
}
}
defer {
cancellable.cancel()
}
context.send(viewAction: .start)
wait(for: [expectation], timeout: 10.0)
XCTAssertEqual(context.viewState.verificationState, .showingChallenge(emojis: MockSessionVerificationControllerProxy.emojis))
}
}