File: models_test.py

package info (click to toggle)
python-geoip2 2.9.0%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 572 kB
  • sloc: python: 1,224; makefile: 5
file content (389 lines) | stat: -rw-r--r-- 15,389 bytes parent folder | download | duplicates (3)
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import unicode_literals

import sys
sys.path.append('..')

import geoip2.models

if sys.version_info[:2] == (2, 6):
    import unittest2 as unittest
else:
    import unittest

if sys.version_info[0] == 2:
    unittest.TestCase.assertRaisesRegex = unittest.TestCase.assertRaisesRegexp
    unittest.TestCase.assertRegex = unittest.TestCase.assertRegexpMatches


class TestModels(unittest.TestCase):
    def test_insights_full(self):
        raw = {
            'city': {
                'confidence': 76,
                'geoname_id': 9876,
                'names': {
                    'en': 'Minneapolis'
                },
            },
            'continent': {
                'code': 'NA',
                'geoname_id': 42,
                'names': {
                    'en': 'North America'
                },
            },
            'country': {
                'confidence': 99,
                'geoname_id': 1,
                'iso_code': 'US',
                'names': {
                    'en': 'United States of America'
                },
            },
            'location': {
                'average_income': 24626,
                'accuracy_radius': 1500,
                'latitude': 44.98,
                'longitude': 93.2636,
                'metro_code': 765,
                'population_density': 1341,
                'time_zone': 'America/Chicago',
            },
            'postal': {
                'code': '55401',
                'confidence': 33,
            },
            'subdivisions': [{
                'confidence': 88,
                'geoname_id': 574635,
                'iso_code': 'MN',
                'names': {
                    'en': 'Minnesota'
                },
            }, {
                'geoname_id': 123,
                'iso_code': 'HP',
                'names': {
                    'en': 'Hennepin'
                },
            }],
            'registered_country': {
                'geoname_id': 2,
                'iso_code': 'CA',
                'names': {
                    'en': 'Canada'
                },
            },
            'represented_country': {
                'geoname_id': 3,
                'is_in_european_union': True,
                'iso_code': 'GB',
                'names': {
                    'en': 'United Kingdom'
                },
                'type': 'military',
            },
            'traits': {
                'autonomous_system_number': 1234,
                'autonomous_system_organization': 'AS Organization',
                'domain': 'example.com',
                'ip_address': '1.2.3.4',
                'is_anonymous': True,
                'is_anonymous_proxy': True,
                'is_anonymous_vpn': True,
                'is_hosting_provider': True,
                'is_public_proxy': True,
                'is_satellite_provider': True,
                'is_tor_exit_node': True,
                'isp': 'Comcast',
                'network_speed': 'cable/DSL',
                'organization': 'Blorg',
                'user_type': 'college',
            },
        }

        model = geoip2.models.Insights(raw)
        self.assertEqual(
            type(model), geoip2.models.Insights,
            'geoip2.models.Insights object')
        self.assertEqual(
            type(model.city), geoip2.records.City,
            'geoip2.records.City object')
        self.assertEqual(
            type(model.continent), geoip2.records.Continent,
            'geoip2.records.Continent object')
        self.assertEqual(
            type(model.country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.registered_country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.represented_country), geoip2.records.RepresentedCountry,
            'geoip2.records.RepresentedCountry object')
        self.assertEqual(
            type(model.location), geoip2.records.Location,
            'geoip2.records.Location object')
        self.assertEqual(
            type(model.subdivisions[0]), geoip2.records.Subdivision,
            'geoip2.records.Subdivision object')
        self.assertEqual(
            type(model.traits), geoip2.records.Traits,
            'geoip2.records.Traits object')
        self.assertEqual(model.raw, raw, 'raw method returns raw input')
        self.assertEqual(model.subdivisions[0].iso_code, 'MN',
                         'div 1 has correct iso_code')
        self.assertEqual(model.subdivisions[0].confidence, 88,
                         'div 1 has correct confidence')
        self.assertEqual(model.subdivisions[0].geoname_id, 574635,
                         'div 1 has correct geoname_id')
        self.assertEqual(model.subdivisions[0].names, {'en': 'Minnesota'},
                         'div 1 names are correct')
        self.assertEqual(model.subdivisions[1].name, 'Hennepin',
                         'div 2 has correct name')
        self.assertEqual(model.subdivisions.most_specific.iso_code, 'HP',
                         'subdivisions.most_specific returns HP')
        self.assertEqual(model.represented_country.name, 'United Kingdom',
                         'represented_country name is correct')
        self.assertEqual(model.represented_country.type, 'military',
                         'represented_country type is correct')
        self.assertEqual(model.location.average_income, 24626,
                         'correct average_income')
        self.assertEqual(model.location.latitude, 44.98, 'correct latitude')
        self.assertEqual(model.location.longitude, 93.2636,
                         'correct longitude')
        self.assertEqual(model.location.metro_code, 765, 'correct metro_code')
        self.assertEqual(model.location.population_density, 1341,
                         'correct population_density')

        self.assertRegex(
            str(model),
            r'^geoip2.models.Insights\(\{.*geoname_id.*\}, \[.*en.*\]\)',
            'Insights str representation looks reasonable')

        self.assertEqual(model, eval(repr(model)),
                         "Insights repr can be eval'd")

        self.assertRegex(
            str(model.location), r'^geoip2.records.Location\(.*longitude=.*\)',
            'Location str representation is reasonable')

        self.assertEqual(model.location, eval(repr(model.location)),
                         "Location repr can be eval'd")

        self.assertIs(model.country.is_in_european_union, False)
        self.assertIs(model.registered_country.is_in_european_union, False)
        self.assertIs(model.represented_country.is_in_european_union, True)

        self.assertIs(model.traits.is_anonymous, True)
        self.assertIs(model.traits.is_anonymous_proxy, True)
        self.assertIs(model.traits.is_anonymous_vpn, True)
        self.assertIs(model.traits.is_hosting_provider, True)
        self.assertIs(model.traits.is_public_proxy, True)
        self.assertIs(model.traits.is_satellite_provider, True)
        self.assertIs(model.traits.is_tor_exit_node, True)

    def test_insights_min(self):
        model = geoip2.models.Insights({'traits': {'ip_address': '5.6.7.8'}})
        self.assertEqual(
            type(model), geoip2.models.Insights,
            'geoip2.models.Insights object')
        self.assertEqual(
            type(model.city), geoip2.records.City,
            'geoip2.records.City object')
        self.assertEqual(
            type(model.continent), geoip2.records.Continent,
            'geoip2.records.Continent object')
        self.assertEqual(
            type(model.country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.registered_country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.location), geoip2.records.Location,
            'geoip2.records.Location object')
        self.assertEqual(
            type(model.traits), geoip2.records.Traits,
            'geoip2.records.Traits object')
        self.assertEqual(
            type(model.subdivisions.most_specific), geoip2.records.Subdivision,
            'geoip2.records.Subdivision object returned even'
            'when none are available.')
        self.assertEqual(model.subdivisions.most_specific.names, {},
                         'Empty names hash returned')

    def test_city_full(self):
        raw = {
            'continent': {
                'code': 'NA',
                'geoname_id': 42,
                'names': {
                    'en': 'North America'
                },
            },
            'country': {
                'geoname_id': 1,
                'iso_code': 'US',
                'names': {
                    'en': 'United States of America'
                },
            },
            'registered_country': {
                'geoname_id': 2,
                'iso_code': 'CA',
                'names': {
                    'en': 'Canada'
                },
            },
            'traits': {
                'ip_address': '1.2.3.4',
                'is_satellite_provider': True,
            },
        }
        model = geoip2.models.City(raw)
        self.assertEqual(
            type(model), geoip2.models.City, 'geoip2.models.City object')
        self.assertEqual(
            type(model.city), geoip2.records.City,
            'geoip2.records.City object')
        self.assertEqual(
            type(model.continent), geoip2.records.Continent,
            'geoip2.records.Continent object')
        self.assertEqual(
            type(model.country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.registered_country), geoip2.records.Country,
            'geoip2.records.Country object')
        self.assertEqual(
            type(model.location), geoip2.records.Location,
            'geoip2.records.Location object')
        self.assertEqual(
            type(model.traits), geoip2.records.Traits,
            'geoip2.records.Traits object')
        self.assertEqual(model.raw, raw, 'raw method returns raw input')
        self.assertEqual(model.continent.geoname_id, 42,
                         'continent geoname_id is 42')
        self.assertEqual(model.continent.code, 'NA', 'continent code is NA')
        self.assertEqual(model.continent.names, {'en': 'North America'},
                         'continent names is correct')
        self.assertEqual(model.continent.name, 'North America',
                         'continent name is correct')
        self.assertEqual(model.country.geoname_id, 1,
                         'country geoname_id is 1')
        self.assertEqual(model.country.iso_code, 'US',
                         'country iso_code is US')
        self.assertEqual(model.country.names,
                         {'en': 'United States of America'},
                         'country names is correct')
        self.assertEqual(model.country.name, 'United States of America',
                         'country name is correct')
        self.assertEqual(model.country.confidence, None,
                         'country confidence is None')
        self.assertEqual(model.registered_country.iso_code, 'CA',
                         'registered_country iso_code is CA')
        self.assertEqual(model.registered_country.names, {'en': 'Canada'},
                         'registered_country names is correct')
        self.assertEqual(model.registered_country.name, 'Canada',
                         'registered_country name is correct')
        self.assertEqual(model.traits.is_anonymous_proxy, False,
                         'traits is_anonymous_proxy returns False by default')
        self.assertEqual(model.traits.is_satellite_provider, True,
                         'traits is_setellite_provider is True')
        self.assertEqual(model.raw, raw, 'raw method produces raw output')

        self.assertRegex(
            str(model),
            r'^geoip2.models.City\(\{.*geoname_id.*\}, \[.*en.*\]\)')

        self.assertFalse(model == True,
                         '__eq__ does not blow up on weird input')

    def test_unknown_keys(self):
        model = geoip2.models.City({
            'traits': {
                'ip_address': '1.2.3.4',
                'invalid': 'blah'
            },
            'unk_base': {
                'blah': 1
            }
        })
        with self.assertRaises(AttributeError):
            model.unk_base
        with self.assertRaises(AttributeError):
            model.traits.invalid
        self.assertEqual(model.traits.ip_address, '1.2.3.4', 'correct ip')


class TestNamess(unittest.TestCase):

    raw = {
        'continent': {
            'code': 'NA',
            'geoname_id': 42,
            'names': {
                'de': 'Nordamerika',
                'en': 'North America',
                'es': 'América del Norte',
                'ja': '北アメリカ',
                'pt-BR': 'América do Norte',
                'ru': 'Северная Америка',
                'zh-CN': '北美洲',
            },
        },
        'country': {
            'geoname_id': 1,
            'iso_code': 'US',
            'names': {
                'en': 'United States of America',
                'fr': 'États-Unis',
                'zh-CN': '美国',
            },
        },
        'traits': {
            'ip_address': '1.2.3.4',
        },
    }

    def test_names(self):
        model = geoip2.models.Country(self.raw, locales=['sq', 'ar'])
        self.assertEqual(model.continent.names, self.raw['continent']['names'],
                         'Correct names dict for continent')
        self.assertEqual(model.country.names, self.raw['country']['names'],
                         'Correct names dict for country')

    def test_three_locales(self):
        model = geoip2.models.Country(self.raw, locales=['fr', 'zh-CN', 'en'])
        self.assertEqual(model.continent.name, '北美洲',
                         'continent name is in Chinese (no French available)')
        self.assertEqual(model.country.name, 'États-Unis',
                         'country name is in French')

    def test_two_locales(self):
        model = geoip2.models.Country(self.raw, locales=['ak', 'fr'])
        self.assertEqual(model.continent.name, None,
                         'continent name is undef (no Akan or French '
                         'available)')
        self.assertEqual(model.country.name, 'États-Unis',
                         'country name is in French')

    def test_unknown_locale(self):
        model = geoip2.models.Country(self.raw, locales=['aa'])
        self.assertEqual(model.continent.name, None,
                         'continent name is undef (no Afar available)')
        self.assertEqual(model.country.name, None,
                         'country name is in None (no Afar available)')

    def test_german(self):
        model = geoip2.models.Country(self.raw, locales=['de'])
        self.assertEqual(model.continent.name, 'Nordamerika',
                         'Correct german name for continent')


if __name__ == '__main__':
    unittest.main()