ResetTest.swift

/*
* Copyright (c) 2020, Nordic Semiconductor
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
*    list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this
*    list of conditions and the following disclaimer in the documentation and/or
*    other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

import XCTest
@testable import nRF_Blinky
@testable import CoreBluetoothMock

/// This test simulates a device with Nordic LED Button service which gets reset during
/// connection.
///
/// It is using the app and testing it by sending notifications that trigger different
/// actions.
class ResetTest: XCTestCase {

    override func setUpWithError() throws {
        // This method is called AFTER ScannerTableViewController.viewDidLoad()
        // where the BlinkyManager is instantiated.
        // Initially mock Bluetooth adapter is powered Off.
        CBMCentralManagerMock.simulatePeripherals([blinky, hrm, thingy])
        CBMCentralManagerMock.simulatePowerOn()
    }

    override func tearDownWithError() throws {
        // We can't call CBMCentralManagerMock.tearDownSimulation() here.
        // That would invalidate the BlinkyManager in ScannerTableViewController.
        // The central manager must be reused, so let's just power mock off,
        // which will allow us to set different set of peripherals in another test.
        CBMCentralManagerMock.simulatePowerOff()
    }

    func testScanningBlinky() {
        // Set up the devices in range.
        blinky.simulateProximityChange(.far)
        hrm.simulateProximityChange(.near)
        thingy.simulateProximityChange(.far)
        // Reset the blinky.
        blinky.simulateReset()

        // Wait until the blinky is found.
        var target: BlinkyPeripheral?
        let found = XCTestExpectation(description: "Device found")
        Sim.onBlinkyDiscovery { blinky in
            XCTAssertEqual(blinky.advertisedName, "nRF Blinky")
            XCTAssert(blinky.isConnectable == true)
            XCTAssert(blinky.isConnected == false)
            XCTAssertGreaterThanOrEqual(blinky.RSSI.intValue, -100 - 15)
            XCTAssertLessThanOrEqual(blinky.RSSI.intValue, -100 + 15)
            target = blinky
            found.fulfill()
        }
        wait(for: [found], timeout: 3)
        XCTAssertNotNil(target, "nRF Blinky not found. Make sure you run the test on a simulator.")
        if target == nil {
            // Going further would cause a crash.
            return
        }

        // Select found device.
        Sim.post(.selectPeripheral(at: 0))

        // Wait until blinky is connected and ready.
        let connected = XCTestExpectation(description: "Connected")
        let ready = XCTestExpectation(description: "Ready")
        target!.onConnected {
            connected.fulfill()
        }
        target!.onReady { ledSupported, buttonSupported in
            if ledSupported && buttonSupported {
                ready.fulfill()
            }
        }
        wait(for: [connected, ready], timeout: 3)

        let appDelegate = UIApplication.shared.delegate as! AppDelegate
        let navigationController = appDelegate.window!.rootViewController as! UINavigationController

        // Initially, LED is OFF and button is released.
        let ledDisabled = XCTestExpectation(description: "LED Disabled")
        let buttonReleased = XCTestExpectation(description: "Button released")
        let buttonPressed = XCTestExpectation(description: "Button pressed")
        buttonPressed.isInverted = true

        let ledObserver = target!.onLedStateDidChange { isOn in
            if isOn == false {
                ledDisabled.fulfill()
            }
        }
        let buttonObserver = target!.onButtonStateDidChange { isPressed in
            if isPressed == true {
                buttonPressed.fulfill()
            } else {
                buttonReleased.fulfill()
            }
        }
        wait(for: [ledDisabled, buttonReleased], timeout: 1)

        // Simulate reset and button press afterwards.
        let reset = XCTestExpectation(description: "Reset")
        target!.onDisconnected { error in
            XCTAssertEqual((error as? CBMError)?.code, CBError.connectionTimeout)
            reset.fulfill()
        }
        blinky.simulateReset()
        blinky.simulateValueUpdate(Data([0x01]), for: .buttonCharacteristic)
        wait(for: [reset, buttonPressed], timeout: 5)

        Sim.dispose(ledObserver)
        Sim.dispose(buttonObserver)
        navigationController.popViewController(animated: true)
    }

}