Merge lp:~johnpaulett/djangorecipe/relative-paths into lp:~roland-micite/djangorecipe/dev

[John Paulett]

Thanks for creating djangorecipe--it has been very useful!

I have a need (related to packaging) to make use of buildout's relative-paths option, so that the manage and test file do not have absolute paths in them.

I made the appropriate changes and tested it in my project.

Please let me know if you see any issues. I would love to get this in the next release of djangorecipe.

[roland (roland-micite)]

Thank you for this patch.
Could you write unittests to go with it?

[lp:~johnpaulett/djangorecipe/relative-paths]

113. By John Paulett on 2011-06-26

Add tests for relative-paths support.

[John Paulett (johnpaulett)]

Definitely! Here is a first past with 2 additional tests:
http://bazaar.launchpad.net/~johnpaulett/djangorecipe/relative-paths/revision/113

This is my first time digging into buildout code, so the tests may not
be optimal. I wanted to assert that the sys.path entries are
modified, but I was having a hard time getting and buildout.develop or
buildout.eggs to show up (probably because I am not doing a full
recipe.install()). Therefore, I am merely testing for the definition
of the `base` variable that buildout will create when
relative-paths=True.

On Sun, Jun 26, 2011 at 8:31 AM, roland <email address hidden> wrote:
> Thank you for this patch.
> Could you write unittests to go with it?
>
>
> --
> https://code.launchpad.net/~johnpaulett/djangorecipe/relative-paths/+merge/65888
> You are the owner of lp:~johnpaulett/djangorecipe/relative-paths.
>

Unmerged revisions

113. By John Paulett on 2011-06-26

Add tests for relative-paths support.

112. By John Paulett on 2011-06-26

Add support for relative-paths (modeled on zc.recipe.egg).

relative-paths = True allows the buildout directory to be safely moved,
since the manage and test scripts have relative paths, not absolute paths.

=== modified file 'src/djangorecipe/recipe.py'
--- src/djangorecipe/recipe.py	2011-06-07 14:09:53 +0000
+++ src/djangorecipe/recipe.py	2011-06-26 15:55:54 +0000
@@ -45,6 +45,16 @@
         options.setdefault('wsgilog', '')
         options.setdefault('logfile', '')
 
+        # respect relative-paths (from zc.recipe.egg)
+        relative_paths = options.get(
+            'relative-paths', buildout['buildout'].get('relative-paths', 'false'))
+        if relative_paths == 'true':
+            options['buildout-directory'] = buildout['buildout']['directory']
+            self._relative_paths = options['buildout-directory']
+        else:
+            self._relative_paths = ''
+            assert relative_paths == 'false'
+
     def install(self):
         location = self.options['location']
         base_dir = self.buildout['buildout']['directory']
@@ -84,6 +94,7 @@
               'djangorecipe.manage', 'main')],
             ws, self.options['executable'], self.options['bin-directory'],
             extra_paths=extra_paths,
+            relative_paths=self._relative_paths,
             arguments="'%s.%s'" % (project,
                                    self.options['settings']))
 
@@ -97,6 +108,7 @@
                 working_set, self.options['executable'],
                 self.options['bin-directory'],
                 extra_paths=extra_paths,
+                relative_paths=self._relative_paths,
                 arguments="'%s.%s', %s" % (
                     self.options['project'],
                     self.options['settings'],
@@ -169,6 +181,7 @@
                         self.options['executable'],
                         self.options['bin-directory'],
                         extra_paths=extra_paths,
+                        relative_paths=self._relative_paths,
                         arguments="'%s.%s', logfile='%s'" % (
                             project, self.options['settings'],
                             self.options.get('logfile'))))
 
=== modified file 'src/djangorecipe/tests.py'
--- src/djangorecipe/tests.py	2011-06-07 14:09:53 +0000
+++ src/djangorecipe/tests.py	2011-06-26 15:55:54 +0000
@@ -451,6 +451,47 @@
                    'python': 'py5k', 'wsgi': 'true'}
         self.assertRaises(UserError, Recipe, *('buildout', 'test', options))
 
+    def test_relative_paths_default(self):
+        self.recipe.options['wsgi'] = 'true'
+
+        self.recipe.make_scripts([], [])
+        self.recipe.create_manage_script([], [])
+
+        manage = os.path.join(self.bin_dir, 'django')
+        wsgi_script = os.path.join(self.bin_dir, 'django.wsgi')
+
+        expected = base = 'base = os.path.dirname(os.path.abspath(os.path.realpath(__file__)))'
+        self.assertFalse(expected in open(manage).read())
+        self.assertFalse(expected in open(wsgi_script).read())
+
+    def test_relative_paths_true(self):
+        recipe = Recipe({
+                'buildout': {
+                    'eggs-directory': self.eggs_dir,
+                    'develop-eggs-directory': self.develop_eggs_dir,
+                    'python': 'python-version',
+                    'bin-directory': self.bin_dir,
+                    'parts-directory': self.parts_dir,
+                    'directory': self.buildout_dir,
+                    'find-links': '',
+                    'allow-hosts': '',
+                    'develop': '.',
+                    'relative-paths': 'true'
+                    },
+                'python-version': {'executable': sys.executable}},
+                             'django',
+                             {'recipe': 'djangorecipe',
+                              'wsgi': 'true'})
+        recipe.make_scripts([], [])
+        recipe.create_manage_script([], [])
+
+        manage = os.path.join(self.bin_dir, 'django')
+        wsgi_script = os.path.join(self.bin_dir, 'django.wsgi')
+
+        expected = base = 'base = os.path.dirname(os.path.abspath(os.path.realpath(__file__)))'
+        self.assertTrue(expected in open(manage).read())
+        self.assertTrue(expected in open(wsgi_script).read())
+
 
 class ScriptTestCase(unittest.TestCase):