diff --git a/.gitignore b/.gitignore index 5bcc641..6488992 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ *.py[co] __pycache__* +.cache # Packages *.egg @@ -7,6 +8,7 @@ __pycache__* dist build eggs +.eggs parts bin var @@ -32,14 +34,7 @@ docs/_build* .tox .cache -tests/* !tests/__init__.py !tests/config.py !tests/test_cloudy.py - -tests/data/* -!tests/data/hello.txt -!tests/data/hello.js - -tests/container_1/* -!tests/container_1/empty +!tests/testconf.py diff --git a/setup.cfg b/setup.cfg index 224a779..6afcf47 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,5 @@ [metadata] -description-file = README.md \ No newline at end of file +description-file = README.md + +[aliases] +test=pytest diff --git a/setup.py b/setup.py index 3f8f348..23cab22 100644 --- a/setup.py +++ b/setup.py @@ -63,6 +63,8 @@ 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 'Topic :: Software Development :: Libraries :: Python Modules' ], - zip_safe=False + zip_safe=False, + test_suite="tests", + setup_requires=['pytest-runner'], + tests_require=['pytest'] ) - diff --git a/tests/config.py b/tests/config.py index b2aed97..58ceab0 100644 --- a/tests/config.py +++ b/tests/config.py @@ -1,10 +1,18 @@ +"""Config for tests.""" +class RemoteConfig(object): + """Config for remote testing.""" + STORAGE_PROVIDER = "S3" + STORAGE_KEY = "" + STORAGE_SECRET = "" + STORAGE_CONTAINER = "yoredis.com" + STORAGE_ALLOWED_EXTENSIONS = [] -PROVIDER = "S3" -KEY = "" -SECRET = "" -CONTAINER = "yoredis.com" -# FOR LOCAL -PROVIDER = "LOCAL" -CONTAINER = "container_1" +class LocalConfig(object): + """Config for local testing.""" + STORAGE_KEY = "" + STORAGE_SECRET = "" + STORAGE_PROVIDER = "LOCAL" + STORAGE_CONTAINER = 'container_1' + STORAGE_ALLOWED_EXTENSIONS = [] diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..d8f4608 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,69 @@ +"""Defines fixtures available to all tests.""" + +import pytest +from tempfile import TemporaryDirectory, NamedTemporaryFile +import os +from flask import Flask +from flask_cloudy import Storage +from tests.config import LocalConfig +import random + + +@pytest.yield_fixture(scope='function') +def temp_dir(): + """A temporary directory for each test.""" + with TemporaryDirectory() as temp_dir: + yield temp_dir + +@pytest.yield_fixture(scope='function') +def temp_container(): + """A temporary container directory for each test.""" + with TemporaryDirectory() as temp_dir: + yield temp_dir + +@pytest.yield_fixture(scope='function') +def temp_txt_file(): + """A temporary txt file with random contents for each test.""" + with NamedTemporaryFile(mode="w+", suffix=".txt") as temp_file: + temp_file.write('%s' % random.random()) + temp_file.file.seek(0) + yield temp_file + + +@pytest.yield_fixture(scope='function') +def temp_png_file(): + """A temporary txt file with random contents for each test.""" + with NamedTemporaryFile(suffix=".png") as temp_file: + yield temp_file + + +@pytest.yield_fixture(scope='function') +def temp_js_file(): + """A temporary js file with random contents for each test.""" + with NamedTemporaryFile(mode="w+", suffix=".js") as temp_file: + temp_file.write('%s' % random.random()) + temp_file.file.seek(0) + yield temp_file + + +@pytest.yield_fixture(scope='function') +def app(temp_container): + """An application for the tests.""" + app = Flask(__name__) + LocalConfig.STORAGE_CONTAINER = temp_container + app.config.from_object(LocalConfig) + + ctx = app.test_request_context() + ctx.push() + + yield app + + ctx.pop() + + +@pytest.fixture(scope='function') +def storage(app): + """A flask-cloudy storage instance for tests.""" + storage = Storage(app=app) + storage.app = app + return storage diff --git a/tests/container_1/empty b/tests/container_1/empty deleted file mode 100644 index e69de29..0000000 diff --git a/tests/data/hello.js b/tests/data/hello.js deleted file mode 100644 index 575a91b..0000000 --- a/tests/data/hello.js +++ /dev/null @@ -1 +0,0 @@ -// This is the javascript file diff --git a/tests/data/hello.txt b/tests/data/hello.txt deleted file mode 100644 index e69de29..0000000 diff --git a/tests/test_cloudy.py b/tests/test_cloudy.py index c777d45..26460ff 100644 --- a/tests/test_cloudy.py +++ b/tests/test_cloudy.py @@ -1,183 +1,208 @@ import os +from os.path import join, dirname import pytest -from libcloud.storage.base import (StorageDriver, Container) -from flask_cloudy import (get_file_extension, - get_file_extension_type, - get_file_name, - get_driver_class, - get_provider_name, - Storage, - Object, - InvalidExtensionError) -from tests import config - -CWD = os.path.dirname(__file__) - -CONTAINER = "%s/%s" % (CWD, config.CONTAINER) if config.PROVIDER == "LOCAL" else config.CONTAINER - -class App(object): - config = dict( - STORAGE_PROVIDER=config.PROVIDER, - STORAGE_KEY=config.KEY, - STORAGE_SECRET=config.SECRET, - STORAGE_CONTAINER=CONTAINER, - STORAGE_ALLOWED_EXTENSIONS=[]) - - -def test_get_file_extension(): - filename = "hello.jpg" - assert get_file_extension(filename) == "jpg" - -def test_get_file_extension_type(): - filename = "hello.mp3" - assert get_file_extension_type(filename) == "AUDIO" - -def test_get_file_name(): - filename = "/dir1/dir2/dir3/hello.jpg" - assert get_file_name(filename) == "hello.jpg" - -def test_get_provider_name(): - class GoogleStorageDriver(object): - pass - driver = GoogleStorageDriver() - assert get_provider_name(driver) == "google_storage" - -#--- - -app = App() - -def app_storage(): - return Storage(app=App()) - -def test_get_driver_class(): - driver = get_driver_class("S3") - assert isinstance(driver, type) - -def test_driver(): - storage = app_storage() - assert isinstance(storage.driver, StorageDriver) - -def test_container(): - storage = app_storage() - assert isinstance(storage.container, Container) - -def test_flask_app(): - storage = app_storage() - assert isinstance(storage.driver, StorageDriver) - -def test_iter(): - storage = app_storage() - l = [o for o in storage] - assert isinstance(l, list) - -def test_storage_object_not_exists(): - object_name = "hello.png" - storage = app_storage() - assert object_name not in storage - -def test_storage_object(): - object_name = "hello.txt" - storage = app_storage() - o = storage.create(object_name) - assert isinstance(o, Object) - -def test_object_type_extension(): - object_name = "hello.jpg" - storage = app_storage() - o = storage.create(object_name) - assert o.type == "IMAGE" - assert o.extension == "jpg" - -def test_object_provider_name(): - object_name = "hello.jpg" - storage = app_storage() - o = storage.create(object_name) - assert o.provider_name == config.PROVIDER.lower() - -def test_object_object_path(): - object_name = "hello.jpg" - storage = app_storage() - o = storage.create(object_name) - p = "%s/%s" % (o.container.name, o.name) - assert o.path.endswith(p) - -def test_storage_upload_invalid(): - storage = app_storage() - object_name = "my-js/hello.js" - with pytest.raises(InvalidExtensionError): - storage.upload(CWD + "/data/hello.js", name=object_name) - -def test_storage_upload_ovewrite(): - storage = app_storage() - object_name = "my-txt-hello.txt" - o = storage.upload(CWD + "/data/hello.txt", name=object_name, overwrite=True) - assert isinstance(o, Object) - assert o.name == object_name - -def test_storage_get(): - storage = app_storage() - object_name = "my-txt-helloIII.txt" - o = storage.upload(CWD + "/data/hello.txt", name=object_name, overwrite=True) - o2 = storage.get(o.name) - assert isinstance(o2, Object) - -def test_storage_get_none(): - storage = app_storage() - o2 = storage.get("idonexist") - assert o2 is None - -def test_storage_upload(): - storage = app_storage() - object_name = "my-txt-hello2.txt" - storage.upload(CWD + "/data/hello.txt", name=object_name) - o = storage.upload(CWD + "/data/hello.txt", name=object_name) - assert isinstance(o, Object) - assert o.name != object_name - -def test_storage_upload_use_filename_name(): - storage = app_storage() - object_name = "hello.js" - o = storage.upload(CWD + "/data/hello.js", overwrite=True, allowed_extensions=["js"]) - assert o.name == object_name - -def test_storage_upload_append_extension(): - storage = app_storage() - object_name = "my-txt-hello-hello" - o = storage.upload(CWD + "/data/hello.txt", object_name, overwrite=True) - assert get_file_extension(o.name) == "txt" - -def test_storage_upload_with_prefix(): - storage = app_storage() - object_name = "my-txt-hello-hello" - prefix = "dir1/dir2/dir3/" - full_name = "%s%s.%s" % (prefix, object_name, "txt") - o = storage.upload(CWD + "/data/hello.txt", name=object_name, prefix=prefix, overwrite=True) - assert full_name in storage - assert o.name == full_name - - -def test_save_to(): - storage = app_storage() - object_name = "my-txt-hello-to-save.txt" - o = storage.upload(CWD + "/data/hello.txt", name=object_name) - file = o.save_to(CWD + "/data", overwrite=True) - file2 = o.save_to(CWD + "/data", name="my_new_file", overwrite=True) - assert os.path.isfile(file) - assert file2 == CWD + "/data/my_new_file.txt" - -def test_werkzeug_upload(): - try: - import werkzeug - except ImportError: - return - storage = app_storage() - object_name = "my-txt-hello.txt" - filepath = CWD + "/data/hello.txt" - file = None - with open(filepath, 'rb') as fp: - file = werkzeug.datastructures.FileStorage(fp) +from tests.config import LocalConfig as config +from flask_cloudy import (InvalidExtensionError, Object, get_driver_class, + get_file_extension, get_file_extension_type, + get_file_name, get_provider_name) +from libcloud.storage.base import Container, StorageDriver + +CWD = dirname(__file__) + +CONTAINER = "%s/%s" % ( + CWD, config.STORAGE_CONTAINER +) if config.STORAGE_PROVIDER == "LOCAL" else config.STORAGE_CONTAINER + + +class TestUtilities: + """Test flask_cloudy utilities.""" + + def test_get_file_extension(self): + filename = "hello.jpg" + assert get_file_extension(filename) == "jpg" + + def test_get_file_extension_type(self): + filename = "hello.mp3" + assert get_file_extension_type(filename) == "AUDIO" + + def test_get_file_name(self): + filename = "/dir1/dir2/dir3/hello.jpg" + assert get_file_name(filename) == "hello.jpg" + + def test_get_provider_name(self): + class GoogleStorageDriver(object): + pass + + driver = GoogleStorageDriver() + assert get_provider_name(driver) == "google_storage" + + def test_get_driver_class(self): + driver = get_driver_class("S3") + assert isinstance(driver, type) + + +class TestLocalStorage: + """Test local storage.""" + + def test_driver(self, storage): + assert isinstance(storage.driver, StorageDriver) + + def test_container(self, storage): + assert isinstance(storage.container, Container) + + def test_flask_app(self, storage): + assert isinstance(storage.driver, StorageDriver) + + def test_iter(self, storage): + l = [o for o in storage] + assert isinstance(l, list) + + def test_storage_object_not_exists(self, storage): + object_name = "hello.png" + assert object_name not in storage + + def test_storage_object(self, storage): + object_name = "hello.txt" + o = storage.create(object_name) + assert isinstance(o, Object) + + def test_empty_storage_object_evaluates_false(self, storage): + """Check that storage object eval false if they are empty.""" + object_name = "hello.txt" + o = storage.create(object_name) + if o: + raise ValueError("Object evaluated to false") + + def test_storage_object_evaluates_true(self, storage, temp_txt_file): + """Check that storage object eval true if they are not empty.""" + o = storage.upload(temp_txt_file.name) + o1 = storage.get(o.name) + if not o: + raise ValueError("Storage upload object evaluated to false") + if not o1: + raise ValueError("Storage get object evaluated to false") + + def test_object_type_extension(self, storage): + object_name = "hello.jpg" + o = storage.create(object_name) + assert o.type == "IMAGE" + assert o.extension == "jpg" + + def test_object_provider_name(self, storage): + object_name = "hello.jpg" + o = storage.create(object_name) + assert o.provider_name == config.STORAGE_PROVIDER.lower() + + def test_object_object_path(self, storage): + object_name = "hello.jpg" + o = storage.create(object_name) + p = "%s/%s" % (o.container.name, o.name) + assert o.path.endswith(p) + + def test_storage_upload_invalid(self, storage, temp_js_file): + """Check .js extensions are not allowed by default.""" + object_name = "my-js/hello.js" + with pytest.raises(InvalidExtensionError): + storage.upload(temp_js_file.name, name=object_name) + + def test_storage_upload_overwrite(self, storage, temp_txt_file, + temp_js_file): + object_name = "hello.txt" + o = storage.upload(temp_js_file.name, + name=object_name, + overwrite=True, + allowed_extensions=["js"]) + o_ow = storage.upload(temp_txt_file.name, + name=object_name, + overwrite=True) + assert isinstance(o_ow, Object) + assert o_ow.name == o.name + assert o_ow.name == object_name + + def test_storage_upload_no_overwrite(self, storage, temp_txt_file, + temp_js_file): + object_name = "hello.txt" + o = storage.upload(temp_js_file.name, + overwrite=True, + allowed_extensions=["js"]) + o_no_ow = storage.upload(temp_txt_file.name, + name=object_name, + overwrite=False) + assert isinstance(o_no_ow, Object) + assert o.name != o_no_ow.name + + def test_storage_get(self, storage, temp_txt_file): + object_name = "test_storage_get.txt" + o = storage.upload(temp_txt_file.name, + name=object_name, + overwrite=True) + o2 = storage.get(o.name) + assert isinstance(o2, Object) + + def test_storage_get_none(self, storage): + o2 = storage.get("idonexist") + assert o2 is None + + def test_storage_upload(self, storage, temp_txt_file): + object_name = "test_storage_upload.txt" + storage.upload(temp_txt_file.name, name=object_name) + o = storage.upload(temp_txt_file.name, name=object_name) + assert isinstance(o, Object) + assert o.name != object_name + + def test_storage_upload_use_filename_name(self, storage, temp_js_file): + """Check that uploaded files retain thier name.""" + object_name = os.path.basename(temp_js_file.name) + o = storage.upload(temp_js_file.name, + overwrite=True, + allowed_extensions=["js"]) + assert o.name == object_name + + def test_storage_upload_append_extension(self, storage, temp_txt_file): + """Check that uploaded names get an appended extension.""" + object_name = "test_storage_upload_append_extension" + o = storage.upload(temp_txt_file.name, object_name, overwrite=True) + assert get_file_extension(o.name) == "txt" + + def test_storage_upload_with_prefix(self, storage, temp_txt_file): + object_name = os.path.splitext(os.path.basename(temp_txt_file.name))[0] + prefix = "dir1/dir2/dir3/" + full_name = "%s%s.%s" % (prefix, object_name, "txt") + o = storage.upload(temp_txt_file.name, + name=object_name, + prefix=prefix, + overwrite=True) + assert full_name in storage + assert o.name == full_name + + def test_save_to(self, storage, temp_dir, temp_txt_file): + object_name = "test_save_to.txt" + o = storage.upload(temp_txt_file.name, name=object_name) + file = o.save_to(temp_dir, overwrite=True) + file2 = o.save_to( + temp_dir, + name="my_new_file", + overwrite=True) + assert os.path.isfile(file) + assert file2 == join(temp_dir, "my_new_file.txt") + + def test_local_server(self, storage, temp_txt_file): + """Test the local server function.""" + object_name = "test_local_server.txt" + storage.upload(temp_txt_file.name, name=object_name, overwrite=True) + file_server = storage.app.view_functions['FLASK_CLOUDY_SERVER'] + response = file_server(object_name) + assert response.status_code == 200 + + @pytest.mark.timeout(30) + def test_werkzeug_upload(self, storage, temp_png_file): + try: + import werkzeug + except ImportError: + return + object_name = "test-werkzeug-upload.txt" + file = werkzeug.datastructures.FileStorage(temp_png_file) file.filename = object_name o = storage.upload(file, overwrite=True) assert isinstance(o, Object) assert o.name == object_name -