Merge lp:~nataliabidart/ubuntuone-control-panel/validate-in-sd into lp:ubuntuone-control-panel

[Natalia Bidart]

- Remove custom path validation and use the one provided by syncdaemon
  (LP: #824252).

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2012-03-29 14:31:49 +0000
+++ ubuntuone/controlpanel/backend.py	2012-03-29 21:44:21 +0000
@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B. Bidart <[e-mail]>
 #
-# Copyright 2010 Canonical Ltd.
+# Copyright 2010-2012 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -26,11 +23,7 @@
 from functools import wraps
 
 from twisted.internet.defer import inlineCallbacks, returnValue
-# No name 'is_link' in module 'ubuntuone.platform'
-# pylint: disable=E0611, F0401
-from ubuntuone.platform import is_link
 from ubuntuone.platform.credentials import CredentialsManagementTool
-# pylint: enable=E0611, F0401
 
 from ubuntuone.controlpanel import sd_client, replication_client
 from ubuntuone.controlpanel.logger import setup_logging, log_call
@@ -720,28 +713,9 @@
         yield self.sd_client.create_folder(path=folder_path)
 
     @log_call(logger.debug)
-    @inlineCallbacks
     def validate_path_for_folder(self, folder_path):
         """Validate 'folder_path' for folder creation."""
-        user_home = yield self.get_home_dir()
-        folder_path = append_path_sep(folder_path)
-
-        # handle folder_path not within '~' or links
-        # XXX is_link expects bytes, see bug #824252
-        if not folder_path.startswith(user_home) or is_link(
-            folder_path.encode('utf-8')):
-            returnValue(False)
-
-        # handle folder_path nested with a existing cloud folder
-        volumes = yield self.volumes_info(with_storage_info=False)
-        for _, _, data in volumes:
-            for volume in data:
-                cloud_folder = append_path_sep(volume['path'])
-                if (folder_path.startswith(cloud_folder) or
-                    cloud_folder.startswith(folder_path)):
-                    returnValue(False)
-
-        returnValue(True)
+        return self.sd_client.validate_path(folder_path)
 
     @log_call(logger.debug)
     @inlineCallbacks

=== modified file 'ubuntuone/controlpanel/sd_client/__init__.py'
--- ubuntuone/controlpanel/sd_client/__init__.py	2012-03-29 14:31:49 +0000
+++ ubuntuone/controlpanel/sd_client/__init__.py	2012-03-29 21:44:21 +0000
@@ -124,6 +124,10 @@
         """Retrieve the folders information from syncdaemon."""
         return self.proxy.get_folders()
 
+    def validate_path(self, path):
+        """Validates 'path' to create a new folder through syncdaemon."""
+        return self.proxy.validate_path(path)
+
     def create_folder(self, path):
         """Create a new folder through syncdaemon."""
         return self.proxy.create_folder(path)

=== modified file 'ubuntuone/controlpanel/tests/test_backend.py'
--- ubuntuone/controlpanel/tests/test_backend.py	2012-03-29 14:31:49 +0000
+++ ubuntuone/controlpanel/tests/test_backend.py	2012-03-29 21:44:21 +0000
@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B. Bidart <[e-mail]>
 #
-# Copyright 2010 Canonical Ltd.
+# Copyright 2010-2012 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -292,6 +289,10 @@
         """Unsubcribe from 'volume_id'."""
         self.subscribed_folders.remove(volume_id)
 
+    def validate_path(self, path):
+        """Validate a path for folder creation."""
+        return path != USER_HOME
+
     def create_folder(self, path):
         """Grab list of folders."""
         self.folders.append(path)
@@ -1144,24 +1145,8 @@
 
         self.assertEqual(self.be.sd_client.folders, [folder_path])
 
-
-class BackendValidatePathForFolderTestCase(BackendBasicTestCase):
-    """Test for the path validator when creating folders."""
-
-    msg = '%r must not be a valid path for creating a folder.'
-
-    @defer.inlineCallbacks
-    def setUp(self):
-        yield super(BackendValidatePathForFolderTestCase, self).setUp()
-        old_home = os.environ['HOME']
-        os.environ['HOME'] = USER_HOME
-        self.addCleanup(os.environ.__setitem__, 'HOME', old_home)
-        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
-        self.patch(backend, 'is_link', lambda p: False)
-
-    @defer.inlineCallbacks
-    def test_valid_if_folder_inside_home(self):
+    @defer.inlineCallbacks
+    def test_validate_path_for_folder(self):
         """Test proper validation of path for creating folders."""
         folder_path = os.path.join(USER_HOME, 'Test Me')
 
@@ -1170,68 +1155,11 @@
             '%r must be a valid path for creating a folder.' % folder_path)
 
     @defer.inlineCallbacks
-    def test_valid_if_folder_shares_a_prefix_with_an_udf(self):
-        """Test proper validation of path for creating folders.
-
-        If the user chooses a folder with the same prefix as an UDF, but
-        outside every UDF, the path is valid.
-
-        """
-        tricky_path = ROOT_PATH
-        assert not tricky_path.endswith(os.path.sep)
-        tricky_path += ' Suffix'
-        assert tricky_path.startswith(ROOT_PATH)
-
-        result = yield self.be.validate_path_for_folder(tricky_path)
-        self.assertTrue(result,
-            '%r must be a valid path for creating a folder.' % tricky_path)
-
-    @inlineCallbacks
-    def test_path_not_valid_if_outside_home(self):
-        """A folder outside ~ is not valid."""
-        outside_home = os.path.abspath(os.path.join(USER_HOME, os.path.pardir))
-
-        result = yield self.be.validate_path_for_folder(outside_home)
-        self.assertFalse(result, self.msg % outside_home)
-
-    @defer.inlineCallbacks
-    def test_not_valid_if_folder_inside_root(self):
-        """A folder inside the root is not valid."""
-        root_path = ROOT_PATH
-        # create a valid path inside the root
-        inside_root = os.path.abspath(os.path.join(root_path, 'test'))
-
-        result = yield self.be.validate_path_for_folder(inside_root)
-        self.assertFalse(result, self.msg % inside_root)
-
-    @defer.inlineCallbacks
-    def test_not_valid_if_folder_inside_an_udf(self):
-        """A folder inside an UDF is not valid."""
-        udf_path = SAMPLE_FOLDERS[-1]['path']
-        # create a valid path inside an existing UDF
-        inside_udf = os.path.abspath(os.path.join(udf_path, 'test'))
-
-        result = yield self.be.validate_path_for_folder(inside_udf)
-        self.assertFalse(result, self.msg % inside_udf)
-
-    @defer.inlineCallbacks
-    def test_not_valid_if_folder_is_parent_of_an_udf(self):
-        """A folder parent of an UDF is not valid."""
-        udf_path = SAMPLE_FOLDERS[-1]['path']
-        # create a valid path that is parent from an existing UDF
-        udf_parent = os.path.abspath(os.path.join(udf_path, os.path.pardir))
-
-        result = yield self.be.validate_path_for_folder(udf_parent)
-        self.assertFalse(result, self.msg % udf_parent)
-
-    @defer.inlineCallbacks
-    def test_not_valid_if_folder_is_link(self):
-        """A link path is not valid."""
-        self.patch(backend, 'is_link', lambda p: True)
-        path_link = os.path.join(USER_HOME, 'Test Me')
-
-        result = yield self.be.validate_path_for_folder(path_link)
-        self.assertFalse(result, self.msg % path_link)
+    def test_validate_path_for_folder_invalid(self):
+        """Test proper validation of path for creating folders."""
+        result = yield self.be.validate_path_for_folder(USER_HOME)
+        self.assertFalse(result,
+            '%r must not be a valid path for creating a folder.' % USER_HOME)
 
 
 class BackendSyncStatusTestCase(BackendBasicTestCase):

=== modified file 'ubuntuone/controlpanel/tests/test_sd_client.py'
--- ubuntuone/controlpanel/tests/test_sd_client.py	2012-03-29 18:28:15 +0000
+++ ubuntuone/controlpanel/tests/test_sd_client.py	2012-03-29 21:44:21 +0000
@@ -157,6 +157,10 @@
         """Get the list of the shares "shared"/created/offered."""
         self.called['list_shared'] = None
 
+    def validate_path(self, path):
+        """Validate a path for folder creation."""
+        return path not in [f['path'] for f in self.folders.itervalues()]
+
     def create_folder(self, path):
         """Create a user defined folder in the specified path."""
         if path == '':  # simulate an error
@@ -510,6 +514,19 @@
         yield self.assertFailure(self.sd.get_folders(), CustomError)
 
     @inlineCallbacks
+    def test_validate_path(self):
+        """Check if a folder path is valid."""
+        path = '~/bar/baz'
+        result = yield self.sd.validate_path(path)
+
+        self.assertTrue(result)
+
+        yield self.sd.create_folder(path)
+        result = yield self.sd.validate_path(path)
+
+        self.assertFalse(result)
+
+    @inlineCallbacks
     def test_create_folder(self):
         """Create a new folder."""
         path = '~/bar/baz'