Merge pull request #3 from althonos/master

Update webdavfs to new fs standards

Author: zopyx

.gitignore

@@ -0,0 +1,92 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# Codacy token
+.codacy.token

.travis.yml

@@ -1,6 +1,5 @@
 language: python
-dist: trusty
-sudo: required
+sudo: false
 
 cache: pip
 
@@ -14,12 +13,16 @@ python:
   - "3.5"
   - "3.6"
 
+before_install:
+  # Pull docker images early for a more responsive nosetests run
+  - echo zopyx/basex-86 zopyx/existdb-22 zopyx/existdb-30 | xargs -n1 docker pull
+
 install:
-  - make install
+  - pip install -U pip setuptools wheel
+  - pip install .
+
+script:
+  - python setup.py test
 
 after_success:
   - coveralls
-
-# command to run tests
-script:
-  - make test test-existdb-22 test-basex

Makefile

@@ -5,28 +5,15 @@ release:
 
 install:
 	virtualenv .
-	bin/pip install -U pip
-	bin/pip install -U setuptools
-	bin/python setup.py develop
+	bin/pip install -U pip setuptools
+	bin/pip install -e .
 
-test:
-	bin/pip install nose
-	/usr/bin/python -c "import os; os.system('docker rm -f existdb30')"
-	docker run -d -p 127.0.0.1:10080:8080 --name existdb30 zopyx/existdb-30
-	sleep 30
-	FS_WEBDAV_URL=http://admin:admin@localhost:10080/exist/webdav/db bin/nosetests -v webdavfs
+pull:
+	docker pull zopyx/basex-86
+	docker pull zopyx/existdb-22
+	docker pull zopyx/existdb-30
 
-test-existdb-22:
-	bin/pip install nose
-	/usr/bin/python -c "import os; os.system('docker rm -f existdb22')"
-	docker run -d -p 127.0.0.1:10082:8080 --name existdb22 zopyx/existdb-22
-	sleep 30
-	FS_WEBDAV_URL=http://admin:admin@localhost:10082/exist/webdav/db bin/nosetests -v webdavfs
-
-test-basex:
-	bin/pip install nose
-	/usr/bin/python -c "import os; os.system('docker rm -f basex')"
-	docker run -d -p 127.0.0.1:10081:8080 --name basex zopyx/basex-86
-	sleep 10
-	FS_WEBDAV_URL=http://admin:admin@localhost:10081/webdav/ bin/nosetests -v webdavfs
+test: pull
+	bin/pip install nose docker
+	bin/nosetests -v webdavfs
 

README.rst

@@ -15,15 +15,24 @@ Supported Python versions
 Usage
 -----
 
+Use the ``fs.open_fs`` method with the ``webdav://`` protocol:
+
+.. code:: python
+
+    >>> import fs
+    >>> handle = fs.open_fs('webdav://admin:[email protected]:22082/exist/webdav/db')
+
+or use the public constructor of the ``WebDAVFS`` class:
+
 .. code:: python
 
-    > from webdavfs.webdavfs import WebDAVFS
-    > url = 'http://zopyx.com:22082'
-    > creds = dict(login='admin', password='admin')
-    > root = '/exist/webdav/db'
-    > handle = WebDAVFS(url, cred, root)
-    > handle.makedir('foo')
-    > print(handle.listdir('.'))
+    >>> from webdavfs.webdavfs import WebDAVFS
+    >>> url = 'http://zopyx.com:22082'
+    >>> creds = dict(login='admin', password='admin')
+    >>> root = '/exist/webdav/db'
+    >>> handle = WebDAVFS(url, cred, root)
+    >>> handle.makedir('foo')
+    >>> print(handle.listdir('.'))
     ....
 
 Repository
@@ -47,6 +56,7 @@ Author and contributors
 - Yuriy Homyakov
 - Semyon Gaivoronskiy
 - Andreas Jung
+- `Martin Larralde <https://github.com/althonos>`_
 
 
 License

setup.cfg

@@ -0,0 +1,5 @@
+[alias]
+test = nosetests
+
+[nosetests]
+verbosity = 2

setup.py

@@ -24,25 +24,27 @@
     HISTORY = f.read()
 
 REQUIREMENTS = [
-    "fs>=2.0.0",
+    "fs~=2.0.7",
     "webdavclient2",
-    "furl"
 ]
 
 setup(
     author="Andreas Jung and others",
     author_email="[email protected]",
     classifiers=CLASSIFIERS,
     description="WebDAV support for pyfilesystem2",
+    entry_points={
+        'fs.opener': 'webdav = webdavfs.opener:WebDAVOpener'
+    },
     install_requires=REQUIREMENTS,
     license="BSD",
     long_description=DESCRIPTION + "\n" + HISTORY,
     name='fs.webdavfs',
     packages=find_packages(exclude=("tests",)),
     platforms=['any'],
-    test_suite="nose.collector",
+    setup_requires=['nose'],
+    tests_require=['docker'],
+    test_suite='webdavfs.tests',
     url="http://pypi.python.org/pypi/fs.webdavfs/",
     version="0.2.1"
 )
-
-

webdavfs/opener.py

@@ -0,0 +1,29 @@
+# coding: utf-8
+"""Defines the WebDAVFS opener."""
+
+from __future__ import absolute_import
+from __future__ import unicode_literals
+
+from fs.opener.base import Opener
+
+__author__ = "Martin Larralde <[email protected]>"
+
+class WebDAVOpener(Opener):
+    protocols = ['webdav']
+
+    def open_fs(self, fs_url, parse_result, writeable, create, cwd):
+        from .webdavfs import WebDAVFS
+        from fs.subfs import ClosingSubFS
+
+        webdav_host, _, dir_path = parse_result.resource.partition('/')
+        webdav_host, _, webdav_port = webdav_host.partition(':')
+        webdav_port = int(webdav_port) if webdav_port.isdigit() else 80
+
+        return WebDAVFS(
+            url='http://{}:{}'.format(webdav_host, webdav_port),
+            credentials={
+                'login': parse_result.username,
+                'password': parse_result.password
+            },
+            root=dir_path,
+        )

webdavfs/tests/base.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+from __future__ import absolute_import
+from __future__ import unicode_literals
+
+import uuid
+import fs
+
+
+#@attr('slow')
+class _TestWebDAVFS(object):
+    """Test WebDAVFS implementation."""
+
+    webdav_url = NotImplemented
+
+    def setUp(self):
+        self.test_root = '{}'.format(uuid.uuid4())
+        self.fs = self.make_fs()
+
+    def make_fs(self):
+        with fs.open_fs(self.webdav_url) as handle:
+            if handle.exists(self.test_root):
+                handle.rmdir(self.test_root, recursive=True)
+            handle.makedir(self.test_root)
+        return fs.open_fs('/'.join([self.webdav_url, self.test_root]))
+
+    def destroy_fs(self, fs):
+        for item in fs.client.list('/'):
+            fs.client.clean(item)
+        super(_TestWebDAVFS, self).destroy_fs(fs)
+
+    def test_directories_mkdir_removedir(self):
+        for i in range(5):
+            self.fs.makedir(u'{}'.format(i))
+        for i in range(5):
+            self.fs.removedir(u'{}'.format(i))

webdavfs/tests/test_docker.py

@@ -0,0 +1,60 @@
+# coding: utf-8
+from __future__ import unicode_literals
+from __future__ import absolute_import
+
+import re
+import time
+import unittest
+import fs.test
+import docker
+
+from .base import _TestWebDAVFS
+
+
+class _TestDocker(_TestWebDAVFS, fs.test.FSTestCases):
+    """Test WebDAVFS implementation using docker images."""
+
+    server_image = NotImplemented
+
+    @classmethod
+    def serverStarted(cls):
+        regex = re.compile(b'Server [hw]as started')
+        cls.webdav_container.update()
+        return regex.search(cls.webdav_container.logs()) is not None
+
+    @classmethod
+    def startServer(cls):
+        cls.webdav_container = cls.docker_client.containers.run(
+            cls.server_image, detach=True, tty=True,
+            ports={'8080/tcp': ('127.0.0.1', 10080)}
+        )
+        while not cls.serverStarted():
+            time.sleep(1)
+
+    @classmethod
+    def stopServer(cls):
+        cls.webdav_container.kill()
+        cls.webdav_container.remove()
+
+    @classmethod
+    def setUpClass(cls):
+        cls.docker_client = docker.from_env(version='auto')
+        cls.startServer()
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.stopServer()
+        time.sleep(20)
+
+
+class TestExistDB30(_TestDocker, unittest.TestCase):
+    server_image = 'zopyx/existdb-30'
+    webdav_url = 'webdav://admin:admin@localhost:10080/exist/webdav/db'
+
+class TestExistDB22(_TestDocker, unittest.TestCase):
+    server_image = 'zopyx/existdb-22'
+    webdav_url = 'webdav://admin:admin@localhost:10080/exist/webdav/db'
+
+class TestBaseX86(_TestDocker, unittest.TestCase):
+    server_image = 'zopyx/basex-86'
+    webdav_url = 'webdav://admin:admin@localhost:10080/webdav'

webdavfs/tests/test_server.py

@@ -0,0 +1,24 @@
+# coding: utf-8
+from __future__ import unicode_literals
+from __future__ import absolute_import
+
+import os
+import unittest
+import fs.test
+
+from .base import _TestWebDAVFS
+
+
+@unittest.skipUnless(
+        os.getenv('WEBDAVFS_USE_SERVERS', 'false').lower() == 'true',
+        'Set WEBDAVFS_USE_SERVERS to True to enable tests against real servers')
+class _TestServer(_TestWebDAVFS):
+    """Test WebDAVFS implementation using actual servers."""
+
+
+class TestServerFull(_TestServer, fs.test.FSTestCases, unittest.TestCase):
+    webdav_url = 'webdav://admin:[email protected]:20082/exist/webdav/db'
+
+
+class TestServerCommons(_TestServer, unittest.TestCase):
+    webdav_url = 'webdav://admin:[email protected]:22082/exist/webdav/db'