AbstractDatabase::loadTestUsers() - Code Metrics - Inspection of "Services" - Ecodev/felix - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 398dce...01f535 )

by Adrien

created 2020-05-08 11:29 UTC

AbstractDatabase::loadTestUsers() A

↳ Parent: AbstractDatabase

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php

declare(strict_types=1);

namespace Ecodev\Felix\Service;

/**
 * Tool to reload the entire local database from remote database for a given site
 *
 * Requirements:
 *
 * - ssh access to remote server (via ~/.ssh/config)
 * - both local and remote sites must be accesible via: /sites/MY_SITE
 * - both local and remote config/autoload/local.php files must contains the database connection info
 */
abstract class AbstractDatabase
{
    /**
     * Dump data from database on $remote server
     *
     * @param string $remote
     * @param string $dumpFile path
     */
    private static function dumpDataRemotely(string $remote, string $dumpFile): void
    {
        $sshCmd = <<<STRING
        ssh $remote "cd /sites/$remote/ && php7.4 bin/dump-data.php $dumpFile"
STRING;

        echo "dumping data $dumpFile on $remote...\n";
        self::executeLocalCommand($sshCmd);
    }

    /**
     * Dump data from database
     *
     * @param string $dumpFile path
     */
    public static function dumpData(string $dumpFile): void
    {
        $config = require 'config/autoload/local.php';
        $dbConfig = $config['doctrine']['connection']['orm_default']['params'];
        $host = $dbConfig['host'];
        $username = $dbConfig['user'];
        $database = $dbConfig['dbname'];
        $password = $dbConfig['password'];

        echo "dumping $dumpFile...\n";
        $dumpCmd = "mysqldump -v --user=$username --password=$password --host=$host $database | sed 's/DEFINER=[^*]*\\*/\\*/g' | gzip > $dumpFile";
        self::executeLocalCommand($dumpCmd);
    }

    /**
     * Copy a file from $remote
     *
     * @param string $remote
     * @param string $dumpFile
     */
    private static function copyFile(string $remote, string $dumpFile): void
    {
        $copyCmd = <<<STRING
        rsync -avz --progress $remote:$dumpFile $dumpFile
STRING;

        echo "copying dump to $dumpFile ...\n";
        self::executeLocalCommand($copyCmd);
    }

    /**
     * Load SQL dump in local database
     *
     * @param string $dumpFile
     */
    public static function loadData(string $dumpFile): void
    {
        $config = require 'config/autoload/local.php';
        $dbConfig = $config['doctrine']['connection']['orm_default']['params'];
        $host = $dbConfig['host'];
        $username = $dbConfig['user'];
        $database = $dbConfig['dbname'];
        $password = $dbConfig['password'];

        $dumpFile = realpath($dumpFile);
        if ($dumpFile === false) {
            throw new \Exception('Cannot find absolute path for file: ' . $dumpFile);
        }

        echo "loading dump $dumpFile...\n";
        if (!is_readable($dumpFile)) {
            throw new \Exception("Cannot read dump file \"$dumpFile\"");
        }

        self::executeLocalCommand(PHP_BINARY . ' ./vendor/bin/doctrine orm:schema-tool:drop --ansi --full-database --force');
        self::executeLocalCommand("gunzip -c \"$dumpFile\" | mysql --user=$username --password=$password --host=$host $database");
        self::executeLocalCommand(PHP_BINARY . ' ./vendor/bin/doctrine-migrations --ansi migrations:migrate --no-interaction');
        self::loadTriggers();
        self::loadTestUsers();
    }

    public static function loadRemoteData(string $remote): void
    {
        $dumpFile = "/tmp/$remote." . exec('whoami') . '.backup.sql.gz';
        self::dumpDataRemotely($remote, $dumpFile);
        self::copyFile($remote, $dumpFile);
        self::loadData($dumpFile);

        echo "database updated\n";
    }

    /**
     * Execute a shell command and throw exception if fails
     *
     * @param string $command
     *
     * @throws \Exception
     */
    public static function executeLocalCommand(string $command): void
    {
        $return_var = null;
        $fullCommand = "$command 2>&1";
        passthru($fullCommand, $return_var);
        if ($return_var) {
            throw new \Exception('FAILED executing: ' . $command);
        }
    }

    /**
     * Load test data
     */
    public static function loadTestData(): void
    {
        self::executeLocalCommand(PHP_BINARY . ' ./vendor/bin/doctrine orm:schema-tool:drop --ansi --full-database --force');
        self::executeLocalCommand(PHP_BINARY . ' ./vendor/bin/doctrine-migrations migrations:migrate --ansi --no-interaction');
        self::loadTriggers();
        self::loadTestUsers();
        self::importFile('tests/data/fixture.sql');
    }

    /**
     * Load triggers
     */
    public static function loadTriggers(): void
    {
        self::importFile('data/triggers.sql');
    }

    /**
     * Load test users
     */
    private static function loadTestUsers(): void
    {
        self::importFile('tests/data/users.sql');
    }

    /**
     * Import a SQL file into DB
     *
     * This use mysql command, instead of DBAL methods, to allow to see errors if any, and
     * also because it seems trigger creation do not work with DBAL for some unclear reasons.
     *
     * @param string $file
     */
    private static function importFile(string $file): void
    {
        $file = realpath($file);
        echo 'importing ' . $file . "\n";
        $connection = _em()->getConnection();
        $database = $connection->getDatabase();
        $username = $connection->getUsername();
        $username = /** @scrutinizer ignore-deprecated */ $connection->getUsername();
        $password = empty($connection->getPassword()) ? '' : '-p' . $connection->getPassword();
        $password = empty(/** @scrutinizer ignore-deprecated */ $connection->getPassword()) ? '' : '-p' . $connection->getPassword();

        $importCommand = "cat $file | mysql -u $username $password $database";

        self::executeLocalCommand($importCommand);
    }
}


Ecodev / felix

Push — master ( 398dce...01f535 )

AbstractDatabase::loadTestUsers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like