rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Code cleanup / Good practices

Browse Source
This commit is contained in:
Corentin Julé 2016-01-23 16:15:19 +01:00
parent ff8d5370a3
commit 47261dbd30
1 changed files with 79 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

221
tests/unit/browser/test_adblock.py
View File

@ -1,8 +1,7 @@
# TODO See utils/test_standarddirutils for OSEError and caplog assertion
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
#!/usr/bin/env python3
# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
# Copyright 2015 Corentin Julé <corentinjule@gmail.com>
#
# This file is part of qutebrowser.
#
@ -33,6 +32,7 @@ from qutebrowser.browser import adblock
from qutebrowser.utils import objreg
from qutebrowser.commands import cmdexc
# TODO See ../utils/test_standarddirutils for OSEError and caplog assertion
WHITELISTED_HOSTS = ('qutebrowser.org', 'mediumhost.io')
@ -46,27 +46,20 @@ CLEAN_HOSTS = ('goodhost.gov', 'verygoodhost.com')
URLS_TO_CHECK = ('http://localhost',
'http://mediumhost.io',
'http://malware.badhost.org',
'ftp://malware.badhost.org',
'http://4-verybadhost.com',
'http://ads.worsthostever.net',
'http://goodhost.gov',
'ftp://verygoodhost.com'
'http://qutebrowser.org')
@pytest.fixture
def data_tmpdir(monkeypatch, tmpdir):
"""Set tmpdir as datadir"""
tmpdir = str(tmpdir)
monkeypatch.setattr('qutebrowser.utils.standarddir.data', lambda: tmpdir)
# XXX Why does read_hosts needs basedir to be None
# in order to print message 'run adblock-update to read host blocklist' ?
# browser/adblock.py line 138
# TODO Replace with unittest mock.mock / See test webelem
class BaseDirStub:
"""Mock for objreg.get('args') called in adblock.HostBlocker.read_hosts."""
@ -77,12 +70,10 @@ class BaseDirStub:
@pytest.yield_fixture
def basedir():
"""Register a Fake basedir."""
args = BaseDirStub()
objreg.register('args', args)
yield args
yield
objreg.delete('args')
@ -92,8 +83,8 @@ class FakeDownloadItem(QObject):
finished = pyqtSignal()
def __init__(self, fileobj, name):
super().__init__()
def __init__(self, fileobj, name, parent=None):
super().__init__(parent)
self.fileobj = fileobj
self.name = name
self.successful = True
@ -104,57 +95,45 @@ class FakeDownloadManager:
"""Mock browser.downloads.DownloadManager."""
def get(self, url, fileobj, **kwargs):
"""Return a FakeDownloadItem instance with a fileobj
whose content is copied from the file the given url links to.
"""
download_item = FakeDownloadItem(fileobj, name=url.path())
with open(url.path(), 'rb') as fake_url_file:
# Ensure cursors are at position 0 before copying
fake_url_file.seek(0)
download_item.fileobj.seek(0)
shutil.copyfileobj(fake_url_file, download_item.fileobj)
return download_item
@pytest.yield_fixture
def download_stub(win_registry):
"""Register a FakeDownloadManager."""
stub = FakeDownloadManager()
objreg.register('download-manager', stub,
scope='window', window='last-focused')
yield stub
yield
objreg.delete('download-manager', scope='window', window='last-focused')
def create_zipfile(directory, files, zipname='test'):
"""Return a path to a created zip file
"""Return a path to a newly created zip file
Args :
- directory : path object where to create the zip file
- files : list of paths to each file to add in the zipfile
- zipname : name to give to the zip file.
"""
directory = str(directory)
zipfile_path = os.path.join(directory, zipname + '.zip')
with zipfile.ZipFile(zipfile_path, 'w') as new_zipfile:
for file_name in files:
new_zipfile.write(file_name, arcname=os.path.basename(file_name))
zipfile_path = directory / zipname + '.zip'
with zipfile.ZipFile(str(zipfile_path), 'w') as new_zipfile:
for file_path in files:
new_zipfile.write(str(file_path),
arcname=os.path.basename(str(file_path)))
# Removes path from file name
return zipfile_path
return str(zipfile_path)
def create_blocklist(directory,
blocked_hosts=BLOCKLIST_HOSTS,
name='hosts',
line_format='one_per_line'):
"""Return a QUrl instance linking to a blocklist file.
def create_blocklist(directory, blocked_hosts=BLOCKLIST_HOSTS,
name='hosts', line_format='one_per_line'):
"""Return a path to a blocklist file.
Args:
- directory : path object where to create the blocklist file
@ -164,33 +143,30 @@ def create_blocklist(directory,
'one_per_line' --> one host per line format
'not_correct' --> Not a correct hosts file format.
"""
blocklist = QUrl(os.path.join(str(directory), name))
with open(blocklist.path(), 'w', encoding='UTF-8') as hosts:
blocklist_file = directory / name
with open(str(blocklist_file), 'w', encoding='UTF-8') as blocklist:
# ensure comments are ignored when processing blocklist
hosts.write('# Blocked Hosts List #\n\n')
blocklist.write('# Blocked Hosts List #\n\n')
if line_format == 'etc_hosts': # /etc/hosts like format
for path in blocked_hosts:
hosts.write('127.0.0.1 ' + path + '\n')
for host in blocked_hosts:
blocklist.write('127.0.0.1 ' + host + '\n')
elif line_format == 'one_per_line':
for path in blocked_hosts:
hosts.write(path + '\n')
for host in blocked_hosts:
blocklist.write(host + '\n')
elif line_format == 'not_correct':
for path in blocked_hosts:
hosts.write(path + ' This is not a correct hosts file\n')
return blocklist
for host in blocked_hosts:
blocklist.write(host + ' This is not a correct hosts file\n')
else:
raise ValueError('Uncorrect line_format argument')
return str(blocklist_file)
def assert_urls(host_blocker,
blocked=BLOCKLIST_HOSTS,
whitelisted_hosts=WHITELISTED_HOSTS,
urls_to_check=URLS_TO_CHECK):
"""Test if urls_to_check are effectively blocked or not by HostBlocker
def assert_urls(host_blocker, blocked=BLOCKLIST_HOSTS,
whitelisted=WHITELISTED_HOSTS, urls_to_check=URLS_TO_CHECK):
"""Test if Urls to check are blocked or not by HostBlocker
Ensure Urls in blocked and not in whitelisted are blocked
All other Urls are not to be blocked."""
whitelisted = list(whitelisted_hosts) + list(host_blocker.WHITELISTED)
All other Urls must not be blocked."""
whitelisted = list(whitelisted) + list(host_blocker.WHITELISTED)
for str_url in urls_to_check:
url = QUrl(str_url)
host = url.host()
@ -201,7 +177,6 @@ def assert_urls(host_blocker,
def generic_blocklists(directory):
"""Return a generic list of files to be used in hosts-block-lists option.
This list contains :
- a remote zip file with 1 hosts file and 2 useless files
@ -212,70 +187,50 @@ def generic_blocklists(directory):
- a remote text file without valid hosts format."""
# remote zip file with 1 hosts file and 2 useless files
file1 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='README',
line_format='not_correct')
file2 = create_blocklist(directory,
blocked_hosts=BLOCKLIST_HOSTS[:3],
name='hosts',
line_format='etc_hosts')
file3 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='false_positive',
line_format='one_per_line')
files_to_zip = [file1.path(), file2.path(), file3.path()]
zip_path = create_zipfile(directory, files_to_zip, 'block1')
blocklist1 = QUrl(zip_path)
file1 = create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='README', line_format='not_correct')
file2 = create_blocklist(directory, blocked_hosts=BLOCKLIST_HOSTS[:3],
name='hosts', line_format='etc_hosts')
file3 = create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='false_positive', line_format='one_per_line')
files_to_zip = [file1, file2, file3]
blocklist1 = QUrl(create_zipfile(directory, files_to_zip, 'block1'))
# remote zip file without file named hosts
# (Should raise a FileNotFoundError)
file1 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='md5sum',
line_format='etc_hosts')
file2 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='README',
line_format='not_correct')
file3 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='false_positive',
line_format='one_per_line')
files_to_zip = [file1.path(), file2.path(), file3.path()]
zip_path = create_zipfile(directory, files_to_zip, 'block2')
blocklist2 = QUrl(zip_path)
file1 = create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='md5sum', line_format='etc_hosts')
file2 = create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='README', line_format='not_correct')
file3 = create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='false_positive', line_format='one_per_line')
files_to_zip = [file1, file2, file3]
blocklist2 = QUrl(create_zipfile(directory, files_to_zip, 'block2'))
# remote zip file with only one valid hosts file inside
blocklist3 = create_blocklist(directory,
blocked_hosts=[BLOCKLIST_HOSTS[3]],
name='malwarelist',
line_format='etc_hosts')
zip_path = create_zipfile(directory, [blocklist3.path()], 'block3')
blocklist3 = QUrl(zip_path)
name='malwarelist', line_format='etc_hosts')
blocklist3 = QUrl(create_zipfile(directory, [blocklist3], 'block3'))
# local text file with valid hosts
blocklist4 = create_blocklist(directory,
blocked_hosts=[BLOCKLIST_HOSTS[4]],
name='mycustomblocklist',
line_format='one_per_line')
blocklist4 = QUrl(create_blocklist(directory,
blocked_hosts=[BLOCKLIST_HOSTS[4]],
name='mycustomblocklist',
line_format='one_per_line'))
blocklist4.setScheme('file')
# remote text file without valid hosts format
blocklist5 = create_blocklist(directory,
blocked_hosts=CLEAN_HOSTS,
name='notcorrectlist',
line_format='not_correct')
blocklist5 = QUrl(create_blocklist(directory, blocked_hosts=CLEAN_HOSTS,
name='notcorrectlist',
line_format='not_correct'))
return [blocklist1, blocklist2, blocklist3, blocklist4, blocklist5]
def test_without_datadir(config_stub, tmpdir, monkeypatch, win_registry):
"""No directory for data configured so no hosts file exists.
CommandError is raised by adblock_update
Ensure no url is blocked."""
Ensure CommandError is raised and no Url is blocked."""
config_stub.data = {'content':
{'host-block-lists': generic_blocklists(tmpdir),
'host-blocking-enabled': True}}
@ -290,9 +245,7 @@ def test_without_datadir(config_stub, tmpdir, monkeypatch, win_registry):
def test_disabled_blocking_update(basedir, config_stub, download_stub,
data_tmpdir, tmpdir, win_registry):
"""Ensure that no url is blocked when host blocking is disabled."""
"""Ensure no Url is blocked when host blocking is disabled."""
config_stub.data = {'content':
{'host-block-lists': generic_blocklists(tmpdir),
'host-blocking-enabled': False}}
@ -308,9 +261,7 @@ def test_disabled_blocking_update(basedir, config_stub, download_stub,
def test_no_blocklist_update(config_stub, download_stub,
data_tmpdir, basedir, tmpdir, win_registry):
"""Ensure no host is blocked when no blocklist exists."""
"""Ensure no Url is blocked when no block list exists."""
config_stub.data = {'content':
{'host-block-lists' : None,
'host-blocking-enabled': True}}
@ -323,10 +274,7 @@ def test_no_blocklist_update(config_stub, download_stub,
def test_successful_update(config_stub, basedir, download_stub,
data_tmpdir, tmpdir, win_registry):
"""Ensure hosts from host-block-lists are correctly
blocked after update."""
"""Ensure hosts from host-block-lists are blocked after an update."""
config_stub.data = {'content':
{'host-block-lists': generic_blocklists(tmpdir),
'host-blocking-enabled': True,
@ -334,24 +282,21 @@ def test_successful_update(config_stub, basedir, download_stub,
host_blocker = adblock.HostBlocker()
host_blocker.adblock_update(0)
# Simulate download is finished
# XXX Is it ok to use private list hostblocker._in_progress ?
while host_blocker._in_progress:
current_download = host_blocker._in_progress[0]
current_download.finished.emit()
host_blocker.read_hosts()
assert_urls(host_blocker, whitelisted_hosts=[])
assert_urls(host_blocker, whitelisted=[])
def test_failed_dl_update(config_stub, basedir, download_stub,
data_tmpdir, tmpdir, win_registry):
""" One blocklist fails to download
Ensure no hosts from this list is blocked."""
dl_fail_blocklist = create_blocklist(tmpdir,
blocked_hosts=CLEAN_HOSTS,
name='download_will_fail',
line_format='one_per_line')
""" One blocklist fails to download.
Ensure hosts from this list are not blocked."""
dl_fail_blocklist = QUrl(create_blocklist(tmpdir,
blocked_hosts=CLEAN_HOSTS,
name='download_will_fail',
line_format='one_per_line'))
hosts_to_block = generic_blocklists(tmpdir) + [dl_fail_blocklist]
config_stub.data = {'content':
{'host-block-lists': hosts_to_block,
@ -366,17 +311,15 @@ def test_failed_dl_update(config_stub, basedir, download_stub,
current_download.successful = False
current_download.finished.emit()
host_blocker.read_hosts()
assert_urls(host_blocker, whitelisted_hosts=[])
assert_urls(host_blocker, whitelisted=[])
def test_blocking_with_whitelist(config_stub, basedir, download_stub,
data_tmpdir, tmpdir):
"""Ensure hosts in host-blocking-whitelist are taken into account."""
# Simulate adblock_update has already been run by naming it blocked-hosts,
# exclude localhost from blocked-hosts file as it is in
# host_blocker.WHITELISTED
"""Ensure hosts in host-blocking-whitelist are never blocked."""
# Simulate adblock_update has already been run
# by creating a file named blocked-hosts,
# Exclude localhost from it, since localhost is in HostBlocker.WHITELISTED
filtered_blocked_hosts = BLOCKLIST_HOSTS[1:]
blocklist = create_blocklist(tmpdir,
blocked_hosts=filtered_blocked_hosts,
@ -406,24 +349,18 @@ def test_blocking_with_whitelist(config_stub, basedir, download_stub,
# host-block-lists is emptied with qutebrowser running
# on_config_changed slot is activated
# blocked_hosts is emptied
# read_hosts doesn't return any host as expected
# read_hosts doesn't return any host, as expected
def test_config_change(config_stub, basedir, download_stub,
data_tmpdir, tmpdir):
"""Ensure blocked_hosts gets a reset when host-block-list
is changed to None."""
# Simulate adblock_update has already been run by naming it blocked-hosts,
# exclude localhost from blocked-hosts file as it is in
# host_blocker.WHITELISTED
filtered_blocked_hosts = BLOCKLIST_HOSTS[1:]
"""Ensure blocked-hosts resets if host-block-list is changed to None."""
filtered_blocked_hosts = BLOCKLIST_HOSTS[1:] # Exclude localhost
blocklist = create_blocklist(tmpdir,
blocked_hosts=filtered_blocked_hosts,
name='blocked-hosts',
line_format='one_per_line')
config_stub.data = {'content':
{'host-block-lists': [blocklist],
{'host-block-lists': [],
'host-blocking-enabled': True,
'host-blocking-whitelist': None}}
host_blocker = adblock.HostBlocker()