Merge pull request #1420 from garberg/repackage_nipap

WIP: Repackage nipapd

.github/workflows/ci.yml

@@ -43,13 +43,15 @@ jobs:
           fakeroot \
           debhelper \
           dh-python \
+          pybuild-plugin-pyproject \
           junit4 \
           libldap-dev \
           libsasl2-dev \
           python3-docutils \
           python3-nose \
           python3-requests \
           python3-setuptools \
+          python3-build \
           python3-wheel \
           python3-all \
           default-jdk \
@@ -79,23 +81,23 @@ jobs:
       if: ${{ matrix.install == 'pip' }}
       run: |
         # install nipap dependencies
-        sudo -H pip3 install --break-system-packages -I -r nipap/requirements.txt
+        sudo -H pip3 install --break-system-packages -I ./nipap/
         # SQL
         sudo su -c "cd nipap/sql; PGPASSWORD=papin make install" postgres
         # move configuration file into place
         sudo mkdir /etc/nipap
         sudo cp nipap/nipap.conf.dist /etc/nipap/nipap.conf
         sudo sed -e "s/{{LISTEN_ADDRESS}}/127.0.0.1/" -e "s/{{LISTEN_PORT}}/1337/" -e "s/#ssl_port.\+$/ssl_port = 1338/" -e "s/#ssl_cert_file.\+$/ssl_cert_file = \/tmp\/ca\/test.bundle.crt/" -e "s/#ssl_key_file.\+$/ssl_key_file = \/tmp\/ca\/test.key/" -e "s/{{DB_USERNAME}}/nipap/" -e "s/{{DB_NAME}}/nipap/" -e "s/{{DB_PASSWORD}}/papin/" -e "s/{{DB_SSLMODE}}/require/" -e "s/{{DB_PORT}}/5432/" -e "s/{{DB_HOST}}/localhost/" -e "s/{{SYSLOG}}/true/" -i /etc/nipap/nipap.conf
         # create local user for unittest
-        sudo nipap/nipap-passwd create-database
-        sudo nipap/nipap-passwd add -u unittest -p gottatest -n unittest
-        sudo nipap/nipap-passwd add -u readonly -p gottatest --readonly -n "Read-only user for running unit tests"
+        sudo nipap-passwd create-database
+        sudo nipap-passwd add -u unittest -p gottatest -n unittest
+        sudo nipap-passwd add -u readonly -p gottatest --readonly -n "Read-only user for running unit tests"
         # install pynipap
-        cd pynipap; sudo python3 setup.py install; cd ..
+        cd pynipap; sudo -H pip3 install --break-system-packages -I .; cd ..
         # install nipap-cli dependencies
         sudo -H pip3 install --break-system-packages -r nipap-cli/requirements.txt
         # start nipap backend
-        nipap/nipapd --no-pid-file -c /etc/nipap/nipap.conf -df 2>&1 > /tmp/nipap.log &
+        nipapd --no-pid-file -c /etc/nipap/nipap.conf -df 2>&1 > /tmp/nipap.log &
 
     - name: "Install latest release from apt"
       if: ${{ matrix.install == 'apt' && matrix.upgrade == true }}
@@ -141,8 +143,8 @@ jobs:
           sudo sed -e "s/#ssl_port.\+$/ssl_port = 1338/" -e "s/#ssl_cert_file.\+$/ssl_cert_file = \/tmp\/ca\/test.bundle.crt/" -e "s/#ssl_key_file.\+$/ssl_key_file = \/tmp\/ca\/test.key/" -i /etc/nipap/nipap.conf; \
         fi
         # create local user for unittests
-        sudo nipap/nipap-passwd add -u unittest -p gottatest -f /etc/nipap/local_auth.db -n "User for running unit tests"
-        sudo nipap/nipap-passwd add -u readonly -p gottatest -f /etc/nipap/local_auth.db --readonly -n "Read-only user for running unit tests"
+        sudo nipap-passwd add -u unittest -p gottatest -f /etc/nipap/local_auth.db -n "User for running unit tests"
+        sudo nipap-passwd add -u readonly -p gottatest -f /etc/nipap/local_auth.db --readonly -n "Read-only user for running unit tests"
         sudo sed -e "s/^db_host *=.*/db_host = localhost/" -e "s/{{SYSLOG}}/true/" -e "s/^debug.\+/debug = true/" -e "s/^user/#user/" -i /etc/nipap/nipap.conf
         sudo systemctl restart nipapd.service
 
@@ -242,7 +244,7 @@ jobs:
           python3-requests \
           postgresql-16-ip4r
 
-        sudo -H pip3 install -I --break-system-packages -r nipap/requirements.txt # needed to run test suite
+        sudo -H pip3 install -I --break-system-packages ./nipap/ # needed to run test suite
 
         # Set up PostgreSQL
         sudo service postgresql start

Dockerfile.nipapd

@@ -66,8 +66,7 @@ ENV REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt
 COPY nipap /nipap
 WORKDIR /nipap
 RUN pip3 --no-input install --break-system-packages --no-cache-dir envtpl==0.7.2 \
- && pip3 --no-input install -I --break-system-packages --no-cache-dir -r requirements.txt \
- && python3 setup.py install
+ && pip3 --no-input install -I --break-system-packages --no-cache-dir .
 
 EXPOSE 1337
 ENV LISTEN_ADDRESS=0.0.0.0 LISTEN_PORT=1337 SYSLOG=false DB_PORT=5432 DB_SSLMODE=disable DB_NAME=nipap

Dockerfile.www

@@ -64,7 +64,7 @@ COPY pynipap /pynipap
 COPY nipap /nipap
 COPY nipap-www /nipap-www
 RUN cd /pynipap && pip3 --no-input install --break-system-packages --no-cache-dir . && \
-    cd /nipap && pip3 --no-input install --break-system-packages --no-cache-dir -r requirements.txt && python3 setup.py install && \
+    cd /nipap && pip3 --no-input install --break-system-packages --no-cache-dir . && \
     cd /nipap-www && pip3 --no-input install --break-system-packages --no-cache-dir -r requirements.txt && python3 setup.py install && \
     cd ..
 

nipap/Makefile

@@ -27,7 +27,7 @@ buildrpm: sql2py
 builddeb: sql2py
 	# build the source package in the parent directory
 	# then rename it to project_version.orig.tar.gz
-	$(PYTHON) setup.py sdist --dist-dir=../ #--prune
+	$(PYTHON) -m build --sdist --outdir=../
 	rename -f 's/$(PROJECT)-(\d.*)\.tar\.gz/$(PROJECT)_$$1\.orig\.tar\.gz/' ../*
 	# build the package
 	debuild -us -uc
@@ -50,7 +50,7 @@ clean:
 		debian/nipap-common.debhelper.log \
 		debian/nipap-common.postinst.debhelper \
 		debian/nipap-common.prerm.debhelper debian/nipap-common.substvars \
-		debian/.debhelper debian/debhelper-build-stamp nipap.egg-info/
+		debian/.debhelper debian/debhelper-build-stamp nipap.egg-info/ build/
 	find . -name '*.pyc' -delete
 
 VER := $(shell head -n1 ../NEWS | awk '{print $$2}')

nipap/debian/control

@@ -2,22 +2,27 @@ Source: nipap
 Maintainer: Lukas Garberg <[email protected]>
 Section: python
 Priority: optional
-Build-Depends: python3 (>= 3.6), debhelper (>= 10), dh-python
-Standards-Version: 4.4.0
-
+Build-Depends: debhelper-compat (= 13),
+               dh-python,
+               python3-all,
+               python3-setuptools
+Standards-Version: 4.6.1
+Homepage: https://spritelink.github.io/NIPAP/
+Rules-Requires-Root: no
 
 Package: nipap-common
 Architecture: all
-Depends: python3 (>= 3.6), ${misc:Depends}, python3-ipy
+Multi-Arch: foreign
+Depends: ${misc:Depends}, ${python3:Depends}
 Suggests: python3-ldap
 Description: Neat IP Address Planner
  The Neat IP Address Planner, NIPAP, is a system built for efficiently managing
  large amounts of IP addresses. This is the common libraries.
 
-
 Package: nipapd
 Architecture: all
-Depends: debconf, nipap-common, python3 (>= 3.6), ${misc:Depends}, python3-psycopg2, python3-flask, python3-flask-xml-rpc-re, python3-flask-restx, python3-flask-compress, python3-tornado, python3-parsedatetime, python3-tz, python3-dateutil, python3-psutil, python3-pyparsing, python3-jwt, python3-requests
+Multi-Arch: foreign
+Depends: ${misc:Depends}, ${python3:Depends}, nipap-common
 Description: Neat IP Address Planner XML-RPC daemon
  The Neat IP Address Planner, NIPAP, is a system built for efficiently managing
  large amounts of IP addresses. This is the XML-RPC daemon.

nipap/debian/nipapd.init

@@ -11,7 +11,7 @@ set -e
 # Short-Description:	NIPAP XML-RPC server
 ### END INIT INFO
 
-DAEMON=/usr/sbin/nipapd
+DAEMON=/usr/bin/nipapd
 CONFIGFILE=/etc/nipap/nipap.conf
 NAME=NIPAPd
 PIDFILE=/var/run/nipap/nipapd.pid

nipap/debian/nipapd.install

@@ -1,4 +1,6 @@
-etc
-usr/sbin/nipap-passwd
-usr/sbin/nipapd
+usr/bin/nipapd
+usr/bin/nipap-passwd
 usr/share/nipap
+usr/share/nipap/nipap.conf.dist etc/nipap
+usr/share/man/man8/nipapd.8
+usr/share/man/man1/nipap-passwd.1

nipap/debian/py3dist-overrides

@@ -0,0 +1,3 @@
+flask-restx python3-flask-restx
+Flask python3-flask (>= 2.0.0)
+flask-xml-rpc-re python3-flask-xml-rpc-re

nipap/debian/rules

@@ -2,6 +2,7 @@
 
 # This file was automatically generated by stdeb 0.6.0+git at
 # Tue, 18 Oct 2011 21:55:07 +0200
+export DH_VERBOSE=1
 
 %:
 	dh $@ --with python3 --buildsystem=pybuild

nipap/entrypoint.sh

@@ -1,12 +1,13 @@
 #!/bin/sh
 
-envtpl --allow-missing --keep-template /nipap/nipap.conf.dist -o /etc/nipap/nipap.conf
+mkdir -p /etc/nipap/
+envtpl --allow-missing --keep-template /usr/local/share/nipap/nipap.conf.dist -o /etc/nipap/nipap.conf
 /bin/bash /nipap/wait-for-it.sh -t 60 $DB_HOST:$DB_PORT -- sleep 5
 
-/usr/sbin/nipap-passwd create-database
+/usr/local/bin/nipap-passwd create-database
 if [ -n "$NIPAP_USERNAME" -a -n "$NIPAP_PASSWORD" ]; then
 	echo "Creating user '$NIPAP_USERNAME'"
-	/usr/sbin/nipap-passwd add --username $NIPAP_USERNAME --name "NIPAP user" --password $NIPAP_PASSWORD
+	/usr/local/bin/nipap-passwd add --username $NIPAP_USERNAME --name "NIPAP user" --password $NIPAP_PASSWORD
 fi
 echo "Starting nipap daemon.."
-exec /usr/sbin/nipapd --debug --foreground --auto-install-db --auto-upgrade-db --no-pid-file
+exec /usr/local/bin/nipapd --debug --foreground --auto-install-db --auto-upgrade-db --no-pid-file

nipap/nipap-passwd → nipap/nipap/nipap_passwd.py

@@ -11,8 +11,8 @@
 import nipap.authlib
 from nipap.nipapconfig import NipapConfig, NipapConfigError
 
-if __name__ == '__main__':
 
+def run():
     # parse arguments
     parser = argparse.ArgumentParser(description='NIPAP User configuration')
     parser.add_argument('action',
@@ -175,3 +175,7 @@
 
     else:
         parser.print_help()
+
+
+if __name__ == '__main__':
+    run()

nipap/nipapd → nipap/nipap/nipapd.py

@@ -85,7 +85,7 @@ def drop_privileges(uid_name='nobody', gid_name='nogroup'):
     old_umask = os.umask(0o077)
 
 
-if __name__ == '__main__':
+def run():
     parser = argparse.ArgumentParser(description='NIPAP backend server')
     parser.add_argument('--auto-install-db', action='store_true', help='automatically install db schema')
     parser.add_argument('--auto-upgrade-db', action='store_true', help='automatically upgrade db schema')
@@ -270,7 +270,7 @@ def drop_privileges(uid_name='nobody', gid_name='nogroup'):
         logger.debug('Tracing is disabled')
 
     Compress(app)
-    
+
     # Set up sockets for handling plaintext and SSL connections
     sockets = []
     ssl_sockets = []
@@ -358,3 +358,7 @@ def drop_privileges(uid_name='nobody', gid_name='nogroup'):
     except Exception as exc:
         logger.error(exc)
         sys.exit(1)
+
+
+if __name__ == '__main__':
+    run()

nipap/pyproject.toml

@@ -0,0 +1,84 @@
+[project]
+name = "nipap"
+dynamic = ["version", "description"]
+readme = "README.rst"
+license = {text = "MIT"}
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Developers',
+    'Intended Audience :: System Administrators',
+    'License :: OSI Approved :: MIT License',
+    'Natural Language :: English',
+    'Operating System :: POSIX :: Linux',
+    'Programming Language :: Python :: 3'
+]
+keywords = ["nipap"]
+dependencies = [
+  "zipp==3.21.0",
+  "importlib_metadata==8.5.0",
+  "Flask==3.0.3",
+  "Flask-Compress==1.17",
+  "flask-xml-rpc-re==0.1.4",
+  "flask-restx==1.3.0",
+  "requests==2.32.3",
+  "IPy==1.01",
+  "Jinja2==3.1.5",
+  "MarkupSafe==3.0.2",
+  "Werkzeug==3.1.3",
+  "certifi==2024.12.14",
+  "itsdangerous==2.2.0",
+  "parsedatetime==2.6",
+  "psutil==6.1.1",
+  "psycopg2==2.9.10",
+  "pyparsing==3.2.1",
+  "python-dateutil==2.8.2",
+  "pytz==2024.2",
+  "pyjwt==2.10.1",
+  "tornado==6.4.2",
+#  "docutils==0.21.2"
+]
+
+[project.optional-dependencies]
+instrumentation = [
+  "opentelemetry-api==1.29.0",
+  "opentelemetry-exporter-otlp==1.29.0",
+  "opentelemetry-exporter-otlp-proto-common==1.29.0",
+  "opentelemetry-exporter-otlp-proto-grpc==1.29.0",
+  "opentelemetry-exporter-otlp-proto-http==1.29.0",
+  "opentelemetry-instrumentation==0.50b0",
+  "opentelemetry-instrumentation-dbapi==0.50b0",
+  "opentelemetry-instrumentation-flask==0.50b0",
+  "opentelemetry-instrumentation-psycopg2==0.50b0",
+  "opentelemetry-instrumentation-wsgi==0.50b0",
+  "opentelemetry-proto==1.29.0",
+  "opentelemetry-sdk==1.29.0",
+  "opentelemetry-semantic-conventions==0.50b0",
+  "opentelemetry-util-http==0.50b0"
+]
+
+ldap_auth = [
+  "python-ldap==3.4.4"
+]
+
+[project.urls]
+Homepage = "http://SpriteLink.github.io/NIPAP"
+
+[project.scripts]
+nipapd = "nipap.nipapd:run"
+nipap-passwd = "nipap.nipap_passwd:run"
+
+[tool.setuptools.dynamic]
+version = {attr = "nipap.__version__"}
+
+[build-system]
+requires = [
+  "setuptools",
+  # Need to be pinned to 0.20.1 in Ubuntu 24.04 as using the latest 0.21.2
+  # gives a diff during .deb package build. Unfortunately the files are
+  # generated twice - first once in a virtualenv (using the version specified
+  # here) and then once without a virtualenv using the one from the system.
+  # There two runs produce different outputs (wich they shouldn't) causing a
+  # diff and the package utils to b0rk out.
+  "docutils==0.20.1"
+]
+build-backend = "setuptools.build_meta"