summaryrefslogtreecommitdiff
path: root/test/extension_crafting.py
blob: df45d26610d08f2b6b7f1779d6b874400f463e7f (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
# SPDX-License-Identifier: GPL-3.0-or-later

"""
Making temporary WebExtensions for use in the test suite
"""

# This file is part of Haketilo.
#
# Copyright (C) 2021 Wojtek Kosior <koszko@koszko.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# I, Wojtek Kosior, thereby promise not to sue for violation of this file's
# license. Although I request that you do not make use this code in a
# proprietary program, I am not going to enforce this in court.

import json
import zipfile
from pathlib import Path
from uuid import uuid4

from .misc_constants import *

class ManifestTemplateValueToFill:
    pass

def manifest_template():
    return {
        'manifest_version': 2,
        'name': 'Haketilo test extension',
        'version': '1.0',
        'applications': {
	    'gecko': {
	        'id': ManifestTemplateValueToFill(),
	        'strict_min_version': '60.0'
	    }
        },
        'permissions': [
	    'contextMenus',
	    'webRequest',
	    'webRequestBlocking',
	    'activeTab',
	    'notifications',
	    'sessions',
	    'storage',
	    'tabs',
	    '<all_urls>',
	    'unlimitedStorage'
        ],
        'content_security_policy': "default-src 'self'; script-src 'self' https://serve.scrip.ts;",
        'web_accessible_resources': ['testpage.html'],
        'background': {
	    'persistent': True,
	    'scripts': ['__open_test_page.js', 'background.js']
        },
        'content_scripts': [
	    {
	        'run_at': 'document_start',
	        'matches': ['<all_urls>'],
	        'match_about_blank': True,
	        'all_frames': True,
	        'js': ['content.js']
	    }
        ]
    }

default_background_script = ''
default_content_script = ''
default_test_page = '''
<!DOCTYPE html>
<html>
  <head>
    <title>Extension's options page for testing</title>
  </head>
  <body>
    <h1>Extension's options page for testing</h1>
  </body>
</html>
'''

open_test_page_script = '''(() => {
const page_url = browser.runtime.getURL("testpage.html");
const execute_details = {
    code: `window.location.href=${JSON.stringify(page_url)};`
};
browser.tabs.query({currentWindow: true, active: true})
    .then(t => browser.tabs.executeScript(t.id, execute_details));
})();'''

def make_extension(destination_dir,
                   background_script=default_background_script,
                   content_script=default_content_script,
                   test_page=default_test_page,
                   extra_files={}):
    manifest = manifest_template()
    extension_id = '{%s}' % uuid4()
    manifest['applications']['gecko']['id'] = extension_id
    files = {
        'manifest.json'      : json.dumps(manifest),
        '__open_test_page.js': open_test_page_script,
        'background.js'      : background_script,
        'content.js'         : content_script,
        'testpage.html'      : test_page,
        **extra_files
    }
    destination_path = destination_dir / f'{extension_id}.xpi'
    with zipfile.ZipFile(destination_path, 'x') as xpi:
        for filename, contents in files.items():
            if hasattr(contents, '__call__'):
                contents = contents()
            xpi.writestr(filename, contents)

    return destination_path