Issue #6942 - Add XTM integration in CMS

tests/utils.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 import contextlib
 import os
 import signal
 import subprocess
 import time
+import zipfile
+from io import BytesIO
+import pytest

[Vasily Kuznetsov, 2018/09/26 15:45:27]

Nit: there should be an empty line before pytest, which is not stdlib.

[Tudor Avram, 2018/10/04 06:48:15]

Done.

 
 
 def get_dir_contents(path):
     # TODO: This function is duplicated in test_page_outputs.py.
     dirdata = {}
     for dirpath, dirnames, filenames in os.walk(path):
         for output_file in filenames:
             filepath = os.path.join(dirpath, output_file)
             with open(filepath) as f:
                 locale = os.path.split(os.path.split(filepath)[0])[1]
                 dirdata[os.path.join(locale, output_file)] = f.read().strip()
     return dirdata
 
 
 @contextlib.contextmanager
 def run_test_server(site_path):
     """Run test server, yield its URL. Terminate server on next iteration.
 
     This function is intended be used in a pytest fixture.
     """
     args = ['python', 'runserver.py', site_path]
     # Werkzeug is a dependency of flask which we are using for the mock api
     # however there is an issue with Werkzeug that prevents it from properly
     # handling the SIGTERM sent by p.kill() or terminate()
     # Issue: https://github.com/pallets/werkzeug/issues/58
     p = subprocess.Popen(args, stdout=subprocess.PIPE, preexec_fn=os.setsid)
     time.sleep(0.5)
     yield 'http://localhost:5000/'
     os.killpg(os.getpgid(p.pid), signal.SIGTERM)
+
+
+def create_in_memory_zip(file_names, file_data):
+    """Create a BytesIO object with the contents of a zip file.
+
+    Parameters
+    ----------
+    file_names: iterable
+        Of file names. Should be the full paths of the file inside the zip.
+    file_data: iterable
+        The data to be contained of the files.
+
+    Returns
+    -------
+    BytesIO
+        The resulting in-memory zip file.
+
+    """
+    memory_zip = BytesIO()
+
+    with zipfile.ZipFile(memory_zip, 'w') as zf:
+        for idx in range(len(file_names)):
+            zf.writestr(file_names[idx], file_data[idx], zipfile.ZIP_DEFLATED)
+
+    memory_zip.seek(0)
+    return memory_zip
+
+
+def exception_test(func, exception, exp_msg, *args, **kw):
+    with pytest.raises(exception) as err:
+        func(*args, **kw)
+
+    assert exp_msg in str(err.value)