test_versioned_template_loader.py

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2025, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################

import os

from flask import Flask
from jinja2 import FileSystemLoader
from jinja2 import TemplateNotFound

from pgadmin import VersionedTemplateLoader
from pgadmin.utils.route import BaseTestGenerator

TEST_FILE_NAME = "some_action.sql"


class TestVersionedTemplateLoader(BaseTestGenerator):
    scenarios = [
        (
            "Render a template when called",
            dict(scenario=1)
        ),
        (
            "Render a version 11 template when it is present",
            dict(scenario=2)
        ),
        (
            "Render a version 12 template when request for a higher version",
            dict(scenario=3)
        ),
        (
            "Render default version when version 10 was requested and only "
            "11 and 12 are present",
            dict(scenario=4)
        ),
        (
            "Raise error when version is smaller than available templates",
            dict(scenario=5)
        ),
    ]

    def setUp(self):
        self.loader = VersionedTemplateLoader(FakeApp())

    def runTest(self):
        if self.scenario == 1:
            self.test_get_source_returns_a_template()
        if self.scenario == 2:
            # test_get_source_when_the_version_is_11_returns_11_template
            self.test_get_source_when_the_version_is_11()
        if self.scenario == 3:
            # test_get_source_when_the_version_is_13_and_there_are_templates_
            # for_12_and_11_returns_12_template
            self.test_get_source_when_the_version_is_13()
        if self.scenario == 4:
            # test_get_source_when_the_version_is_10_and_there_are_templates_
            # for_11_and_12_returns_default_template
            self.test_get_source_when_the_version_is_10()
        if self.scenario == 5:
            # test_raise_not_found_exception_when_postgres_version_less_than_
            # all_available_sql_templates
            self.test_raise_not_found_exception()

    def test_get_source_returns_a_template(self):
        expected_content = "Some SQL" \
                           "\nsome more stuff on a new line\n"
        # For cross-platform we join the SQL path
        # (This solves the slashes issue)
        sql_path = os.path.join(
            "some_feature", "sql", "11_plus", TEST_FILE_NAME
        )
        content, filename, up_to_dateness = self.loader.get_source(
            None, "some_feature/sql/11_plus/some_action.sql"
        )
        self.assertEqual(
            expected_content, str(content).replace("\r", "")
        )
        self.assertIn(sql_path, filename)

    def test_get_source_when_the_version_is_11(self):
        """Render a version 11 template when it is present"""
        expected_content = "Some SQL" \
                           "\nsome more stuff on a new line\n"
        # For cross-platform we join the SQL path
        # (This solves the slashes issue)
        sql_path = os.path.join(
            "some_feature", "sql", "11_plus", TEST_FILE_NAME
        )
        content, filename, up_to_dateness = self.loader.get_source(
            None, "some_feature/sql/#110000#/some_action.sql"
        )

        self.assertEqual(
            expected_content, str(content).replace("\r", "")
        )
        self.assertIn(sql_path, filename)

    def test_get_source_when_the_version_is_13(self):
        """Render a version 12 template when request for a higher version"""
        # For cross-platform we join the SQL path
        # (This solves the slashes issue)
        sql_path = os.path.join(
            "some_feature", "sql", "12_plus", TEST_FILE_NAME
        )
        content, filename, up_to_dateness = self.loader.get_source(
            None, "some_feature/sql/#130000#/some_action.sql"
        )

        self.assertEqual(
            "Some 12 SQL\n", str(content).replace("\r", "")
        )
        self.assertIn(sql_path, filename)

    def test_get_source_when_the_version_is_10(self):
        """Render default version when version 10 was requested and only
        11 and 12 are present"""

        # For cross-platform we join the SQL path
        # (This solves the slashes issue)
        sql_path = os.path.join("some_feature", "sql",
                                "default", "some_action_with_default.sql")
        content, filename, up_to_dateness = self.loader.get_source(
            None,
            "some_feature/sql/#100000#/some_action_with_default.sql")

        self.assertEqual("Some default SQL", str(content).replace("\r", ""))
        self.assertIn(sql_path, filename)

    def test_raise_not_found_exception(self):
        """Raise error when version is smaller than available templates"""
        try:
            self.loader.get_source(
                None, "some_feature/sql/#10100#/some_action.sql"
            )
            self.fail("No exception raised")
        except TemplateNotFound:
            return


class FakeApp(Flask):
    def __init__(self):
        super().__init__("")
        self.jinja_loader = FileSystemLoader(
            os.path.dirname(os.path.realpath(__file__)) + "/templates"
        )