[feat] Add '--dry-run' option.

src/zc/buildout/buildout.py

@@ -321,6 +321,7 @@ _buildout_default_options = _annotate_section({
     'log-level': 'INFO',
     'newest': 'true',
     'offline': 'false',
+    'dry-run': 'false',
     'parts-directory': 'parts',
     'prefer-final': 'true',
     'python': 'buildout',
@@ -501,6 +502,7 @@ class Buildout(DictMixin):
         self.newest = ((not self.offline) and
                        bool_option(buildout_section, 'newest')
                        )
+        self.dry_run = (buildout_section['dry-run'] == 'true')
 
         ##################################################################
         ## WARNING!!!
@@ -890,6 +892,8 @@ class Buildout(DictMixin):
             if part in installed_parts: # update
                 __doing__ = 'Updating %s.', part
                 self._logger.info(*__doing__)
+                if self.dry_run:
+                    continue
                 old_options = installed_part_options[part]
                 installed_files = old_options['__buildout_installed__']
 
@@ -920,6 +924,8 @@ class Buildout(DictMixin):
             else: # install
                 __doing__ = 'Installing %s.', part
                 self._logger.info(*__doing__)
+                if self.dry_run:
+                    continue
                 installed_files = self[part]._call(recipe.install)
                 if installed_files is None:
                     self._logger.warning(
@@ -947,6 +953,8 @@ class Buildout(DictMixin):
         # uninstall part
         __doing__ = 'Uninstalling %s.', part
         self._logger.info(*__doing__)
+        if self.dry_run:
+            return
 
         # run uninstall recipe
         recipe, entry = _recipe(installed_part_options[part])
@@ -1091,6 +1099,8 @@ class Buildout(DictMixin):
 
 
     def _save_installed_options(self):
+        if self.dry_run:
+            return
         installed_path = self['buildout']['installed']
         if not installed_path:
             return
@@ -2183,6 +2193,12 @@ Options:
 
     Print buildout version number and exit.
 
+  --dry-run
+
+    Dry-run mode.  With this setting, buildout will display what will
+    be uninstalled and what will be installed without doing anything
+    in reality.
+
 Assignments are of the form: section:option=value and are used to
 provide configuration options that override those given in the
 configuration file.  For example, to run the buildout in offline mode,
@@ -2302,13 +2318,16 @@ def main(args=None):
                         _error("No timeout value specified for option", orig_op)
                     except ValueError:
                         _error("Timeout value must be numeric", orig_op)
+
+            elif orig_op == '--dry-run':
+                    options.append(('buildout', 'dry-run', 'true'))
             elif op:
                 if orig_op == '--help':
                     _help()
                 elif orig_op == '--version':
                     _version()
                 else:
-                    _error("Invalid option", '-'+op[0])
+                    _error("Invalid option", orig_op)
         elif '=' in args[0]:
             option, value = args.pop(0).split('=', 1)
             option = option.split(':')

src/zc/buildout/tests/buildout.txt

@@ -337,6 +337,10 @@ we'll see that the directory gets removed and recreated::
     ... path = mydata
     ... """)
 
+    >>> print_(system(buildout+' --dry-run'), end='')
+    Develop: '/sample-buildout/recipes'
+    Uninstalling data-dir.
+    Installing data-dir.
     >>> print_(system(buildout), end='')
     Develop: '/sample-buildout/recipes'
     Uninstalling data-dir.
@@ -357,6 +361,10 @@ If any of the files or directories created by a recipe are removed,
 the part will be reinstalled::
 
     >>> rmdir(sample_buildout, 'mydata')
+    >>> print_(system(buildout+' --dry-run'), end='')
+    Develop: '/sample-buildout/recipes'
+    Uninstalling data-dir.
+    Installing data-dir.
     >>> print_(system(buildout), end='')
     Develop: '/sample-buildout/recipes'
     Uninstalling data-dir.
@@ -816,6 +824,8 @@ the origin of the value (file name or ``COMPUTED_VALUE``, ``DEFAULT_VALUE``,
         DEFAULT_VALUE
     directory= /sample-buildout
         COMPUTED_VALUE
+    dry-run= false
+        DEFAULT_VALUE
     eggs-directory= /sample-buildout/eggs
         DEFAULT_VALUE
     executable= ...
@@ -911,6 +921,11 @@ You get more information about the way values are computed::
        AS COMPUTED_VALUE
        SET VALUE = /sample-buildout
     <BLANKLINE>
+    dry-run= false
+    <BLANKLINE>
+       AS DEFAULT_VALUE
+       SET VALUE = false
+    <BLANKLINE>
     eggs-directory= /sample-buildout/eggs
     <BLANKLINE>
        AS DEFAULT_VALUE
@@ -2915,6 +2930,7 @@ database is shown::
     bin-directory = /sample-buildout/bin
     develop-eggs-directory = /sample-buildout/develop-eggs
     directory = /sample-buildout
+    dry-run = false
     eggs-directory = /sample-buildout/eggs
     executable = python
     extra-paths = ...