threema-ios/Threema Tests/ThreemaPushNotificationTests.swift

//  _____ _
// |_   _| |_  _ _ ___ ___ _ __  __ _
//   | | | ' \| '_/ -_) -_) '  \/ _` |_
//   |_| |_||_|_| \___\___|_|_|_\__,_(_)
//
// Threema iOS Client
// Copyright (c) 2020 Threema GmbH
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License, version 3,
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

import XCTest

@testable import Threema

class ThreemaPushNotificationTests: XCTestCase {
    
    func testCompleteDictionaryDecoding() throws {
        let from = "ABCDEFGH"
        let nick = "Hansmuster"
        let messageId = "0123456789abcdef"
        
        let payload = [
            "cmd": "newmsg",
            "from": from,
            "nick": nick,
            "messageId": messageId,
            "voip": "true",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        XCTAssertEqual(threemaPushNotification.from, from)
        XCTAssertEqual(threemaPushNotification.nickname, nick)
        XCTAssertEqual(threemaPushNotification.messageId, messageId)
        let actualVoip = try XCTUnwrap(threemaPushNotification.voip)
        XCTAssertTrue(actualVoip)
    }
    
    // MARK: Command tests
    
    func testNewMessageCommandDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        XCTAssertEqual(threemaPushNotification.command, ThreemaPushNotification.Command.newMessage)
    }
    
    func testNewGroupMessageCommandDictionaryDecoding() throws {
        let payload = [
            "cmd": "newgroupmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        XCTAssertEqual(threemaPushNotification.command, ThreemaPushNotification.Command.newGroupMessage)
    }
    
    // MARK: Voip tests
    
    func testMissingVoipDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        XCTAssertNil(threemaPushNotification.voip)
    }
    
    func testFalseVoipStringDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "false",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        let actualVoip = try XCTUnwrap(threemaPushNotification.voip)
        XCTAssertFalse(actualVoip)
    }
    
    func testTrueVoipStringDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        let actualVoip = try XCTUnwrap(threemaPushNotification.voip)
        XCTAssertTrue(actualVoip)
    }
    
    func testTrueVoipDictionaryDecoding() throws {
        let payload: [String: Any] = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": true,
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        let actualVoip = try XCTUnwrap(threemaPushNotification.voip)
        XCTAssertTrue(actualVoip)
    }
    
    func testFalseVoipDictionaryDecoding() throws {
        let payload: [String: Any] = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": false,
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        let actualVoip = try XCTUnwrap(threemaPushNotification.voip)
        XCTAssertFalse(actualVoip)
    }

    // MARK: Missing nick test
    
    func testMissingNickDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
        
        let threemaPushNotification = try ThreemaPushNotification(from: payload)
        
        XCTAssertNil(threemaPushNotification.nickname)
    }
    
    // MARK: Failing payloads
    
    func testWrongCommandKeyDictionaryDecoding() throws {
        let payload = [
            "cmds": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
                
        XCTAssertThrowsError(try ThreemaPushNotification(from: payload)) { error in
            XCTAssertEqual(error as? ThreemaPushNotificationError, .keyNotFoundOrTypeMissmatch(ThreemaPushNotificationDictionary.commandKey))
        }
    }
    
    func testMissingCommandDictionaryDecoding() throws {
        let payload = [
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
                
        XCTAssertThrowsError(try ThreemaPushNotification(from: payload)) { error in
            XCTAssertEqual(error as? ThreemaPushNotificationError, .keyNotFoundOrTypeMissmatch(ThreemaPushNotificationDictionary.commandKey))
        }
    }
    
    func testWrongCommandValueDictionaryDecoding() throws {
        let command = "foobar"
        
        let payload = [
            "cmd": command,
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "messageId": "0123456789abcdef",
            "voip": "true",
        ]
                
        XCTAssertThrowsError(try ThreemaPushNotification(from: payload)) { error in
            XCTAssertEqual(error as? ThreemaPushNotificationError, .unknownCommand(command))
        }
    }
    
    func testMissingMessageIdDictionaryDecoding() throws {
        let payload = [
            "cmd": "newmsg",
            "from": "ABCDEFGH",
            "nick": "Hansmuster",
            "voip": "true",
        ]
                
        XCTAssertThrowsError(try ThreemaPushNotification(from: payload)) { error in
            XCTAssertEqual(error as? ThreemaPushNotificationError, .keyNotFoundOrTypeMissmatch(ThreemaPushNotificationDictionary.messageIdKey))
        }
    }
    
}