db-sync-tool-kmi 2.11.6__py3-none-any.whl → 3.0.2__py3-none-any.whl

db_sync_tool/recipes/drupal.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: future_fstrings -*-
 
 """
 Drupal script
@@ -7,15 +6,48 @@ Drupal script
 
 import json
 from db_sync_tool.utility import mode, system, helper, output
+from db_sync_tool.utility.exceptions import ParsingError
+from db_sync_tool.recipes.parsing import (  # noqa: F401 (re-export)
+    parse_drupal_drush_credentials,
+)
 
 
 def check_configuration(client):
+    """
+    Checking Drupal database configuration.
+    First tries to parse settings.php directly, falls back to Drush if needed.
+    :param client: String
+    :return:
+    """
+    cfg = system.get_typed_config()
+    _path = cfg.get_client(client).path
+
+    # Try direct settings.php parsing first
+    try:
+        _db_config = parse_settings_php(client, _path)
+        if _db_config and _db_config.get('name') and _db_config.get('host'):
+            output.message(
+                output.host_to_subject(client),
+                'Parsed database config from settings.php',
+                True
+            )
+            system.set_database_config(client, helper.clean_db_config(_db_config))
+            return
+    except Exception:
+        pass
+
+    # Fall back to Drush
+    check_configuration_drush(client)
+
+
+def check_configuration_drush(client):
     """
     Checking Drupal database configuration with Drush
     :param client: String
     :return:
     """
-    _path = system.config[client]['path']
+    cfg = system.get_typed_config()
+    _path = cfg.get_client(client).path
 
     # Check Drush version
     _raw_version = mode.run_command(
@@ -38,24 +70,67 @@ def check_configuration(client):
         client,
         True
     )
+    if not stdout:
+        raise ParsingError('Failed to read Drupal configuration via drush')
 
     _db_config = parse_database_credentials(json.loads(stdout))
 
-    system.config[client]['db'] = _db_config
+    system.set_database_config(client, helper.clean_db_config(_db_config))
 
 
-def parse_database_credentials(db_credentials):
+def parse_settings_php(client, path):
     """
-    Parsing database credentials to needed format
-    :param db_credentials: Dictionary
-    :return: Dictionary
+    Parse database credentials directly from settings.php
+    :param client: String
+    :param path: String
+    :return: Dictionary or None
     """
     _db_config = {
-        'name': db_credentials['db-name'],
-        'host': db_credentials['db-hostname'],
-        'password': db_credentials['db-password'],
-        'port': db_credentials['db-port'],
-        'user': db_credentials['db-username'],
+        'name': get_setting_value(client, 'database', path),
+        'host': get_setting_value(client, 'host', path),
+        'password': get_setting_value(client, 'password', path),
+        'port': get_setting_value(client, 'port', path) or 3306,
+        'user': get_setting_value(client, 'username', path),
     }
 
     return _db_config
+
+
+def get_setting_value(client, key, path):
+    """
+    Extract a single value from Drupal settings.php
+    Handles both 'key' => 'value' and 'key' => "value" formats
+    :param client: String
+    :param key: String
+    :param path: String
+    :return: String
+    """
+    # Try single quotes first, then double quotes
+    cmd_result = mode.run_command(
+        helper.get_command(client, 'sed') +
+        f' -n "s/.*\'{key}\' *=> *[\'\\"]\\([^\'\\"]*\\)[\'\\"].*/\\1/p" {path} | head -1',
+        client,
+        True
+    )
+    result = cmd_result.strip() if cmd_result else ''
+
+    # For numeric values like port (without quotes)
+    if not result:
+        cmd_result = mode.run_command(
+            helper.get_command(client, 'sed') +
+            f' -n "s/.*\'{key}\' *=> *\\([0-9]*\\).*/\\1/p" {path} | head -1',
+            client,
+            True
+        )
+        result = cmd_result.strip() if cmd_result else ''
+
+    return result
+
+
+def parse_database_credentials(db_credentials):
+    """
+    Parsing database credentials to needed format
+    :param db_credentials: Dictionary
+    :return: Dictionary
+    """
+    return parse_drupal_drush_credentials(db_credentials)

db_sync_tool/recipes/laravel.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: future_fstrings -*-
 
 """
 Laravel script
@@ -13,15 +12,16 @@ def check_configuration(client):
     :param client: String
     :return:
     """
-    _path = system.config[client]['path']
+    cfg = system.get_typed_config()
+    _path = cfg.get_client(client).path
 
-    system.config[client]['db'] = {
+    system.set_database_config(client, helper.clean_db_config({
         'name': get_database_parameter(client, 'DB_DATABASE', _path),
         'host': get_database_parameter(client, 'DB_HOST', _path),
         'password': get_database_parameter(client, 'DB_PASSWORD', _path),
         'port': get_database_parameter(client, 'DB_PORT', _path),
         'user': get_database_parameter(client, 'DB_USERNAME', _path),
-    }
+    }))
 
 
 def get_database_parameter(client, name, file):
@@ -33,8 +33,9 @@ def get_database_parameter(client, name, file):
     :param file: String
     :return:
     """
-    return mode.run_command(
+    result = mode.run_command(
         helper.get_command(client, 'grep') + f' {name} {file} | cut -d \'=\' -f2',
         client,
         True
-    ).replace('\n', '')
+    )
+    return result.replace('\n', '') if result else ''

db_sync_tool/recipes/parsing.py

@@ -0,0 +1,102 @@
+#!/usr/bin/env python3
+
+"""
+Pure parsing functions for framework configuration files.
+
+This module contains parsing functions with minimal dependencies,
+allowing proper unit testing and code coverage measurement.
+Only depends on utility/exceptions.py which has no other project dependencies.
+
+Functions here are imported and used by the framework recipe modules.
+"""
+
+from urllib.parse import urlparse, unquote
+from db_sync_tool.utility.exceptions import ParsingError
+
+
+def parse_symfony_database_url(db_credentials: str) -> dict:
+    """
+    Parse Symfony DATABASE_URL format into database config dict.
+
+    Format: DATABASE_URL=mysql://user:password@host:port/dbname?options
+
+    :param db_credentials: DATABASE_URL string
+    :return: Dictionary with db_type, user, password, host, port, name
+    :raises ParsingError: If format doesn't match expected pattern
+    """
+    db_credentials = str(db_credentials).replace('\\n\'', '')
+
+    # Remove DATABASE_URL= prefix if present
+    if db_credentials.startswith('DATABASE_URL='):
+        url = db_credentials[len('DATABASE_URL='):]
+    else:
+        url = db_credentials
+
+    parsed = urlparse(url)
+
+    # Validate required components (password is required for database connections)
+    if not all([parsed.scheme, parsed.username, parsed.hostname, parsed.port, parsed.path]):
+        raise ParsingError('Mismatch of expected database credentials')
+
+    # Password is required
+    if parsed.password is None:
+        raise ParsingError('Mismatch of expected database credentials')
+
+    # Extract database name from path (remove leading /)
+    dbname = parsed.path.lstrip('/')
+    if not dbname:
+        raise ParsingError('Mismatch of expected database credentials')
+
+    # These are validated as non-None above, but mypy can't infer that
+    assert parsed.username is not None
+    assert parsed.password is not None
+    assert parsed.hostname is not None
+
+    return {
+        'db_type': parsed.scheme,
+        'user': unquote(parsed.username),
+        'password': unquote(parsed.password),
+        'host': parsed.hostname,
+        'port': str(parsed.port),
+        'name': dbname,
+    }
+
+
+def parse_drupal_drush_credentials(db_credentials: dict) -> dict:
+    """
+    Parse Drupal Drush core-status output into database config dict.
+
+    :param db_credentials: Dictionary from Drush JSON output
+    :return: Dictionary with name, host, password, port, user
+    """
+    return {
+        'name': db_credentials['db-name'],
+        'host': db_credentials['db-hostname'],
+        'password': db_credentials['db-password'],
+        'port': db_credentials['db-port'],
+        'user': db_credentials['db-username'],
+    }
+
+
+def parse_typo3_database_credentials(db_credentials: dict) -> dict:
+    """
+    Parse TYPO3 LocalConfiguration.php DB array into database config dict.
+
+    Handles both TYPO3 v8+ (Connections/Default) and TYPO3 v7- formats.
+
+    :param db_credentials: Dictionary from LocalConfiguration DB section
+    :return: Dictionary with name, host, password, port, user
+    """
+    # Distinguish between database config scheme of TYPO3 v8+ and TYPO3 v7-
+    if 'Connections' in db_credentials:
+        _db_config = dict(db_credentials['Connections']['Default'])
+        _db_config['name'] = _db_config['dbname']
+    else:
+        _db_config = dict(db_credentials)
+        _db_config['user'] = _db_config['username']
+        _db_config['name'] = _db_config['database']
+
+    if 'port' not in _db_config:
+        _db_config['port'] = 3306
+
+    return _db_config

db_sync_tool/recipes/symfony.py

@@ -1,14 +1,14 @@
 #!/usr/bin/env python3
-# -*- coding: future_fstrings -*-
 
 """
 Symfony script
 """
 
-import re
-import sys
-
-from db_sync_tool.utility import mode, system, helper, output
+from db_sync_tool.utility import mode, system, helper
+from db_sync_tool.utility.exceptions import ParsingError
+from db_sync_tool.recipes.parsing import (  # noqa: F401 (re-export)
+    parse_symfony_database_url,
+)
 
 
 def check_configuration(client):
@@ -17,7 +17,8 @@ def check_configuration(client):
     :param client: String
     :return:
     """
-    _path = system.config[client]['path']
+    cfg = system.get_typed_config()
+    _path = cfg.get_client(client).path
 
     # Check for symfony 2.8
     if 'parameters.yml' in _path:
@@ -31,14 +32,14 @@ def check_configuration(client):
     # Using for symfony >=3.4
     else:
         stdout = mode.run_command(
-            helper.get_command(client, 'grep') + ' -v "^#" ' + system.config[client][
-                'path'] + ' | ' + helper.get_command(client, 'grep') + ' DATABASE_URL',
+            helper.get_command(client, 'grep') + ' -v "^#" ' + _path +
+            ' | ' + helper.get_command(client, 'grep') + ' DATABASE_URL',
             client,
             True
         )
         _db_config = parse_database_credentials(stdout)
 
-    system.config[client]['db'] = _db_config
+    system.set_database_config(client, helper.clean_db_config(_db_config))
 
 
 def parse_database_credentials(db_credentials):
@@ -47,23 +48,10 @@ def parse_database_credentials(db_credentials):
     :param db_credentials: Dictionary
     :return: Dictionary
     """
-    db_credentials = str(db_credentials).replace('\\n\'','')
-    # DATABASE_URL=mysql://db-user:1234@db-host:3306/db-name
-    pattern = r'^DATABASE_URL=(?P<db_type>\w+):\/\/(?P<user>[^:]+):(?P<password>[^@]+)@(?P<host>[^:]+):(?P<port>\d+)\/(?P<name>[^?]+)(?:\?.*)?$'
-
-    match = re.match(pattern, db_credentials)
-
-    if match:
-        db_config = match.groupdict()
-        return db_config
-    else:
-        sys.exit(
-            output.message(
-                output.Subject.ERROR,
-                'Mismatch of expected database credentials',
-                False
-            )
-        )
+    try:
+        return parse_symfony_database_url(db_credentials)
+    except (ValueError, ParsingError):
+        raise ParsingError('Mismatch of expected database credentials') from None
 
 
 def get_database_parameter(client, name, file):
@@ -75,8 +63,9 @@ def get_database_parameter(client, name, file):
     :param file: String
     :return:
     """
-    return mode.run_command(
+    result = mode.run_command(
         helper.get_command(client, 'sed') + f' -n -e \'/{name}/ s/.*\\: *//p\' {file}',
         client,
         True
-    ).replace('\n', '')
+    )
+    return result.replace('\n', '') if result else ''

db_sync_tool/recipes/typo3.py

@@ -1,13 +1,16 @@
 #!/usr/bin/env python3
-# -*- coding: future_fstrings -*-
 
 """
 TYPO3 script
 """
 
-import json, sys
+import json
 
-from db_sync_tool.utility import mode, system, helper, output
+from db_sync_tool.utility import mode, system, helper
+from db_sync_tool.utility.exceptions import ParsingError
+from db_sync_tool.recipes.parsing import (  # noqa: F401 (re-export)
+    parse_typo3_database_credentials,
+)
 
 
 def check_configuration(client):
@@ -16,50 +19,50 @@ def check_configuration(client):
     :param client: String
     :return:
     """
-    _path = system.config[client]['path']
+    cfg = system.get_typed_config()
+    client_cfg = cfg.get_client(client)
+    _path = client_cfg.path
 
     if 'LocalConfiguration' in _path:
         stdout = mode.run_command(
             helper.get_command(client, 'php') + ' -r "echo json_encode(include \'' +
-            system.config[client][
-                'path'] + '\');"',
+            _path + '\');"',
             client,
             True
         )
+        if not stdout:
+            raise ParsingError('Failed to read TYPO3 configuration')
 
         _db_config = parse_database_credentials(json.loads(stdout)['DB'])
     elif '.env' in _path:
         # Try to parse settings from .env file
+        # db_cfg fields can override default env var names if user provides them
+        db_cfg = client_cfg.db
         _db_config = {
-            'name': get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__dbname', system.config[client]['path']),
-            'host': get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__host', system.config[client]['path']),
-            'password': get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__password', system.config[client]['path']),
-            'port': get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__port', system.config[client]['path'])
-            if get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__port',
-                                    system.config[client]['path']) != '' else 3306,
-            'user': get_database_setting_from_env(client, 'TYPO3_CONF_VARS__DB__Connections__Default__user', system.config[client]['path']),
+            'name': get_database_setting_from_env(client, db_cfg.name or 'TYPO3_CONF_VARS__DB__Connections__Default__dbname', _path),
+            'host': get_database_setting_from_env(client, db_cfg.host or 'TYPO3_CONF_VARS__DB__Connections__Default__host', _path),
+            'password': get_database_setting_from_env(client, db_cfg.password or 'TYPO3_CONF_VARS__DB__Connections__Default__password', _path),
+            'port': get_database_setting_from_env(client, str(db_cfg.port) if db_cfg.port else 'TYPO3_CONF_VARS__DB__Connections__Default__port', _path) or 3306,
+            'user': get_database_setting_from_env(client, db_cfg.user or 'TYPO3_CONF_VARS__DB__Connections__Default__user', _path),
         }
     elif 'AdditionalConfiguration.php' in _path:
         # Try to parse settings from AdditionalConfiguration.php file
         _db_config = {
-            'name': get_database_setting_from_additional_configuration(client, 'dbname', system.config[client]['path']),
-            'host': get_database_setting_from_additional_configuration(client, 'host', system.config[client]['path']),
-            'password': get_database_setting_from_additional_configuration(client, 'password', system.config[client]['path']),
-            'port': get_database_setting_from_additional_configuration(client, 'port', system.config[client]['path'])
-            if get_database_setting_from_additional_configuration(client, 'port',
-                                    system.config[client]['path']) != '' else 3306,
-            'user': get_database_setting_from_additional_configuration(client, 'user', system.config[client]['path']),
+            'name': get_database_setting_from_additional_configuration(client, 'dbname', _path),
+            'host': get_database_setting_from_additional_configuration(client, 'host', _path),
+            'password': get_database_setting_from_additional_configuration(client, 'password', _path),
+            'port': get_database_setting_from_additional_configuration(client, 'port', _path)
+            if get_database_setting_from_additional_configuration(client, 'port', _path) != '' else 3306,
+            'user': get_database_setting_from_additional_configuration(client, 'user', _path),
         }
     else:
-        sys.exit(
-            output.message(
-                output.Subject.ERROR,
-                f'Can\'t extract database information from given path {system.config[client]["path"]}. Can only extract settings from the following files: LocalConfiguration.php, AdditionalConfiguration.php, .env',
-                False
-            )
+        raise ParsingError(
+            f'Can\'t extract database information from given path {_path}. '
+            f'Can only extract settings from the following files: LocalConfiguration.php, '
+            f'AdditionalConfiguration.php, .env'
         )
 
-    system.config[client]['db'] = _db_config
+    system.set_database_config(client, helper.clean_db_config(_db_config))
 
 
 def parse_database_credentials(db_credentials):
@@ -68,21 +71,7 @@ def parse_database_credentials(db_credentials):
     :param db_credentials: Dictionary
     :return: Dictionary
     """
-    #
-    # Distinguish between database config scheme of TYPO3 v8+ and TYPO3 v7-
-    #
-    if 'Connections' in db_credentials:
-        _db_config = db_credentials['Connections']['Default']
-        _db_config['name'] = _db_config['dbname']
-    else:
-        _db_config = db_credentials
-        _db_config['user'] = _db_config['username']
-        _db_config['name'] = _db_config['database']
-
-    if 'port' not in _db_config:
-        _db_config['port'] = 3306
-
-    return _db_config
+    return parse_typo3_database_credentials(db_credentials)
 
 
 def get_database_setting_from_additional_configuration(client, name, file):
@@ -94,12 +83,7 @@ def get_database_setting_from_additional_configuration(client, name, file):
     :param file: String
     :return:
     """
-    return mode.run_command(
-        helper.get_command(client, 'sed') +
-        f' -nE "s/\'{name}\'.*=>.*\'(.*)\'.*$/\\1/p" {file}',
-        client,
-        True
-    ).replace('\n', '').strip()
+    return helper.run_sed_command(client, f'"s/\'{name}\'.*=>.*\'(.*)\'.*$/\\1/p" {file}')
 
 def get_database_setting_from_env(client, name, file):
     """
@@ -110,9 +94,4 @@ def get_database_setting_from_env(client, name, file):
     :param file: String
     :return:
     """
-    return mode.run_command(
-        helper.get_command(client, 'sed') +
-        f' -nE "s/{name}=(.*).*$/\\1/p" {file}',
-        client,
-        True
-    ).replace('\n', '').strip()
+    return helper.run_sed_command(client, f'"s/{name}=(.*).*$/\\1/p" {file}')

db_sync_tool/recipes/wordpress.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: future_fstrings -*-
 
 """
 Wordpress script
@@ -10,22 +9,23 @@ from db_sync_tool.utility import mode, system, helper
 
 def check_configuration(client):
     """
-    Checking Drupal database configuration
+    Checking WordPress database configuration
     :param client: String
     :return:
     """
-    _path = system.config[client]['path']
+    cfg = system.get_typed_config()
+    _path = cfg.get_client(client).path
 
     _db_config = {
-        'name': get_database_setting(client, 'DB_NAME', system.config[client]['path']),
-        'host': get_database_setting(client, 'DB_HOST', system.config[client]['path']),
-        'password': get_database_setting(client, 'DB_PASSWORD', system.config[client]['path']),
-        'port': get_database_setting(client, 'DB_PORT', system.config[client]['path'])
-        if get_database_setting(client, 'DB_PORT', system.config[client]['path']) != '' else 3306,
-        'user': get_database_setting(client, 'DB_USER', system.config[client]['path']),
+        'name': get_database_setting(client, 'DB_NAME', _path),
+        'host': get_database_setting(client, 'DB_HOST', _path),
+        'password': get_database_setting(client, 'DB_PASSWORD', _path),
+        'port': get_database_setting(client, 'DB_PORT', _path)
+        if get_database_setting(client, 'DB_PORT', _path) != '' else 3306,
+        'user': get_database_setting(client, 'DB_USER', _path),
     }
 
-    system.config[client]['db'] = _db_config
+    system.set_database_config(client, helper.clean_db_config(_db_config))
 
 
 def get_database_setting(client, name, file):
@@ -37,9 +37,10 @@ def get_database_setting(client, name, file):
     :param file: String
     :return:
     """
-    return mode.run_command(
+    result = mode.run_command(
         helper.get_command(client, 'sed') +
         f' -n "s/define( *\'{name}\', *\'\([^\']*\)\'.*/\\1/p" {file}',
         client,
         True
-    ).replace('\n', '')
+    )
+    return result.replace('\n', '') if result else ''