Add tests for HostBlocker class

tests/unit/browser/test_adblock.py

@@ -22,12 +22,57 @@
 
 import os
 import zipfile
+import shutil
 
 import pytest
 
+from PyQt5.QtCore import pyqtSignal, QUrl, QObject
+
 from qutebrowser.browser import adblock
 from qutebrowser.config import configexc
+from qutebrowser.utils import objreg
 
+UNDESIRED_HOSTS = ['badsite.org','verybadsite.com','worstsiteever.net']
+
+class FakeDownloadItem(QObject):
+    """Mock browser.downloads.DownloadItem."""
+
+    finished = pyqtSignal()
+
+    def __init__(self, fileobj):
+        super().__init__()
+        self.fileobj = fileobj
+        self.successful = True
+
+
+class FakeDownloadManager:
+    """Mock browser.downloads.DownloadManager."""
+
+    def get(self, url, fileobj, **kwargs):
+        """Returns a FakeDownloadItem instance with a fileobj
+           copied from given fake url file."""
+        download_item = FakeDownloadItem(fileobj)
+        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
+    objreg.delete('download-manager', scope='window', window='last-focused')
+
+@pytest.fixture
+def data_tmpdir(monkeypatch, tmpdir):
+    """Use tmpdir as datadir"""
+    monkeypatch.setattr('qutebrowser.utils.standarddir.data',
+                        lambda: str(tmpdir))
 
 def create_text_files(files_names, directory):
     """Returns a list of text files created
@@ -37,11 +82,10 @@ def create_text_files(files_names, directory):
     for file_name in files_names:
         test_file = os.path.join(directory, file_name)
         with open(test_file, 'w', encoding='utf-8') as current_file:
-            current_file.write('inside ' + file_name)
+            current_file.write('www.' + file_name + '.com')
         created_files.append(test_file)
     return created_files
 
-
 def create_zipfile(files_names, directory):
     """Returns a zipfile populated with created files and its name."""
     directory = str(directory)
@@ -85,12 +129,12 @@ class TestGetFileObj:
         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"
+        assert adblock.get_fileobj(zipobj).read() == "www.hosts.com"
 
     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"
+        assert adblock.get_fileobj(test_file).read() == "www.testfile.com"
 
 
 class TestIsWhitelistedHost:
@@ -115,5 +159,58 @@ class TestIsWhitelistedHost:
 
 
 class TestHostBlocker:
-    """Test for class HostBlocker."""
-    pass
+    """Tests for class HostBlocker."""
+
+    def test_without_datadir(self, config_stub, monkeypatch):
+        """No directory for data configured, no hosts file present."""
+        monkeypatch.setattr('qutebrowser.utils.standarddir.data',
+                            lambda: None)
+        host_blocker = adblock.HostBlocker()
+        assert host_blocker._hosts_file == None
+
+    def test_with_datadir(self, config_stub, data_tmpdir, tmpdir):
+        #TODO Remove since now useless as already tested by test_update
+        host_blocker = adblock.HostBlocker()
+        hosts_file_path = os.path.join(str(tmpdir), 'blocked-hosts')
+        assert host_blocker._hosts_file == hosts_file_path
+
+    def test_update_with_fake_url(self, config_stub, download_stub,
+                                  data_tmpdir, tmpdir, win_registry):
+        """Test update, checked Url host is in the new blocklist added by update
+           Remote Url is faked by a local file."""
+        # Create blocklist and add it to config
+        blocklist = QUrl(os.path.join(str(tmpdir), 'new_hosts.txt'))
+        with open(blocklist.path(), 'w', encoding='UTF-8') as hosts:
+            for path in UNDESIRED_HOSTS:
+                hosts.write(path + '\n')
+        config_stub.data = {'content':
+                            {'host-block-lists': [blocklist],
+                             'host-blocking-enabled': True,
+                             'host-blocking-whitelist': None}}
+        host_blocker = adblock.HostBlocker()
+        host_blocker.adblock_update(0)
+        #Simulate download is finished
+        host_blocker._in_progress[0].finished.emit()
+        url_to_check = QUrl("www.ugly.verybadsite.com")
+        url_to_check.setHost("verybadsite.com")
+        assert host_blocker.is_blocked(url_to_check)
+
+    def test_update_with_local_file(self, config_stub, download_stub,
+                                    data_tmpdir, tmpdir, win_registry):
+        """Test update, checked Url host is in the new blocklist added by update
+           Url is a local file."""
+        # Create blocklist and add it to config
+        local_blocklist = QUrl(os.path.join(str(tmpdir), 'new_hosts.txt'))
+        local_blocklist.setScheme("file")
+        with open(local_blocklist.path(), 'w', encoding='UTF-8') as hosts:
+            for path in UNDESIRED_HOSTS:
+                hosts.write(path + '\n')
+        config_stub.data = {'content':
+                            {'host-block-lists': [local_blocklist],
+                             'host-blocking-enabled': True,
+                             'host-blocking-whitelist': None}}
+        host_blocker = adblock.HostBlocker()
+        host_blocker.adblock_update(0)
+        url_to_check = QUrl("www.ugly.verybadsite.com")
+        url_to_check.setHost("verybadsite.com")
+        assert host_blocker.is_blocked(url_to_check)