BackupTrait::getBinary() method has been moved to Driver abstract class

Author: mirko-pagliai

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 2.x branch
 ## 2.7 branch
 ### 2.7.0
+* `BackupTrait::getBinary()` method has been moved to `Driver` abstract class;
 * `BackupTrait::getTarget()`, `BackupTrait::getDriverName()` and
     `BackupTrait::getValidExtensions()` methods have been removed.
 

src/BackupTrait.php

@@ -17,7 +17,6 @@
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
 use InvalidArgumentException;
-use RuntimeException;
 use Symfony\Component\Filesystem\Filesystem;
 
 /**
@@ -46,21 +45,6 @@ public function getAbsolutePath($path)
         return $path;
     }
 
-    /**
-     * Gets a binary path
-     * @param string $name Binary name
-     * @return string
-     * @since 2.0.0
-     * @throws \RuntimeException
-     */
-    public function getBinary($name)
-    {
-        $binary = Configure::read('DatabaseBackup.binaries.' . $name);
-        is_true_or_fail($binary, sprintf('Binary for `%s` could not be found. You have to set its path manually', $name), RuntimeException::class);
-
-        return $binary;
-    }
-
     /**
      * Returns the compression type from a filename
      * @param string $filename Filename

src/Driver/Driver.php

@@ -17,6 +17,7 @@
 use Cake\Event\EventDispatcherTrait;
 use Cake\Event\EventListenerInterface;
 use DatabaseBackup\BackupTrait;
+use RuntimeException;
 
 /**
  * Represents a driver containing all methods to export/import database backups
@@ -120,6 +121,7 @@ public function beforeImport()
      * @param string $filename Filename where you want to export the database
      * @return string
      * @uses _exportExecutable()
+     * @uses getBinary()
      */
     protected function _exportExecutableWithCompression($filename)
     {
@@ -143,6 +145,7 @@ protected function _exportExecutableWithCompression($filename)
      * @param string $filename Filename from which you want to import the database
      * @return string
      * @uses _importExecutable()
+     * @uses getBinary()
      */
     protected function _importExecutableWithCompression($filename)
     {
@@ -189,6 +192,20 @@ final public function export($filename)
         return file_exists($filename);
     }
 
+    /**
+     * Gets a binary path
+     * @param string $name Binary name
+     * @return string
+     * @throws \RuntimeException
+     */
+    public function getBinary($name)
+    {
+        $binary = Configure::read('DatabaseBackup.binaries.' . $name);
+        is_true_or_fail($binary, sprintf('Binary for `%s` could not be found. You have to set its path manually', $name), RuntimeException::class);
+
+        return $binary;
+    }
+
     /**
      * Gets a config value or the whole configuration
      * @param string|null $key Config key or `null` to get all config values

src/Driver/Mysql.php

@@ -30,6 +30,7 @@ class Mysql extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      * @uses $auth
      */
@@ -46,6 +47,7 @@ protected function _exportExecutable()
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      * @uses $auth
      */

src/Driver/Postgres.php

@@ -46,6 +46,7 @@ protected function getDbnameAsString()
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getDbnameAsString()
      */
     protected function _exportExecutable()
@@ -56,6 +57,7 @@ protected function _exportExecutable()
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getDbnameAsString()
      */
     protected function _importExecutable()

src/Driver/Sqlite.php

@@ -23,6 +23,7 @@ class Sqlite extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      */
     protected function _exportExecutable()
@@ -33,6 +34,7 @@ protected function _exportExecutable()
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      */
     protected function _importExecutable()

src/TestSuite/DriverTestCase.php

@@ -219,7 +219,7 @@ public function testExportExecutableWithCompression()
             $expected = sprintf(
                 '%s | %s > %s%s',
                 $basicExecutable,
-                $this->getBinary($compression),
+                $this->Driver->getBinary($compression),
                 escapeshellarg($filename),
                 REDIRECT_TO_DEV_NULL
             );
@@ -310,7 +310,7 @@ public function testImportExecutableWithCompression()
             $result = $this->invokeMethod($this->Driver, '_importExecutableWithCompression', [$filename]);
             $expected = sprintf(
                 '%s -dc %s | %s%s',
-                $this->getBinary($compression),
+                $this->Driver->getBinary($compression),
                 escapeshellarg($filename),
                 $basicExecutable,
                 REDIRECT_TO_DEV_NULL

tests/TestCase/BackupTraitTest.php

@@ -56,20 +56,6 @@ public function testGetAbsolutePath()
         $this->assertEquals($expected, $this->getAbsolutePath(Configure::read('DatabaseBackup.target') . DS . 'file.txt'));
     }
 
-    /**
-     * Test for `getBinary()` method
-     * @test
-     */
-    public function testGetBinary()
-    {
-        $this->assertEquals(which('mysql'), $this->getBinary('mysql'));
-
-        //With a binary not available
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Binary for `noExisting` could not be found. You have to set its path manually');
-        $this->getBinary('noExisting');
-    }
-
     /**
      * Test for `getCompression()` method
      * @test

tests/TestCase/Driver/DriverTest.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * This file is part of cakephp-database-backup.
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright   Copyright (c) Mirko Pagliai
+ * @link        https://github.com/mirko-pagliai/cakephp-database-backup
+ * @license     https://opensource.org/licenses/mit-license.php MIT License
+ */
+
+namespace DatabaseBackup\Test\TestCase\Driver;
+
+use DatabaseBackup\Driver\Mysql;
+use DatabaseBackup\TestSuite\TestCase;
+use RuntimeException;
+
+/**
+ * DriverTest class
+ */
+class DriverTest extends TestCase
+{
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->Driver = new Mysql($this->getConnection('test'));
+    }
+
+    /**
+     * Test for `getBinary()` method
+     * @test
+     */
+    public function testGetBinary()
+    {
+        $this->assertEquals(which('mysql'), $this->invokeMethod($this->Driver, 'getBinary', ['mysql']));
+
+        //With a binary not available
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Binary for `noExisting` could not be found. You have to set its path manually');
+        $this->invokeMethod($this->Driver, 'getBinary', ['noExisting']);
+    }
+}

tests/TestCase/Driver/MysqlTest.php

@@ -46,7 +46,7 @@ class MysqlTest extends DriverTestCase
      */
     public function testExportExecutable()
     {
-        $expected = sprintf('%s --defaults-file=%s test', $this->getBinary('mysqldump'), escapeshellarg('authFile'));
+        $expected = sprintf('%s --defaults-file=%s test', $this->Driver->getBinary('mysqldump'), escapeshellarg('authFile'));
         $this->setProperty($this->Driver, 'auth', 'authFile');
         $this->assertEquals($expected, $this->invokeMethod($this->Driver, '_exportExecutable'));
     }
@@ -67,7 +67,7 @@ public function testExportExecutableWithCompression()
      */
     public function testImportExecutable()
     {
-        $expected = sprintf('%s --defaults-extra-file=%s test', $this->getBinary('mysql'), escapeshellarg('authFile'));
+        $expected = sprintf('%s --defaults-extra-file=%s test', $this->Driver->getBinary('mysql'), escapeshellarg('authFile'));
         $this->setProperty($this->Driver, 'auth', 'authFile');
         $this->assertEquals($expected, $this->invokeMethod($this->Driver, '_importExecutable'));
     }