fix: support for password special characters, fixes #440 (#441)

pgbelt/config/models.py

@@ -10,6 +10,7 @@
 from pydantic import BaseModel
 from pydantic import ValidationError
 from pydantic import field_validator
+from urllib.parse import quote
 
 
 def config_dir(db: str, dc: str) -> str:
@@ -86,15 +87,24 @@ def pglogical_dsn(self) -> str:
 
     @property
     def root_uri(self) -> str:
-        return f"postgresql://{self.root_user.name}:{self.root_user.pw}@{self.ip}:{self.port}/{self.db}"
+        password = quote(
+            self.root_user.pw
+        )  # https://github.com/encode/databases/issues/145#issuecomment-1303792343 need this to handle special characters
+        return f"postgresql://{self.root_user.name}:{password}@{self.ip}:{self.port}/{self.db}"
 
     @property
     def owner_uri(self) -> str:
-        return f"postgresql://{self.owner_user.name}:{self.owner_user.pw}@{self.ip}:{self.port}/{self.db}"
+        password = quote(
+            self.owner_user.pw
+        )  # https://github.com/encode/databases/issues/145#issuecomment-1303792343 need this to handle special characters
+        return f"postgresql://{self.owner_user.name}:{password}@{self.ip}:{self.port}/{self.db}"
 
     @property
     def pglogical_uri(self) -> str:
-        return f"postgresql://{self.pglogical_user.name}:{self.pglogical_user.pw}@{self.ip}:{self.port}/{self.db}"
+        password = quote(
+            self.pglogical_user.pw
+        )  # https://github.com/encode/databases/issues/145#issuecomment-1303792343 need this to handle special characters
+        return f"postgresql://{self.pglogical_user.name}:{password}@{self.ip}:{self.port}/{self.db}"
 
 
 class DbupgradeConfig(BaseModel):

tests/integration/conftest.py

@@ -33,7 +33,8 @@ async def _create_dbupgradeconfigs() -> dict[str, DbupgradeConfig]:
             pw="postgres",
         ),
         # We will create the owner_user in the DBs via the integration test setup.
-        "owner_user": User(name="owner", pw="ownerpassword"),
+        # Due to issue #440, we're adding a special character to the password to ensure this still works.
+        "owner_user": User(name="owner", pw="owner#password"),
         "pglogical_user": User(name="pglogical", pw="pglogicalpassword"),
         "db": "testdb",
     }