db_sync_tool.recipes.typo3

Complexity

Total Complexity

12

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes

0

4 Functions

Rating	Name	Duplication	Size	Complexity
B	check_configuration()	0	52	7
A	parse_database_credentials()	0	21	3
A	get_database_setting_from_additional_configuration()	0	10	1
A	get_database_setting_from_env()	0	10	1

#!/usr/bin/env python3
# -*- coding: future_fstrings -*-

"""
TYPO3 script
"""

import json, sys

Multiple imports on one line (json, sys)

from db_sync_tool.utility import mode, system, helper, output


def check_configuration(client):
    """
    Checking remote TYPO3 database configuration
    :param client: String
    :return:
    """
    _path = system.config[client]['path']

    if 'LocalConfiguration' in _path:
        stdout = mode.run_command(
            helper.get_command(client, 'php') + ' -r "echo json_encode(include \'' +
            system.config[client][
                'path'] + '\');"',
            client,
            True
        )

        _db_config = parse_database_credentials(json.loads(stdout)['DB'])
    elif '.env' in _path:
        # Try to parse settings from .env file
        if 'db' not in system.config[client]:
            system.config[client]['db'] = {}

        _db_config = {
            'name': get_database_setting_from_env(client, system.config[client]['db'].get('name', 'TYPO3_CONF_VARS__DB__Connections__Default__dbname'), system.config[client]['path']),

This line is too long as per the coding-style (183/100).

            'host': get_database_setting_from_env(client, system.config[client]['db'].get('host', 'TYPO3_CONF_VARS__DB__Connections__Default__host'), system.config[client]['path']),

This line is too long as per the coding-style (181/100).

            'password': get_database_setting_from_env(client, system.config[client]['db'].get('password', 'TYPO3_CONF_VARS__DB__Connections__Default__password'), system.config[client]['path']),

This line is too long as per the coding-style (193/100).

            'port': get_database_setting_from_env(client, system.config[client]['db'].get('port', 'TYPO3_CONF_VARS__DB__Connections__Default__port'), system.config[client]['path'])

This line is too long as per the coding-style (180/100).

            if get_database_setting_from_env(client, system.config[client]['db'].get('port', 'TYPO3_CONF_VARS__DB__Connections__Default__port'), system.config[client]['path']) != '' else 3306,

Wrong continued indentation (add 8 spaces).

This line is too long as per the coding-style (192/100).

            'user': get_database_setting_from_env(client, system.config[client]['db'].get('user', 'TYPO3_CONF_VARS__DB__Connections__Default__user'), system.config[client]['path']),

This line is too long as per the coding-style (181/100).

        }
    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']),

This line is too long as per the coding-style (120/100).

            'host': get_database_setting_from_additional_configuration(client, 'host', system.config[client]['path']),

This line is too long as per the coding-style (118/100).

            'password': get_database_setting_from_additional_configuration(client, 'password', system.config[client]['path']),

This line is too long as per the coding-style (126/100).

            'port': get_database_setting_from_additional_configuration(client, 'port', system.config[client]['path'])

This line is too long as per the coding-style (117/100).

            if get_database_setting_from_additional_configuration(client, 'port',

Wrong continued indentation (add 8 spaces).

                                    system.config[client]['path']) != '' else 3306,

Wrong continued indentation (add 30 spaces).

            'user': get_database_setting_from_additional_configuration(client, 'user', system.config[client]['path']),

This line is too long as per the coding-style (118/100).

        }
    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',

This line is too long as per the coding-style (214/100).

                False
            )
        )

    system.config[client]['db'] = helper.clean_db_config(_db_config)

The variable _db_config does not seem to be defined for all execution paths.

def parse_database_credentials(db_credentials):
    """
    Parsing database credentials to needed format
    :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


def get_database_setting_from_additional_configuration(client, name, file):
    """
    Get database setting try to regex from AdditionalConfiguration
    sed -nE "s/'dbname'.*=>.*'(.*)'.*$/\1/p" /var/www/html/tests/files/www1/AdditionalConfiguration.php

This line is too long as per the coding-style (103/100).

    :param client: String
    :param name: String
    :param file: String
    :return:
    """
    return helper.run_sed_command(client, f'"s/\'{name}\'.*=>.*\'(.*)\'.*$/\\1/p" {file}')

def get_database_setting_from_env(client, name, file):
    """
    Get database setting try to regex from .env
    sed -nE "s/TYPO3_CONF_VARS__DB__Connections__Default__host=(.*).*$/\1/p" /var/www/html/tests/files/www1/typo3.env

This line is too long as per the coding-style (117/100).

    :param client: String
    :param name: String
    :param file: String
    :return:
    """
    return helper.run_sed_command(client, f'"s/{name}=(.*).*$/\\1/p" {file}')

Final newline missing