cs3-python-client/tests/test_user.py at 376f23611e27356f55cf401fa15af92268214f95 · cs3org/cs3-python-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
"""
test_user.py

Tests that the User class methods work as expected.

Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
Emails: rasmus.oscar.welander@cern.ch, diogo.castro@cern.ch, giuseppe.lopresti@cern.ch
Last updated: 28/08/2024
"""

import pytest
from unittest.mock import Mock, patch
import cs3.rpc.v1beta1.code_pb2 as cs3code
import cs3.identity.user.v1beta1.user_api_pb2 as cs3iu
import cs3.identity.user.v1beta1.resources_pb2 as cs3iur

from cs3client.exceptions import (
    AuthenticationException,
    NotFoundException,
    UnknownException,
)
from .fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
    mock_config,
    mock_logger,
    mock_gateway,
    user_instance,
    mock_status_code_handler,
)

# Test cases for the User class


@pytest.mark.parametrize(
    "status_code, status_message, expected_exception, user_data",
    [
        (cs3code.CODE_OK, None, None, Mock(idp="idp", opaque_id="opaque_id")),
        (cs3code.CODE_NOT_FOUND, "error", NotFoundException, None),
        (-2, "error", UnknownException, None),
    ],
)
def test_get_user(
    user_instance, status_code, status_message, expected_exception, user_data  # noqa: F811 (not a redefinition)
):
    idp = "idp"
    opaque_id = "opaque_id"

    mock_response = Mock()
    mock_response.status.code = status_code
    mock_response.status.message = status_message
    mock_response.user = user_data

    with patch.object(user_instance._gateway, "GetUser", return_value=mock_response):
        if expected_exception:
            with pytest.raises(expected_exception):
                user_instance.get_user(idp, opaque_id)
        else:
            result = user_instance.get_user(idp, opaque_id)
            assert result == user_data


@pytest.mark.parametrize(
    "status_code, status_message, expected_exception, user_data",
    [
        (cs3code.CODE_OK, None, None, Mock(idp="idp", opaque_id="opaque_id")),
        (cs3code.CODE_NOT_FOUND, "error", NotFoundException, None),
        (-2, "error", UnknownException, None),
    ],
)
def test_get_user_by_claim(
    user_instance, status_code, status_message, expected_exception, user_data  # noqa: F811 (not a redefinition)
):
    claim = "claim"
    value = "value"

    mock_response = Mock()
    mock_response.status.code = status_code
    mock_response.status.message = status_message
    mock_response.user = user_data

    with patch.object(user_instance._gateway, "GetUserByClaim", return_value=mock_response):
        if expected_exception:
            with pytest.raises(expected_exception):
                user_instance.get_user_by_claim(claim, value)
        else:
            result = user_instance.get_user_by_claim(claim, value)
            assert result == user_data


@pytest.mark.parametrize(
    "status_code, status_message, expected_exception, groups",
    [
        (cs3code.CODE_OK, None, None, ["group1", "group2"]),
        (cs3code.CODE_NOT_FOUND, "error", NotFoundException, None),
        (-2, "error", UnknownException, None),
    ],
)
def test_get_user_groups(
    user_instance, status_code, status_message, expected_exception, groups  # noqa: F811 (not a redefinition)
):
    idp = "idp"
    opaque_id = "opaque_id"

    mock_response = Mock()
    mock_response.status.code = status_code
    mock_response.status.message = status_message
    mock_response.groups = groups

    with patch.object(user_instance._gateway, "GetUserGroups", return_value=mock_response):
        if expected_exception:
            with pytest.raises(expected_exception):
                user_instance.get_user_groups(idp, opaque_id)
        else:
            result = user_instance.get_user_groups(idp, opaque_id)
            assert result == groups


@pytest.mark.parametrize(
    "status_code, status_message, expected_exception, users",
    [
        (cs3code.CODE_OK, None, None, [Mock(), Mock()]),
        (cs3code.CODE_NOT_FOUND, "error", NotFoundException, None),
        (cs3code.CODE_UNAUTHENTICATED, "error", AuthenticationException, None),
        (-2, "error", UnknownException, None),
    ],
)
def test_find_users(
    user_instance, status_code, status_message, expected_exception, users  # noqa: F811 (not a redefinition)
):
    filters = [
        cs3iu.Filter(
            type=cs3iur.UserType.USER_TYPE_PRIMARY
        )
    ]

    mock_response = Mock()
    mock_response.status.code = status_code
    mock_response.status.message = status_message
    mock_response.users = users
    auth_token = ('x-access-token', "some_token")

    with patch.object(user_instance._gateway, "FindUsers", return_value=mock_response):
        if expected_exception:
            with pytest.raises(expected_exception):
                user_instance.find_users(auth_token, filters)
        else:
            result = user_instance.find_users(auth_token, filters)
            assert result == users