Fix bug with symlink creation

Previously, this was executing a command using a shell, but without properly
escaping the input. This instead passes a list in to Popen, to ensure escape is
working properly.

Author: agjohnson

readthedocs/core/symlink.py

@@ -198,7 +198,13 @@ def symlink_subprojects(self):
                 symlink_dir = os.sep.join(symlink.split(os.path.sep)[:-1])
                 if not os.path.lexists(symlink_dir):
                     safe_makedirs(symlink_dir)
-                run('ln -nsf %s %s' % (docs_dir, symlink))
+                # TODO this should use os.symlink, not a call to shell. For now,
+                # this passes command as a list to be explicit about escaping
+                # spaces.
+                status, _, stderr = run(['ln', '-nsf', docs_dir, symlink])
+                if status > 0:
+                    log.error('Could not symlink path: status=%d error=%s',
+                              status, stderr)
 
         # Remove old symlinks
         if os.path.exists(self.subproject_root):
@@ -251,8 +257,10 @@ def symlink_single_version(self):
         # Clean up symlinks
         symlink = self.project_root
         if os.path.islink(symlink):
+            self._log('Unlinking single version: {0}'.format(symlink))
             os.unlink(symlink)
         if os.path.exists(symlink):
+            self._log('Unlinking single version: {0}'.format(symlink))
             shutil.rmtree(symlink)
 
         # Create symlink

readthedocs/projects/utils.py

@@ -72,6 +72,8 @@ def run(*commands, **kwargs):
         if shell:
             log.info("Running commands in a shell")
             run_command = command
+        elif isinstance(command, list):
+            run_command = command
         else:
             run_command = command.split()
         log.info("Running: '%s' [%s]", command, cwd)

readthedocs/rtd_tests/tests/test_project_symlinks.py

@@ -322,6 +322,53 @@ def test_subproject_alias(self):
             filesystem['private_web_root'] = public_root
         self.assertFilesystem(filesystem)
 
+    def test_subproject_alias_with_spaces(self):
+        """Symlink pass adds symlink for subproject alias"""
+        self.project.add_subproject(self.subproject, alias='Sweet Alias')
+        self.symlink.symlink_subprojects()
+        filesystem = {
+            'private_cname_project': {},
+            'private_cname_root': {},
+            'private_web_root': {
+                'kong': {'en': {}},
+                'sub': {'en': {}},
+            },
+            'public_cname_project': {},
+            'public_cname_root': {},
+            'public_web_root': {
+                'kong': {
+                    'en': {'latest': {
+                        'type': 'link',
+                        'target': 'user_builds/kong/rtd-builds/latest',
+                    }},
+                    'projects': {
+                        'sub': {
+                            'type': 'link',
+                            'target': 'public_web_root/sub',
+                        },
+                        'Sweet Alias': {
+                            'type': 'link',
+                            'target': 'public_web_root/sub',
+                        },
+                    }
+                },
+                'sub': {
+                    'en': {'latest': {
+                        'type': 'link',
+                        'target': 'user_builds/sub/rtd-builds/latest',
+                    }}
+                }
+            }
+        }
+        if self.privacy == 'private':
+            public_root = filesystem['public_web_root'].copy()
+            private_root = filesystem['private_web_root'].copy()
+            public_root['kong']['projects']['sub']['target'] = 'private_web_root/sub'
+            public_root['kong']['projects']['Sweet Alias']['target'] = 'private_web_root/sub'
+            filesystem['public_web_root'] = private_root
+            filesystem['private_web_root'] = public_root
+        self.assertFilesystem(filesystem)
+
     def test_remove_subprojects(self):
         """Nonexistant subprojects are unlinked"""
         self.project.add_subproject(self.subproject)