File: test_query.py

package info (click to toggle)
python-pynetbox 7.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,296 kB
  • sloc: python: 4,343; makefile: 3
file content (186 lines) | stat: -rw-r--r-- 6,793 bytes parent folder | download
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
import unittest
from unittest.mock import Mock

from pynetbox.core.query import Request, _is_v2_token


class RequestTestCase(unittest.TestCase):
    def test_get_count(self):
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api/dcim/devices",
            filters={"q": "abcd"},
        )
        test_obj.http_session.get.return_value.json.return_value = {
            "count": 42,
            "next": "http://localhost:8001/api/dcim/devices?limit=1&offset=1&q=abcd",
            "previous": False,
            "results": [],
        }
        test_obj.http_session.get.ok = True
        test = test_obj.get_count()
        self.assertEqual(test, 42)
        test_obj.http_session.get.assert_called_with(
            "http://localhost:8001/api/dcim/devices/",
            params={"q": "abcd", "limit": 1, "brief": 1},
            headers={"accept": "application/json"},
            json=None,
        )

    def test_get_count_no_filters(self):
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api/dcim/devices",
        )
        test_obj.http_session.get.return_value.json.return_value = {
            "count": 42,
            "next": "http://localhost:8001/api/dcim/devices?limit=1&offset=1",
            "previous": False,
            "results": [],
        }
        test_obj.http_session.get.ok = True
        test = test_obj.get_count()
        self.assertEqual(test, 42)
        test_obj.http_session.get.assert_called_with(
            "http://localhost:8001/api/dcim/devices/",
            params={"limit": 1, "brief": 1},
            headers={"accept": "application/json"},
            json=None,
        )

    def test_get_manual_pagination(self):
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api/dcim/devices",
            limit=10,
            offset=20,
        )
        test_obj.http_session.get.return_value.json.return_value = {
            "count": 4,
            "next": "http://localhost:8001/api/dcim/devices?limit=10&offset=30",
            "previous": False,
            "results": [1, 2, 3, 4],
        }
        test_obj.http_session.get.ok = True
        generator = test_obj.get()
        self.assertEqual(len(list(generator)), 4)
        test_obj.http_session.get.assert_called_with(
            "http://localhost:8001/api/dcim/devices/",
            params={"offset": 20, "limit": 10},
            headers={"accept": "application/json"},
            json=None,
        )


class TokenDetectionTestCase(unittest.TestCase):
    """Tests for v1 vs v2 token detection."""

    def test_v1_token_without_dot(self):
        """V1 tokens are simple strings without dots."""
        token = "d6f4e314a5b5fefd164995169f28ae32d987704f"
        self.assertFalse(_is_v2_token(token))

    def test_v2_token_with_prefix(self):
        """V2 tokens have nbt_ prefix for secrets detection."""
        token = "nbt_abc123.def456ghi789"
        self.assertTrue(_is_v2_token(token))


class TokenAuthorizationHeaderTestCase(unittest.TestCase):
    """Tests for authorization header format with v1 and v2 tokens."""

    def test_v1_token_uses_token_header(self):
        """V1 tokens should use 'Token' authorization header."""
        v1_token = "d6f4e314a5b5fefd164995169f28ae32d987704f"
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api/dcim/devices",
            token=v1_token,
        )
        test_obj.http_session.get.return_value.ok = True
        test_obj.http_session.get.return_value.json.return_value = {
            "count": 1,
            "next": None,
            "previous": None,
            "results": [{"id": 1, "name": "test"}],
        }

        list(test_obj.get())

        # Check that the authorization header uses "Token" format
        call_args = test_obj.http_session.get.call_args
        self.assertIn("authorization", call_args.kwargs["headers"])
        self.assertEqual(
            call_args.kwargs["headers"]["authorization"], f"Token {v1_token}"
        )

    def test_v2_token_with_prefix_uses_bearer_header(self):
        """V2 tokens with prefix should use 'Bearer' authorization header."""
        v2_token = "nbt_abc123.def456ghi789"
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api/dcim/devices",
            token=v2_token,
        )
        test_obj.http_session.get.return_value.ok = True
        test_obj.http_session.get.return_value.json.return_value = {
            "count": 1,
            "next": None,
            "previous": None,
            "results": [{"id": 1, "name": "test"}],
        }

        list(test_obj.get())

        # Check that the authorization header uses "Bearer" format
        call_args = test_obj.http_session.get.call_args
        self.assertIn("authorization", call_args.kwargs["headers"])
        self.assertEqual(
            call_args.kwargs["headers"]["authorization"], f"Bearer {v2_token}"
        )

    def test_get_status_with_v1_token(self):
        """get_status should use 'Token' header for v1 tokens."""
        v1_token = "d6f4e314a5b5fefd164995169f28ae32d987704f"
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api",
            token=v1_token,
        )
        test_obj.http_session.get.return_value.ok = True
        test_obj.http_session.get.return_value.json.return_value = {
            "django-version": "4.0",
            "netbox-version": "4.4.0",
        }

        test_obj.get_status()

        # Check that the authorization header uses "Token" format
        call_args = test_obj.http_session.get.call_args
        self.assertIn("authorization", call_args.kwargs["headers"])
        self.assertEqual(
            call_args.kwargs["headers"]["authorization"], f"Token {v1_token}"
        )

    def test_get_status_with_v2_token(self):
        """get_status should use 'Bearer' header for v2 tokens."""
        v2_token = "nbt_abc123.def456ghi789"
        test_obj = Request(
            http_session=Mock(),
            base="http://localhost:8001/api",
            token=v2_token,
        )
        test_obj.http_session.get.return_value.ok = True
        test_obj.http_session.get.return_value.json.return_value = {
            "django-version": "4.0",
            "netbox-version": "4.5.0",
        }

        test_obj.get_status()

        # Check that the authorization header uses "Bearer" format
        call_args = test_obj.http_session.get.call_args
        self.assertIn("authorization", call_args.kwargs["headers"])
        self.assertEqual(
            call_args.kwargs["headers"]["authorization"], f"Bearer {v2_token}"
        )