Issue 4954 - Implement a downloader script supporting OAuth2 authentication/authorization

sitescripts/oauth2dl/test/test_oauth2dl.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/>.
 
+from __future__ import unicode_literals
+
 import subprocess

[Vasily Kuznetsov, 2018/07/20 21:00:01]

Same comment about ordering as in oauth2dl.py

[Tudor Avram, 2018/07/23 19:29:03]

Acknowledged.

[Tudor Avram, 2018/07/31 09:20:17]

Done.

 import pytest
 import json
+
 from wsgi_intercept.interceptor import Httplib2Interceptor
 
 import sitescripts.oauth2dl.bin.constants as cnts
-from sitescripts.oauth2dl.utils.dummy_wsgi_app import main as intercept_app
-from sitescripts.oauth2dl.bin.oauth2dl import download_file, write_to_file
+from sitescripts.oauth2dl.test.dummy_wsgi_app import main as intercept_app
+from sitescripts.oauth2dl.bin.oauth2dl import download_file
+
+
+def get_valid_keyfile():
+    return {
+        'private_key_id': 6,
+        'private_key': cnts.DUMMY_PRIVATE_KEY,
+        'client_email': 'firstpart@secondpart.com',
+        'client_id': '8',
+        'type': 'service_account',
+    }
 
 
 def get_intercept_app():
     """Return the intercepting WSGI application."""
     return intercept_app
 
 
 def write_to_json(data, path):
     """Write data to JSON."""
     with open(str(path), 'w') as f:
         json.dump(data, f)
 
 
 @pytest.fixture
 def rootdir(tmpdir):
     """Directory with prepared key and downloadable files."""
     rootdir = tmpdir.join('root')
     rootdir.mkdir()
 
     # Keyfile missing a key - private_key_id
     invalid_keyfile_path = rootdir.join('keyfile_missing_key.json')
-    data = {
-        'private_key': cnts.DUMMY_PRIVATE_KEY,
-        'client_email': 'firstpart@secondpart.com',
-        'client_id': '8',
-        'type': 'service_account',
-    }
+    data = get_valid_keyfile()
+    data.pop('private_key')
     write_to_json(data, str(invalid_keyfile_path))
 
     # Keyfile with invalid private key
     invalid_keyfile_path = rootdir.join('keyfile_invalid_private_key.json')
-    data = {
-        'private_key_id': 6,
-        'private_key': cnts.DUMMY_PRIVATE_KEY[:-10],
-        'client_email': 'firstpart@secondpart.com',
-        'client_id': '8',
-        'type': 'service_account',
-    }
+    data = get_valid_keyfile()
+    data['private_key'] = data['private_key'][:-10]
     write_to_json(data, str(invalid_keyfile_path))
 
     # Keyfile with wrong value for 'type'
     invalid_keyfile_path = rootdir.join('keyfile_invalid_type.json')
-    data = {
-        'private_key_id': 6,
-        'private_key': cnts.DUMMY_PRIVATE_KEY,
-        'client_email': 'firstpart@secondpart.com',
-        'client_id': '8',
-        'type': 'invalid',
-    }
+    data = get_valid_keyfile()
+    data['type'] = 'invalid'
     write_to_json(data, str(invalid_keyfile_path))
 
     # Valid (dummy) keyfile
     valid_keyfile_path = rootdir.join('good_keyfile.json')
-    data = {

[Vasily Kuznetsov, 2018/07/20 21:00:01]

There seems to be some repetition here, maybe we can extract a function for
writing a keyfile to make things a bit more compact and clear. What do you
think?

[Tudor Avram, 2018/07/31 09:20:17]

Done.

-        'private_key_id': 6,
-        'private_key': cnts.DUMMY_PRIVATE_KEY,
-        'client_email': 'firstpart@secondpart.com',
-        'client_id': '8',
-        'type': 'service_account',
-    }
-    write_to_json(data, str(valid_keyfile_path))
+    write_to_json(get_valid_keyfile(), str(valid_keyfile_path))
 
     # Downloadable file
     rootdir.join('file_to_download').write('Success!')
 
     # Downloadable file with utf-8 characters
-    rootdir.join('file_to_download_utf8').write('Ok! \u1234'.encode('utf-8'),
+    rootdir.join('file_to_download_utf8').write('Ok \u1234'.encode('utf-8'),
                                                 mode='wb')
 
     return rootdir
 
 
 @pytest.fixture
 def dstfile(tmpdir):
     """Destination file for saving the downloaded whitelist."""
     return tmpdir.join('dst')
 
@@ skipping 85 matching lines @@
     assert expected in data
 
 
 def test_download_wrong_url(rootdir):
     """Test authenticating and trying to download a file from an invalid url.
 
     Uses a local server that simulates the interaction with the google API.
     """
     keyfile_path = str(rootdir.join('good_keyfile.json'))
     url = 'https://www.googleapis.com/download?path={0}'.format(
-        str(rootdir.join('file_to_downlaaoad_utf8')))

[Vasily Kuznetsov, 2018/07/20 21:00:01]

..._donwlaaoad_... -- typo or on purpose? :)

[Tudor Avram, 2018/07/23 19:29:03]

It was on purpose. I wanted to test the behaviour in the case of a wrong path. 

I can change it to 'missing_file' or something like that, so it makes things a
little more clear.

[Tudor Avram, 2018/07/31 09:20:18]

Done.

+        str(rootdir.join('inexistent_file')))
     scope = 'www.googleapis.com'
 
     with Httplib2Interceptor(get_intercept_app, host='www.googleapis.com',
                              port=443):
         headers, data = download_file(url, keyfile_path, scope)
 
     assert 'NOT FOUND' in data.upper()
     assert headers['status'] == '404'
-
-
-def test_script_run_as_file():
-    """Test the script's handling of relative imports."""
-    command = 'python sitescripts/oauth2dl/bin/oauth2dl.py '
-    _, stderr, _ = run_script(cmd=command)
-
-    assert 'ValueError' not in stderr
-    assert 'ImportError' not in stderr
-
-
-@pytest.mark.parametrize('file, expected', [
-    ('file_to_download', 'Success!'),
-    ('file_to_download_utf8', '\u1234'),
-])
-def test_write_to_file(rootdir, dstfile, file, expected):
-    """Test if the script writes the data correctly."""
-    data = rootdir.join(file).read().encode('utf-8')
-    write_to_file(data, str(dstfile))
-
-    assert expected in dstfile.read(mode='rb').decode('utf-8')