aboutsummaryrefslogtreecommitdiff
path: root/test/unit/test_content.py
blob: c8e0987f09ec479a2cc79811dc0dba71d6f18f1d (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
# SPDX-License-Identifier: CC0-1.0

"""
Haketilo unit tests - main content script
"""

# 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
import json
from selenium.webdriver.support.ui import WebDriverWait

from ..script_loader import load_script

# From:
# https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/contentScripts/register
# it is unclear whether the dynamically-registered content script is guaranteed
# to be always executed after statically-registered ones. We want to test both
# cases, so we'll make the mocked dynamic content script execute before
# content.js on http:// pages and after it on https:// pages.
dynamic_script = \
    ''';
    this.haketilo_secret        = "abracadabra";
    this.haketilo_pattern_tree  = {};
    this.haketilo_defualt_allow = false;

    if (this.haketilo_content_script_main)
        this.haketilo_content_script_main();
    '''

content_script = \
    '''
    /* Mock dynamic content script - case 'before'. */
    if (/#dynamic_before$/.test(document.URL)) {
        %s;
    }

    /* Place amalgamated content.js here. */
    %s;

    /* Rest of mocks */
    const data_to_verify = {};
    function data_set(prop, val) {
        data_to_verify[prop] = val;
        window.wrappedJSObject.data_to_verify = JSON.stringify(data_to_verify);
    }

    repo_query_cacher.start = () => data_set("cacher_started", true);

    enforce_blocking = policy => data_set("enforcing", policy);

    browser.runtime.onMessage.addListener = async function (listener_cb) {
        await new Promise(cb => setTimeout(cb, 0));

        /* Mock a good request. */
        const set_good = val => data_set("good_request_result", val);
        listener_cb(["page_info"], {}, val => set_good(val));

        /* Mock a bad request. */
        const set_bad = val => data_set("bad_request_result", val);
        listener_cb(["???"], {}, val => set_bad(val));
    }

    /* main() call - normally present in content.js, inside '#IF !UNIT_TEST'. */
    main();

    /* Mock dynamic content script - case 'after'. */
    if (/#dynamic_after$/.test(document.URL)) {
        %s;
    }

    data_set("script_run_without_errors", true);
    ''' % (dynamic_script, load_script('content/content.js'), dynamic_script)

@pytest.mark.ext_data({'content_script': content_script})
@pytest.mark.usefixtures('webextension')
@pytest.mark.parametrize('target', ['dynamic_before', 'dynamic_after'])
def test_content_unprivileged_page(driver, execute_in_page, target):
    """
    Test functioning of content.js on an page using unprivileged schema (e.g.
    'https://' and not 'about:').
    """
    driver.get(f'https://gotmyowndoma.in/index.html#{target}')
    data = json.loads(driver.execute_script('return window.data_to_verify;'))

    assert 'gotmyowndoma.in' in data['good_request_result']['url']
    assert 'bad_request_result' not in data

    assert data['cacher_started'] == True

    assert data['enforcing']['allow']  == False
    assert 'mapping' not in data['enforcing']
    assert 'error'   not in data['enforcing']

    assert data['script_run_without_errors'] == True

@pytest.mark.ext_data({'content_script': content_script})
@pytest.mark.usefixtures('webextension')
@pytest.mark.parametrize('target', ['dynamic_before', 'dynamic_after'])
def test_content_privileged_page(driver, execute_in_page, target):
    """
    Test functioning of content.js on an page considered privileged (e.g. a
    directory listing at 'file:///').
    """
    driver.get(f'file:///#{target}')
    data = json.loads(driver.execute_script('return window.data_to_verify;'))

    assert data == {'script_run_without_errors': True}