|
| 1 | +"""PostgreSQL extension testing framework for multi-version compatibility. |
| 2 | +
|
| 3 | +This module provides a test framework for PostgreSQL extensions that need to be |
| 4 | +tested across multiple PostgreSQL versions and extension versions. It handles |
| 5 | +installation, upgrades, and version verification of PostgreSQL extensions. |
| 6 | +""" |
| 7 | + |
| 8 | +from typing import Sequence, Mapping |
| 9 | +from test_driver.machine import Machine |
| 10 | + |
| 11 | +Versions = Mapping[str, Sequence[str]] |
| 12 | + |
| 13 | +class PostgresExtensionTest(object): |
| 14 | + def __init__(self, vm: Machine, extension_name: str, versions: Versions, support_upgrade: bool = True): |
| 15 | + """Initialize the PostgreSQL extension test framework. |
| 16 | +
|
| 17 | + Args: |
| 18 | + vm: Test machine instance for executing commands |
| 19 | + extension_name: Name of the PostgreSQL extension to test |
| 20 | + versions: Mapping of PostgreSQL versions to available extension versions |
| 21 | + support_upgrade: Whether the extension supports in-place upgrades |
| 22 | + """ |
| 23 | + self.vm = vm |
| 24 | + self.extension_name = extension_name |
| 25 | + self.versions = versions |
| 26 | + self.support_upgrade = support_upgrade |
| 27 | + |
| 28 | + def run_sql(self, query: str) -> str: |
| 29 | + return self.vm.succeed(f"""sudo -u postgres psql -t -A -F\",\" -c \"{query}\" """).strip() |
| 30 | + |
| 31 | + def drop_extension(self): |
| 32 | + self.run_sql(f"DROP EXTENSION IF EXISTS {self.extension_name};") |
| 33 | + |
| 34 | + def install_extension(self, version: str): |
| 35 | + self.run_sql(f"""CREATE EXTENSION {self.extension_name} WITH VERSION '{version}' CASCADE;""") |
| 36 | + # Verify version was installed correctly |
| 37 | + self.assert_version_matches(version) |
| 38 | + |
| 39 | + def update_extension(self, version: str): |
| 40 | + self.run_sql(f"""ALTER EXTENSION {self.extension_name} UPDATE TO '{version}';""") |
| 41 | + # Verify version was installed correctly |
| 42 | + self.assert_version_matches(version) |
| 43 | + |
| 44 | + def get_installed_version(self) -> str: |
| 45 | + """Get the currently installed version of the extension. |
| 46 | +
|
| 47 | + Returns: |
| 48 | + Version string of the currently installed extension, |
| 49 | + or empty string if extension is not installed |
| 50 | + """ |
| 51 | + return self.run_sql(f"""SELECT extversion FROM pg_extension WHERE extname = '{self.extension_name}';""") |
| 52 | + |
| 53 | + def assert_version_matches(self, expected_version: str): |
| 54 | + """Check if the installed version matches the expected version. |
| 55 | +
|
| 56 | + Args: |
| 57 | + expected_version: Expected version string to verify against |
| 58 | +
|
| 59 | + Raises: |
| 60 | + AssertionError: If the installed version does not match the expected version |
| 61 | + """ |
| 62 | + installed_version = self.get_installed_version() |
| 63 | + assert installed_version == expected_version, f"Expected version {expected_version}, but found {installed_version}" |
| 64 | + |
| 65 | + def check_upgrade_path(self, pg_version): |
| 66 | + """Test the complete upgrade path for a PostgreSQL version. |
| 67 | +
|
| 68 | + This method tests all available extension versions for a given PostgreSQL |
| 69 | + version, either through in-place upgrades or reinstallation depending on |
| 70 | + the support_upgrade setting. |
| 71 | +
|
| 72 | + Args: |
| 73 | + pg_version: PostgreSQL version to test (e.g., "14", "15") |
| 74 | +
|
| 75 | + Raises: |
| 76 | + ValueError: If no versions are available for the specified PostgreSQL version |
| 77 | + AssertionError: If version installation or upgrade fails |
| 78 | + """ |
| 79 | + available_versions = self.versions.get(pg_version, []) |
| 80 | + if not available_versions: |
| 81 | + raise ValueError(f"No versions available for PostgreSQL version {pg_version}") |
| 82 | + |
| 83 | + # Install and verify first version |
| 84 | + firstVersion = available_versions[0] |
| 85 | + self.drop_extension() |
| 86 | + self.install_extension(firstVersion) |
| 87 | + |
| 88 | + # Test remaining versions |
| 89 | + for version in available_versions[1:]: |
| 90 | + if self.support_upgrade: |
| 91 | + self.update_extension(version) |
| 92 | + else: |
| 93 | + self.drop_extension() |
| 94 | + self.install_extension(version) |
| 95 | + |
| 96 | + |
| 97 | + def check_install_last_version(self, pg_version: str) -> str: |
| 98 | + """Test if the install of the last version of the extension works for a given PostgreSQL version. |
| 99 | +
|
| 100 | + Args: |
| 101 | + pg_version: PostgreSQL version to check (e.g., "14", "15") |
| 102 | + """ |
| 103 | + available_versions = self.versions.get(pg_version, []) |
| 104 | + if not available_versions: |
| 105 | + raise ValueError(f"No versions available for PostgreSQL version {pg_version}") |
| 106 | + last_version = available_versions[-1] |
| 107 | + self.drop_extension() |
| 108 | + self.install_extension(last_version) |
| 109 | + return last_version |
0 commit comments