python-telegram-bot/tests/test_voicechat.py

#!/usr/bin/env python
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2022
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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 Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program.  If not, see [http://www.gnu.org/licenses/].

import datetime as dtm
import pytest

from telegram import (
    VoiceChatStarted,
    VoiceChatEnded,
    VoiceChatParticipantsInvited,
    User,
    VoiceChatScheduled,
)
from telegram._utils.datetime import to_timestamp


@pytest.fixture(scope='class')
def user1():
    return User(first_name='Misses Test', id=123, is_bot=False)


@pytest.fixture(scope='class')
def user2():
    return User(first_name='Mister Test', id=124, is_bot=False)


class TestVoiceChatStarted:
    def test_slot_behaviour(self, mro_slots):
        action = VoiceChatStarted()
        for attr in action.__slots__:
            assert getattr(action, attr, 'err') != 'err', f"got extra slot '{attr}'"
        assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot"

    def test_de_json(self):
        voice_chat_started = VoiceChatStarted.de_json({}, None)
        assert isinstance(voice_chat_started, VoiceChatStarted)

    def test_to_dict(self):
        voice_chat_started = VoiceChatStarted()
        voice_chat_dict = voice_chat_started.to_dict()
        assert voice_chat_dict == {}


class TestVoiceChatEnded:
    duration = 100

    def test_slot_behaviour(self, mro_slots):
        action = VoiceChatEnded(8)
        for attr in action.__slots__:
            assert getattr(action, attr, 'err') != 'err', f"got extra slot '{attr}'"
        assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot"

    def test_de_json(self):
        json_dict = {'duration': self.duration}
        voice_chat_ended = VoiceChatEnded.de_json(json_dict, None)

        assert voice_chat_ended.duration == self.duration

    def test_to_dict(self):
        voice_chat_ended = VoiceChatEnded(self.duration)
        voice_chat_dict = voice_chat_ended.to_dict()

        assert isinstance(voice_chat_dict, dict)
        assert voice_chat_dict["duration"] == self.duration

    def test_equality(self):
        a = VoiceChatEnded(100)
        b = VoiceChatEnded(100)
        c = VoiceChatEnded(50)
        d = VoiceChatStarted()

        assert a == b
        assert hash(a) == hash(b)

        assert a != c
        assert hash(a) != hash(c)

        assert a != d
        assert hash(a) != hash(d)


class TestVoiceChatParticipantsInvited:
    def test_slot_behaviour(self, mro_slots, user1):
        action = VoiceChatParticipantsInvited([user1])
        for attr in action.__slots__:
            assert getattr(action, attr, 'err') != 'err', f"got extra slot '{attr}'"
        assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot"

    def test_de_json(self, user1, user2, bot):
        json_data = {"users": [user1.to_dict(), user2.to_dict()]}
        voice_chat_participants = VoiceChatParticipantsInvited.de_json(json_data, bot)

        assert isinstance(voice_chat_participants.users, list)
        assert voice_chat_participants.users[0] == user1
        assert voice_chat_participants.users[1] == user2
        assert voice_chat_participants.users[0].id == user1.id
        assert voice_chat_participants.users[1].id == user2.id

    @pytest.mark.parametrize('use_users', (True, False))
    def test_to_dict(self, user1, user2, use_users):
        voice_chat_participants = VoiceChatParticipantsInvited(
            [user1, user2] if use_users else None
        )
        voice_chat_dict = voice_chat_participants.to_dict()

        assert isinstance(voice_chat_dict, dict)
        if use_users:
            assert voice_chat_dict["users"] == [user1.to_dict(), user2.to_dict()]
            assert voice_chat_dict["users"][0]["id"] == user1.id
            assert voice_chat_dict["users"][1]["id"] == user2.id
        else:
            assert voice_chat_dict == {}

    def test_equality(self, user1, user2):
        a = VoiceChatParticipantsInvited([user1])
        b = VoiceChatParticipantsInvited([user1])
        c = VoiceChatParticipantsInvited([user1, user2])
        d = VoiceChatParticipantsInvited(None)
        e = VoiceChatStarted()

        assert a == b
        assert hash(a) == hash(b)

        assert a != c
        assert hash(a) != hash(c)

        assert a != d
        assert hash(a) != hash(d)

        assert a != e
        assert hash(a) != hash(e)


class TestVoiceChatScheduled:
    start_date = dtm.datetime.utcnow()

    def test_slot_behaviour(self, mro_slots):
        inst = VoiceChatScheduled(self.start_date)
        for attr in inst.__slots__:
            assert getattr(inst, attr, 'err') != 'err', f"got extra slot '{attr}'"
        assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"

    def test_expected_values(self):
        assert pytest.approx(VoiceChatScheduled(start_date=self.start_date) == self.start_date)

    def test_de_json(self, bot):
        assert VoiceChatScheduled.de_json({}, bot=bot) is None

        json_dict = {'start_date': to_timestamp(self.start_date)}
        voice_chat_scheduled = VoiceChatScheduled.de_json(json_dict, bot)

        assert pytest.approx(voice_chat_scheduled.start_date == self.start_date)

    def test_to_dict(self):
        voice_chat_scheduled = VoiceChatScheduled(self.start_date)
        voice_chat_scheduled_dict = voice_chat_scheduled.to_dict()

        assert isinstance(voice_chat_scheduled_dict, dict)
        assert voice_chat_scheduled_dict["start_date"] == to_timestamp(self.start_date)

    def test_equality(self):
        a = VoiceChatScheduled(self.start_date)
        b = VoiceChatScheduled(self.start_date)
        c = VoiceChatScheduled(dtm.datetime.utcnow() + dtm.timedelta(seconds=5))
        d = VoiceChatStarted()

        assert a == b
        assert hash(a) == hash(b)

        assert a != c
        assert hash(a) != hash(c)

        assert a != d
        assert hash(a) != hash(d)