Merge ppa-dev-tools:packaging-debian into ppa-dev-tools:main

[Bryce Harrington]

Implementation of the Debian packaging. This successfully produces an installable .deb for me, that sets up a functional /usr/bin/ppa and modules. Broader testing is appreciated of course, but in review I'm hoping for some detailed nitpicking of the packaging itself.

In particular one issue I'm scratching my head over is when running `debuild` I see lintian errors like these::

dpkg-buildpackage: info: full upload; Debian-native package (full source is included)
Now running lintian ppa-dev-tools_0.2.0~focal3_amd64.changes ...
E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/ root/0 != root/root (or 0/0)
E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/changelog.gz root/0 != root/root (or 0/0)
E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/copyright root/0 != root/root (or 0/0)
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ppa 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/ 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/__init__.py 0/1001
E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/_version.py 0/1001
...

I'm not sure what's causing the group to be set to 1001. The installation still works, and I don't think the group permission should affect anything, but it's definitely incorrect:

  triage-jammy+22.04:~/src/PpaDevTools$ ls -l /usr/bin/ppa
  -rwxr-xr-x 1 root 1001 18303 Sep 21 03:30 /usr/bin/ppa*

I'm going to continue debugging this and get it sorted before landing this branch, but if anyone has advice or knows what's going on it'd be appreciated.

Another question I've pondered is whether to keep the debian packaging on a separate branch and/or repo from the upstream tree, as we do with ordinary upstream packages. However, I'm leaning towards keeping it all in the same repo both for simplicity and to facilitate future release automation via the Makefile (ultimately I'd like to run one command to generate all the various packages).

Although this seems to package 0.2.0 adequately, my intent is to produce a 0.2.1 release that includes this branch as well as the snap branch, to pick up all the documentation and other misc. fixups.

[Christian Ehrhardt  (paelzer)]

Hey,
FYI building this in sbuild locally as I usually do does NOT show those ownership issues.

The only W I see is
 W: ppa-dev-tools: no-manual-page [usr/bin/ppa]

Which I think you could fix to be warning-free :-)

buildlog: https://paste.ubuntu.com/p/m5DG9mPVf7/

[Sergio Durigan Junior (sergiodj)]

On Tuesday, September 27 2022, Bryce Harrington wrote:

> In particular one issue I'm scratching my head over is when running `debuild` I see lintian errors like these::
>
> dpkg-buildpackage: info: full upload; Debian-native package (full source is included)
> Now running lintian ppa-dev-tools_0.2.0~focal3_amd64.changes ...
> E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/ root/0 != root/root (or 0/0)
> E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/changelog.gz root/0 != root/root (or 0/0)
> E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/copyright root/0 != root/root (or 0/0)
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ppa 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/ 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/__init__.py 0/1001
> E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/ppa/_version.py 0/1001
> ...

Wild guess here, but maybe you're doing the build inside a container
where your $USER doesn't exist, but where you've mounted your $HOME (or
some of its subdirectories) in order to have access to your project.
Since this directory is externally owned by your $USER, and since $USER
doesn't exist in the container, you end up with files owned by the 1001
UID.

--
Sergio
GPG key ID: E92F D0B3 6B14 F1F4 D8E0 EB2F 106D A1C8 C3CB BF14

[Bryce Harrington (bryce)]

> On Tuesday, September 27 2022, Bryce Harrington wrote:
>
> > In particular one issue I'm scratching my head over is when running
> `debuild` I see lintian errors like these::
> >
> > dpkg-buildpackage: info: full upload; Debian-native package (full source is
> included)
> > Now running lintian ppa-dev-tools_0.2.0~focal3_amd64.changes ...
> > E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-tools/ root/0
> != root/root (or 0/0)
> > E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-
> tools/changelog.gz root/0 != root/root (or 0/0)
> > E: ppa-dev-tools: bad-owner-for-doc-file usr/share/doc/ppa-dev-
> tools/copyright root/0 != root/root (or 0/0)
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/ 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/bin/ppa 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/ 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/ 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-packages/
> 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-
> packages/ppa/ 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-
> packages/ppa/__init__.py 0/1001
> > E: ppa-dev-tools: wrong-file-owner-uid-or-gid usr/lib/python3/dist-
> packages/ppa/_version.py 0/1001
> > ...
>
> Wild guess here, but maybe you're doing the build inside a container
> where your $USER doesn't exist, but where you've mounted your $HOME (or
> some of its subdirectories) in order to have access to your project.
> Since this directory is externally owned by your $USER, and since $USER
> doesn't exist in the container, you end up with files owned by the 1001
> UID.

Interesting guess, but weirdly it seems the situation is the opposite. I'm doing the devel and packaging in my regular focal desktop ($USER set properly and all) but getting these E's. However, if I do exactly the same but in a jammy or focal LXC container it works fine, no lint E's.

Since I plan to do the official packaging in LXC containers anyway, I guess that's my solution.

[Bryce Harrington (bryce)]

Thanks for the feedback, I did some additional debugging and testing and added a few more fixes, and just now landed it:

To git+ssh://git.launchpad.net/ppa-dev-tools
   0ac612e..01fe475 main -> main

diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..376e9d6
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,14 @@
+ppa-dev-tools (0.2.0) focal; urgency=medium
+
+  * New release
+    - Adds 'tests' subcommand
+    - Fixes parsing errors for ppa addresses
+    - Improves packaging support
+
+ -- Bryce Harrington <[e-mail]>  Mon, 19 Sep 2022 23:12:02 -0700
+
+ppa-dev-tools (0.1.0) focal; urgency=medium
+
+  * Initial release.
+
+ -- Bryce Harrington <[e-mail]>  Mon, 25 Jul 2022 19:49:19 -0700
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..f1a4699
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,37 @@
+Source: ppa-dev-tools
+Section: devel
+Priority: optional
+Standards-Version: 4.5.0
+Maintainer: Ubuntu Developers <[e-mail]>
+Build-Depends:
+ dh-python,
+ debhelper-compat (= 12),
+ python3 (>= 3.6),
+ python3-appdirs,
+ python3-debian,
+ python3-distro-info,
+ python3-launchpadlib,
+ python3-lazr.restfulclient,
+ python3-mock,
+ python3-pytest,
+ python3-pytest-runner,
+ python3-setuptools,
+ python3-software-properties,
+ python3-yaml,
+
+Package: ppa-dev-tools
+Architecture: all
+Depends:
+ ${misc:Depends},
+ ${python3:Depends},
+ python3-debian,
+ python3-launchpadlib,
+ python3-lazr.restfulclient,
+ python3-setuptools,
+ python3-software-properties,
+ python3-xdg,
+ python3-yaml,
+Description: command line client for managing PPAs in Launchpad.
+ Provides a command line tool for creating, deleting, and configuring PPAs.
+ Includes functionality to wait/block until all packages have built.
+
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..944d56b
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,24 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: ppa-dev-tools
+Upstream-Contact: Bryce Harrington <[e-mail]>
+
+Files: *
+Copyright: 2022, Bryce Harrington <[e-mail]>
+License: GPL-2+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version. 
+ .
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+ .
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ .
+ On Debian systems, the full text of the GNU General Public
+ License version 2 can be found in the file
+ '/usr/share/common-licenses/GPL-2'.
diff --git a/debian/install b/debian/install
new file mode 100644
index 0000000..bef6191
--- /dev/null
+++ b/debian/install
@@ -0,0 +1 @@
+scripts/ppa usr/bin/
diff --git a/debian/rules b/debian/rules
new file mode 100755
index 0000000..641186e
--- /dev/null
+++ b/debian/rules
@@ -0,0 +1,4 @@
+#!/usr/bin/make -f
+
+%:
+	dh $@ --with python3 --buildsystem=pybuild
diff --git a/debian/source/format b/debian/source/format
new file mode 100644
index 0000000..89ae9db
--- /dev/null
+++ b/debian/source/format
@@ -0,0 +1 @@
+3.0 (native)
diff --git a/tests/test_result.py b/tests/test_result.py
index 836bbd1..cbd574c 100644
--- a/tests/test_result.py
+++ b/tests/test_result.py
@@ -18,6 +18,8 @@ import gzip
 
 sys.path.insert(0, os.path.realpath(
     os.path.join(os.path.dirname(__file__), "..")))
+DATA_DIR = os.path.realpath(
+    os.path.join(os.path.dirname(__file__), "data"))
 
 from ppa.result import Result
 
@@ -61,6 +63,5 @@ def test_log(tmp_path):
 
 def test_triggers():
     """Checks that autopkgtest triggers can be extracted from test result logs."""
-    data_dir = "/home/bryce/src/PpaDevTools/ppa-dev-tools-result-class/tests/data"
-    result = Result(f"file://{data_dir}/results-six-s390x.log.gz", None, None, None, None)
+    result = Result(f"file://{DATA_DIR}/results-six-s390x.log.gz", None, None, None, None)
     assert result.triggers == ['pygobject/3.42.2-2', 'six/1.16.0-4']
diff --git a/tests/test_scripts_ppa.py b/tests/test_scripts_ppa.py
index ca6d1fe..d344340 100644
--- a/tests/test_scripts_ppa.py
+++ b/tests/test_scripts_ppa.py
@@ -17,9 +17,17 @@ import pytest
 
 SCRIPT_NAME = 'ppa'
 BASE_PATH = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
-scripts_path = os.path.join(BASE_PATH, 'scripts')
 sys.path.insert(0, BASE_PATH)
 
+if '.pybuild' in BASE_PATH:
+    python_version = '.'.join([str(v) for v in sys.version_info[0:2]])
+    scripts_path = os.path.join(
+        BASE_PATH.replace(f'/.pybuild/cpython3_{python_version}/', '/'),
+        f'scripts-{python_version}'
+    )
+else:
+    scripts_path = os.path.join(BASE_PATH, 'scripts')
+
 script_path = os.path.join(scripts_path, SCRIPT_NAME)
 loader = importlib.machinery.SourceFileLoader(SCRIPT_NAME, script_path)
 script = types.ModuleType(loader.name)
diff --git a/tox.ini b/tox.ini
index 5340f7c..5e56ea0 100644
--- a/tox.ini
+++ b/tox.ini
@@ -7,21 +7,21 @@ skipsdist = true
 deps =
     flake8
     flake8-docstrings
-commands = flake8 dsctriage setup.py
+commands = flake8 ppa tests setup.py
 
 [testenv:pylint]
 deps =
     pylint
     pytest
 commands =
-    pylint --max-line-length=100 dsctriage setup.py
+    pylint --max-line-length=100 ppa tests setup.py
 
 [testenv:pytest]
 deps =
     pytest
     pytest-cov
 commands =
-    py.test --cov dsctriage dsctriage
+    py.test --cov ppa tests
 
 [flake8]
 max-line-length = 100