test: fix example package class

this class can be much simpler and more robust and doesn't require
checking in the example package files to git

.gitignore

@@ -5,9 +5,7 @@ __pycache__/
 *.pyc
 /build/
 /.pybuild/
-/test-data/example_1.0-1.debian.tar.xz
+/test-data/
-/test-data/example_1.0-1.dsc
-/test-data/example_1.0.orig.tar.gz
 /debian/python-ubuntutools/
 /debian/python3-ubuntutools/
 /debian/ubuntu-dev-tools/

debian/clean

@@ -1,2 +1 @@
 *.egg-info/
-test-data/example_*

debian/control

@@ -10,6 +10,7 @@ Build-Depends:
  dctrl-tools,
  debhelper-compat (= 12),
  devscripts (>= 2.11.0~),
+ dh-make,
  dh-python,
  distro-info (>= 0.2~),
  flake8,

debian/copyright

@@ -152,7 +152,6 @@ Files: doc/pull-debian-debdiff.1
        reverse-depends
        seeded-in-ubuntu
        sponsor-patch
-       test-data/*
        ubuntu-upload-permission
        ubuntutools/archive.py
        ubuntutools/builder.py
@@ -167,7 +166,7 @@ Copyright: 2009-2011, Benjamin Drung <bdrung@ubuntu.com>
            2010,      Evan Broder <evan@ebroder.net>
            2008,      Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com>
            2010-2011, Stefano Rivera <stefanor@ubuntu.com>
-           2017-2019, Dan Streetman <ddstreet@canonical.com>
+           2017-2021, Dan Streetman <ddstreet@canonical.com>
 License: ISC
  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above

debian/tests/control

@@ -5,6 +5,7 @@ Restrictions: allow-stderr
 
 Test-Command: nosetests3 -v ubuntutools
 Depends:
+ dh-make,
  python3-nose,
  python3-setuptools,
  @,

test-data/blank-example/content

@@ -1 +0,0 @@
-upstream

test-data/blank-example/debian/compat

@@ -1 +0,0 @@
-7

test-data/blank-example/debian/control

@@ -1,12 +0,0 @@
-Source: example
-Section: misc
-Priority: extra
-Maintainer: Ubuntu Developers <ubuntu-dev-team@lists.alioth.debian.org>
-Build-Depends: debhelper (>= 7.0.50~)
-Standards-Version: 3.9.1
-
-Package: example
-Architecture: all
-Depends: ${misc:Depends}, ${shlibs:Depends}
-Description: Example package for testing purposes
- An example package used by the test suite. Useless.

test-data/blank-example/debian/copyright

@@ -1,17 +0,0 @@
-Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=152
-Source: https://launchpad.net/ubuntu-dev-tools
-
-Files: *
-Copyright: 2010-2011, Stefano Rivera <stefanor@ubuntu.com>
-License: ISC
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
- .
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.

test-data/blank-example/debian/rules

@@ -1,4 +0,0 @@
-#!/usr/bin/make -f
-
-%:
-	dh $@

test-data/blank-example/debian/source/format

@@ -1 +0,0 @@
-3.0 (quilt)

test-data/blank-example/debian/source/local-options

@@ -1 +0,0 @@
-abort-on-upstream-changes

test-data/blank-example/debian/source/options

@@ -1 +0,0 @@
-compression=xz

ubuntutools/test/example_package.py

@@ -14,55 +14,69 @@
 # OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 # PERFORMANCE OF THIS SOFTWARE.
 
-import os.path
+import os
-import shutil
 import subprocess
+import tempfile
 
+from pathlib import Path
 from ubuntutools.version import Version
 
 
 class ExamplePackage(object):
-    def __init__(self, source='example', version='1.0-1'):
+    def __init__(self, source='example', version='1.0-1', destdir='test-data'):
         self.source = source
         self.version = Version(version)
-        self.srcdir = os.path.join('test-data', '%s-%s' % (source,
+        self.destdir = Path(destdir)
-                                   self.version.upstream_version))
-        if os.path.exists(self.srcdir):
-            shutil.rmtree(self.srcdir)
-        shutil.copytree('test-data/blank-example', self.srcdir)
 
-    def create_orig(self):
+        self.env = dict(os.environ)
-        "Create .orig.tar.gz"
+        self.env['DEBFULLNAME'] = 'Example'
-        orig = '%s_%s.orig.tar.gz' % (self.source,
+        self.env['DEBEMAIL'] = 'example@example.net'
-                                      self.version.upstream_version)
-        subprocess.check_call(
-            (
-                'tar',
-                '-czf', orig,
-                '--exclude', 'debian',
-                os.path.basename(self.srcdir),
-            ),
-            cwd='test-data'
-        )
 
-    def changelog_entry(self, version=None, create=False):
+    @property
-        "Add a changelog entry"
+    def orig(self):
-        cmd = ['dch', '--noconf', '--preserve', '--package', self.source]
+        return self.destdir / f'{self.source}_{self.version.upstream_version}.orig.tar.xz'
-        if create:
+
-            cmd.append('--create')
+    @property
-        cmd += ['--newversion', version or self.version.full_version]
+    def debian(self):
-        cmd.append('')
+        return self.destdir / f'{self.source}_{self.version}.debian.tar.xz'
-        env = dict(os.environ)
+
-        env['DEBFULLNAME'] = 'Example'
+    @property
-        env['DEBEMAIL'] = 'example@example.net'
+    def dsc(self):
-        subprocess.check_call(cmd, env=env, cwd=self.srcdir)
+        return self.destdir / f'{self.source}_{self.version}.dsc'
+
+    @property
+    def dirname(self):
+        return f'{self.source}-{self.version.upstream_version}'
+
+    @property
+    def content_filename(self):
+        return 'content'
+
+    @property
+    def content_text(self):
+        return 'my content'
 
     def create(self):
-        "Build source package"
+        with tempfile.TemporaryDirectory() as d:
-        self.changelog_entry(create=True)
+            self._create(Path(d))
-        (basename, dirname) = os.path.split(self.srcdir)
-        subprocess.check_call(('dpkg-source', '-b', dirname), cwd=basename)
 
-    def cleanup(self):
+    def _create(self, d):
-        "Remove srcdir"
+        pkgdir = d / self.dirname
-        shutil.rmtree(self.srcdir)
+        pkgdir.mkdir()
+        (pkgdir / self.content_filename).write_text(self.content_text)
+
+        # run dh_make to create orig tarball
+        subprocess.run('dh_make -sy --createorig'.split(),
+                       check=True, env=self.env, cwd=str(pkgdir),
+                       stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+
+        # run dpkg-source -b to create debian tar and dsc
+        subprocess.run(f'dpkg-source -b {self.dirname}'.split(),
+                       check=True, env=self.env, cwd=str(d),
+                       stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+
+        # move tarballs and dsc to destdir
+        self.destdir.mkdir(parents=True, exist_ok=True)
+        (d / self.orig.name).rename(self.orig)
+        (d / self.debian.name).rename(self.debian)
+        (d / self.dsc.name).rename(self.dsc)