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

Add some docstrings

Browse Source
This commit is contained in:
Corentin Jule 2015-12-04 21:57:34 +01:00
commit 3426dd06f6
1 changed files with 23 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,7 +18,7 @@
# You should have received a copy of the GNU General Public License
# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
"""Tests for qutebrowser.browser.adblock"""
"""Tests for qutebrowser.browser.adblock."""
import os
import zipfile
@ -29,60 +29,49 @@ from qutebrowser.browser import adblock
from qutebrowser.config import config
from qutebrowser.utils import objreg
# TODO Should I use it ? And how ?
# @pytest.yield_fixture
# def default_config():
# """Fixture that provides and registers an empty default config object."""
# config_obj = config.ConfigManager(configdir=None,
# fname=None,
# relaxed=True)
# objreg.register('config', config_obj)
# yield config_obj
# objreg.delete('config')
def create_text_files(files_names, directory):
"""Returns a list of text files created
with given names in given directory"""
with given names in given directory."""
directory = str(directory)
created_files = []
for file_name in files_names:
test_file = os.path.join(directory, file_name)
with open(test_file, 'w', encoding='utf-8') as f:
f.write('inside ' + file_name)
with open(test_file, 'w', encoding='utf-8') as current_file:
current_file.write('inside ' + file_name)
created_files.append(test_file)
return created_files
def create_zipfile(files_names, directory):
"""Returns a zipfile populated with created files and its name"""
"""Returns a zipfile populated with created files and its name."""
directory = str(directory)
files = create_text_files(files_names, directory)
# include created files in a ZipFile
zipfile_name = os.path.join(directory, 'test.zip')
with zipfile.ZipFile(zipfile_name, 'w') as zf:
with zipfile.ZipFile(zipfile_name, 'w') as new_zipfile:
for file_name in files:
zf.write(file_name, arcname=os.path.basename(file_name))
new_zipfile.write(file_name, arcname=os.path.basename(file_name))
# Removes path from file name
return zf, zipfile_name
return new_zipfile, zipfile_name
class TestGuessZipFilename:
""" Test function adblock.guess_zip_filename() """
"""Test function adblock.guess_zip_filename()."""
def test_with_single_file(self, tmpdir):
"""Zip provided only contains a single file"""
"""Zip provided only contains a single file."""
zf = create_zipfile(['test_a'], tmpdir)[0]
assert adblock.guess_zip_filename(zf) == 'test_a'
def test_with_multiple_files(self, tmpdir):
"""Zip provided contains multiple files including hosts"""
"""Zip provided contains multiple files including hosts."""
names = ['test_a', 'test_b', 'hosts', 'test_c']
zf = create_zipfile(names, tmpdir)[0]
assert adblock.guess_zip_filename(zf) == 'hosts'
def test_without_hosts_file(self, tmpdir):
"""Zip provided does not contain any hosts file"""
"""Zip provided does not contain any hosts file."""
names = ['test_a', 'test_b', 'test_d', 'test_c']
zf = create_zipfile(names, tmpdir)[0]
with pytest.raises(FileNotFoundError):
@ -90,21 +79,23 @@ class TestGuessZipFilename:
class TestGetFileObj:
"""Test Function adblock.get_fileobj()"""
"""Test Function adblock.get_fileobj()."""
def test_with_zipfile(self, tmpdir):
"""File provided is a zipfile."""
names = ['test_a', 'test_b', 'hosts', 'test_c']
zf_name = create_zipfile(names, tmpdir)[1]
zipobj = open(zf_name, 'rb')
assert adblock.get_fileobj(zipobj).read() == "inside hosts"
def test_with_text_file(self, tmpdir):
"""File provided is not a zipfile."""
test_file = open(create_text_files(['testfile'], tmpdir)[0], 'rb')
assert adblock.get_fileobj(test_file).read() == "inside testfile"
class TestIsWhitelistedHost:
"""Test function adblock.is_whitelisted_host"""
"""Test function adblock.is_whitelisted_host."""
# FIXME Error since we deleted host-blocking-whitelist
# If we don't remove host-block-whitelist, test behaves as in a mismatch
@ -118,6 +109,7 @@ class TestIsWhitelistedHost:
# objreg.delete('config')
def test_with_match(self):
"""Given host is in the whitelist."""
config_obj = config.ConfigManager(configdir=None, fname=None,
relaxed=True)
config_obj.set_command(0, section_='content',
@ -128,6 +120,7 @@ class TestIsWhitelistedHost:
objreg.delete('config')
def test_without_match(self):
"""Given host is not in the whitelist."""
config_obj = config.ConfigManager(configdir=None, fname=None,
relaxed=True)
config_obj.set_command(0, section_='content',
@ -139,5 +132,6 @@ class TestIsWhitelistedHost:
class TestHostBlocker:
"""Test for class HostBlocker."""
# TODO
pass