add spi plugin (#290)

Author: TakoB222

config.yaml

@@ -215,6 +215,10 @@ options:
     default: false
     type: boolean
     description: Enable uuid_ossp extension
+  plugin_spi_enable:
+    default: false
+    type: boolean
+    description: Enable spi extension
   profile:
    description: |
       Profile representing the scope of deployment, and used to tune resource allocation.

src/charm.py

@@ -947,6 +947,7 @@ def enable_disable_extensions(self, database: str = None) -> None:
         Args:
             database: optional database where to enable/disable the extension.
         """
+        spi_module = ["refint", "autoinc", "insert_username", "moddatetime"]
         original_status = self.unit.status
         plugins_exception = {"uuid_ossp": '"uuid-ossp"'}
         extensions = {}
@@ -956,6 +957,10 @@ def enable_disable_extensions(self, database: str = None) -> None:
 
             # Enable or disable the plugin/extension.
             extension = "_".join(plugin.split("_")[1:-1])
+            if extension == "spi":
+                for ext in spi_module:
+                    extensions[ext] = enable
+                continue
             if extension in plugins_exception:
                 extension = plugins_exception[extension]
             extensions[extension] = enable

src/config.py

@@ -63,6 +63,7 @@ class CharmConfig(BaseConfigModel):
     plugin_tsm_system_rows_enable: bool
     plugin_tsm_system_time_enable: bool
     plugin_uuid_ossp_enable: bool
+    plugin_spi_enable: bool
     request_date_style: Optional[str]
     request_standard_conforming_strings: Optional[bool]
     request_time_zone: Optional[str]

src/constants.py

@@ -32,7 +32,7 @@
 # Snap constants.
 PGBACKREST_EXECUTABLE = "charmed-postgresql.pgbackrest"
 POSTGRESQL_SNAP_NAME = "charmed-postgresql"
-SNAP_PACKAGES = [(POSTGRESQL_SNAP_NAME, {"revision": "86"})]
+SNAP_PACKAGES = [(POSTGRESQL_SNAP_NAME, {"revision": "87"})]
 
 SNAP_COMMON_PATH = "/var/snap/charmed-postgresql/common"
 SNAP_CURRENT_PATH = "/var/snap/charmed-postgresql/current"

tests/integration/test_plugins.py

@@ -53,6 +53,10 @@
 TSM_SYSTEM_ROWS_EXTENSION_STATEMENT = "CREATE TABLE tsm_system_rows_test (i int);SELECT * FROM tsm_system_rows_test TABLESAMPLE SYSTEM_ROWS(100);"
 TSM_SYSTEM_TIME_EXTENSION_STATEMENT = "CREATE TABLE tsm_system_time_test (i int);SELECT * FROM tsm_system_time_test TABLESAMPLE SYSTEM_TIME(1000);"
 UUID_OSSP_EXTENSION_STATEMENT = "SELECT uuid_nil();"
+REFINT_EXTENSION_STATEMENT = "CREATE TABLE A (ID int4 not null); CREATE UNIQUE INDEX AI ON A (ID);CREATE TABLE B (REFB int4);CREATE INDEX BI ON B (REFB);CREATE TRIGGER BT BEFORE INSERT OR UPDATE ON B FOR EACH ROW EXECUTE PROCEDURE check_primary_key ('REFB', 'A', 'ID');"
+AUTOINC_EXTENSION_STATEMENT = "CREATE TABLE ids (id int4, idesc text);CREATE TRIGGER ids_nextid BEFORE INSERT OR UPDATE ON ids FOR EACH ROW EXECUTE PROCEDURE autoinc (id, next_id);"
+INSERT_USERNAME_EXTENSION_STATEMENT = "CREATE TABLE username_test (name text, username text not null);CREATE TRIGGER insert_usernames BEFORE INSERT OR UPDATE ON username_test FOR EACH ROW EXECUTE PROCEDURE insert_username (username);"
+MODDATETIME_EXTENSION_STATEMENT = "CREATE TABLE mdt (moddate timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL);CREATE TRIGGER mdt_moddatetime BEFORE UPDATE ON mdt FOR EACH ROW EXECUTE PROCEDURE moddatetime (moddate);"
 
 
 @pytest.mark.abort_on_fail
@@ -99,6 +103,12 @@ async def test_plugins(ops_test: OpsTest) -> None:
         "plugin_tsm_system_rows_enable": TSM_SYSTEM_ROWS_EXTENSION_STATEMENT,
         "plugin_tsm_system_time_enable": TSM_SYSTEM_TIME_EXTENSION_STATEMENT,
         "plugin_uuid_ossp_enable": UUID_OSSP_EXTENSION_STATEMENT,
+        "plugin_spi_enable": [
+            REFINT_EXTENSION_STATEMENT,
+            AUTOINC_EXTENSION_STATEMENT,
+            INSERT_USERNAME_EXTENSION_STATEMENT,
+            MODDATETIME_EXTENSION_STATEMENT,
+        ],
     }
 
     def enable_disable_config(enabled: False):
@@ -120,8 +130,13 @@ def enable_disable_config(enabled: False):
     with db_connect(host=address, password=password) as connection:
         connection.autocommit = True
         for query in sql_tests.values():
-            with pytest.raises(psycopg2.Error):
-                connection.cursor().execute(query)
+            if isinstance(query, list):
+                for test in query:
+                    with pytest.raises(psycopg2.Error):
+                        connection.cursor().execute(test)
+            else:
+                with pytest.raises(psycopg2.Error):
+                    connection.cursor().execute(query)
     connection.close()
 
     # Enable the plugins.
@@ -136,5 +151,9 @@ def enable_disable_config(enabled: False):
     with db_connect(host=address, password=password) as connection:
         connection.autocommit = True
         for query in sql_tests.values():
-            connection.cursor().execute(query)
+            if isinstance(query, list):
+                for test in query:
+                    connection.cursor().execute(test)
+            else:
+                connection.cursor().execute(query)
     connection.close()

tests/unit/test_charm.py

@@ -393,6 +393,9 @@ def test_enable_disable_extensions(self, _):
   plugin_uuid_ossp_enable:
     default: false
     type: boolean
+  plugin_spi_enable:
+    default: false
+    type: boolean
   profile:
     default: production
     type: string"""