From 01f28131a22763c2ffa186ef820e0acb19de28bb Mon Sep 17 00:00:00 2001 From: "d.kovalenko" Date: Sun, 15 Nov 2026 22:09:30 +0300 Subject: [PATCH] A support of 'include_if_exists' directive is added --- src/__init__.py | 19 + src/abstract/v00/configuration.py | 54 +++ src/core/bugcheck_error.py | 18 + src/core/model.py | 35 ++ src/core/model_utils.py | 133 +++++- src/core/raise_error.py | 18 + src/implementation/v00/configuration_base.py | 331 +++++++++++++++ .../v00/configuration_base_r.py | 109 ++++- .../v00/configuration_base_w.py | 27 ++ src/os/abstract/configuration_os_ops.py | 4 + src/os/local/configuration_os_ops.py | 4 + tests/ErrorMessageBuilder.py | 12 + .../core/raise_error/test_for__RaiseError.py | 11 + .../Mix/test_set002__real_work.py | 73 +++- .../AddInclude/test_set001__common.py | 51 ++- .../AddIncludeIfExists/__init__.py | 0 .../AddIncludeIfExists/test_set001__common.py | 383 ++++++++++++++++++ .../Clear/test_set001__common.py | 50 +++ .../Delete/__init__.py | 0 .../Delete/test_set001__common.py | 255 ++++++++++++ .../__init__.py | 0 .../test_set001__common.py | 48 ++- .../test_set001__common.py | 178 ++++++++ .../AddIncludeIfExists/__init__.py | 0 .../AddIncludeIfExists/test_set001__common.py | 284 +++++++++++++ .../DoWork/test_set001__work.py | 39 +- .../test_set001__common.py | 158 ++++++++ .../v00/configuration_std/conftest.py | 21 + 28 files changed, 2302 insertions(+), 13 deletions(-) create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/__init__.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/test_set001__common.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/__init__.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/test_set001__common.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/__init__.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/__init__.py create mode 100644 tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/test_set001__common.py diff --git a/src/__init__.py b/src/__init__.py index 5c0bac8..09f836d 100644 --- a/src/__init__.py +++ b/src/__init__.py @@ -7,6 +7,16 @@ from .implementation.v00.configuration_std import PostgresConfigurationReader_Std as PostgresConfigurationReader from .implementation.v00.configuration_std import PostgresConfigurationWriter_Std as PostgresConfigurationWriter + +from .abstract.v00.configuration import PostgresConfigurationOption +from .abstract.v00.configuration import PostgresConfigurationInclude +from .abstract.v00.configuration import PostgresConfigurationIncludeIfExists +from .abstract.v00.configuration import PostgresConfigurationComment +from .abstract.v00.configuration import PostgresConfigurationOptions +from .abstract.v00.configuration import PostgresConfigurationFiles +from .abstract.v00.configuration import AddIncludeIfExistsRule +from .abstract.v00.configuration import PostgresConfigurationSetOptionValueResult +from .abstract.v00.configuration import PostgresConfigurationSetOptionValueEventID # fmt: on # ////////////////////////////////////////////////////////////////////////////// @@ -16,6 +26,15 @@ "PostgresConfiguration", "PostgresConfigurationReader", "PostgresConfigurationWriter", + "PostgresConfigurationOption", + "PostgresConfigurationInclude", + "PostgresConfigurationIncludeIfExists", + "PostgresConfigurationComment", + "PostgresConfigurationOptions", + "PostgresConfigurationFiles", + "AddIncludeIfExistsRule", + "PostgresConfigurationSetOptionValueResult", + "PostgresConfigurationSetOptionValueEventID", ] diff --git a/src/abstract/v00/configuration.py b/src/abstract/v00/configuration.py index 1b6ddd8..7499221 100644 --- a/src/abstract/v00/configuration.py +++ b/src/abstract/v00/configuration.py @@ -8,6 +8,15 @@ import typing import enum +# ////////////////////////////////////////////////////////////////////////////// +# AddIncludeIfExistsRule + + +class AddIncludeIfExistsRule(enum.Enum): + without_file = 0 + with_file = 1 + + # ////////////////////////////////////////////////////////////////////////////// # class PostgresConfigurationObject @@ -174,6 +183,27 @@ def Delete( RaiseError.MethodIsNotImplemented(__class__, "Delete") +# ////////////////////////////////////////////////////////////////////////////// +# class PostgresConfigurationIncludeIfExists + + +class PostgresConfigurationIncludeIfExists(PostgresConfigurationElement): + def __init__(self): + super().__init__() + + # interface ---------------------------------------------------------- + def get_File(self) -> typing.Optional[PostgresConfigurationFile]: + RaiseError.MethodIsNotImplemented(__class__, "get_File") + + # -------------------------------------------------------------------- + def Delete( + self, + withLine: bool, + ) -> None: + assert type(withLine) is bool + RaiseError.MethodIsNotImplemented(__class__, "Delete") + + # ////////////////////////////////////////////////////////////////////////////// # class PostgresConfigurationFileLine @@ -220,6 +250,19 @@ def AddInclude( assert (offset is None) or (type(offset) is int) RaiseError.MethodIsNotImplemented(__class__, "AddInclude") + # -------------------------------------------------------------------- + def AddIncludeIfExists( + self, + path: str, + offset: typing.Optional[int], + rule: AddIncludeIfExistsRule, + ) -> PostgresConfigurationIncludeIfExists: + assert type(path) is str + assert path != "" + assert (offset is None) or (type(offset) is int) + assert type(rule) is AddIncludeIfExistsRule + RaiseError.MethodIsNotImplemented(__class__, "AddIncludeIfExists") + # -------------------------------------------------------------------- def Clear(self) -> None: RaiseError.MethodIsNotImplemented(__class__, "Clear") @@ -313,6 +356,17 @@ def AddInclude( assert path != "" RaiseError.MethodIsNotImplemented(__class__, "AddInclude") + # -------------------------------------------------------------------- + def AddIncludeIfExists( + self, + path: str, + rule: AddIncludeIfExistsRule, + ) -> PostgresConfigurationIncludeIfExists: + assert type(path) is str + assert path != "" + assert type(rule) is AddIncludeIfExistsRule + RaiseError.MethodIsNotImplemented(__class__, "AddIncludeIfExists") + # -------------------------------------------------------------------- # # Method for inserting, updating and deleting of an option. diff --git a/src/core/bugcheck_error.py b/src/core/bugcheck_error.py index c6c408d..d1e42b8 100644 --- a/src/core/bugcheck_error.py +++ b/src/core/bugcheck_error.py @@ -153,6 +153,12 @@ def IncludeIsNotFoundInFileLine() -> typing.NoReturn: errMsg = "Include is not found in file line." __class__.Helper__Raise(errMsg) + # -------------------------------------------------------------------- + @staticmethod + def IncludeIfExistsIsNotFoundInFileLine() -> typing.NoReturn: + errMsg = "IncludeIfExists is not found in file line." + __class__.Helper__Raise(errMsg) + # -------------------------------------------------------------------- @staticmethod def FileLineIsNotFoundInFile() -> typing.NoReturn: @@ -296,6 +302,18 @@ def UnknownOptionValueType( __class__.Helper__Raise(errMsg) + # -------------------------------------------------------------------- + @staticmethod + def UnknownAddIncludeIfExistsRule( + value: typing.AnyStr, + ) -> typing.NoReturn: + + errMsg = "Unknown AddIncludeIfExistsRule: {}.".format( + value, + ) + + __class__.Helper__Raise(errMsg) + # -------------------------------------------------------------------- @staticmethod def UnsupportedPgConfStrategy( diff --git a/src/core/model.py b/src/core/model.py index 155d04e..ebfc571 100644 --- a/src/core/model.py +++ b/src/core/model.py @@ -155,6 +155,41 @@ def __init__( return +# ////////////////////////////////////////////////////////////////////////////// +# IncludeIfExistsData + + +class IncludeIfExistsData(FileLineElementData): + m_Path: str + m_File: typing.Optional[FileData] + + # -------------------------------------------------------------------- + def __init__( + self, + parent: FileLineData, + offset: typing.Optional[int], + path: str, + fileData: typing.Optional[FileData], + ): + assert type(parent) is FileLineData + assert type(path) is str + assert fileData is None or type(fileData) is FileData + assert offset is None or type(offset) is int + + assert parent.IsAlive() + + if fileData is not None: + assert fileData.IsAlive() + assert fileData.get_Parent() is parent.get_Parent().get_Parent() + pass + + super().__init__(parent, offset) + + self.m_Path = path + self.m_File = fileData + return + + # ////////////////////////////////////////////////////////////////////////////// # FileLineData diff --git a/src/core/model_utils.py b/src/core/model_utils.py index 22c806c..40fc070 100644 --- a/src/core/model_utils.py +++ b/src/core/model_utils.py @@ -10,6 +10,7 @@ from .model import CommentData as PgCfgModel__CommentData from .model import OptionData as PgCfgModel__OptionData from .model import IncludeData as PgCfgModel__IncludeData +from .model import IncludeIfExistsData as PgCfgModel__IncludeIfExistsData from .model import FileLineData as PgCfgModel__FileLineData from .model import FileData as PgCfgModel__FileData from .model import MultiIndex as PgCfgModel__MultiIndex @@ -110,6 +111,31 @@ def Include__delete( __class__.Helper__DeleteFileLine(cfgData, fileLineData) return + # -------------------------------------------------------------------- + @staticmethod + def IncludeIfExists__delete( + cfgData: PgCfgModel__ConfigurationData, + includeIfExistsData: PgCfgModel__IncludeIfExistsData, + withLine: bool, + ) -> None: + assert type(cfgData) is PgCfgModel__ConfigurationData + assert type(includeIfExistsData) is PgCfgModel__IncludeIfExistsData + assert type(withLine) is bool + + fileLineData = includeIfExistsData.m_Parent + assert fileLineData is not None + assert type(fileLineData) is PgCfgModel__FileLineData + + __class__.Helper__DeleteIncludeIfExists(includeIfExistsData) + + if not withLine: + return + + assert not __class__.Helper__FileLineHasWorkData(fileLineData) + + __class__.Helper__DeleteFileLine(cfgData, fileLineData) + return + # -------------------------------------------------------------------- @staticmethod def Comment__delete( @@ -193,6 +219,9 @@ def Helper__CheckThatWeCanAddCommentToFileLine( if type(lastItem.m_Element) is PgCfgModel__IncludeData: return + if type(lastItem.m_Element) is PgCfgModel__IncludeIfExistsData: + return + if type(lastItem.m_Element) is PgCfgModel__CommentData: RaiseError.FileLineAlreadyHasComment() @@ -230,7 +259,39 @@ def FileLine__add_Include( fileLineDataItem, ) - # TODO: Reg include data in a global index? + return includeData + + # -------------------------------------------------------------------- + @staticmethod + def FileLine__add_IncludeIfExists( + fileLineData: PgCfgModel__FileLineData, + filePath: str, + fileData: typing.Optional[PgCfgModel__FileData], + offset: typing.Optional[int], + ) -> PgCfgModel__IncludeIfExistsData: + assert type(fileLineData) is PgCfgModel__FileLineData + assert type(filePath) is str + assert fileData is None or type(fileData) is PgCfgModel__FileData + assert filePath != "" + assert offset is None or type(offset) is int + + assert fileLineData.IsAlive() + assert fileData is None or fileData.IsAlive() + + __class__.Helper__CheckThatWeCanAddWorkDataToFileLine(fileLineData) + + includeData = PgCfgModel__IncludeIfExistsData( + fileLineData, + offset, + filePath, + fileData, + ) + fileLineDataItem = PgCfgModel__FileLineData.tagItem( + includeData, + ) + fileLineData.m_Items.append( + fileLineDataItem, + ) return includeData @@ -325,6 +386,9 @@ def Helper__CheckThatWeCanAddWorkDataToFileLine( if type(lastItem.m_Element) is PgCfgModel__IncludeData: RaiseError.FileLineAlreadyHasIncludeDirective() + if type(lastItem.m_Element) is PgCfgModel__IncludeIfExistsData: + RaiseError.FileLineAlreadyHasIncludeIfExistsDirective() + if type(lastItem.m_Element) is PgCfgModel__CommentData: RaiseError.FileLineAlreadyHasComment() @@ -463,6 +527,27 @@ def File__FindSimpleOption( return firstItem.m_Element # <--------- BINGO if type(firstItem.m_Element) is PgCfgModel__IncludeData: + assert firstItem.m_Element.m_File is not None + assert type(firstItem.m_Element.m_File.m_Path) is str + + if not enterIntoIncludes: + # Stop searching upwards: any option defined above an include + # might be overridden by that included file. + return None # <--------- FAIL + + assert findCtx is not None + if not findCtx.reg_file(firstItem.m_Element.m_File.m_Path): + continue + + nextFile = firstItem.m_Element.m_File + break + + if type(firstItem.m_Element) is PgCfgModel__IncludeIfExistsData: + if firstItem.m_Element.m_File is None: + continue + + assert type(firstItem.m_Element.m_File.m_Path) is str + if not enterIntoIncludes: # Stop searching upwards: any option defined above an include # might be overridden by that included file. @@ -1036,6 +1121,9 @@ def Helper__DeleteElement( if type(objectData) is PgCfgModel__IncludeData: return __class__.Helper__DeleteInclude(objectData) + if type(objectData) is PgCfgModel__IncludeIfExistsData: + return __class__.Helper__DeleteIncludeIfExists(objectData) + BugCheckError.UnkObjectDataType(type(objectData)) # -------------------------------------------------------------------- @@ -1195,6 +1283,49 @@ def Helper__DeleteInclude( fileLineData.m_Items.pop(iFileLineItem) return + # -------------------------------------------------------------------- + @staticmethod + def Helper__DeleteIncludeIfExists( + includeIfExistsData: PgCfgModel__IncludeIfExistsData, + ) -> None: + assert type(includeIfExistsData) is PgCfgModel__IncludeIfExistsData + assert includeIfExistsData.IsAlive() + + # 0. + fileLineData = None + iFileLineItem = None + + # 1.1 Set fileLineData + fileLineData = includeIfExistsData.m_Parent + assert fileLineData is not None + assert type(fileLineData) is PgCfgModel__FileLineData + assert fileLineData.IsAlive() + + # 1.2 Set iFileLineItem + iFileLineItem = __class__.Helper__FindIndexOfFileLineElement( + fileLineData, + includeIfExistsData, + ) + + assert iFileLineItem >= 0 + assert iFileLineItem <= len(fileLineData.m_Items) + + if iFileLineItem == len(fileLineData.m_Items): + BugCheckError.IncludeIfExistsIsNotFoundInFileLine() + + assert iFileLineItem >= 0 + assert iFileLineItem < len(fileLineData.m_Items) + assert fileLineData.m_Items[iFileLineItem] is not None + assert fileLineData.m_Items[iFileLineItem].m_Element is includeIfExistsData + + # 2. Perform delete operations + + # delete from fileLine + includeIfExistsData.MarkAsDeletedFrom(fileLineData) + assert not includeIfExistsData.IsAlive() + fileLineData.m_Items.pop(iFileLineItem) + return + # -------------------------------------------------------------------- @staticmethod def Helper__DeleteFileLine( diff --git a/src/core/raise_error.py b/src/core/raise_error.py index 08de330..a0d37c8 100644 --- a/src/core/raise_error.py +++ b/src/core/raise_error.py @@ -128,6 +128,15 @@ def IncludeObjectWasDeleted() -> typing.NoReturn: errMsg, ) + # -------------------------------------------------------------------- + @staticmethod + def IncludeIfExistsObjectWasDeleted() -> typing.NoReturn: + errMsg = "IncludeIfExists object was deleted." + + __class__.Helper__RaiseErr__PostgresConfigException( + errMsg, + ) + # -------------------------------------------------------------------- @staticmethod def FileLineObjectWasDeleted() -> typing.NoReturn: @@ -384,6 +393,15 @@ def FileLineAlreadyHasIncludeDirective() -> typing.NoReturn: errMsg, ) + # -------------------------------------------------------------------- + @staticmethod + def FileLineAlreadyHasIncludeIfExistsDirective() -> typing.NoReturn: + errMsg = "File line already has an include_if_exists directive." + + __class__.Helper__RaiseErr__PostgresConfigException( + errMsg, + ) + # -------------------------------------------------------------------- @staticmethod def CfgReader__UnexpectedSymbol( diff --git a/src/implementation/v00/configuration_base.py b/src/implementation/v00/configuration_base.py index 49f3d70..fbcb9e9 100644 --- a/src/implementation/v00/configuration_base.py +++ b/src/implementation/v00/configuration_base.py @@ -11,6 +11,7 @@ from ...abstract.v00.configuration import PostgresConfigurationOptions from ...abstract.v00.configuration import PostgresConfigurationOptionsIterator from ...abstract.v00.configuration import PostgresConfigurationInclude +from ...abstract.v00.configuration import PostgresConfigurationIncludeIfExists from ...abstract.v00.configuration import PostgresConfigurationFileLine from ...abstract.v00.configuration import PostgresConfigurationFileLines from ...abstract.v00.configuration import PostgresConfigurationFileLinesIterator @@ -19,12 +20,14 @@ from ...abstract.v00.configuration import PostgresConfigurationFilesIterator from ...abstract.v00.configuration import PostgresConfigurationSetOptionValueEventID from ...abstract.v00.configuration import PostgresConfigurationSetOptionValueResult +from ...abstract.v00.configuration import AddIncludeIfExistsRule from ...core.model import ConfigurationData as PgCfgModel__ConfigurationData from ...core.model import ObjectData as PgCfgModel__ObjectData from ...core.model import CommentData as PgCfgModel__CommentData from ...core.model import OptionData as PgCfgModel__OptionData from ...core.model import IncludeData as PgCfgModel__IncludeData +from ...core.model import IncludeIfExistsData as PgCfgModel__IncludeIfExistsData from ...core.model import FileLineData as PgCfgModel__FileLineData from ...core.model import FileData as PgCfgModel__FileData from ...core.model import MultiIndex as PgCfgModel__MultiIndex @@ -358,6 +361,99 @@ def Helper__CheckAlive(self) -> None: return +# ////////////////////////////////////////////////////////////////////////////// +# class PostgresConfigurationIncludeIfExists_Base + + +class PostgresConfigurationIncludeIfExists_Base(PostgresConfigurationIncludeIfExists): + m_FileLine: PostgresConfigurationFileLine_Base + m_IncludeIfExistsData: PgCfgModel__IncludeIfExistsData + + # -------------------------------------------------------------------- + def __init__( + self, + fileLine: PostgresConfigurationFileLine_Base, + includeIfExistsData: PgCfgModel__IncludeIfExistsData, + ): + assert type(fileLine) is PostgresConfigurationFileLine_Base + assert type(includeIfExistsData) is PgCfgModel__IncludeIfExistsData + + super().__init__() + + self.m_FileLine = fileLine + self.m_IncludeIfExistsData = includeIfExistsData + return + + # Object interface --------------------------------------------------- + def get_Configuration(self) -> PostgresConfiguration_Base: + self.Helper__CheckAlive() + return self.m_FileLine.get_Configuration() + + # -------------------------------------------------------------------- + def get_Parent(self) -> PostgresConfigurationFileLine_Base: + self.Helper__CheckAlive() + return self.m_FileLine + + # IncludeIfExists interface ------------------------------------------ + def get_File( + self, + ) -> typing.Optional[PostgresConfigurationIncludedIfExistsFile_Base]: + self.Helper__CheckAlive() + + if self.m_IncludeIfExistsData.m_File is None: + return None + + return PostgresConfigurationIncludedIfExistsFile_Base( + self, + self.m_IncludeIfExistsData.m_File, + ) + + # -------------------------------------------------------------------- + def Delete( + self, + withLine: bool, + ) -> None: + assert type(withLine) is bool + + self.Helper__CheckAlive() + assert type(self.m_IncludeIfExistsData) is PgCfgModel__IncludeIfExistsData + assert type(self.m_IncludeIfExistsData.m_Parent) is PgCfgModel__FileLineData + assert ( + type(self.m_IncludeIfExistsData.m_Parent.m_Parent) is PgCfgModel__FileData + ) + assert ( + type(self.m_IncludeIfExistsData.m_Parent.m_Parent.m_Parent) + is PgCfgModel__ConfigurationData + ) + + cfgData = self.m_IncludeIfExistsData.m_Parent.m_Parent.m_Parent + assert type(cfgData) is PgCfgModel__ConfigurationData + + PgCfgModel__ModelUtils.IncludeIfExists__delete( + cfgData, + self.m_IncludeIfExistsData, + withLine, + ) + return + + # Private interface -------------------------------------------------- + def Private__CheckAlive(self) -> None: + self.Helper__CheckAlive() + return + + # Helper methods ----------------------------------------------------- + def Helper__CheckAlive(self) -> None: + assert self.m_IncludeIfExistsData is not None + assert type(self.m_IncludeIfExistsData) is PgCfgModel__IncludeIfExistsData + + if not self.m_IncludeIfExistsData.IsAlive(): + RaiseError.IncludeIfExistsObjectWasDeleted() + + assert type(self.m_FileLine) is PostgresConfigurationFileLine_Base + assert isinstance(self.m_FileLine, PostgresConfigurationFileLine) + return + + # ////////////////////////////////////////////////////////////////////////////// # class PostgresConfigurationFileLine_Base @@ -566,6 +662,90 @@ def AddInclude( return include + # -------------------------------------------------------------------- + def AddIncludeIfExists( + self, + path: str, + offset: typing.Optional[int], + rule: AddIncludeIfExistsRule, + ) -> PostgresConfigurationIncludeIfExists_Base: + assert offset is None or type(offset) is int + assert offset is None or offset >= 0 + assert type(rule) is AddIncludeIfExistsRule + + DataVerificator.CheckStringOfFilePath(path) + + assert type(path) is str + assert path != "" + + self.Helper__CheckAlive() + + assert isinstance(self.m_Parent, PostgresConfigurationFile_Base) + + cfg = self.m_Parent.m_Cfg + assert isinstance(cfg, PostgresConfiguration_Base) + assert type(cfg.m_Data) is PgCfgModel__ConfigurationData + + # Add/Get file + # Add include element + + if rule == AddIncludeIfExistsRule.without_file: + withFile = False + elif rule == AddIncludeIfExistsRule.with_file: + withFile = True + else: + BugCheckError.UnknownAddIncludeIfExistsRule(rule) + + if not withFile: + fileData = None + else: + assert self.m_FileLineData.m_Parent is not None + + baseFolder = cfg.m_Data.OsOps.Path_DirName( + self.m_FileLineData.m_Parent.m_Path, + ) + assert type(baseFolder) is str + + fileData = PgCfgModel__ModelUtils.Cfg__GetOrCreateFile__USER( + cfg.m_Data, + baseFolder, + path, + ) + assert type(fileData) is PgCfgModel__FileData + + try: + includeData = PgCfgModel__ModelUtils.FileLine__add_IncludeIfExists( + self.m_FileLineData, + path, + fileData, + offset, + ) + assert includeData is not None + assert type(includeData) is PgCfgModel__IncludeIfExistsData + assert includeData.m_Path == path + assert includeData.m_File is fileData + assert includeData.m_Parent == self.m_FileLineData + + try: + # ----------- + include = PostgresConfigurationIncludeIfExists_Base( + self, + includeData, + ) + assert include.m_FileLine is self + assert include.m_IncludeIfExistsData is includeData + except: # rollback an include + PgCfgModel__ModelUtils.IncludeIfExists__delete( + cfg.m_Data, + includeData, + False, + ) + raise + except: # TODO: rollback a file + raise + + return include + # -------------------------------------------------------------------- def Clear(self) -> None: self.Helper__CheckAlive() @@ -1005,6 +1185,103 @@ def AddInclude( return include + # -------------------------------------------------------------------- + def AddIncludeIfExists( + self, + path: str, + rule: AddIncludeIfExistsRule, + ) -> PostgresConfigurationIncludeIfExists_Base: + DataVerificator.CheckStringOfFilePath(path) + + assert type(path) is str + assert path != "" + assert type(rule) is AddIncludeIfExistsRule + + self.Internal__CheckAlive() + + assert self.m_Cfg is not None + assert isinstance(self.m_Cfg, PostgresConfiguration_Base) + assert type(self.m_Cfg.m_Data) is PgCfgModel__ConfigurationData + + # Add/Get file + # Add empty line + # Add include element + + if rule == AddIncludeIfExistsRule.without_file: + withFile = False + elif rule == AddIncludeIfExistsRule.with_file: + withFile = True + else: + BugCheckError.UnknownAddIncludeIfExistsRule(rule) + + if not withFile: + fileData = None + else: + baseFolder = self.m_Cfg.m_Data.OsOps.Path_DirName( + self.m_FileData.m_Path, + ) + assert type(baseFolder) is str + + fileData = PgCfgModel__ModelUtils.Cfg__GetOrCreateFile__USER( + self.m_Cfg.m_Data, + baseFolder, + path, + ) + assert type(fileData) is PgCfgModel__FileData + + try: + fileLineData = PgCfgModel__ModelUtils.File__add_Line( + self.m_FileData, + ) + + assert self.m_FileData is not None + assert type(self.m_FileData) is PgCfgModel__FileData + assert self.m_FileData.m_Lines is not None + assert type(self.m_FileData.m_Lines) is list + assert len(self.m_FileData.m_Lines) > 0 + assert self.m_FileData.m_Lines[-1] is fileLineData + + try: + includeData = PgCfgModel__ModelUtils.FileLine__add_IncludeIfExists( + fileLineData, + path, + fileData, + None, + ) + assert includeData is not None + assert type(includeData) is PgCfgModel__IncludeIfExistsData + assert includeData.m_Path == path + assert includeData.m_File is fileData + assert includeData.m_Parent == fileLineData + + # ----------- + fileLine = PostgresConfigurationFileLine_Base( + self, + fileLineData, + ) + assert fileLine is not None + assert type(fileLine) is PostgresConfigurationFileLine_Base + assert fileLine.m_FileLineData is fileLineData + assert fileLine.m_Parent is self + + # ----------- + include = PostgresConfigurationIncludeIfExists_Base( + fileLine, + includeData, + ) + assert include.m_FileLine is fileLine + assert include.m_IncludeIfExistsData is includeData + except: # rollback a line + PgCfgModel__ModelUtils.FileLine__delete( + self.m_Cfg.m_Data, + fileLineData, + ) + raise + except: # TODO: rollback a file + raise + + return include + # -------------------------------------------------------------------- # # Method for inserting, updating and deleting of an option. @@ -1185,6 +1462,60 @@ def Internal__CheckAlive(self) -> None: return +# ////////////////////////////////////////////////////////////////////////////// +# class PostgresConfigurationIncludedIfExistsFile_Base + + +class PostgresConfigurationIncludedIfExistsFile_Base(PostgresConfigurationFile_Base): + m_IncludeIfExists: PostgresConfigurationIncludeIfExists_Base + + # -------------------------------------------------------------------- + def __init__( + self, + include: PostgresConfigurationIncludeIfExists_Base, + fileData: PgCfgModel__FileData, + ): + assert type(include) is PostgresConfigurationIncludeIfExists_Base + assert type(fileData) is PgCfgModel__FileData + + super().__init__( + include.get_Configuration(), + fileData, + ) + + self.m_IncludeIfExists = include + return + + # Object interface --------------------------------------------------- + def get_Parent(self) -> PostgresConfigurationIncludeIfExists_Base: + self.Internal__CheckAlive() + assert isinstance( + self.m_IncludeIfExists, + PostgresConfigurationIncludeIfExists_Base, + ) + assert isinstance( + self.m_IncludeIfExists, + PostgresConfigurationIncludeIfExists, + ) + return self.m_IncludeIfExists + + # Internal interface ------------------------------------------------- + def Internal__CheckAlive(self) -> None: + assert self.m_FileData is not None + assert self.m_IncludeIfExists is not None + assert type(self.m_FileData) is PgCfgModel__FileData + assert type(self.m_IncludeIfExists) is PostgresConfigurationIncludeIfExists_Base + + if not self.m_FileData.IsAlive(): + RaiseError.FileObjectWasDeleted() + + self.m_IncludeIfExists.Private__CheckAlive() + + assert isinstance(self.m_Cfg, PostgresConfiguration_Base) + assert isinstance(self.m_Cfg, PostgresConfiguration) + return + + # ////////////////////////////////////////////////////////////////////////////// # class PostgresConfigurationSetOptionValueResult_Base diff --git a/src/implementation/v00/configuration_base_r.py b/src/implementation/v00/configuration_base_r.py index d71a42c..1a274c7 100644 --- a/src/implementation/v00/configuration_base_r.py +++ b/src/implementation/v00/configuration_base_r.py @@ -9,10 +9,12 @@ from .configuration_base import PostgresConfigurationFile_Base from .configuration_base import PostgresConfigurationTopLevelFile_Base from .configuration_base import PostgresConfigurationFactory_Base +from .configuration_base import AddIncludeIfExistsRule from ...core.model import CommentData as PgCfgModel__CommentData from ...core.model import OptionData as PgCfgModel__OptionData from ...core.model import IncludeData as PgCfgModel__IncludeData +from ...core.model import IncludeIfExistsData as PgCfgModel__IncludeIfExistsData from ...core.model import FileLineData as PgCfgModel__FileLineData from ...core.model import FileData as PgCfgModel__FileData from ...core.model import FileStatus as PgCfgModel__FileStatus @@ -148,6 +150,33 @@ def LoadConfigurationFile( queuedFileDatas.add(includeData.m_File) continue + if type(fileLineElementData) is PgCfgModel__IncludeIfExistsData: + # look at existFileDatas + includeIfExistsData = fileLineElementData + + if includeIfExistsData.m_File is None: + continue + + assert type(includeIfExistsData.m_File) is PgCfgModel__FileData + assert type(includeIfExistsData.m_File.m_Path) is str + + if includeIfExistsData.m_File.m_Path in existFileDatas: + continue # it is an old file + + assert ( + includeIfExistsData.m_File.m_Status + == PgCfgModel__FileStatus.IS_NEW + ) + assert ( + includeIfExistsData.m_File.m_LastModifiedTimestamp is None + ) + + if includeIfExistsData.m_File in queuedFileDatas: + continue # already in queue + + queuedFileDatas.add(includeIfExistsData.m_File) + continue + BugCheckError.UnkObjectDataType(type(fileLineElementData)) continue continue # while queuedFileDatas @@ -272,6 +301,17 @@ def Helper__ProcessLineData( ) continue + if sequence.lower() == "include_if_exists": + if ch is not None: + lineReader.StepBack() + + __class__.Helper__ProcessLineData__IncludeIfExists( + fileLine, + lineReader, + sequenceOffset, + ) + continue + if ch is not None: lineReader.StepBack() @@ -333,6 +373,69 @@ def Helper__ProcessLineData__Include( assert type(includeOffset) is int assert includeOffset >= 0 + filePath = __class__.Helper__ProcessFilePath( + fileLine, + lineReader, + ) + + fileLine.AddInclude( + filePath, + includeOffset, + ) + return + + # -------------------------------------------------------------------- + @staticmethod + def Helper__ProcessLineData__IncludeIfExists( + fileLine: PostgresConfigurationFileLine_Base, + lineReader: ReadUtils__LineReader, + includeOffset: int, + ) -> None: + assert type(fileLine) is PostgresConfigurationFileLine_Base + assert type(lineReader) is ReadUtils__LineReader + assert type(includeOffset) is int + assert includeOffset >= 0 + assert fileLine.m_Parent is not None + assert fileLine.m_Parent.m_FileData is not None + assert fileLine.m_Parent.m_FileData.m_Parent is not None + + filePath = __class__.Helper__ProcessFilePath( + fileLine, + lineReader, + ) + + osOps = fileLine.m_Parent.m_FileData.m_Parent.m_OsOps + assert osOps is not None + + normFilePath = Helpers.NormalizeFilePath( + osOps, + osOps.Path_DirName(fileLine.m_Parent.m_FileData.m_Path), + filePath, + ) + assert type(normFilePath) is str + assert normFilePath != "" + + if osOps.Path_IsExists(normFilePath): + rule = AddIncludeIfExistsRule.with_file + else: + rule = AddIncludeIfExistsRule.without_file + + fileLine.AddIncludeIfExists( + filePath, + includeOffset, + rule=rule, + ) + return + + # -------------------------------------------------------------------- + @staticmethod + def Helper__ProcessFilePath( + fileLine: PostgresConfigurationFileLine_Base, + lineReader: ReadUtils__LineReader, + ) -> str: + assert type(fileLine) is PostgresConfigurationFileLine_Base + assert type(lineReader) is ReadUtils__LineReader + # find first quote while True: ch = lineReader.ReadSymbol() @@ -452,11 +555,7 @@ def Helper__ProcessLineData__Include( lineReader.GetLineNum(), ) - fileLine.AddInclude( - filePath, - includeOffset, - ) - return + return filePath # -------------------------------------------------------------------- @staticmethod diff --git a/src/implementation/v00/configuration_base_w.py b/src/implementation/v00/configuration_base_w.py index 39a6369..8650ffd 100644 --- a/src/implementation/v00/configuration_base_w.py +++ b/src/implementation/v00/configuration_base_w.py @@ -11,6 +11,7 @@ from ...core.model import CommentData as PgCfgModel__CommentData from ...core.model import OptionData as PgCfgModel__OptionData from ...core.model import IncludeData as PgCfgModel__IncludeData +from ...core.model import IncludeIfExistsData as PgCfgModel__IncludeIfExistsData from ...core.model import FileLineData as PgCfgModel__FileLineData from ...core.model import FileData as PgCfgModel__FileData from ...core.model import FileStatus as PgCfgModel__FileStatus @@ -475,6 +476,12 @@ def Helper__ElementToString( elementData, ) + if type(elementData) is PgCfgModel__IncludeIfExistsData: + return __class__.Helper__IncludeIfExistsToString( + ctx, + elementData, + ) + BugCheckError.UnkObjectDataType(type(elementData)) # -------------------------------------------------------------------- @@ -552,5 +559,25 @@ def Helper__IncludeToString( assert result != "" return result + # -------------------------------------------------------------------- + @staticmethod + def Helper__IncludeIfExistsToString( + ctx: PostgresConfigurationWriterCtx_Base, + includeIfExistsData: PgCfgModel__IncludeIfExistsData, + ) -> str: + assert type(ctx) is PostgresConfigurationWriterCtx_Base + assert ctx.Cfg is not None + assert isinstance(ctx.Cfg, PostgresConfiguration_Base) + assert type(includeIfExistsData) is PgCfgModel__IncludeIfExistsData + assert includeIfExistsData.m_Path is not None + assert type(includeIfExistsData.m_Path) is str + assert includeIfExistsData.m_Path != "" + + result = "include_if_exists " + WriteUtils.Pack_Str(includeIfExistsData.m_Path) + + assert type(result) is str + assert result != "" + return result + # ////////////////////////////////////////////////////////////////////////////// diff --git a/src/os/abstract/configuration_os_ops.py b/src/os/abstract/configuration_os_ops.py index daf46df..339bddb 100644 --- a/src/os/abstract/configuration_os_ops.py +++ b/src/os/abstract/configuration_os_ops.py @@ -55,6 +55,10 @@ def GetModificationTS(self) -> datetime.datetime: class ConfigurationOsOps: + def Path_IsExists(self, a: str) -> bool: + assert type(a) is str + RaiseError.MethodIsNotImplemented(__class__, "Path_IsExists") + def Path_IsAbs(self, a: str) -> bool: assert type(a) is str RaiseError.MethodIsNotImplemented(__class__, "Path_IsAbs") diff --git a/src/os/local/configuration_os_ops.py b/src/os/local/configuration_os_ops.py index ce32067..50a96d6 100644 --- a/src/os/local/configuration_os_ops.py +++ b/src/os/local/configuration_os_ops.py @@ -97,6 +97,10 @@ def GetModificationTS(self) -> datetime.datetime: class ConfigurationOsOps(abstract.ConfigurationOsOps): + def Path_IsExists(self, a: str) -> bool: + assert type(a) is str + return os.path.exists(a) + def Path_IsAbs(self, a: str) -> bool: assert type(a) is str return os.path.isabs(a) diff --git a/tests/ErrorMessageBuilder.py b/tests/ErrorMessageBuilder.py index 7795c18..316770c 100644 --- a/tests/ErrorMessageBuilder.py +++ b/tests/ErrorMessageBuilder.py @@ -101,6 +101,12 @@ def IncludeObjectWasDeleted() -> str: errMsg = "Include object was deleted." return errMsg + # -------------------------------------------------------------------- + @staticmethod + def IncludeIfExistsObjectWasDeleted() -> str: + errMsg = "IncludeIfExists object was deleted." + return errMsg + # -------------------------------------------------------------------- @staticmethod def FileLineObjectWasDeleted() -> str: @@ -309,6 +315,12 @@ def FileLineAlreadyHasIncludeDirective() -> str: errMsg = "File line already has an include directive." return errMsg + # -------------------------------------------------------------------- + @staticmethod + def FileLineAlreadyHasIncludeIfExistsDirective() -> str: + errMsg = "File line already has an include_if_exists directive." + return errMsg + # -------------------------------------------------------------------- @staticmethod def CfgReader__UnexpectedSymbol( diff --git a/tests/core/raise_error/test_for__RaiseError.py b/tests/core/raise_error/test_for__RaiseError.py index 6b5cf20..629264c 100644 --- a/tests/core/raise_error/test_for__RaiseError.py +++ b/tests/core/raise_error/test_for__RaiseError.py @@ -397,6 +397,17 @@ def test_FileLineAlreadyHasIncludeDirective(self): assert str(x.value) == ErrorMessageBuilder.FileLineAlreadyHasIncludeDirective() return + # -------------------------------------------------------------------- + def test_FileLineAlreadyHasIncludeIfExistsDirective(self): + with pytest.raises(PostgresConfigException) as x: + RaiseError.FileLineAlreadyHasIncludeIfExistsDirective() + + assert ( + str(x.value) + == ErrorMessageBuilder.FileLineAlreadyHasIncludeIfExistsDirective() + ) + return + # -------------------------------------------------------------------- def test_CfgReader__UnexpectedSymbol(self): with pytest.raises(PostgresConfigException) as x: diff --git a/tests/implementation/v00/configuration_std/Mix/test_set002__real_work.py b/tests/implementation/v00/configuration_std/Mix/test_set002__real_work.py index 82202f8..7393e8d 100644 --- a/tests/implementation/v00/configuration_std/Mix/test_set002__real_work.py +++ b/tests/implementation/v00/configuration_std/Mix/test_set002__real_work.py @@ -7,9 +7,9 @@ from src.implementation.v00.configuration_std import PostgresConfigurationWriterCtx_Base as PgCfg_WriterCtx_Base from src.implementation.v00.configuration_std import PostgresConfigurationWriter_Base as PgCfg_Writer_Base +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg_AddIncludeIfExistsRule from src.implementation.v00.configuration_base import PostgresConfigurationSetOptionValueEventID as PgCfg_SetOptionEventID - from .....TestServices import TestServices # fmt: on @@ -154,5 +154,76 @@ def test_001__modify_and_save_realistic_config__Standard( return + # -------------------------------------------------------------------- + def test_002__integration_and_overrides__Standard( + self, + request: pytest.FixtureRequest, + ): + assert isinstance(request, pytest.FixtureRequest) + + # Author: Mark G. + + rootTmpDir = TestServices.GetCurTestTmpDir(request) + os.makedirs(rootTmpDir, exist_ok=True) + + C_PG_CONF = PgCfg_Std.C_POSTGRESQL_CONF + C_MISSING_CONF = "missing_extension.conf" + C_EXISTS_CONF = "active_extension.conf" + + # 1. Create the optional file that DOES exist + existsConfPath = os.path.join(rootTmpDir, C_EXISTS_CONF) + + # Note: 'missing_extension.conf' is deliberately NOT created on disk + + # 2. Initialize manager and programmatic layout tree + cfg = PgCfg_Std( + rootTmpDir, + strategy=PgCfg_Std.Strategy.Standard, + ) + pgFile = cfg.AddTopLevelFile(C_PG_CONF) + + # Base configuration parameters + pgFile.SetOptionValue("port", 5432) + pgFile.SetOptionValue("max_connections", 100) + + # 3. Add include_if_exists for the MISSING file + # Standard behavior: Must NOT raise exception despite file absence on disk. + line_missing = pgFile.AddEmptyLine() + inc_missing = line_missing.AddIncludeIfExists( + C_MISSING_CONF, + offset=None, + rule=PgCfg_AddIncludeIfExistsRule.without_file, + ) + assert inc_missing.get_File() is None + + # 4. Add include_if_exists for the EXISTING file + inc_exists = pgFile.AddIncludeIfExists( + C_EXISTS_CONF, + rule=PgCfg_AddIncludeIfExistsRule.with_file, + ) + + # Load the content of the existing optional file into the graph context + # (simulating reader loading pass) + attachedFile = inc_exists.get_File() + assert attachedFile is not None + assert attachedFile.get_Path() == existsConfPath + + attachedFile.AddComment("# Optional active extension configuration") + attachedFile.AddOption("max_connections", 300) + attachedFile.AddOption("shared_buffers", "512MB") + + # 5. Verify the effective global configuration behavior + # 'port' was never modified by missing.conf -> stays 5432 + assert cfg.GetOptionValue("port") == 5432 + + # 'max_connections' was overridden by active_extension.conf -> last definition wins (300) + assert cfg.GetOptionValue("max_connections") == 300 + assert cfg.GetOptionValue("shared_buffers") == "512MB" + + # 6. Verify total option count (2 from postgresql.conf + 2 from active_extension.conf) + allOptions = list(cfg.get_AllOptions()) + assert len(allOptions) == 4 + return + # ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddInclude/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddInclude/test_set001__common.py index 59fc3a5..ef2c853 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddInclude/test_set001__common.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddInclude/test_set001__common.py @@ -9,9 +9,11 @@ from src.implementation.v00.configuration_base import PostgresConfigurationOption_Base as PgCfg_Option_Base from src.implementation.v00.configuration_base import PostgresConfigurationFile_Base as PgCfg_File_Base from src.implementation.v00.configuration_base import PostgresConfigurationFileLine_Base as PgCfg_FileLine_Base +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg_AddIncludeIfExistsRule from src.implementation.v00.configuration_base import PgCfgModel__OptionData from src.implementation.v00.configuration_base import PgCfgModel__IncludeData +from src.implementation.v00.configuration_base import PgCfgModel__IncludeIfExistsData from src.exceptions import PostgresConfigException # fmt: on @@ -140,7 +142,10 @@ def Helper__AddLineAndInclude( C_FILE_NAME = "a.conf" - include = fileLine.AddInclude(name, offset) + include = fileLine.AddInclude( + name, + offset, + ) assert len(fileLine) == 1 @@ -287,5 +292,49 @@ def test_E03__after_comment( assert fileLine.m_FileLineData.m_Items[0].m_Element is comment.m_CommentData return + # -------------------------------------------------------------------- + def test_E04__after_include_if_exists( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + comment = file.AddIncludeIfExists( + "aa.conf", + PgCfg_AddIncludeIfExistsRule.with_file, + ) + + fileLine = comment.m_FileLine + + assert len(fileLine) == 1 + + with pytest.raises(PostgresConfigException) as x: + fileLine.AddInclude("a.conf", 222) + + assert ( + str(x.value) + == ErrorMessageBuilder.FileLineAlreadyHasIncludeIfExistsDirective() + ) + + assert len(fileLine) == 1 + + elementData = fileLine.m_FileLineData.m_Items[0].m_Element + assert elementData is not None + assert type(elementData) is PgCfgModel__IncludeIfExistsData + assert elementData.m_Path == "aa.conf" + return + # ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/__init__.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/test_set001__common.py new file mode 100644 index 0000000..c1b275b --- /dev/null +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/AddIncludeIfExists/test_set001__common.py @@ -0,0 +1,383 @@ +# ////////////////////////////////////////////////////////////////////////////// +# Postgres Pro. PostgreSQL Configuration Python Library. Tests. + +# fmt: off +from src.implementation.v00.configuration_std import PostgresConfiguration_Std as PgCfg_Std + +from src.implementation.v00.configuration_base import PostgresConfigurationIncludedIfExistsFile_Base as PgCfg_IncludedIfExistFile_Base +from src.implementation.v00.configuration_base import PostgresConfigurationIncludeIfExists_Base as PgCfg_IncludeIfExists_Base +from src.implementation.v00.configuration_base import PostgresConfigurationOption_Base as PgCfg_Option_Base +from src.implementation.v00.configuration_base import PostgresConfigurationFile_Base as PgCfg_File_Base +from src.implementation.v00.configuration_base import PostgresConfigurationFileLine_Base as PgCfg_FileLine_Base +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg_AddIncludeIfExistsRule + +from src.implementation.v00.configuration_base import PgCfgModel__OptionData +from src.implementation.v00.configuration_base import PgCfgModel__IncludeIfExistsData +from src.exceptions import PostgresConfigException +# fmt: on + +from .......TestServices import TestServices +from .......ErrorMessageBuilder import ErrorMessageBuilder + +import pytest +import os +import typing +import logging + +# ////////////////////////////////////////////////////////////////////////////// +# TestSet001__Common + + +class TestSet001__Common: + sm_data001__offsets: typing.List[typing.Optional[int]] = [None, 1, 2, 3, 10] + + # -------------------------------------------------------------------- + @pytest.fixture( + params=sm_data001__offsets, + ids=[ + ("offset_" + (str(x) if x is not None else "None")) + for x in sm_data001__offsets + ], + ) + def fx_offset001( + self, + request: pytest.FixtureRequest, + ) -> typing.Optional[int]: + assert isinstance(request, pytest.FixtureRequest) + assert request.param is None or type(request.param) is int + return request.param + + # -------------------------------------------------------------------- + def test_001( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_offset001: typing.Optional[int], + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert fx_offset001 is None or type(fx_offset001) is int + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile( + cfg.C_POSTGRESQL_CONF, + ) + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + C_FILE_NAME = "a.conf" + + __class__.Helper__AddLineAndIncludeIfExists( + file, + C_FILE_NAME, + fx_offset001, + rootTmpDir, + fx_add_include_if_exists_rule, + ) + return + + # -------------------------------------------------------------------- + def test_002__multiple( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_offset001: typing.Optional[int], + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert fx_offset001 is None or type(fx_offset001) is int + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile( + cfg.C_POSTGRESQL_CONF, + ) + + C_FILE_NAME = "a.conf" + C_INCLUDES = 3 + + passN = 0 + + while passN < C_INCLUDES: + passN += 1 + + logging.info("------------- pass: {}".format(passN)) + + __class__.Helper__AddLineAndIncludeIfExists( + file, + C_FILE_NAME, + fx_offset001, + rootTmpDir, + fx_add_include_if_exists_rule, + ) + continue + + assert len(file.get_Lines()) == C_INCLUDES + assert len(file.m_FileData.m_Lines) == C_INCLUDES + + return + + # -------------------------------------------------------------------- + @staticmethod + def Helper__AddLineAndIncludeIfExists( + file: PgCfg_File_Base, + name: str, + offset: typing.Optional[int], + rootTmpDir: str, + rule: PgCfg_AddIncludeIfExistsRule, + ) -> typing.Tuple[PgCfg_FileLine_Base, PgCfg_IncludeIfExists_Base]: + assert type(rule) is PgCfg_AddIncludeIfExistsRule + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + C_FILE_NAME = "a.conf" + + include = fileLine.AddIncludeIfExists( + name, + offset, + rule=rule, + ) + + assert len(fileLine) == 1 + + assert include is not None + assert type(include) is PgCfg_IncludeIfExists_Base + assert include.m_FileLine.m_FileLineData is fileLine.m_FileLineData + assert include.m_FileLine is fileLine + assert type(include.m_IncludeIfExistsData) is PgCfgModel__IncludeIfExistsData + assert include.m_IncludeIfExistsData.m_Offset == offset + + assert include.m_IncludeIfExistsData.IsAlive() + assert include.m_IncludeIfExistsData.m_Path == C_FILE_NAME + assert include.m_IncludeIfExistsData.m_Parent == fileLine.m_FileLineData + + assert include.get_Configuration() is file.get_Configuration() + assert include.get_Parent() is fileLine + + includedFile = include.get_File() + + if rule == PgCfg_AddIncludeIfExistsRule.without_file: + assert includedFile is None + pass + else: + assert rule == PgCfg_AddIncludeIfExistsRule.with_file + assert type(includedFile) is PgCfg_IncludedIfExistFile_Base + # assert include.get_File() is includedFile + assert includedFile.get_Path() == os.path.join(rootTmpDir, C_FILE_NAME) + assert includedFile.get_Parent() is include + pass + + return (fileLine, include) + + # -------------------------------------------------------------------- + def test_E01__after_option( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + option = fileLine.AddOption("port", 123, 2) + + with pytest.raises(PostgresConfigException) as x: + fileLine.AddIncludeIfExists( + "a.conf", + 222, + fx_add_include_if_exists_rule, + ) + + assert str(x.value) == ErrorMessageBuilder.FileLineAlreadyHasOption( + "port", + ) + + assert len(fileLine) == 1 + + assert option is not None + assert type(option) is PgCfg_Option_Base + assert option.m_FileLine.m_FileLineData is fileLine.m_FileLineData + assert type(option.m_OptionData) is PgCfgModel__OptionData + assert option.m_OptionData.m_Offset == 2 + + assert option.m_OptionData.IsAlive() + assert option.m_OptionData.m_Name == "port" + assert option.m_OptionData.m_Value == 123 + assert option.m_OptionData.m_Parent == fileLine.m_FileLineData + + assert option.get_Configuration() is cfg + assert option.get_Parent().m_FileLineData is fileLine.m_FileLineData + assert option.get_Name() == "port" + assert option.get_Value() == 123 + return + + # -------------------------------------------------------------------- + def test_E02__after_include( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + include = file.AddInclude(cfg.C_POSTGRESQL_AUTO_CONF) + + fileLine = include.m_FileLine + + assert len(fileLine) == 1 + + with pytest.raises(PostgresConfigException) as x: + fileLine.AddIncludeIfExists( + "a.conf", + 222, + fx_add_include_if_exists_rule, + ) + + assert str(x.value) == ErrorMessageBuilder.FileLineAlreadyHasIncludeDirective() + + assert len(fileLine) == 1 + + assert fileLine.m_FileLineData.m_Items[0].m_Element is include.m_IncludeData + return + + # -------------------------------------------------------------------- + def test_E03__after_comment( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + comment = file.AddComment("comment") + + fileLine = comment.m_FileLine + + assert len(fileLine) == 1 + + with pytest.raises(PostgresConfigException) as x: + fileLine.AddIncludeIfExists( + "a.conf", + 222, + fx_add_include_if_exists_rule, + ) + + assert str(x.value) == ErrorMessageBuilder.FileLineAlreadyHasComment() + + assert len(fileLine) == 1 + + assert fileLine.m_FileLineData.m_Items[0].m_Element is comment.m_CommentData + return + + # -------------------------------------------------------------------- + def test_E04__after_include_if_exists( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + include = file.AddIncludeIfExists( + cfg.C_POSTGRESQL_AUTO_CONF, + rule=PgCfg_AddIncludeIfExistsRule.with_file, + ) + + fileLine = include.m_FileLine + + assert len(fileLine) == 1 + + with pytest.raises(PostgresConfigException) as x: + fileLine.AddIncludeIfExists( + "a.conf", + 222, + fx_add_include_if_exists_rule, + ) + + assert ( + str(x.value) + == ErrorMessageBuilder.FileLineAlreadyHasIncludeIfExistsDirective() + ) + + assert len(fileLine) == 1 + + assert ( + fileLine.m_FileLineData.m_Items[0].m_Element + is include.m_IncludeIfExistsData + ) + return + + +# ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/Clear/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/Clear/test_set001__common.py index 09156f4..33e0f6a 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/Clear/test_set001__common.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationFileLine/Clear/test_set001__common.py @@ -9,12 +9,14 @@ from src.implementation.v00.configuration_base import PostgresConfigurationFile_Base as PgCfg_File_Base from src.implementation.v00.configuration_base import PostgresConfigurationTopLevelFile_Base as PgCfg_TopLevelFile_Base from src.implementation.v00.configuration_base import PostgresConfigurationFileLine_Base as PgCfg_FileLine_Base +from src.implementation.v00.configuration_base import PostgresConfigurationInclude_Base as PgCfg_Include_Base from src.implementation.v00.configuration_base import PostgresConfigurationComment_Base as PgCfg_Comment_Base from src.implementation.v00.configuration_base import PostgresConfigurationFileLines_Base as PgCfg_FileLines_Base from src.implementation.v00.configuration_base import PgCfgModel__FileLineData from src.implementation.v00.configuration_base import PgCfgModel__CommentData from src.implementation.v00.configuration_base import PgCfgModel__OptionData +from src.implementation.v00.configuration_base import PgCfgModel__IncludeData from src.abstract.v00.configuration import PostgresConfigurationComment as PgCfg_Comment from src.abstract.v00.configuration import PostgresConfigurationFileLine as PgCfg_FileLine @@ -179,5 +181,53 @@ def test_002__line_with_comment( assert comment1.m_CommentData.m_Parent is None return + # -------------------------------------------------------------------- + def test_003__line_with_include( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile("a.conf") + assert file is not None + assert type(file) is PgCfg_TopLevelFile_Base + assert isinstance(file, PgCfg_File_Base) + assert isinstance(file, PgCfg_File) + assert len(file) == 0 + + include1 = file.AddInclude("file.conf") + assert include1 is not None + assert type(include1) is PgCfg_Include_Base + assert isinstance(include1, PgCfg_Include_Base) + assert len(file) == 1 + + fileLine = include1.get_Parent() + assert fileLine is not None + assert type(fileLine) is PgCfg_FileLine_Base + assert len(fileLine) == 1 + + assert ( + include1.get_Parent().get_Parent().Private__GetFileData() is file.m_FileData + ) + + fileLine.Clear() + + assert len(fileLine) == 0 + assert include1.m_FileLine is not None + assert type(include1.m_IncludeData) is PgCfgModel__IncludeData + + assert include1.m_IncludeData.m_Parent is None + return + # ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/__init__.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/test_set001__common.py new file mode 100644 index 0000000..2e497b3 --- /dev/null +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/Delete/test_set001__common.py @@ -0,0 +1,255 @@ +# ////////////////////////////////////////////////////////////////////////////// +# Postgres Pro. PostgreSQL Configuration Python Library. Tests. + +# fmt: off +from src.implementation.v00.configuration_std import PostgresConfiguration_Std as PgCfg_Std + +from src.implementation.v00.configuration_base import PostgresConfigurationIncludeIfExists_Base as PgCfg_IncludeIfExists_Base +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg_AddIncludeIfExistsRule +# fmt: on + +from .......TestServices import TestServices +from .......ErrorMessageBuilder import ErrorMessageBuilder + +from src.exceptions import PostgresConfigException + +import pytest + +# ////////////////////////////////////////////////////////////////////////////// +# TestSet001__Common + + +class TestSet001__Common: + def test_001__withLine( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + include = fileLine.AddIncludeIfExists( + "a.conf", + None, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + + assert len(fileLine) == 1 + + assert type(include) is PgCfg_IncludeIfExists_Base + assert include.get_File() is not None + assert len(cfg.get_AllFiles()) == 2 + + include.Delete(True) + + with pytest.raises(PostgresConfigException) as x: + include.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.Delete(True) + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + fileLine.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + fileLine.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + len(fileLine) + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + return + + # -------------------------------------------------------------------- + def test_002__withoutLine( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + include = fileLine.AddIncludeIfExists( + "a.conf", + None, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + + assert len(fileLine) == 1 + + assert type(include) is PgCfg_IncludeIfExists_Base + assert include.get_File() is not None + assert len(cfg.get_AllFiles()) == 2 + + include.Delete(False) + + with pytest.raises(PostgresConfigException) as x: + include.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.Delete(False) + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + assert fileLine.m_FileLineData.IsAlive() + + assert fileLine.get_Configuration() is cfg + + assert fileLine.get_Parent() is file + + assert len(fileLine) == 0 + return + + # -------------------------------------------------------------------- + + def test_003__line_with_comment__delete_withLine( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + fileLine = file.AddEmptyLine() + + assert len(fileLine) == 0 + + include = fileLine.AddIncludeIfExists( + "a.conf", + None, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + comment = fileLine.AddComment( + "aaa", + None, + ) + + assert len(fileLine) == 2 + + assert type(include) is PgCfg_IncludeIfExists_Base + assert include.get_File() is not None + assert len(cfg.get_AllFiles()) == 2 + + include.Delete(True) + + with pytest.raises(PostgresConfigException) as x: + include.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + include.Delete(True) + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + comment.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.CommentObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + comment.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.CommentObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + comment.get_Text() + + assert str(x.value) == ErrorMessageBuilder.CommentObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + fileLine.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + fileLine.get_Parent() + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + len(fileLine) + + assert str(x.value) == ErrorMessageBuilder.FileLineObjectWasDeleted() + return + + +# ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/__init__.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationIncludeIfExists/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadConfigurationFile/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadConfigurationFile/test_set001__common.py index f114e16..313160f 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadConfigurationFile/test_set001__common.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadConfigurationFile/test_set001__common.py @@ -13,6 +13,7 @@ from src.implementation.v00.configuration_base import PgCfgModel__CommentData from src.implementation.v00.configuration_base import PgCfgModel__OptionData from src.implementation.v00.configuration_base import PgCfgModel__FileData +from src.implementation.v00.configuration_base import PgCfgModel__IncludeIfExistsData from src.implementation.v00.configuration_base_r import PgCfgModel__FileStatus @@ -268,6 +269,8 @@ def test_003__two_files__duplication_and_cycles( # --------------- C_FILE_NAME1 = PgCfg_Std.C_POSTGRESQL_CONF C_FILE_NAME2 = "postgresql.biha.conf" + C_FILE_NAME3 = "file3.conf" + C_FILE_NAME4 = "file4.conf" # --------------- filePath1 = os.path.join(rootTmpDir, C_FILE_NAME1) @@ -278,6 +281,9 @@ def test_003__two_files__duplication_and_cycles( # fmt: off f.write("include '{0}'\n".format(C_FILE_NAME2)) f.write("include '{0}'\n".format(C_FILE_NAME2)) + f.write("include_if_exists '{}'\n".format(C_FILE_NAME2)) + f.write("include_if_exists '{}'\n".format(C_FILE_NAME3)) + f.write("include_if_exists '{}'\n".format(C_FILE_NAME4)) f.flush() # fmt: on @@ -306,6 +312,23 @@ def test_003__two_files__duplication_and_cycles( assert type(lastMDate2) is datetime.datetime f.close() + # --------------- + filePath3 = os.path.join(rootTmpDir, C_FILE_NAME3) + + logging.info("File {0} is creating...".format(filePath3)) + + with open(filePath3, "x") as f: + # fmt: off + f.write("prop3 321 # HAHA\n") + f.flush() + # fmt: on + + fd = f.fileno() + assert type(fd) is int + lastMDate3 = datetime.datetime.fromtimestamp(os.path.getmtime(fd)) + assert type(lastMDate3) is datetime.datetime + f.close() + # --------------- cfg = PgCfg_Std( rootTmpDir, @@ -317,15 +340,38 @@ def test_003__two_files__duplication_and_cycles( PgCfg_Reader_Base.LoadConfigurationFile(cfg, cfg.C_POSTGRESQL_CONF) - assert len(cfg.get_AllFiles()) == 2 + assert len(cfg.get_AllFiles()) == 3 assert (cfg.GetOptionValue("port")) == 123 + assert (cfg.GetOptionValue("prop3")) == "321" file1 = cfg.get_AllFiles().GetFileByName(C_FILE_NAME1) file2 = cfg.get_AllFiles().GetFileByName(C_FILE_NAME2) + file3 = cfg.get_AllFiles().GetFileByName(C_FILE_NAME3) assert file1.GetOptionValue("port") == 123 assert file2.GetOptionValue("port") == 123 + assert file3.GetOptionValue("prop3") == "321" + + assert len(file1.get_Lines()) == 5 + assert len(file1.m_FileData.m_Lines) == 5 + + file1_line3data = file1.m_FileData.m_Lines[3] + assert len(file1_line3data.m_Items) == 1 + element = file1_line3data.m_Items[0].m_Element + assert element is not None + assert type(element) is PgCfgModel__IncludeIfExistsData + assert element.m_Path == C_FILE_NAME3 + assert element.m_File is not None + + file1_line4data = file1.m_FileData.m_Lines[4] + assert len(file1_line4data.m_Items) == 1 + element = file1_line4data.m_Items[0].m_Element + assert element is not None + assert type(element) is PgCfgModel__IncludeIfExistsData + assert element.m_Path == C_FILE_NAME4 + assert element.m_File is None + return # -------------------------------------------------------------------- diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadFileDataContent/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadFileDataContent/test_set001__common.py index cd653a4..634dc43 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadFileDataContent/test_set001__common.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationReader_Base/LoadFileDataContent/test_set001__common.py @@ -12,6 +12,7 @@ from src.implementation.v00.configuration_base import PgCfgModel__CommentData from src.implementation.v00.configuration_base import PgCfgModel__OptionData from src.implementation.v00.configuration_base import PgCfgModel__IncludeData +from src.implementation.v00.configuration_base import PgCfgModel__IncludeIfExistsData from src.exceptions import PostgresConfigException # fmt: on @@ -888,5 +889,182 @@ def test_4E05__include_without_path( ) return + # -------------------------------------------------------------------- + def test_501__include_if_exists( + self, + request: pytest.FixtureRequest, + ): + assert isinstance(request, pytest.FixtureRequest) + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + assert len(cfg.get_AllFiles()) == 1 + + src = CfgFileReader("include_if_exists 'a.conf'\n") + + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert len(file1) == 1 + assert len(file1.m_FileData.m_Lines) == 1 + + fileLineData0 = file1.m_FileData.m_Lines[0] + assert len(fileLineData0.m_Items) == 1 + assert ( + type(fileLineData0.m_Items[0].m_Element) is PgCfgModel__IncludeIfExistsData + ) + assert fileLineData0.m_Items[0].m_Element.m_Offset == 0 + assert fileLineData0.m_Items[0].m_Element.m_Path == "a.conf" + assert fileLineData0.m_Items[0].m_Element.m_File is None + + assert len(cfg.get_AllFiles()) == 1 + return + + # -------------------------------------------------------------------- + def test_5E01__empty_path( + self, + request: pytest.FixtureRequest, + ): + assert isinstance(request, pytest.FixtureRequest) + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + src = CfgFileReader("include_if_exists ''\n") + + with pytest.raises(PostgresConfigException) as x: + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert str(x.value) == ErrorMessageBuilder.CfgReader__IncludeHasEmptyPath( + 1, + ) + return + + # -------------------------------------------------------------------- + @pytest.mark.parametrize( + "data", [x[1] for x in sm_dataE4E02], ids=[x[0] for x in sm_dataE4E02] + ) + def test_5E02__incompleted_path( + self, + request: pytest.FixtureRequest, + data: str, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(data) is str + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + src = CfgFileReader("include '" + data) + + with pytest.raises(PostgresConfigException) as x: + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert str( + x.value, + ) == ErrorMessageBuilder.CfgReader__EndOfIncludePathIsNotFound( + 1, + ) + return + + # -------------------------------------------------------------------- + def test_5E03__unknown_escape_symbol( + self, + request: pytest.FixtureRequest, + ): + assert isinstance(request, pytest.FixtureRequest) + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + src = CfgFileReader("include_if_exists '\\a") + + with pytest.raises(PostgresConfigException) as x: + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert str( + x.value, + ) == ErrorMessageBuilder.CfgReader__UnknownEscapedSymbolInInclude( + 1, + 21, + "a", + ) + return + + # -------------------------------------------------------------------- + @pytest.mark.parametrize( + "data", [x[1] for x in sm_dataE4E04], ids=[x[0] for x in sm_dataE4E04] + ) + def test_5E04__incompleted_escape( + self, + request: pytest.FixtureRequest, + data: str, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(data) is str + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + src = CfgFileReader("include_if_exists '\\" + data) + + with pytest.raises(PostgresConfigException) as x: + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert str( + x.value, + ) == ErrorMessageBuilder.CfgReader__IncompletedEscapeInInclude( + 1, + ) + return + + # -------------------------------------------------------------------- + @pytest.mark.parametrize( + "data", [x[1] for x in sm_dataE4E05], ids=[x[0] for x in sm_dataE4E05] + ) + def test_5E05__include_without_path( + self, + request: pytest.FixtureRequest, + data: str, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(data) is str + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std(rootTmpDir) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + + src = CfgFileReader("include_if_exists" + data) + + with pytest.raises(PostgresConfigException) as x: + PgCfg_Reader_Base.LoadFileContent(file1, src) + + assert str(x.value) == ErrorMessageBuilder.CfgReader__IncludeWithoutPath( + 1, + ) + return + # ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/__init__.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/test_set001__common.py new file mode 100644 index 0000000..a174301 --- /dev/null +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationTopLevelFile/AddIncludeIfExists/test_set001__common.py @@ -0,0 +1,284 @@ +# ////////////////////////////////////////////////////////////////////////////// +# Postgres Pro. PostgreSQL Configuration Python Library. Tests. + +# fmt: off +from src.implementation.v00.configuration_std import PostgresConfiguration_Std as PgCfg_Std + +from src.implementation.v00.configuration_base import PostgresConfigurationIncludeIfExists_Base as PgCfg_IncludeIfExists_Base +from src.implementation.v00.configuration_base import PostgresConfigurationFile_Base as PgCfg_File_Base +from src.implementation.v00.configuration_base import PostgresConfigurationTopLevelFile_Base as PgCfg_TopLevelFile_Base + +from src.implementation.v00.configuration_base import PostgresConfigurationIncludeIfExists as PgCfg_IncludeIfExists +from src.implementation.v00.configuration_base import PostgresConfigurationFile as PgCfg_File +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg_AddIncludeIfExistsRule + +from src.exceptions import PostgresConfigException +# fmt: on + +from .......TestServices import TestServices +from .......ErrorMessageBuilder import ErrorMessageBuilder + +import pytest +import os + +# ////////////////////////////////////////////////////////////////////////////// +# TestSet001__Common + + +class TestSet001__Common: + def test_001__with_file( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file1 = cfg.AddTopLevelFile( + cfg.C_POSTGRESQL_CONF, + ) + assert file1 is not None + assert type(file1) is PgCfg_TopLevelFile_Base + + C_BIHA_CONF_FILE_NAME = "postgresql.biha.conf" + + bihaConfFileInclude = file1.AddIncludeIfExists( + C_BIHA_CONF_FILE_NAME, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + + assert bihaConfFileInclude is not None + assert isinstance(bihaConfFileInclude, PgCfg_IncludeIfExists_Base) + assert isinstance(bihaConfFileInclude, PgCfg_IncludeIfExists) + + assert len(file1.get_Lines()) == 1 + + bihaConfFile = bihaConfFileInclude.get_File() + assert bihaConfFile is not None + assert isinstance(bihaConfFile, PgCfg_File_Base) + assert isinstance(bihaConfFile, PgCfg_File) + + assert bihaConfFile.get_Path() == os.path.join( + rootTmpDir, + C_BIHA_CONF_FILE_NAME, + ) + + assert bihaConfFile.get_Configuration() is cfg + assert bihaConfFile.get_Parent() is bihaConfFileInclude + + bihaConfFile__Lines = bihaConfFile.get_Lines() + + assert bihaConfFile.get_Lines() is bihaConfFile__Lines # check a cache + assert len(bihaConfFile__Lines) == 0 + + # -------------- + assert ( + cfg.get_AllFiles().GetFileByName(C_BIHA_CONF_FILE_NAME).m_FileData + is bihaConfFile.m_FileData + ) + + assert file1.m_FileData in cfg.m_Data.m_TopLevelFiles + assert bihaConfFile.m_FileData not in cfg.m_Data.m_TopLevelFiles + + assert len(cfg.m_Data.m_TopLevelFiles) == 1 + assert cfg.m_Data.m_TopLevelFiles[0] is file1.m_FileData + + assert len(list(cfg.m_Data.m_AllFilesByName.keys())) == 2 + + assert cfg.C_POSTGRESQL_CONF in cfg.m_Data.m_AllFilesByName.keys() + assert cfg.m_Data.m_AllFilesByName[cfg.C_POSTGRESQL_CONF] is file1.m_FileData + + assert C_BIHA_CONF_FILE_NAME in cfg.m_Data.m_AllFilesByName.keys() + assert ( + cfg.m_Data.m_AllFilesByName[C_BIHA_CONF_FILE_NAME] + is bihaConfFile.m_FileData + ) + + # -------------- + bihaConfFileIncludeLine = file1.get_Lines().__iter__().__next__() + + assert ( + bihaConfFileIncludeLine.m_FileLineData + is bihaConfFileInclude.m_FileLine.m_FileLineData + ) + + bihaConfFileIncludeLine.Clear() + + assert len(bihaConfFileIncludeLine) == 0 + + with pytest.raises(PostgresConfigException) as x: + len(bihaConfFile__Lines) + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + len(bihaConfFile) + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + bihaConfFileInclude.get_Configuration() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + with pytest.raises(PostgresConfigException) as x: + bihaConfFileInclude.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + return + + # -------------------------------------------------------------------- + def test_002__without_file( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file1 = cfg.AddTopLevelFile( + cfg.C_POSTGRESQL_CONF, + ) + assert file1 is not None + assert type(file1) is PgCfg_TopLevelFile_Base + + C_BIHA_CONF_FILE_NAME = "postgresql.biha.conf" + + bihaConfFileInclude = file1.AddIncludeIfExists( + C_BIHA_CONF_FILE_NAME, + PgCfg_AddIncludeIfExistsRule.without_file, + ) + + assert bihaConfFileInclude is not None + assert isinstance(bihaConfFileInclude, PgCfg_IncludeIfExists_Base) + assert isinstance(bihaConfFileInclude, PgCfg_IncludeIfExists) + + assert len(file1.get_Lines()) == 1 + + bihaConfFile = bihaConfFileInclude.get_File() + assert bihaConfFile is None + + # -------------- + bihaConfFileIncludeLine = file1.get_Lines().__iter__().__next__() + + assert ( + bihaConfFileIncludeLine.m_FileLineData + is bihaConfFileInclude.m_FileLine.m_FileLineData + ) + + bihaConfFileIncludeLine.Clear() + + assert len(bihaConfFileIncludeLine) == 0 + + with pytest.raises(PostgresConfigException) as x: + bihaConfFileInclude.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + return + + # -------------------------------------------------------------------- + def test_003__include_twice( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + bihaConfFile1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + assert bihaConfFile1 is not None + assert type(bihaConfFile1) is PgCfg_TopLevelFile_Base + + C_BIHA_CONF_FILE_NAME = "postgresql.biha.conf" + + bihaConfFileInclude1 = bihaConfFile1.AddIncludeIfExists( + C_BIHA_CONF_FILE_NAME, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + bihaConfFileInclude2 = bihaConfFile1.AddIncludeIfExists( + C_BIHA_CONF_FILE_NAME, + PgCfg_AddIncludeIfExistsRule.with_file, + ) + + assert bihaConfFileInclude1 is not bihaConfFileInclude2 + # They use the one file + bihaConfFile1 = bihaConfFileInclude1.get_File() + bihaConfFile2 = bihaConfFileInclude2.get_File() + assert bihaConfFile1 is not None + assert bihaConfFile1.m_FileData is not None + assert bihaConfFile2 is not None + assert bihaConfFile2.m_FileData is not None + assert bihaConfFile1.m_FileData is bihaConfFile2.m_FileData + + bihaConfFileInclude1.get_Parent().Clear() + + with pytest.raises(PostgresConfigException) as x: + bihaConfFileInclude1.get_File() + + assert str(x.value) == ErrorMessageBuilder.IncludeIfExistsObjectWasDeleted() + + assert bihaConfFile2.get_Parent() is bihaConfFileInclude2 + assert bihaConfFile2.get_Path() == os.path.join( + rootTmpDir, + C_BIHA_CONF_FILE_NAME, + ) + return + + # -------------------------------------------------------------------- + def test_004__empty_file_path( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + fx_add_include_if_exists_rule: PgCfg_AddIncludeIfExistsRule, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(fx_add_include_if_exists_rule) is PgCfg_AddIncludeIfExistsRule + + rootTmpDir = TestServices.GetRootTmpDir() + assert type(rootTmpDir) is str + + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + + file1 = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_CONF) + assert file1 is not None + assert type(file1) is PgCfg_TopLevelFile_Base + + with pytest.raises(PostgresConfigException) as x: + file1.AddIncludeIfExists( + "", + fx_add_include_if_exists_rule, + ) + + assert str(x.value) == ErrorMessageBuilder.FilePathIsEmpty() + return + + +# ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/DoWork/test_set001__work.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/DoWork/test_set001__work.py index 54efa78..b05f0f3 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/DoWork/test_set001__work.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/DoWork/test_set001__work.py @@ -12,6 +12,7 @@ from src.implementation.v00.configuration_base import PostgresConfigurationFile as PgCfg_File from src.implementation.v00.configuration_base import PgCfgModel__FileData +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule from src.implementation.v00.configuration_base_r import PgCfgModel__FileStatus from src.exceptions import PostgresConfigException @@ -190,6 +191,8 @@ def test_003__two_files( # --------------- C_FILE1_NAME = PgCfg_Std.C_POSTGRESQL_CONF C_FILE2_NAME = "postgresql.proxima.conf" + C_FILE3_NAME = "file3.conf" + C_FILE4_NAME = "file4.conf" C_OPT_NAME = "proxima.port" @@ -204,15 +207,24 @@ def test_003__two_files( file1 = cfg.AddTopLevelFile(C_FILE1_NAME) file2 = file1.AddInclude(C_FILE2_NAME).get_File() + file3 = file1.AddIncludeIfExists( + C_FILE3_NAME, + AddIncludeIfExistsRule.with_file, + ).get_File() + file1.AddIncludeIfExists( + C_FILE4_NAME, + AddIncludeIfExistsRule.without_file, + ) portNumber = 321 file2.AddOption(C_OPT_NAME, portNumber) - assert file2.GetOptionValue(C_OPT_NAME) == portNumber - assert file2.AddComment(" IT IS ALL!") + assert file3 is not None + file3.AddOption("prop3", True) + # --------------- cfgWriterCtx = PgCfg_WriterCtx_Base(cfg) @@ -240,8 +252,20 @@ def test_003__two_files( logging.info("File objects are being checked...") fileDatas = [ - (file1, "include 'postgresql.proxima.conf'\n"), - (file2, "{0} = {1}\n# IT IS ALL!\n".format(C_OPT_NAME, portNumber)), + ( + file1, + "include 'postgresql.proxima.conf'\n" + "include_if_exists 'file3.conf'\n" + "include_if_exists 'file4.conf'\n", + ), + ( + file2, + "{0} = {1}\n# IT IS ALL!\n".format(C_OPT_NAME, portNumber), + ), + ( + file3, + "prop3 = on\n", + ), ] for fileData in fileDatas: @@ -268,6 +292,13 @@ def test_003__two_files( assert fileContent_n == fileData[1] continue + + assert not os.path.exists( + os.path.join( + rootTmpDir, + C_FILE4_NAME, + ) + ) continue return diff --git a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/test_set001__common.py b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/test_set001__common.py index 8826024..261f5d3 100644 --- a/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/test_set001__common.py +++ b/tests/implementation/v00/configuration_std/Objects/PostgresConfigurationWriter_Base/test_set001__common.py @@ -8,12 +8,14 @@ from src.implementation.v00.configuration_std import PostgresConfigurationWriterCtx_Base as PgCfg_WriterCtx_Base from src.implementation.v00.configuration_base import PgCfgModel__FileData +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule as PgCfg__AddIncludeIfExistsRule from ......TestServices import TestServices # fmt: on import pytest import typing +import dataclasses # ////////////////////////////////////////////////////////////////////////////// # TestSet001__Common @@ -390,5 +392,161 @@ def test_009__include__mix( assert actualFileContent == data009.result return + # -------------------------------------------------------------------- + @dataclasses.dataclass + class tagData010: + descr: str + fileName: str + result: str + + # -------------------------------------------------------------------- + sm_Data010: typing.List[tagData010] = [ + # fmt: off + tagData010( + "a_space_a_conf", + "a a.conf", + "include_if_exists 'a a.conf'\n" + ), + tagData010( + "quote_a_quote_conf", + "'a'.conf", + "include_if_exists '\\'a\\'.conf'\n" + ), + tagData010( + "quote2_a_quote2_conf", + "\"a\".conf", + "include_if_exists '\"a\".conf'\n" + ), + ] + + # -------------------------------------------------------------------- + @pytest.fixture( + params=sm_Data010, + ids=[x.descr for x in sm_Data010], + ) + def data010( + self, + request: pytest.FixtureRequest, + ) -> tagData010: + assert isinstance(request, pytest.FixtureRequest) + assert type(request.param) is __class__.tagData010 + return request.param + + # -------------------------------------------------------------------- + def test_010__include_if_exists__mix( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + data010: tagData010, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + assert type(data010) is __class__.tagData010 + + rootTmpDir = TestServices.GetRootTmpDir() + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_AUTO_CONF) + + file2 = file.AddIncludeIfExists( + data010.fileName, + PgCfg__AddIncludeIfExistsRule.with_file, + ).get_File() + + assert file2 is not None + assert ( + file2.get_Parent().get_Parent().get_Parent() is file + ) # check a references + + cfgWriterCtx = PgCfg_WriterCtx_Base(cfg) + + actualFileContent = PgCfg_Writer_Base.MakeFileDataContent( + cfgWriterCtx, + file.m_FileData, + ) + + assert actualFileContent == data010.result + return + + # -------------------------------------------------------------------- + def test_011__include_if_exists__with_file( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_AUTO_CONF) + + C_INCLUDED_FILE_NAME = "postgresql.proxima.conf" + + file2 = file.AddIncludeIfExists( + C_INCLUDED_FILE_NAME, + PgCfg__AddIncludeIfExistsRule.with_file, + ).get_File() + + assert file2 is not None + + assert ( + file2.get_Parent().get_Parent().get_Parent() is file + ) # check a references + + cfgWriterCtx = PgCfg_WriterCtx_Base(cfg) + + actualFileContent = PgCfg_Writer_Base.MakeFileDataContent( + cfgWriterCtx, + file.m_FileData, + ) + + expectedFileContent = "include_if_exists '{0}'\n".format(C_INCLUDED_FILE_NAME) + + assert actualFileContent == expectedFileContent + return + + # -------------------------------------------------------------------- + def test_012__include_if_exists__without_file( + self, + request: pytest.FixtureRequest, + pg_conf_strategy: PgCfg_Std.Strategy, + ): + assert isinstance(request, pytest.FixtureRequest) + assert type(pg_conf_strategy) is PgCfg_Std.Strategy + + rootTmpDir = TestServices.GetRootTmpDir() + cfg = PgCfg_Std( + rootTmpDir, + strategy=pg_conf_strategy, + ) + file = cfg.AddTopLevelFile(cfg.C_POSTGRESQL_AUTO_CONF) + + C_INCLUDED_FILE_NAME = "postgresql.proxima.conf" + + file2 = file.AddIncludeIfExists( + C_INCLUDED_FILE_NAME, + PgCfg__AddIncludeIfExistsRule.without_file, + ).get_File() + + assert file2 is None + + cfgWriterCtx = PgCfg_WriterCtx_Base(cfg) + + actualFileContent = PgCfg_Writer_Base.MakeFileDataContent( + cfgWriterCtx, + file.m_FileData, + ) + + expectedFileContent = "include_if_exists '{0}'\n".format(C_INCLUDED_FILE_NAME) + + assert actualFileContent == expectedFileContent + return + # ////////////////////////////////////////////////////////////////////////////// diff --git a/tests/implementation/v00/configuration_std/conftest.py b/tests/implementation/v00/configuration_std/conftest.py index 585c359..623f1de 100644 --- a/tests/implementation/v00/configuration_std/conftest.py +++ b/tests/implementation/v00/configuration_std/conftest.py @@ -2,6 +2,7 @@ # Postgres Pro. PostgreSQL Configuration Python Library. Tests. from src.implementation.v00.configuration_std import PostgresConfiguration_Std +from src.implementation.v00.configuration_base import AddIncludeIfExistsRule import pytest @@ -21,3 +22,23 @@ def pg_conf_strategy( # ////////////////////////////////////////////////////////////////////////////// + + +@pytest.fixture( + params=[ + pytest.param( + x, + id="rule={}".format(x.name), + ) + for x in list(AddIncludeIfExistsRule) + ], +) +def fx_add_include_if_exists_rule( + request: pytest.FixtureRequest, +) -> AddIncludeIfExistsRule: + assert isinstance(request, pytest.FixtureRequest) + assert type(request.param) is AddIncludeIfExistsRule + return request.param + + +# //////////////////////////////////////////////////////////////////////////////