MessageKit/Tests/MessageKitTests/Controllers Test/MessagesViewControllerTests.swift

// MIT License
//
// Copyright (c) 2017-2020 MessageKit
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import CoreLocation
import XCTest
@testable import MessageKit

// MARK: - MessagesViewControllerTests

@MainActor
final class MessagesViewControllerTests: XCTestCase {

    // MARK: - Private helper API

    private func makeSUT() -> MessagesViewController {
        let sut = MessagesViewController()
        sut.messagesCollectionView.messagesLayoutDelegate = layoutDelegate
        sut.messagesCollectionView.messagesDisplayDelegate = layoutDelegate
        _ = sut.view
        sut.beginAppearanceTransition(true, animated: true)
        sut.endAppearanceTransition()
        sut.view.layoutIfNeeded()

        return sut
    }

    // MARK: - Test

    func testNumberOfSectionWithoutData_isZero() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource

        XCTAssertEqual(sut.messagesCollectionView.numberOfSections, 0)
    }

    func testNumberOfSection_isNumberOfMessages() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages = makeMessages(for: messagesDataSource.senders)

        sut.messagesCollectionView.reloadData()

        let count = sut.messagesCollectionView.numberOfSections
        let expectedCount = messagesDataSource.numberOfSections(in: sut.messagesCollectionView)

        XCTAssertEqual(count, expectedCount)
    }

    func testNumberOfItemInSection_isOne() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages = makeMessages(for: messagesDataSource.senders)

        sut.messagesCollectionView.reloadData()

        XCTAssertEqual(sut.messagesCollectionView.numberOfItems(inSection: 0), 1)
        XCTAssertEqual(sut.messagesCollectionView.numberOfItems(inSection: 1), 1)
    }

    func testCellForItemWithTextData_returnsTextMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages.append(MockMessage(
            text: "Test",
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is TextMessageCell)
    }

    func testCellForItemWithAttributedTextData_returnsTextMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        let attributes = [NSAttributedString.Key.foregroundColor: UIColor.outgoingMessageLabel]
        let attriutedString = NSAttributedString(string: "Test", attributes: attributes)
        messagesDataSource.messages.append(MockMessage(
            attributedText: attriutedString,
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is TextMessageCell)
    }

    func testCellForItemWithPhotoData_returnsMediaMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages.append(MockMessage(
            image: UIImage(),
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is MediaMessageCell)
    }

    func testCellForItemWithVideoData_returnsMediaMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages.append(MockMessage(
            thumbnail: UIImage(),
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is MediaMessageCell)
    }

    func testCellForItemWithLocationData_returnsLocationMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages.append(MockMessage(
            location: CLLocation(latitude: 60.0, longitude: 70.0),
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is LocationMessageCell)
    }

    func testCellForItemWithAudioData_returnsAudioMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource
        messagesDataSource.messages.append(MockMessage(
            audioURL: URL(fileURLWithPath: ""),
            duration: 4.0,
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is AudioMessageCell)
    }

    func testCellForItemWithLinkPreviewData_returnsLinkPreviewMessageCell() {
        let messagesDataSource = MockMessagesDataSource()
        let sut = makeSUT()
        sut.messagesCollectionView.messagesDataSource = messagesDataSource

        let linkItem = MockLinkItem(
            text: "https://link.test",
            attributedText: nil,
            url: URL(string: "https://github.com/MessageKit")!,
            title: "Link Title",
            teaser: "Link Teaser",
            thumbnailImage: UIImage())

        messagesDataSource.messages.append(MockMessage(
            linkItem: linkItem,
            user: messagesDataSource.senders[0],
            messageId: "test_id"))

        sut.messagesCollectionView.reloadData()

        let cell = sut.messagesCollectionView.dataSource?.collectionView(
            sut.messagesCollectionView,
            cellForItemAt: IndexPath(item: 0, section: 0))

        XCTAssertNotNil(cell)
        XCTAssertTrue(cell is LinkPreviewMessageCell)
    }

    // MARK: - Setups

    func testSubviewsSetup() {
        let controller = MessagesViewController()
        XCTAssertTrue(controller.view.subviews.contains(controller.messagesCollectionView))
    }

    func testDelegateAndDataSourceSetup() {
        let controller = MessagesViewController()
        controller.view.layoutIfNeeded()
        XCTAssertTrue(controller.messagesCollectionView.delegate is MessagesViewController)
        XCTAssertTrue(controller.messagesCollectionView.dataSource is MessagesViewController)
    }

    func testDefaultPropertyValues() {
        let controller = MessagesViewController()
        XCTAssertNotNil(controller.messagesCollectionView)
        XCTAssertTrue(controller.messagesCollectionView.collectionViewLayout is MessagesCollectionViewFlowLayout)

        controller.view.layoutIfNeeded()
        XCTAssertTrue(controller.extendedLayoutIncludesOpaqueBars)
        XCTAssertEqual(controller.view.backgroundColor, UIColor.collectionViewBackground)
        XCTAssertEqual(controller.messagesCollectionView.keyboardDismissMode, UIScrollView.KeyboardDismissMode.interactive)
        XCTAssertTrue(controller.messagesCollectionView.alwaysBounceVertical)
    }

    // MARK: Private

    // swiftlint:disable:next weak_delegate
    private var layoutDelegate = MockLayoutDelegate()

    // MARK: - Assistants

    private func makeMessages(for senders: [MockUser]) -> [MessageType] {
        [
            MockMessage(text: "Text 1", user: senders[0], messageId: "test_id_1"),
            MockMessage(text: "Text 2", user: senders[1], messageId: "test_id_2"),
        ]
    }
}

// MARK: - MockLayoutDelegate

private class MockLayoutDelegate: MessagesLayoutDelegate, MessagesDisplayDelegate {
    // MARK: - LocationMessageLayoutDelegate

    func heightForLocation(message _: MessageType, at _: IndexPath, with _: CGFloat, in _: MessagesCollectionView) -> CGFloat {
        0.0
    }

    func heightForMedia(message _: MessageType, at _: IndexPath, with _: CGFloat, in _: MessagesCollectionView) -> CGFloat {
        10.0
    }

    func snapshotOptionsForLocation(
        message _: MessageType,
        at _: IndexPath,
        in _: MessagesCollectionView)
    -> LocationMessageSnapshotOptions
    {
        LocationMessageSnapshotOptions()
    }
}