summaryrefslogtreecommitdiff
path: root/tests/unit/test_engine_github_code.py
blob: d10081f283a6a09506aa0821f5f7560c0c9a6822 (plain)
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
# SPDX-License-Identifier: AGPL-3.0-or-later
# pylint: disable=missing-module-docstring,disable=missing-class-docstring

import logging
from unittest.mock import Mock
from urllib.parse import urlparse
from parameterized import parameterized

import searx.engines
from tests import SearxTestCase
from searx.result_types import EngineResults


class GithubCodeTests(SearxTestCase):

    TEST_SETTINGS = "test_github_code.yml"

    def setUp(self):
        super().setUp()
        self.ghc = searx.engines.engines['github code']
        self.ghc.logger.setLevel(logging.INFO)

    def tearDown(self):
        searx.search.load_engines([])

    @parameterized.expand(
        [
            [
                [
                    {
                        "fragment": "    - [Tab management](#tab-management)\n    - [Buffer/window management]"
                        "(#bufferwindow-management)\n- [🎨 Highlights](#-highlights)",
                        "matches": [{"indices": [47, 53], "text": "Buffer"}, {"indices": [74, 80], "text": "buffer"}],
                    },
                    {
                        "fragment": "To conditionally activate plugins, the best solution is to use the\n"
                        "[LazyVim VSCode extra](https://www.lazyvim.org/extras/vscode). However, "
                        "`packer.nvim` and `lazy.nvim` have built-in\nsupport for "
                        "`cond = vim.g.vscode` and `vim-plug` has a",
                        "matches": [
                            {"indices": [68, 75], "text": "LazyVim"},
                            {"indices": [102, 109], "text": "lazyvim"},
                        ],
                    },
                ],
                [
                    "    - [Tab management](#tab-management)",
                    "    - [Buffer/window management](#bufferwindow-management)",
                    "- [🎨 Highlights](#-highlights)",
                    "To conditionally activate plugins, the best solution is to use the",
                    "[LazyVim VSCode extra](https://www.lazyvim.org/extras/vscode)."
                    " However, `packer.nvim` and `lazy.nvim` have built-in",
                    "support for `cond = vim.g.vscode` and `vim-plug` has a",
                ],
                {2, 5},
            ],
            [
                [
                    {
                        "fragment": "\n| `<leader>uf` | Toggle format (global) |\n"
                        "| `<leader>uF` | Toggle format (buffer) |\n"
                        "| `<leader>us` | Toggle spelling |\n",
                        "matches": [{"indices": [74, 80], "text": "buffer"}],
                    },
                ],
                [
                    "| `<leader>uf` | Toggle format (global) |",
                    "| `<leader>uF` | Toggle format (buffer) |",
                    "| `<leader>us` | Toggle spelling |",
                ],
                {2},
            ],
            [
                [
                    {
                        "fragment": "\n\n\n1\n2\n3\n4",
                        "matches": [{"indices": [3, 4], "text": "1"}],
                    },
                ],
                [
                    "1",
                    "2",
                    "3",
                    "4",
                ],
                {1},
            ],
            [
                [
                    {
                        "fragment": "placeholder",
                        "matches": [],
                    },
                ],
                [
                    "placeholder",
                ],
                set(),
            ],
        ]
    )
    def test_code_extraction(self, code_matches, expected_code, expected_highlighted_lines):
        code, highlights = self.ghc.extract_code(code_matches=code_matches)
        self.assertEqual(code, expected_code)
        self.assertEqual(highlights, expected_highlighted_lines)

    def test_transforms_response(self):
        response = Mock()
        response.json.return_value = {
            "items": [
                {
                    "name": "TODO.md",
                    "path": "TODO.md",
                    "html_url": "https://github.com/folke/dot/blob/3140f4f5720c3cc6b5034c624eb7706f8533a82c/TODO.md",
                    "repository": {
                        "full_name": "folke/dot",
                        "html_url": "https://github.com/folke/dot",
                        "description": "☕️   My Dot Files",
                    },
                    "text_matches": [
                        {
                            "object_type": "FileContent",
                            "property": "content",
                            "fragment": "- [x] windows picker\n"
                            "- [x] toggle cwd / root (LazyVim)\n"
                            "- [x] dynamic workspace symbol",
                            "matches": [{"indices": [46, 53], "text": "LazyVim"}],
                        },
                        {
                            "object_type": "FileContent",
                            "property": "content",
                            "fragment": "- [x] smart stops working after custom\n"
                            "- [x] edit in empty buffer\n"
                            "- [x] support toggling line nr for preview",
                            "matches": [{"indices": [59, 65], "text": "buffer"}, {"indices": [89, 93], "text": "line"}],
                        },
                    ],
                }
            ]
        }
        response.status_code = 200
        results = self.ghc.response(response)
        expected_results = EngineResults()
        expected_results.add(
            expected_results.types.LegacyResult(
                **{
                    'url': "https://github.com/folke/dot/blob/3140f4f5720c3cc6b5034c624eb7706f8533a82c/TODO.md",
                    'title': "folke/dot · TODO.md",
                    'content': "☕️   My Dot Files",
                    'repository': "https://github.com/folke/dot",
                    'codelines': [
                        (1, "- [x] windows picker"),
                        (2, "- [x] toggle cwd / root (LazyVim)"),
                        (3, "- [x] dynamic workspace symbol"),
                        (4, "- [x] smart stops working after custom"),
                        (5, "- [x] edit in empty buffer"),
                        (6, "- [x] support toggling line nr for preview"),
                    ],
                    'hl_lines': {2, 5, 6},
                    'code_language': "markdown",
                    'template': 'code.html',
                    'strip_whitespace': False,
                    'strip_new_lines': True,
                    'parsed_url': urlparse(
                        "https://github.com/folke/dot/blob/3140f4f5720c3cc6b5034c624eb7706f8533a82c/TODO.md"
                    ),
                }
            )
        )
        self.assertEqual(results, expected_results)