Merge lp:~johnf-inodes/autoppa/version_template into lp:autoppa

[John Ferlito]

[John Ferlito (johnf-inodes)]

Version templates

[John Ferlito (johnf-inodes)]

Not 100% happy with the template variables but I couldn't come up with anything better.

[John Ferlito (johnf-inodes)]

Not 100% happy with the template variables but I couldn't come up with anything better.

[John Ferlito (johnf-inodes)]

Not 100% happy with the template variables but I couldn't come up with anything better.

review: Abstain

[Jamu Kakar (jkakar)]

[1]

+ file = open(filename, "r")
+ try:
+ expected = "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~ppa1)'"
+ self.assertEquals(file.read(), expected)
+ finally:
+ file.close()
+ self.builder.version_template = original_version_template

The try/finally isn't really necessary here. If it leaks, the file
will be closed when it gets garbage collected. Also, the final line
isn't necessary since self.builder is created afresh for each test
case.

[2]

+ def _get_version(self, release_name):
+
+ version = self.version_template
+ version = re.sub("\${version}", self.version, version)
+ version = re.sub("\${release_number}", self._get_release_number(release_name), version)
+ version = re.sub("\${release_name}", release_name, version)
+
+ return version

The standard library provides builtin string template interpolation
functionality that will simplify this a bit:

    def _get_version(self, release_name):
        version_template = Template(self.version_template)
        release_number = self._get_release_number(release_name, self.version)
        data = {"version": self.version, "release_name": release_name,
                "release_number": release_number}
        return version_template.substitute(data)

You'll need to add the following import:

from string import Template

[3]

What do you think about expanding the version variables to include
everything in this list:

version 'version' in the diff
revision The revision of the source branch
dist_codename 'release_name' in the diff
dist_version 'release_number' in the diff
now The current time in UTC formatted as YYYYMMDDHHMMSS
today Today's date formatted as YYYYMMDD
user The name from the USER environment variable

Is there anything else that should be included?

[4]

+version_template = ${version}~ppa1~${codename}

+${version} - The version passed on the command line
+${release_number} - 6.04, 6.10, etc
+${release_name} - dapper, gutsy, etc

'codename' should be 'release_name' above, in the README.

[5]

It'd be cool to add a help topic describing the functionality. If
you look at autoppa.help_topics you'll see an example of a topic.
If you implement a class following the same pattern called
topic_version_templates it will be included in the list of topics
you see when you run 'bin/autoppa help topics' and can be viewed by
running 'bin/autoppa help version-templates'.

[6]

+ build_target = self._configuration[build_target]
+ if "version_template" not in build_target:
+ build_target["version_template"] = DEFAULT_VERSION_TEMPLATE
+ return build_target

I think this logic is a bit dangerous, because it will end up
injecting data into user configuration that wasn't actually provided
by the user. I recommend you revert this change and deal with the
default version template in autoppa.application. I would move the
definition of DEFAULT_VERSION_TEMPLATE there, too.

+ version_template = version_template or data["version_template"]

Then the above line in AutoPPA._create_build...

review: Needs Fixing

[John Ferlito (johnf-inodes)]

On Thu, Oct 22, 2009 at 07:03:12PM -0000, Jamu Kakar wrote:
> Review: Needs Fixing
> [1]
>
> + file = open(filename, "r")
> + try:
> + expected = "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~ppa1)'"
> + self.assertEquals(file.read(), expected)
> + finally:
> + file.close()
> + self.builder.version_template = original_version_template
>
> The try/finally isn't really necessary here. If it leaks, the file
> will be closed when it gets garbage collected. Also, the final line
> isn't necessary since self.builder is created afresh for each test
> case.

OK. I'll fix that up. I pretty much copied this test case from the
one above which does something similar.

> [2]
>
> + def _get_version(self, release_name):
> +
> + version = self.version_template
> + version = re.sub("\${version}", self.version, version)
> + version = re.sub("\${release_number}", self._get_release_number(release_name), version)
> + version = re.sub("\${release_name}", release_name, version)
> +
> + return version
>
> The standard library provides builtin string template interpolation
> functionality that will simplify this a bit:
>
> def _get_version(self, release_name):
> version_template = Template(self.version_template)
> release_number = self._get_release_number(release_name, self.version)
> data = {"version": self.version, "release_name": release_name,
> "release_number": release_number}
> return version_template.substitute(data)
>
> You'll need to add the following import:
>
> from string import Template

Ahh that is very cool. Much more elegant. Thanks!

> [3]
>
> What do you think about expanding the version variables to include
> everything in this list:
>
> version 'version' in the diff
> revision The revision of the source branch
> dist_codename 'release_name' in the diff
> dist_version 'release_number' in the diff
> now The current time in UTC formatted as YYYYMMDDHHMMSS
> today Today's date formatted as YYYYMMDD
> user The name from the USER environment variable
>
> Is there anything else that should be included?

Can't think of anything else right now.
There are a couple of TODOs and FIXMEs regarding this change.

Testing ${revision} is painful since FakeExpect doesn't deal with
grabbing output. I'll implement it after I redo the bzrlib stuff since
then we shouldn't need expect any more.

Also I'm not sure how to stub/mock time and date so that we can test
$today so I left it out for now.

> [4]
>
> +version_template = ${version}~ppa1~${codename}
>
> +${version} - The version passed on the command line
> +${release_number} - 6.04, 6.10, etc
> +${release_name} - dapper, gutsy, etc
>
> 'codename' should be 'release_name' above, in the README.

Done.

> [5]
>
> It'd be cool to add a help topic describing the functionality. If
> you look at autoppa.help_topics you'll see an example of a topic.
> If you implement a class following the same pattern called
> topic_version_templates it will be included in the list of topics
> you see when you r...

[lp:~johnf-inodes/autoppa/version_template]

31. By John Ferlito on 2009-10-23

Use string template

32. By John Ferlito on 2009-10-23

Move default version template

33. By John Ferlito on 2009-10-23

Add extra substitutions to version_template

34. By John Ferlito on 2009-10-26

Add a help topic for version templates

[John Ferlito (johnf-inodes)]

OK. All those changes have been pushed

[lp:~johnf-inodes/autoppa/version_template]

35. By John Ferlito on 2009-10-26

merge in trunk

[Jamu Kakar (jkakar)]

[9]

+ def _get_revno(self):
+ # FIXME Can't use this until we move to using bzrlib
+ # directly as it causes to much hassle with FakeExpect
+ revno = self.expect.run("bzr revno %s" % self.working_tree,
+ logfile=file,
+ timeout=None)
+ print revno
+ return revno

I would remove this. We can add it when its necessary. Thanks for
adding the TODO about it in _get_version.

[10]

+ "now": time.strftime("%Y%m%d%H%M%S"),
+ "today": datetime.date.today().strftime("%Y%m%d"),

These should be changed to:

        now = datetime.utcnow()
...
            "now": now.strftime("%Y%m%d%H%M%S"),
            "today": now.strftime("%Y%m%d"),

[11]

I have a test failure:

[FAIL]: autoppa.tests.test_target.BuildTargetTest.test_prepare_custom_files_with_custom_version_content

Traceback (most recent call last):
  File "/usr/lib/python2.6/unittest.py", line 279, in run
    testMethod()
  File "/home/jkakar/src/johnf-inodes/autoppa/version-template/autoppa/tests/test_target.py", line 280, in test_prepare_custom_files_with_custom_version_content
    self.assertEquals(file.read(), expected)
exceptions.AssertionError: "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~6.06~20091027~user_from_env)'" != "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~6.06~20091024~user_from_env)'"

Looking great, +1 considering these comments. Have you had a chance
to sign the Canonical contributor agreement yet?

review: Approve

[John Ferlito (johnf-inodes)]

On Wed, Oct 28, 2009 at 04:36:59AM -0000, Jamu Kakar wrote:
> Review: Approve
> [9]
>
> + def _get_revno(self):
> + # FIXME Can't use this until we move to using bzrlib
> + # directly as it causes to much hassle with FakeExpect
> + revno = self.expect.run("bzr revno %s" % self.working_tree,
> + logfile=file,
> + timeout=None)
> + print revno
> + return revno
>
> I would remove this. We can add it when its necessary. Thanks for
> adding the TODO about it in _get_version.

Done.

>
>
> [10]
>
> + "now": time.strftime("%Y%m%d%H%M%S"),
> + "today": datetime.date.today().strftime("%Y%m%d"),
>
> These should be changed to:
>
> now = datetime.utcnow()
> ...
> "now": now.strftime("%Y%m%d%H%M%S"),
> "today": now.strftime("%Y%m%d"),
>
>
> [11]

Done, with changes in next comment.

> I have a test failure:
>
> [FAIL]: autoppa.tests.test_target.BuildTargetTest.test_prepare_custom_files_with_custom_version_content
>
> Traceback (most recent call last):
> File "/usr/lib/python2.6/unittest.py", line 279, in run
> testMethod()
> File "/home/jkakar/src/johnf-inodes/autoppa/version-template/autoppa/tests/test_target.py", line 280, in test_prepare_custom_files_with_custom_version_content
> self.assertEquals(file.read(), expected)
> exceptions.AssertionError: "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~6.06~20091027~user_from_env)'" != "version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~6.06~20091024~user_from_env)'"

Fixed. It was because it was a different day. I noticed you had some
datetime_factory code in there. I've moved that up into the
BuildTarget itself so that all date related code has access to it.

> Looking great, +1 considering these comments. Have you had a chance
> to sign the Canonical contributor agreement yet?

Yes, you should have been CC'd on the email.

[lp:~johnf-inodes/autoppa/version_template]

36. By John Ferlito on 2009-10-28

* Remove unused _get_revision code
* Use UTC time for ${now} and ${today}
* Add a datetime_factory to BuildTarget so we can test date stuff properly.

=== modified file 'README'
--- README	2009-09-21 03:13:54 +0000
+++ README	2009-10-28 06:25:19 +0000
@@ -105,7 +105,7 @@
 
 AutoPPA automatically inserts a release version into package version
 numbers.  The conventions specified by Ubuntu's SRU [1] policy
-should be followed when generating version numbers.  In the above
+are followed by default when generating version numbers.  In the above
 example, the smart-0.51-landscape12 would build packages with the
 following versions:
 
@@ -114,6 +114,30 @@
 0.51-landscape12.7.04
 0.51-landscape12.7.10
 
+A version_template configuration can be set in the autoppa configuration file
+or on the command line using the --version-template flag. For example:
+
+[landscape-client]
+version_template = ${version}~ppa1~${dist_codename}
+
+would produce:
+
+0.51-landscape12~ppa1~dapper
+0.51-landscape12~ppa1~edgy
+0.51-landscape12~ppa1~feisty
+0.51-landscape12~ppa1~gutsy
+
+The following environment variables are available:
+
+${version}        - The version passed on the command line
+${revision}       - The revision of the source branch
+${dist_codename}  - dapper, gutsy, etc
+${dist_version}   - 6.04, 6.10, etc
+${now}            - The current time in UTC formatted as YYYYMMDDHHMMSS
+${today}          - Today's date formatted as YYYYMMDD
+${user}           - The name from the USER environment variable
+
+
 [1] https://wiki.ubuntu.com/MOTU/SRU
 
 
 
=== modified file 'autoppa/application.py'
--- autoppa/application.py	2009-09-21 01:35:24 +0000
+++ autoppa/application.py	2009-10-28 06:25:19 +0000
@@ -23,6 +23,9 @@
 from autoppa.errors import BuildTargetError
 from autoppa.target import BuildTarget
 
+from autoppa import configuration
+
+DEFAULT_VERSION_TEMPLATE = "${version}.${dist_version}"
 
 class AutoPPA(object):
 
@@ -36,7 +39,7 @@
             self.log_file.write("%s\n" % (message,))
 
     def build(self, build_target, version, no_upload=None, no_merge=None,
-              no_tag=None, no_cleanup=None):
+              no_tag=None, no_cleanup=None, version_template=None):
         """Process sources for C{built_target} using the current settings.
 
         @param build_target: The target to build.  This should correspond to
@@ -44,7 +47,7 @@
         @param version: The version to for the new build.
         """
         self._log_info("AutoPPA %s" % (VERSION,))
-        build_target = self._create_build_target(build_target, version)
+        build_target = self._create_build_target(build_target, version, version_template)
         build_target.prepare_changelog()
         build_target.prepare_working_tree()
         for release in build_target.releases:
@@ -66,17 +69,20 @@
         """Switch files to use a version and Ubuntu code name."""
         build_target = BuildTarget("unused-name", version, "unused@email",
                                    "unused-branch", "unused-repository",
-                                   "unused-ppa", [code_name])
+                                   "unused-ppa", [code_name],
+                                   DEFAULT_VERSION_TEMPLATE)
         build_target.working_tree = path
         build_target._prepare_custom_autoppa_files(code_name)
         build_target._prepare_custom_autoppa_version(code_name)
 
-    def _create_build_target(self, build_target, version, expect=pexpect):
+    def _create_build_target(self, build_target, version, version_template,
+                             expect=pexpect):
         """Create a L{BuildTarget} instance for C{build_target}.
 
         @param build_target: The target to build.  This should correspond to
             the name of the Debian source package being built.
         @param version: The version to for the new build.
+        @param version_template: The template to use to create the version.
         @param expect: Optionally, a L{pexpect} like object.  Defaults to
             L{pexpect}.
         @raises BuildTargetError: Raised when a build target is specified that
@@ -88,10 +94,15 @@
         if not data:
             raise BuildTargetError("'%s' is not a known build target."
                                    % build_target)
+        if version_template is None:
+            version_template = data.get("version_template",
+                                        DEFAULT_VERSION_TEMPLATE)
+
         builder = BuildTarget(build_target, version, data["email"],
                               data["branch"], data["repository"],
                               data["ppa"], data["releases"].split(),
-                              expect=expect, log_file=self.log_file)
+                              version_template, expect=expect,
+                              log_file=self.log_file)
         if "options" in data:
             options = set(data["options"].split())
             if "no-version-replacement" in options:
 
=== modified file 'autoppa/commands.py'
--- autoppa/commands.py	2009-09-21 01:20:28 +0000
+++ autoppa/commands.py	2009-10-28 06:25:19 +0000
@@ -46,10 +46,13 @@
         Option("no-cleanup",
                help="Don't automatically cleanup signed sources and the "
                     "release branch created during a build."),
+        Option("version-template", type=str,
+               help="The version template to use when creating the version "
+                    "for each PPA."),
         ]
 
     def run(self, build_target, version, config=None, log=None, no_upload=None,
-            no_merge=None, no_tag=None, no_cleanup=None):
+            no_merge=None, no_tag=None, no_cleanup=None, version_template=None):
         """Run command."""
         if not config:
             config = os.path.join(os.environ["HOME"], ".autoppa.conf")
@@ -57,7 +60,8 @@
         log_file = get_log_file(log, self.outf)
         autoppa = AutoPPA(configuration, log_file)
         autoppa.build(build_target, version, no_upload=no_upload,
-                      no_merge=no_merge, no_tag=no_tag, no_cleanup=no_cleanup)
+                      no_merge=no_merge, no_tag=no_tag, no_cleanup=no_cleanup,
+                      version_template=version_template)
 
 
 class cmd_switch(Command):
 
=== modified file 'autoppa/configuration.py'
--- autoppa/configuration.py	2009-10-21 22:40:23 +0000
+++ autoppa/configuration.py	2009-10-28 06:25:19 +0000
@@ -21,7 +21,6 @@
 
 from autoppa.lib.configobj import ConfigObj
 
-
 class Configuration(object):
     """Get configuration details for named build targets.
 
@@ -63,6 +62,7 @@
       repository = /home/jkakar/src/canonical/landscape-client
       ppa = landscape-client-ppa
       releases = dapper edgy feisty gutsy
+      version_template = ~${release_name}
 
       [smart]
       email = Jamshed Kakar <[e-mail]>
@@ -71,7 +71,7 @@
       ppa = landscape-client-ppa
       releases = dapper edgy feisty gutsy
     """
-
+    
     def __init__(self, configuration):
         self._configuration = configuration
 
@@ -93,7 +93,8 @@
     def get_build_target(self, build_target):
         """Get a C{dict}-like object with data related to C{build_target}."""
         try:
-            return self._configuration[build_target]
+            build_target = self._configuration[build_target]
+            return build_target
         except KeyError:
             pass
         return None
 
=== modified file 'autoppa/help_topics.py'
--- autoppa/help_topics.py	2009-09-21 03:13:54 +0000
+++ autoppa/help_topics.py	2009-10-28 06:25:19 +0000
@@ -59,3 +59,46 @@
 
       options = no-version-replacement
     """
+
+class topic_version_template(DocstringHelpTopic):
+    """Information about version templating functionality.
+
+    AutoPPA automatically inserts a release version into package version
+    numbers.  The conventions specified by Ubuntu's SRU [1] policy
+    are followed by default when generating version numbers.  For example
+    if you built a package which had a version of 0.51-landscape12, then you
+    would get the following versions for each release:
+
+      0.51-landscape12.6.06
+      0.51-landscape12.6.10
+      0.51-landscape12.7.04
+      0.51-landscape12.7.10
+
+    A version_template configuration can be set in the autoppa configuration
+    file or on the command line using the --version-template flag. For example
+    you could add the following to the configuration file for the
+    landscape-client package:
+
+      [landscape-client]
+      version_template = ${version}~ppa1~${dist_codename}
+
+    This would produce versions like:
+
+      0.51-landscape12~ppa1~dapper
+      0.51-landscape12~ppa1~edgy
+      0.51-landscape12~ppa1~feisty
+      0.51-landscape12~ppa1~gutsy
+
+    The following environment variables are available:
+
+      ${version}       - The version passed on the command line
+      ${revision}      - The revision of the source branch
+      ${dist_codename} - dapper, gutsy, etc
+      ${dist_version}  - 6.04, 6.10, etc
+      ${now}           - The current time in UTC formatted as YYYYMMDDHHMMSS
+      ${today}         - Today's date formatted as YYYYMMDD
+      ${user}          - The name from the USER environment variable
+
+
+    [1] https://wiki.ubuntu.com/MOTU/SRU
+    """
 
=== modified file 'autoppa/target.py'
--- autoppa/target.py	2009-10-22 18:06:19 +0000
+++ autoppa/target.py	2009-10-28 06:25:19 +0000
@@ -18,10 +18,12 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from datetime import datetime
+import time
 import tempfile
 import os
 
 import pexpect
+from string import Template
 
 from autoppa.errors import ChangelogError, EditorError
 from autoppa.file import ReleaseSpecificInclude, VersionReplacement
@@ -41,7 +43,8 @@
     """
 
     def __init__(self, name, version, email, branch, repository, ppa, releases,
-                 expect=pexpect, system=os.system, log_file=None):
+                 version_template, expect=pexpect, system=os.system,
+                 datetime_factory=None, log_file=None):
         """
         @param name: The package name.  Note that multiple .deb files may be
             produced for this package.
@@ -56,10 +59,14 @@
         @param ppa: The name of the PPA to use, as defined in C{~/.dput.cf}.
         @param releases: A list of Ubuntu releases, such as
             C{['hardy', 'karmic']}.
+        @param version_template: A template for adding PPA sepecific version.
         @param expect: Optionally, a L{pexpect}-like object.  Defaults to
             L{pexpect}.
         @param system: Optionally, an L{os.system}-like function.  Defaults to
             L{os.system}.
+        @param datetime_factory: Optionally, an object that yields a datetime
+            instance to use as the changelog time.  Defaults to
+            C{datetime.utcnow}.
         @param log_file: Optionally, a stream to write log output to.
         """
         self.name = name
@@ -69,11 +76,13 @@
         self.repository = repository
         self.ppa = ppa
         self.releases = releases
+        self.version_template = version_template
         self.working_tree = None
         self.changelog = None
         self.log_file = log_file
         self.expect = expect
         self.system = system
+        self.datetime_factory = datetime_factory or datetime.utcnow()
         self.version_replacement = True
         self._prepared_files = set()
 
@@ -166,7 +175,7 @@
     def _get_working_tree(self):
         return "%s_%s" % (self.name, self.version)
 
-    def prepare_custom_files(self, release, datetime_factory=None):
+    def prepare_custom_files(self, release):
         """Prepare the release-specific files for the new release.
 
         Packages often require release-specific content for files such as the
@@ -187,17 +196,14 @@
         C{debian/changelog}.  A new changelog file is created if necessary.
 
         @param release: The name of the release to prepare package files for.
-        @param datetime_factory: Optionally, an object that yields a datetime
-            instance to use as the changelog time.  Defaults to
             C{datetime.utcnow}.
         """
         self._log_info("== Preparing custom files for %s on %s =="
                        % (self.name, release))
-        datetime_factory = datetime_factory or datetime.utcnow
         self._prepare_custom_autoppa_files(release)
         if self.version_replacement:
             self._prepare_custom_autoppa_version(release)
-        self._prepare_custom_changelog(release, datetime_factory)
+        self._prepare_custom_changelog(release)
 
     def _prepare_custom_autoppa_files(self, release):
         include = ReleaseSpecificInclude(release)
@@ -245,12 +251,23 @@
                    "lucid": "10.04"}
         return numbers[release_name]
 
-    def _get_version(self, release):
-        parts = self.version.split("-", 1)
-        return "%s-%s.%s" % (parts[0], parts[1],
-                             self._get_release_number(release))
-
-    def _prepare_custom_changelog(self, release, datetime_factory):
+    def _get_version(self, release_name):
+        version_template = Template(self.version_template)
+        # TODO Implement revision when we move to bzrlib
+        # "revision": self._get_revno(),
+
+        data = {
+            "version": self.version,
+            "dist_codename": release_name,
+            "dist_version": self._get_release_number(release_name),
+            "now": self.datetime_factory.strftime("%Y%m%d%H%M%S"),
+            "today": self.datetime_factory.strftime("%Y%m%d"),
+            "user": os.environ["USER"]
+            }
+
+        return version_template.substitute(data)
+
+    def _prepare_custom_changelog(self, release):
         try:
             path = os.path.join(self.working_tree, "debian/changelog")
             file = open(path, "r")
@@ -262,7 +279,7 @@
             old_changelog = ""
 
         version = self._get_version(release)
-        date = datetime_factory().strftime("%a, %-d %b %Y %H:%M:%S +0000")
+        date = self.datetime_factory.strftime("%a, %-d %b %Y %H:%M:%S +0000")
         changelog = """\
 %(package)s (%(version)s) %(release)s; urgency=low
 
 
=== modified file 'autoppa/tests/test_configuration.py'
--- autoppa/tests/test_configuration.py	2009-10-21 22:40:23 +0000
+++ autoppa/tests/test_configuration.py	2009-10-28 06:25:19 +0000
@@ -57,6 +57,7 @@
 branch = /home/john/src/supertool/production
 repository = /home/john/src/supertool
 releases = dapper edgy gutsy feisty
+version-template = ~${release_name}~ppa
 """
         path = self.fs.make_path(content=content)
         configuration = Configuration.from_file(path)
@@ -65,6 +66,7 @@
         self.assertEquals(data["branch"], "/home/john/src/supertool/production")
         self.assertEquals(data["repository"], "/home/john/src/supertool")
         self.assertEquals(data["releases"], "dapper edgy gutsy feisty")
+        self.assertEquals(data["version-template"], "~${release_name}~ppa")
 
     def test_get_missing_build_target(self):
         """
 
=== modified file 'autoppa/tests/test_target.py'
--- autoppa/tests/test_target.py	2009-10-21 22:20:53 +0000
+++ autoppa/tests/test_target.py	2009-10-28 06:25:19 +0000
@@ -33,10 +33,12 @@
         self.expect = FakeExpect()
         self.fs = FilesystemPath()
         self.branch_path = self.fs.make_dir("production")
+        datetime_factory = datetime(2007, 8, 2, 13, 14, 15)
         self.builder = BuildTarget(
             "supertool", "1.3.11-upside1", "John Smith <[e-mail]>",
             self.branch_path, self.fs.dirname, "supertool-ppa",
-            ["dapper", "edgy", "feisty"], expect=self.expect,
+            ["dapper", "edgy", "feisty"], "${version}.${dist_version}",
+            expect=self.expect, datetime_factory=datetime_factory,
             system=self.expect.run)
 
     def tearDown(self):
@@ -254,6 +256,30 @@
         finally:
             file.close()
 
+    def test_prepare_custom_files_with_custom_version_content(self):
+        """
+        L{BuildTarget.prepare_custom_files} replaces the magic
+        C{AUTOPPA_VERSION()} symbol in lines found in processed files
+        with a custom version template.
+        """
+        filename = self.fs.make_path(content="version = 'AUTOPPA_VERSION()'",
+                                     path="debian/version")
+        original_user = os.environ.get("USER")
+        os.environ["USER"] = "user_from_env"
+        try:
+            self.builder.version_template = ("${version}~${dist_codename}~"
+                                            "${dist_version}~${now}~${today}~${user}")
+            self.builder.working_tree = self.fs.dirname
+            self.builder.prepare_custom_files("dapper")
+            file = open(filename, "r")
+
+            expected = ("version = 'AUTOPPA_VERSION(1.3.11-upside1~dapper~"
+                       "6.06~20070802131415~20070802~user_from_env)'")
+            self.assertEquals(file.read(), expected)
+            file.close()
+        finally:
+            os.environ["USER"] = original_user
+
     def test_prepare_custom_files_with_version_replacement_suppressed(self):
         """
         L{BuildTarget.prepare_custom_files} replaces the magic
@@ -298,8 +324,7 @@
         self.builder.changelog = "  * Supertool runs 3x faster than before!"
         self.builder.working_tree = self.fs.dirname
         self.assertFalse(os.path.exists(changelog_filename))
-        factory = lambda: datetime(2007, 8, 2, 13, 14, 15)
-        self.builder.prepare_custom_files("dapper", datetime_factory=factory)
+        self.builder.prepare_custom_files("dapper")
         file = open(changelog_filename, "r")
         try:
             changelog = file.read()
@@ -338,8 +363,7 @@
 
         self.builder.changelog = "  * Supertool runs 3x faster than before!"
         self.builder.working_tree = self.fs.dirname
-        factory = lambda: datetime(2007, 8, 2, 13, 14, 15)
-        self.builder.prepare_custom_files("dapper", datetime_factory=factory)
+        self.builder.prepare_custom_files("dapper")
         file = open(changelog_filename, "r")
         try:
             changelog = file.read()