slack_test.py

"""Tests for slack functions"""

import pytest


from slack import get_channels_info, get_doofs_id


pytestmark = pytest.mark.asyncio


async def test_get_channels_info(mocker):
    """get_channels_info should obtain information for all public and private channels that doof knows about"""
    post_patch = mocker.async_patch("client_wrapper.ClientWrapper.post")
    next_cursor = "some cursor"
    post_patch.return_value.json.side_effect = [
        {
            "channels": [
                {
                    "name": "a",
                    "id": "public channel",
                },
                {
                    "name": "and a",
                    "id": "private one",
                },
            ],
            "response_metadata": {
                "next_cursor": next_cursor,
            },
        },
        {"channels": [{"name": "two", "id": "a channel in the next page"}]},
    ]
    token = "token"
    assert await get_channels_info(token) == {
        "a": "public channel",
        "and a": "private one",
        "two": "a channel in the next page",
    }
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/conversations.list",
        data={
            "token": token,
            "types": "public_channel,private_channel",
            "limit": 200,
            "exclude_archived": "true",
        },
    )
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/conversations.list",
        data={
            "token": token,
            "types": "public_channel,private_channel",
            "limit": 200,
            "cursor": next_cursor,
            "exclude_archived": "true",
        },
    )


async def test_get_doofs_id(mocker):
    """get_doofs_id should contact the user API which gets slack info"""
    post_patch = mocker.async_patch("client_wrapper.ClientWrapper.post")
    doof_id = "It's doof"
    token = "It's a token"
    next_cursor = "some cursor"
    post_patch.return_value.json.side_effect = [
        {
            "members": [
                {
                    "name": "someone",
                    "id": "their id",
                },
                {
                    "name": "other person",
                    "id": "other id",
                },
            ],
            "response_metadata": {
                "next_cursor": next_cursor,
            },
        },
        {"members": [{"name": "doof", "id": doof_id}]},
    ]
    assert await get_doofs_id(token) == doof_id
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/users.list",
        data={
            "token": token,
            "cursor": next_cursor,
        },
    )
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/users.list",
        data={
            "token": token,
        },
    )


async def test_get_doofs_id_missing(mocker):
    """get_doofs_id should raise an exception if the user id can't be found"""
    post_patch = mocker.async_patch("client_wrapper.ClientWrapper.post")
    token = "It's a token"
    next_cursor = "some cursor"
    post_patch.return_value.json.side_effect = [
        {
            "members": [
                {
                    "name": "someone",
                    "id": "their id",
                },
                {
                    "name": "other person",
                    "id": "other id",
                },
            ],
            "response_metadata": {
                "next_cursor": next_cursor,
            },
        },
        {"members": [{"name": "other person", "id": "someone else"}]},
    ]
    with pytest.raises(Exception) as ex:
        await get_doofs_id(token)
    assert ex.value.args[0] == "Unable to find Doof's user id"
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/users.list",
        data={
            "token": token,
            "cursor": next_cursor,
        },
    )
    post_patch.assert_any_call(
        mocker.ANY,
        "https://slack.com/api/users.list",
        data={
            "token": token,
        },
    )