feat(db): support using postgresql service connection file

Add new service rdbms config option to set the service name to be used
with a postgresql service connection file.

This can be done using the PGSERVICE environment variable for a single
instance tracker server. For a multi-instance server this per-tracker
config option is needed.

Note that settings (host, user, (db)name...) in config.ini file will
override the service connection file setting. Also setting PGSERVICE
and service will use the service setting.

Author: rouilj

CHANGES.txt

@@ -92,7 +92,11 @@ Features:
 - issue685275 - add pragma show_retired to control display of retired
   items when using list/table. Add pragma display_header to print
   headers for display command. Header displays designator and
-  retired/active status.
+  retired/active status. (John Rouillard)
+- support config.ini rdbms option 'service'. Allow use of a
+  PostgreSQL connection service file for configuring database on a
+  per-tracker basis. Also replaces use of PGSERVICE env variable for
+  single instance trackers. (From ML question by ivanov. John Rouillard)
 
 2023-07-13 2.3.0
 

doc/reference.txt

@@ -293,6 +293,19 @@ Section **rdbms**
  password -- ``roundup``
   Database user password.
 
+ service -- default *blank*
+  Use to define the Connection Service for your PostgreSQL connection
+  when using a system-wide pg_service.conf or ~/.pg_service.conf as
+  discussed in
+  https://www.postgresql.org/docs/current/libpq-pgservice.html.
+
+  Setting this to the name of the service allows different trackers to
+  connect to different services when running multiple trackers under
+  one Roundup server. If you are only running one tracker, you can set
+  the PGSERVICE environment variable. Note that other settings
+  specified in this file (rdbms: user, password, port, host, (db)name)
+  will override the corresponding connection service setting.
+
  read_default_file -- ``~/.my.cnf``
   Name of the MySQL defaults file. Only used in MySQL connections.
 

roundup/backends/back_postgresql.py

@@ -176,8 +176,13 @@ class Database(rdbms_common.Database):
 
     def sql_open_connection(self):
         db = connection_dict(self.config, 'database')
-        logging.getLogger('roundup.hyperdb').info(
-            'open database %r' % db['database'])
+        # database option always present: log it if not null
+        if db['database']:
+            logging.getLogger('roundup.hyperdb').info(
+                'open database %r' % db['database'])
+        if 'service' in db:  # only log if used
+            logging.getLogger('roundup.hyperdb').info(
+                'open database via service %r' % db['service'])
         try:
             conn = psycopg2.connect(**db)
         except psycopg2.OperationalError as message:

roundup/backends/rdbms_common.py

@@ -112,8 +112,8 @@ def connection_dict(config, dbnamestr=None):
     d = {}
     if dbnamestr:
         d[dbnamestr] = config.RDBMS_NAME
-    for name in ('host', 'port', 'password', 'user', 'read_default_group',
-                 'read_default_file'):
+    for name in ('host', 'port', 'password', 'user', 'service',
+                 'read_default_group', 'read_default_file'):
         cvar = 'RDBMS_'+name.upper()
         if config[cvar] is not None:
             d[name] = config[cvar]

roundup/configuration.py

@@ -1451,6 +1451,10 @@ def str2value(self, value):
         (SecretNullableOption, 'password', 'roundup',
             "Database user password.",
             ['MYSQL_DBPASSWORD']),
+        (NullableOption, 'service', '',
+            "Name of the PostgreSQL connection service for this Roundup\n"
+            "instance. Only used in Postgresql connections. You need to set\n"
+            "up a pg_service.conf file usable by psql use this option."),
         (NullableOption, 'read_default_file', '~/.my.cnf',
             "Name of the MySQL defaults file.\n"
             "Only used in MySQL connections."),