Fix handling of the unix connection parameter.

James William Pye · James William Pye · commit dd3ea31b22be · 2010-02-02T15:43:55.000-07:00
There was an assorted set of bugs around this:

 - SocketCreator was referenced instead of SocketFactory.
 - pg.open(unix = '') would cause a TypeError because of standard parameters.
 - pq-IRI's [unix:...] representation would not serialize and parse correctly.
 - The unix keyword was undocumented.
 - There were no tests for unix domain sockets.

Issue reported by twitter.com/rintavarustus
diff --git a/postgresql/__init__.py b/postgresql/__init__.py
@@ -74,6 +74,11 @@ def open(iri = None, prompt_title = None, **kw):
 		iri_params = {}
 
 	std_params = _pg_param.collect(prompt_title = None)
+	# If unix is specified, it's going to conflict with any standard
+	# settings, so remove them right here.
+	if 'unix' in kw or 'unix' in iri_params:
+		std_params.pop('host', None)
+		std_params.pop('port', None)
 	params = _pg_param.normalize(
 		list(_pg_param.denormalize_parameters(std_params)) + \
 		list(_pg_param.denormalize_parameters(iri_params)) + \
diff --git a/postgresql/documentation/changes.txt b/postgresql/documentation/changes.txt
@@ -8,6 +8,8 @@ Changes
  * **DEPRECATION**: Removed 2PC support documentation.
  * **DEPRECATION**: Removed pg_python and pg_dotconf 'scripts'.
    They are still accessible by python3 -m postgresql.bin.pg_*
+ * Fix handling of unix domain sockets by pg.open and driver.connect.
+   [Reported by twitter.com/rintavarustus]
 
 0.9.3 released on 2010-01-01
 ----------------------------
diff --git a/postgresql/documentation/clientparameters.txt b/postgresql/documentation/clientparameters.txt
@@ -199,6 +199,8 @@ systems it is ``"%APPDATA%\postgresql"``
  [PGDATA] is *not* an environment variable.
 
 
+.. _pg_envvars:
+
 PostgreSQL Environment Variables
 ================================
 
@@ -227,6 +229,8 @@ The following is a list of environment variables that will be collected by the
  ===================== ======================================
 
 
+.. _pg_passfile:
+
 PostgreSQL Password File
 ========================
 
diff --git a/postgresql/documentation/driver.txt b/postgresql/documentation/driver.txt
@@ -110,11 +110,8 @@ successful connection, there is no need to pass anything to open::
 
 For a complete list of keywords that `postgresql.open` can accept, see
 `Connection Keywords`_.
-For more information about the environment variables, see :doc:`Environment
-Variables</clientparameters>`.
-For more information about the ``pgpassfile``, see :doc:`PostgreSQL Password
-File</clientparameters>`.
-
+For more information about the environment variables, see :ref:`pg_envvars`.
+For more information about the ``pgpassfile``, see :ref:`pg_passfile`.
 
 `postgresql.driver.connect`
 ---------------------------
@@ -185,7 +182,8 @@ a connection:
   Connect to a single IPv6 addressed host.
 
  ``postgresql.driver.default.unix(...)``
-  Connect to a single unix domain socket.
+  Connect to a single unix domain socket. Requires the ``unix`` keyword which
+  must be an absolute path to the unix domain socket to connect to.
 
 ``host`` is the usual connector used to establish a connection::
 
@@ -241,6 +239,11 @@ interfaces:
  ``port``
   The port on the host to connect to.
 
+ ``unix``
+  The unix domain socket to connect to. Exclusive with ``host`` and ``port``.
+  Expects a string containing the absolute path to the unix domain socket to
+  connect to.
+
  ``settings``
   A dictionary or key-value pair sequence stating the parameters to give to the
   database. These settings are included in the startup packet, and should be
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -2425,7 +2425,7 @@ def __init__(self, unix = None, **kw):
 			raise TypeError("'unix' is a required keyword and cannot be 'None'")
 		self.unix = unix
 		# constant socket connector
-		self._socketcreator = SocketCreator(
+		self._socketcreator = SocketFactory(
 			(socket.AF_UNIX, socket.SOCK_STREAM), self.unix
 		)
 		self._socketcreators = (self._socketcreator,)
diff --git a/postgresql/iri.py b/postgresql/iri.py
@@ -42,7 +42,7 @@ def structure(d, fieldproc = ri.unescape):
 		if host.startswith('[') and host.endswith(']'):
 			host = host[1:-1]
 			if host.startswith('unix:'):
-				cpd['unix'] = host[len('unix:'):]
+				cpd['unix'] = host[len('unix:'):].replace(':','/')
 			else:
 				cpd['host'] = host[1:-1]
 		else:
@@ -115,7 +115,7 @@ def construct(x, obscure_password = False):
 
 	port = None
 	if 'unix' in x:
-		host = '[unix:/' + x['unix'] + ']'
+		host = '[unix:' + x['unix'].replace('/',':') + ']'
 		# ignore port.. it's a mis-config.
 	elif 'host' in x:
 		host = x['host']
diff --git a/postgresql/test/test_connect.py b/postgresql/test/test_connect.py
@@ -17,7 +17,7 @@
 
 class test_connect(pg_unittest.TestCaseWithCluster):
 	"""
-	postgresql.driver *interface* tests.
+	postgresql.driver connectivity tests
 	"""
 	ip6 = '::1'
 	ip4 = '127.0.0.1'
@@ -29,10 +29,15 @@ def __init__(self, *args, **kw):
 		super().__init__(*args,**kw)
 		# 8.4 nixed this.
 		self.do_crypt = self.cluster.installation.version_info < (8,4)
+		self.do_unix = sys.platform != msw
 
 	def configure_cluster(self):
 		super().configure_cluster()
-		self.cluster.settings['log_min_messages'] = 'log'
+		self.cluster.settings.update({
+			'log_min_messages' : 'log',
+			'unix_socket_directory' : self.cluster.data_directory,
+		})
+
 		# Configure the hba file with the supported methods.
 		with open(self.cluster.hba_file, 'w') as hba:
 			hosts = ['0.0.0.0/0',]
@@ -47,6 +52,7 @@ def configure_cluster(self):
 						m = m
 					)])
 			# trusted
+			hba.writelines(["local all all trust\n"])
 			hba.writelines(["host test trusted 0.0.0.0/0 trust\n"])
 			if not msw:
 				hba.writelines(["host test trusted 0::0/0 trust\n"])
@@ -344,5 +350,34 @@ def test_trusted_connect(self):
 		with c:
 			self.failUnlessEqual(c.prepare('select current_user').first(), 'trusted')
 
+	def test_Unix_connect(self):
+		if msw:
+			return
+		unix_domain_socket = os.path.join(
+			self.cluster.data_directory,
+			'.s.PGSQL.' + self.cluster.settings['port']
+		)
+		C = pg_driver.default.unix(
+			user = 'test',
+			unix = unix_domain_socket,
+		)
+		with C() as c:
+			self.failUnlessEqual(c.prepare('select 1').first(), 1)
+			self.failUnlessEqual(c.client_address, None)
+
+	def test_pg_open_unix(self):
+		if msw:
+			return
+		unix_domain_socket = os.path.join(
+			self.cluster.data_directory,
+			'.s.PGSQL.' + self.cluster.settings['port']
+		)
+		with pg_open(unix = unix_domain_socket, user = 'test') as c:
+			self.failUnlessEqual(c.prepare('select 1').first(), 1)
+			self.failUnlessEqual(c.client_address, None)
+		with pg_open('pq://test@[unix:' + unix_domain_socket.replace('/',':') + ']') as c:
+			self.failUnlessEqual(c.prepare('select 1').first(), 1)
+			self.failUnlessEqual(c.client_address, None)
+
 if __name__ == '__main__':
 	unittest.main()

Original file line number	Diff line number	Diff line change
`@@ -2425,7 +2425,7 @@ def __init__(self, unix = None, **kw):`
`2425`	`2425`	`raise TypeError("'unix' is a required keyword and cannot be 'None'")`
`2426`	`2426`	`self.unix = unix`
`2427`	`2427`	`# constant socket connector`
`2428`		`- self._socketcreator = SocketCreator(`
	`2428`	`+ self._socketcreator = SocketFactory(`
`2429`	`2429`	`(socket.AF_UNIX, socket.SOCK_STREAM), self.unix`
`2430`	`2430`	`)`
`2431`	`2431`	`self._socketcreators = (self._socketcreator,)`