aboutsummaryrefslogtreecommitdiff
path: root/test/haketilo_test/unit/test_repo_query.py
blob: c8c4875c18d96c9913193ee9ddde25d470e8837b (about) (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
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
# SPDX-License-Identifier: CC0-1.0

"""
Haketilo unit tests - repository querying
"""

# This file is part of Haketilo
#
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the CC0 1.0 Universal License as published by
# the Creative Commons Corporation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# CC0 1.0 Universal License for more details.

import pytest
from selenium.webdriver.support.ui import WebDriverWait

from ..extension_crafting import ExtraHTML
from ..script_loader import load_script
from .utils import *

repo_urls = [f'https://hydril.la/{s}' for s in ('', '1/', '2/', '3/', '4/')]

queried_url = 'https://example_a.com/something'

def setup_view(execute_in_page, repo_urls):
    mock_cacher(execute_in_page)

    execute_in_page(load_script('html/repo_query.js'))
    execute_in_page(
        '''
        const repo_proms = arguments[0].map(url => haketilodb.set_repo(url));

        const cb_calls = [];
        const view = new RepoQueryView(0,
                                       () => cb_calls.push("show"),
                                       () => cb_calls.push("hide"));
        document.body.append(view.main_div);
        const shw = slice => [cb_calls.slice(slice || 0), view.shown];

        returnval(Promise.all(repo_proms));
        ''',
        repo_urls)

repo_query_ext_data = {
    'background_script': broker_js,
    'extra_html': ExtraHTML('html/repo_query.html', {}),
    'navigate_to': 'html/repo_query.html'
}

@pytest.mark.ext_data(repo_query_ext_data)
@pytest.mark.usefixtures('webextension')
def test_repo_query_normal_usage(driver, execute_in_page):
    """
    Test of using the repo query view to browse results from repository and to
    start installation.
    """
    setup_view(execute_in_page, repo_urls)

    assert execute_in_page('returnval(shw());') == [[], False]

    execute_in_page('view.show(arguments[0]);', queried_url)

    assert execute_in_page('returnval(shw());') == [['show'], True]

    def get_repo_entries(driver):
        return execute_in_page(
            f'returnval((view.repo_entries || []).map({nodes_props_code}));'
        )

    repo_entries = WebDriverWait(driver, 10).until(get_repo_entries)

    assert len(repo_urls) == len(repo_entries)

    for url, entry in reversed(list(zip(repo_urls, repo_entries))):
        assert url in entry['main_li'].text

    but_ids = ('show_results_but', 'hide_results_but')
    for but_idx in (0, 1, 0):
        assert bool(but_idx) == entry['list_container'].is_displayed()

        assert not entry[but_ids[1 - but_idx]].is_displayed()

        entry[but_ids[but_idx]].click()

    def get_mapping_entries(driver):
        return execute_in_page(
            f'''{{
            const result_entries = (view.repo_entries[0].result_entries || []);
            returnval(result_entries.map({nodes_props_code}));
            }}''')

    mapping_entries = WebDriverWait(driver, 10).until(get_mapping_entries)

    assert len(mapping_entries) == 3

    expected_names = ['MAPPING_ABCD', 'MAPPING_ABCD-DEFG-GHIJ', 'MAPPING_A']

    for name, entry in zip(expected_names, mapping_entries):
        assert entry['mapping_name'].text == name
        assert entry['mapping_id'].text == f'{name.lower()}-2022.5.11'

    containers = execute_in_page(
        '''{
        const reductor = (acc, k) => Object.assign(acc, {[k]: view[k]});
        returnval(container_ids.reduce(reductor, {}));
        }''')

    for id, container in containers.items():
        assert (id == 'repos_list_container') == container.is_displayed()

    entry['install_but'].click()

    for id, container in containers.items():
        assert (id == 'install_view_container') == container.is_displayed()

    execute_in_page('returnval(view.install_view.cancel_but);').click()

    for id, container in containers.items():
        assert (id == 'repos_list_container') == container.is_displayed()

    assert execute_in_page('returnval(shw());') == [['show'], True]
    execute_in_page('returnval(view.cancel_but);').click()
    assert execute_in_page('returnval(shw());') == [['show', 'hide'], False]

@pytest.mark.ext_data(repo_query_ext_data)
@pytest.mark.usefixtures('webextension')
@pytest.mark.parametrize('message', [
    'browsing_for',
    'no_repos',
    'failure_to_communicate',
    'HTTP_code',
    'invalid_JSON',
    'newer_API_version',
    'invalid_response_format',
    'querying_repo',
    'no_results'
])
def test_repo_query_messages(driver, execute_in_page, message):
    """
    Test of loading and error messages shown in parts of the repo query view.
    """
    def has_msg(message, elem=None):
        def has_msg_and_is_visible(dummy_driver):
            if elem:
                return elem.is_displayed() and message in elem.text
            else:
                return message in driver.page_source
        return has_msg_and_is_visible

    def show_and_wait_for_repo_entry():
        execute_in_page('view.show(arguments[0]);', queried_url)
        done = lambda d: execute_in_page('returnval(!!view.repo_entries);')
        WebDriverWait(driver, 10).until(done)
        execute_in_page(
            '''
            if (view.repo_entries.length > 0)
                view.repo_entries[0].show_results_but.click();
            ''')

    if message == 'browsing_for':
        setup_view(execute_in_page, [])
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.url_span.parentNode);')
        assert has_msg(f'Browsing custom resources for: {queried_url}', elem)(0)
    elif message == 'no_repos':
        setup_view(execute_in_page, [])
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repos_list);')
        done = has_msg('You have no repositories configured :(', elem)
        WebDriverWait(driver, 10).until(done)
    elif message == 'failure_to_communicate':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            'browser.tabs.sendMessage = () => Promise.resolve({error: "sth"});'
        )
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        done = has_msg('Failure to communicate with repository :(', elem)
        WebDriverWait(driver, 10).until(done)
    elif message == 'HTTP_code':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            '''
            const response = {ok: false, status: 405};
            browser.tabs.sendMessage = () => Promise.resolve(response);
            ''')
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        done = has_msg('Repository sent HTTP code 405 :(', elem)
        WebDriverWait(driver, 10).until(done)
    elif message == 'invalid_JSON':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            '''
            const response = {ok: true, status: 200, error_json: "sth"};
            browser.tabs.sendMessage = () => Promise.resolve(response);
            ''')
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        done = has_msg("Repository's response is not valid JSON :(", elem)
        WebDriverWait(driver, 10).until(done)
    elif message == 'newer_API_version':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            '''
            const response = {
                ok: true,
                status: 200,
                json: {$schema: "https://hydrilla.koszko.org/schemas/api_query_result-3.2.1.schema.json"}
            };
            browser.tabs.sendMessage = () => Promise.resolve(response);
            ''')
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        msg = 'Results were served using unsupported Hydrilla API version. You might need to update Haketilo.'
        WebDriverWait(driver, 10).until(has_msg(msg, elem))
    elif message == 'invalid_response_format':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            '''
            const response = {
                ok: true,
                status: 200,
                /* $schema is not a string as it should be. */
                json: {$schema: null}
            };
            browser.tabs.sendMessage = () => Promise.resolve(response);
            ''')
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        msg = 'Results were served using a nonconforming response format.'
        WebDriverWait(driver, 10).until(has_msg(msg, elem))
    elif message == 'querying_repo':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            'browser.tabs.sendMessage = () => new Promise(() => {});'
        )
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        assert has_msg('Querying repository...', elem)(0)
    elif message == 'no_results':
        setup_view(execute_in_page, repo_urls)
        execute_in_page(
            '''
            const response = {
                ok: true,
                status: 200,
                json: {
                    $schema: "https://hydrilla.koszko.org/schemas/api_query_result-1.schema.json",
                    mappings: []
                }
            };
            browser.tabs.sendMessage = () => Promise.resolve(response);
            ''')
        show_and_wait_for_repo_entry()

        elem = execute_in_page('returnval(view.repo_entries[0].info_div);')
        WebDriverWait(driver, 10).until(has_msg('No results :(', elem))
    else:
        raise Exception('made a typo in test function params?')