Changeset 40949 for branches/ipp-259_genericise_backups/tools/backups/backup.py

Timestamp:

Oct 18, 2019, 10:35:56 AM (7 years ago)

Author:

fairlamb

Message:

changed the structure so that a full schema must be given, also allowed a full schema to exist

File:

• branches/ipp-259_genericise_backups/tools/backups/backup.py (modified) (6 diffs)

branches/ipp-259_genericise_backups/tools/backups/backup.py

@@ -10 +10 @@
 import backups.utils.errors as errs
 import backups.utils.subprocess_utils as sub_utils
-from backups.utils.config_parse_helper import ConfigSchemaSection, ConfigSchemaLine
+from backups.utils.config_parse_helper import ConfigSchema, ConfigSchemaSection, ConfigSchemaLine, ParsedConfig
 
 DEFAULT_CONFIG_FILE = path.join(path.dirname(__file__), 'atlassian_backups.config')
+
+DEFAULT_SCHEMA_SECTION = ConfigSchemaSection('DEFAULT',
+    [ ConfigSchemaLine('backup_paths', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
+    , ConfigSchemaLine('source_machine', True, str)
+    , ConfigSchemaLine('verbose', False, bool)
+    , ConfigSchemaLine('make_dirs', False, bool)
+    ]
+)
+COPY_SCHEMA_SECTION = ConfigSchemaSection('COPY',
+    [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
+    , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
+    ]
+)
+TAR_SCHEMA_SECTION = ConfigSchemaSection('TAR',
+    [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
+    , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
+    , ConfigSchemaLine('target_filename', True, str)
+    , ConfigSchemaLine('prefix_date', True, bool)
+    ]
+)
+RSYNC_SCHEMA_SECTION = ConfigSchemaSection('RSYNC',
+    [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
+    , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
+    ]
+)
+
+MYSQLDUMP_SCHEMA_SECTION = ConfigSchemaSection('MYSQLDUMP',
+    [ ConfigSchemaLine('user', True, str)
+    , ConfigSchemaLine('password', True, str)
+    , ConfigSchemaLine('db_name', True, str)
+    , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
+    , ConfigSchemaLine('target_filename', True, str)
+    , ConfigSchemaLine('prefix_date', True, bool)
+    ]
+)
+
+
+def get_backup_schema() -> ConfigSchema:
+    backup_schema = ConfigSchema(None)
+    backup_schema.add_section(DEFAULT_SCHEMA_SECTION)
+    backup_schema.add_section(COPY_SCHEMA_SECTION)
+    backup_schema.add_section(TAR_SCHEMA_SECTION)
+    backup_schema.add_section(RSYNC_SCHEMA_SECTION)
+    backup_schema.add_section(MYSQLDUMP_SCHEMA_SECTION)
+    return backup_schema
 
 
@@ -20 +65 @@
     """
 
-    def __init__(self, config_file=None):
+    def __init__(self, config_file=None, schema: ConfigSchema=None):
         if config_file is None:
             raise errs.ValidationError("ValidationError: Backup class must be given a config")
-        self.load_config(config_file)
-
-    def load_config(self, config_class_or_filepath):
+        if schema is None:
+            schema = get_backup_schema()
+        print(schema)
+        self.load_config(config_file, schema)
+
+    def load_config(self, config_class_or_filepath, schema):
         """Accepts a filepath to a config file, or """
 
@@ -38 +86 @@
         config.read(config_class_or_filepath)
 
-        self.read_default_section(config)
-        if self._has_copy_section(config):
-            self.read_copy_config_section(config)
-        if self._has_tar_section(config):
-            self.read_tar_config_section(config)
-        if self._has_rsync_section(config):
-            self.read_rsync_config_section(config)
-        if self._has_mysqldump_section(config):
-            self.read_mysqldump_config_section(config)
-
-    def _has_copy_section(self, config_parser: ConfigParser) -> bool:
-        section = 'COPY'
-        self.run_copy = config_parser.has_section(section)
-        return self.run_copy
-
-    def _has_tar_section(self, config_parser: ConfigParser) -> bool:
-        section = 'TAR'
-        self.run_tar = config_parser.has_section(section)
-        return self.run_tar
-
-    def _has_rsync_section(self, config_parser: ConfigParser) -> bool:
-        section = 'RSYNC'
-        self.run_rsync = config_parser.has_section(section)
-        return self.run_rsync
-
-    def _has_mysqldump_section(self, config_parser: ConfigParser) -> bool:
-        section = 'MYSQLDUMP'
-        self.run_mysqldump = config_parser.has_section(section)
-        return self.run_mysqldump
-
-    DEFAULT_SCHEMA = ConfigSchemaSection('DEFAULT',
-        [ ConfigSchemaLine('backup_paths', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
-        , ConfigSchemaLine('source_machine', True, str)
-        , ConfigSchemaLine('verbose', False, bool)
-        , ConfigSchemaLine('make_dirs', False, bool)
-        ]
-    )
-
-    def read_default_section(self, config: ConfigParser, schema: ConfigSchemaSection=DEFAULT_SCHEMA):
-        self.default_dict = cfg_help.parse_config(config, schema)
+        self.read_config_and_schema(config, schema)
+        # self.read_copy_config_section(config, schema)
+        # self.read_tar_config_section(config, schema)
+        # self.read_rsync_config_section(config, schema)
+        # self.read_mysqldump_config_section(config, schema)
+
+    def read_config_and_schema(self, config: ConfigParser, schema: ConfigSchema):
+        parsed_config = ParsedConfig(config, schema)
+        print(parsed_config)
+        self.default_dict = parsed_config.get_section('DEFAULT')
         self.hostname_is_valid()
         self.maybe_make_backup_dirs()
 
-    COPY_SCHEMA = ConfigSchemaSection('COPY',
-        [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
-        , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
-        ]
-    )
-
-    def read_copy_config_section(self, config: ConfigParser, schema: ConfigSchemaSection=COPY_SCHEMA):
-        self.copy_dict = cfg_help.parse_config(config, schema)
-
-    TAR_SCHEMA = ConfigSchemaSection('TAR',
-        [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
-        , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
-        , ConfigSchemaLine('target_filename', True, str)
-        , ConfigSchemaLine('prefix_date', True, bool)
-        ]
-    )
-
-    def read_tar_config_section(self, config: ConfigParser, schema: ConfigSchemaSection=TAR_SCHEMA):
-        self.tar_dict = cfg_help.parse_config(config, schema)
-
-    RSYNC_SCHEMA = ConfigSchemaSection('RSYNC',
-        [ ConfigSchemaLine('sources', True, list, cfg_help.SpecialSchemaProcessing.commma_separated)
-        , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
-        ]
-    )
-
-    def read_rsync_config_section(self, config: ConfigParser, schema: ConfigSchemaSection=RSYNC_SCHEMA):
-        self.rsync_dict = cfg_help.parse_config(config, schema)
-
-    MYSQLDUMP_SCHEMA = ConfigSchemaSection('MYSQLDUMP',
-        [ ConfigSchemaLine('user', True, str)
-        , ConfigSchemaLine('password', True, str)
-        , ConfigSchemaLine('db_name', True, str)
-        , ConfigSchemaLine('additional_args', False, list, cfg_help.SpecialSchemaProcessing.space_separated)
-        , ConfigSchemaLine('target_filename', True, str)
-        , ConfigSchemaLine('prefix_date', True, bool)
-        ]
-    )
-
-    def read_mysqldump_config_section(self, config: ConfigParser, schema: ConfigSchemaSection=MYSQLDUMP_SCHEMA):
-        self.mysqldump_dict = cfg_help.parse_config(config, schema)
+        section = 'COPY'
+        self.should_run_copy = parsed_config.has_section(section)
+        if self.should_run_copy:
+            self.copy_dict = parsed_config.get_section(section)
+
+        section = 'TAR'
+        self.should_run_tar = parsed_config.has_section(section)
+        if self.should_run_tar:
+            self.tar_dict = parsed_config.get_section(section)
+
+        section = 'RSYNC'
+        self.should_run_rsync = parsed_config.has_section(section)
+        if self.should_run_rsync:
+            self.rsync_dict = parsed_config.get_section(section)
+
+        section = 'MYSQLDUMP'
+        self.should_run_mysqldump = parsed_config.has_section(section)
+        if self.should_run_mysqldump:
+            self.mysqldump_dict = parsed_config.get_section(section)
+
+    def run_backup_processes(self):
+
+        if self.should_run_copy:
+            self._run_copy()
+        if self.should_run_tar:
+            self._run_tar()
+        if self.should_run_rsync:
+            self._run_rsync()
+        if self.should_run_mysqldump:
+            self._run_mysqldump()
 
     def hostname_is_valid(self) -> bool:
@@ -146 +153 @@
                     os.makedirs(backup_path)
 
-    def run_backup(self):
-            self._run_copy()
-            self._run_tar()
-            self._run_rsync()
-            self._run_mysqldump()
-
     def _run_copy(self):
-        if self.run_copy is None or False:
+        if self.should_run_copy is None or False:
             return 0
         self.target_backup_paths_ok(raise_error=True)
@@ -177 +178 @@
 
     def _run_tar(self):
-        if self.run_tar is None or False:
+        if self.should_run_tar is None or False:
             return 0
 
@@ -203 +204 @@
 
     def _run_rsync(self):
-        if self.run_rsync is None or False:
+        if self.should_run_rsync is None or False:
             return 0