public-apis/scripts/validate/api_health.py at 47b0f85f31d4f4cb80fb7d6ec9c1640781c9b45a · marcelscruz/public-apis · 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
# -*- coding: utf-8 -*-

import unittest
from unittest.mock import patch

from validate.api_health import ApiEntry
from validate.api_health import has_free_tier_signal
from validate.api_health import find_entries_to_remove
from validate.api_health import parse_api_entries
from validate.api_health import remove_entries_from_lines


class TestValidateApis(unittest.TestCase):

    def test_parse_api_entries(self):
        lines = [
            '| [Cat Facts](https://example.com/cats) | Free cat facts | No | Yes | Yes |',
            '| [Dog Facts](https://example.com/dogs) | Premium data only | `apiKey` | Yes | Yes |',
            '| Not an API line |',
        ]

        entries = parse_api_entries(lines)

        self.assertEqual(len(entries), 2)
        self.assertEqual(entries[0].title, 'Cat Facts')
        self.assertEqual(entries[0].link, 'https://example.com/cats')
        self.assertEqual(entries[0].auth, 'no')

    def test_has_free_tier_signal(self):
        free_entry_auth = ApiEntry(1, '', 'A', 'Paid service', 'no', 'https://example.com')
        free_entry_desc = ApiEntry(2, '', 'B', 'This API has a free tier for hobby usage', 'apikey', 'https://example.com')
        paid_entry = ApiEntry(3, '', 'C', 'Enterprise pricing only', 'apikey', 'https://example.com')

        self.assertTrue(has_free_tier_signal(free_entry_auth))
        self.assertTrue(has_free_tier_signal(free_entry_desc))
        self.assertFalse(has_free_tier_signal(paid_entry))


    @patch('validate.api_health.check_if_link_is_working', return_value=(True, 'ERR'))
    def test_find_entries_to_remove_counts_link_failures(self, _):
        entries = [
            ApiEntry(1, '', 'A', 'Free tier', 'apikey', 'https://example.com/a'),
            ApiEntry(2, '', 'B', 'Paid only', 'apikey', 'https://example.com/b'),
        ]

        to_remove, report, link_failures = find_entries_to_remove(entries)

        self.assertEqual(len(to_remove), 2)
        self.assertEqual(len(report), 2)
        self.assertEqual(link_failures, 2)

    def test_remove_entries_from_lines(self):
        lines = ['line 1', 'line 2', 'line 3']
        entries_to_remove = [
            ApiEntry(2, 'line 2', 'X', 'Y', 'no', 'https://example.com')
        ]

        result = remove_entries_from_lines(lines, entries_to_remove)

        self.assertEqual(result, ['line 1', 'line 3'])


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