Merge pull request #169 from chrisrollins65

Added a dereference option to copy symbolic link target with tar

Author: sebastianfeldmann

doc/config/source/tar.json

@@ -7,6 +7,7 @@
     "compressProgram": "lbzip2",
     "removeSourceDir": false,
     "throttle": "5m",
-    "pathToTar": "/path/to/custom/bin"
+    "pathToTar": "/path/to/custom/bin",
+    "dereference": false
   }
 }

doc/config/source/tar.xml

@@ -23,4 +23,7 @@
 
   <!-- define your custom tar executable location -->
   <option name="pathToTar" value="/path/to/custom/bin" />
+
+  <!-- optional, default false -->
+  <option name="dereference" value="false" />
 </source>

src/Backup/Source/Tar.php

@@ -104,6 +104,13 @@ class Tar extends SimulatorExecutable implements Simulator
      */
     private $pathToArchive;
 
+    /**
+     * Instead of archiving symbolic links, archive the files they link to
+     *
+     * @var bool
+     */
+    private $dereference;
+
     /**
      * Setup.
      *
@@ -121,6 +128,7 @@ public function setup(array $conf = [])
         $this->forceLocal       = Util\Str::toBoolean(Util\Arr::getValue($conf, 'forceLocal', ''), false);
         $this->ignoreFailedRead = Util\Str::toBoolean(Util\Arr::getValue($conf, 'ignoreFailedRead', ''), false);
         $this->removeSourceDir  = Util\Str::toBoolean(Util\Arr::getValue($conf, 'removeSourceDir', ''), false);
+        $this->dereference      = Util\Str::toBoolean(Util\Arr::getValue($conf, 'dereference', ''), false);
     }
 
     /**
@@ -192,7 +200,8 @@ protected function createExecutable(Target $target) : Executable
                    ->ignoreFailedRead($this->ignoreFailedRead)
                    ->removeSourceDirectory($this->removeSourceDir)
                    ->throttle($this->throttle)
-                   ->archiveTo($this->pathToArchive);
+                   ->archiveTo($this->pathToArchive)
+                   ->dereference($this->dereference);
         // add paths to exclude
         foreach ($this->excludes as $path) {
             $executable->addExclude($path);

src/Cli/Executable/Tar.php

@@ -98,6 +98,13 @@ class Tar extends Abstraction implements Executable
         'xz'    => 'J'
     ];
 
+    /**
+     * Instead of archiving symbolic links, archive the files they link to
+     *
+     * @var bool
+     */
+    private $dereference = false;
+
     /**
      * Constructor.
      *
@@ -241,6 +248,18 @@ public function removeSourceDirectory(bool $bool) : Tar
         return $this;
     }
 
+    /**
+     * Instead of archiving symbolic links, archive the files they link
+     *
+     * @param bool $bool
+     * @return \phpbu\App\Cli\Executable\Tar
+     */
+    public function dereference(bool $bool) : Tar
+    {
+        $this->dereference = $bool;
+        return $this;
+    }
+
     /**
      * Tar CommandLine generator.
      *
@@ -259,6 +278,7 @@ protected function createCommandLine() : CommandLine
         $this->setExcludeOptions($tar);
         $this->handleWarnings($tar);
 
+        $tar->addOptionIfNotEmpty('-h', $this->dereference, false);
         $tar->addOptionIfNotEmpty('--force-local', $this->local, false);
         $tar->addOptionIfNotEmpty('--use-compress-program', $this->compressProgram);
         $tar->addOption('-' . (empty($this->compressProgram) ? $this->compression : '') . $create);

tests/phpbu/Backup/Source/TarTest.php

@@ -58,6 +58,28 @@ public function testDefault()
         );
     }
 
+    /**
+     * Tests Tar::getExecutable
+     */
+    public function testDereferenceOption()
+    {
+        $target = $this->createTargetMock('/tmp/backup.tar');
+        $target->method('shouldBeCompressed')->willReturn(false);
+        $target->method('getPathname')->willReturn('/tmp/backup.tar');
+
+        $tar = new Tar();
+        $tar->setup(['pathToTar' => PHPBU_TEST_BIN, 'path' => __DIR__, 'dereference' => 'true']);
+
+        $exec = $tar->getExecutable($target);
+
+        $this->assertEquals(
+            PHPBU_TEST_BIN . '/tar -h -cf \'/tmp/backup.tar\' -C \''
+            . dirname(__DIR__) . '\' \''
+            . basename(__DIR__) . '\'',
+            $exec->getCommand()
+        );
+    }
+
     /**
      * Tests Tar::getExecutable
      */

tests/phpbu/Cli/Executable/TarTest.php

@@ -32,6 +32,24 @@ public function testDefault()
         );
     }
 
+    /**
+     * Tests Tar::getCommandLine
+     */
+    public function testDereference()
+    {
+        $dir  = sys_get_temp_dir();
+        $tarC = dirname($dir);
+        $tarD = basename($dir);
+        $tar  = new Tar(PHPBU_TEST_BIN);
+        $tar->archiveDirectory($dir)->archiveTo('/tmp/foo.tar')->dereference(true);
+
+        $this->assertEquals([0], $tar->getAcceptableExitCodes());
+        $this->assertEquals(
+            PHPBU_TEST_BIN . '/tar -h -cf \'/tmp/foo.tar\' -C \'' . $tarC .  '\' \'' . $tarD . '\'',
+            $tar->getCommand()
+        );
+    }
+
     /**
      * Tests Tar::getCommandLine
      */