Issue 4540 - Add Platform Specific Branch Support to createNightlies.py

sitescripts/extensions/test/conftest.py

+# This file is part of the Adblock Plus web scripts,
+# Copyright (C) 2006-2016 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/>.
+
+"""
+Contains fixtures that are useful across test scripts for the extensions module
+"""
+

[Jon Sonesen, 2016/10/24 17:32:32]

Broke these fixtures out of Vasily's test script as they will be useful as we
add coverage. I also think the use of the function scoped tmpdir fixture over
the session scoped tmpdir_factory fixture slows the tests way down. I have a
version which has a bit more code duplication but executes about 30% faster
which is not insignificant. However, maintainability is also a priority so let
me know what you think. I changed the fixtures that could be changed to session
scoped and it actually sped it back up by about a second.

[kzar, 2016/10/25 08:13:01]

Perhaps Vasily disagrees with me but I don't think this matters too much.
(Google for "Premature Optimization" there's been quite a lot written about it.
Something I'm often still guilty of as well to be honest!)

I do think adding a comment in the test code somewhere noting that the
alternative approach would be faster, with any other relevant details would be a
good idea though. That way in the future if you decide it _does_ matter that the
tests are a little slow you could come back and improve things.

[Jon Sonesen, 2016/10/25 09:15:18]

Acknowledged in main message. I  will add a comment.

+import subprocess
+
+import pytest
+import py
+
+REPOS = {
+    'adblockplus': ('metadata.gecko', '2.7.3'),
+    'adblockplusie': ('README.txt', '1.33.7'),
+    'adblockpluschrome': ('metadata.safari', '1.12.3'),
+    'adblockplusandroid': ('AndroidManifest.xml', '1.3'),
+    'adblockplusnightly': ('nightlies', '0.0')
+}
+
+
+@pytest.fixture(scope='session')
+def tests_dir():
+    """Directory that contains this tests and the data files it uses."""
+    return py.path.local(__file__).dirpath()
+
+
+@pytest.fixture(scope='session')
+def oracle(tests_dir):
+    """Function that returns expected content of generated files."""
+    def expected_value_of(what):
+        return tests_dir.join('oracle').join(what).read().strip()
+    return expected_value_of
+
+
+@pytest.fixture(scope='session')
+def data_dir(tests_dir):
+    return tests_dir.join('data')
+
+
+@pytest.fixture()
+def keys_dir(tmpdir, tests_dir):
+    keys_dir = tmpdir.mkdir('keys')
+    key_filename = 'adblockplussafari.pem'
+    tests_dir.join(key_filename).copy(keys_dir.join(key_filename))
+    return keys_dir
+
+
+def call_hg(cwd, *params):
+    return subprocess.check_call(['hg'] + list(params), cwd=str(cwd))
+
+
+@pytest.fixture()
+def hg_dir(tmpdir, data_dir):
+    """Directory that contains the repository mocks."""
+    hg_dir = tmpdir.mkdir('hg')
+
+    # Mock plugin repositories.
+    for repo, config in REPOS.items():
+        filename, tag = config
+        repo_dir = hg_dir.mkdir(repo)
+        call_hg(repo_dir, 'init')
+        data_dir.join(filename).copy(repo_dir.join(filename))
+        call_hg(repo_dir, 'add', filename)
+        call_hg(repo_dir, 'commit', '-m', '1')
+        call_hg(repo_dir, 'tag', tag)
+
+    call_hg(hg_dir.join('adblockplusnightly'), 'bookmark', 'foo')
+
+    # Mock the downloads repository.
+    downloads_list = data_dir.join('downloads.list').read().splitlines()
+    downloads_dir = hg_dir.mkdir('downloads')
+    call_hg(downloads_dir, 'init')
+    for item in downloads_list:
+        downloads_dir.join(item).write('')
+    call_hg(downloads_dir, 'add', *downloads_list)
+    call_hg(downloads_dir, 'commit', '-m', 'ok')
+
+    return hg_dir
+
+
+@pytest.fixture()
+def config_ini(tests_dir, tmpdir, hg_dir, keys_dir):
+    """Sitescripts configuration."""
+    template = tests_dir.join('sitescripts.ini.template').read()
+    conf = template.format(hg_dir=hg_dir, out_dir=tmpdir, keys_dir=keys_dir)
+    config_ini = tmpdir.join('sitescripts.ini')
+    config_ini.write(conf)
+    return config_ini