fix: make the process more extensible, avoid touching anything (#141)

* fix: make the process more extensible, avoid touching anything * fix: I'm assuming that in some cases, exiting the method is closing the file resource. Setting the tmpfile earlier should mean that this won't happen.
spatie · Jan 27, 2021 · 98194c7 · 98194c7
1 parent 6a90048
commit 98194c7
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 22 deletions.
diff --git a/src/Databases/MongoDb.php b/src/Databases/MongoDb.php
@@ -28,9 +28,7 @@ public function dumpToFile(string $dumpFile)
     {
         $this->guardAgainstIncompleteCredentials();
 
-        $command = $this->getDumpCommand($dumpFile);
-
-        $process = Process::fromShellCommandline($command, null, null, null, $this->timeout);
+        $process = $this->getProcess($dumpFile);
 
         $process->run();
 
@@ -43,7 +41,7 @@ public function dumpToFile(string $dumpFile)
      * @throws \Spatie\DbDumper\Exceptions\CannotStartDump
      * @return void
      */
-    protected function guardAgainstIncompleteCredentials()
+    public function guardAgainstIncompleteCredentials()
     {
         foreach (['dbName', 'host'] as $requiredProperty) {
             if (strlen($this->$requiredProperty) === 0) {
@@ -119,4 +117,15 @@ public function getDumpCommand(string $filename): string
 
         return $this->echoToFile(implode(' ', $command), $filename);
     }
+
+    /**
+     * @param string $dumpFile
+     * @return Process
+     */
+    public function getProcess(string $dumpFile): Process
+    {
+        $command = $this->getDumpCommand($dumpFile);
+
+        return Process::fromShellCommandline($command, null, null, null, $this->timeout);
+    }
 }
diff --git a/src/Databases/MySql.php b/src/Databases/MySql.php
@@ -41,6 +41,9 @@ class MySql extends DbDumper
     /** @var bool */
     protected $createTables = true;
 
+    /** @var false|resource */
+    private $tempFileHandle;
+
     public function __construct()
     {
         $this->port = 3306;
@@ -191,12 +194,9 @@ public function dumpToFile(string $dumpFile)
         $this->guardAgainstIncompleteCredentials();
 
         $tempFileHandle = tmpfile();
-        fwrite($tempFileHandle, $this->getContentsOfCredentialsFile());
-        $temporaryCredentialsFile = stream_get_meta_data($tempFileHandle)['uri'];
-
-        $command = $this->getDumpCommand($dumpFile, $temporaryCredentialsFile);
+        $this->setTempFileHandle($tempFileHandle);
 
-        $process = Process::fromShellCommandline($command, null, null, null, $this->timeout);
+        $process = $this->getProcess($dumpFile);
 
         $process->run();
 
@@ -320,7 +320,7 @@ public function getContentsOfCredentialsFile(): string
         return implode(PHP_EOL, $contents);
     }
 
-    protected function guardAgainstIncompleteCredentials()
+    public function guardAgainstIncompleteCredentials()
     {
         foreach (['userName', 'host'] as $requiredProperty) {
             if (strlen($this->$requiredProperty) === 0) {
@@ -332,4 +332,34 @@ protected function guardAgainstIncompleteCredentials()
             throw CannotStartDump::emptyParameter('dbName');
         }
     }
+
+    /**
+     * @param string $dumpFile
+     * @return Process
+     */
+    public function getProcess(string $dumpFile): Process
+    {
+        fwrite($this->getTempFileHandle(), $this->getContentsOfCredentialsFile());
+        $temporaryCredentialsFile = stream_get_meta_data($this->getTempFileHandle())['uri'];
+
+        $command = $this->getDumpCommand($dumpFile, $temporaryCredentialsFile);
+
+        return Process::fromShellCommandline($command, null, null, null, $this->timeout);
+    }
+
+    /**
+     * @return false|resource
+     */
+    public function getTempFileHandle()
+    {
+        return $this->tempFileHandle;
+    }
+
+    /**
+     * @param false|resource $tempFileHandle
+     */
+    public function setTempFileHandle($tempFileHandle)
+    {
+        $this->tempFileHandle = $tempFileHandle;
+    }
 }
diff --git a/src/Databases/PostgreSql.php b/src/Databases/PostgreSql.php
@@ -14,6 +14,9 @@ class PostgreSql extends DbDumper
     /** @var bool */
     protected $createTables = true;
 
+    /** @var false|resource */
+    private $tempFileHandle;
+
     public function __construct()
     {
         $this->port = 5432;
@@ -41,15 +44,10 @@ public function dumpToFile(string $dumpFile)
     {
         $this->guardAgainstIncompleteCredentials();
 
-        $command = $this->getDumpCommand($dumpFile);
-
         $tempFileHandle = tmpfile();
-        fwrite($tempFileHandle, $this->getContentsOfCredentialsFile());
-        $temporaryCredentialsFile = stream_get_meta_data($tempFileHandle)['uri'];
+        $this->setTempFileHandle($tempFileHandle);
 
-        $envVars = $this->getEnvironmentVariablesForDumpCommand($temporaryCredentialsFile);
-
-        $process = Process::fromShellCommandline($command, null, $envVars, null, $this->timeout);
+        $process = $this->getProcess($dumpFile);
 
         $process->run();
 
@@ -110,7 +108,7 @@ public function getContentsOfCredentialsFile(): string
         return implode(':', $contents);
     }
 
-    protected function guardAgainstIncompleteCredentials()
+    public function guardAgainstIncompleteCredentials()
     {
         foreach (['userName', 'dbName', 'host'] as $requiredProperty) {
             if (empty($this->$requiredProperty)) {
@@ -136,4 +134,36 @@ public function doNotCreateTables()
 
         return $this;
     }
+
+    /**
+     * @param string $dumpFile
+     * @return Process
+     */
+    public function getProcess(string $dumpFile): Process
+    {
+        $command = $this->getDumpCommand($dumpFile);
+
+        fwrite($this->getTempFileHandle(), $this->getContentsOfCredentialsFile());
+        $temporaryCredentialsFile = stream_get_meta_data($this->getTempFileHandle())['uri'];
+
+        $envVars = $this->getEnvironmentVariablesForDumpCommand($temporaryCredentialsFile);
+
+        return Process::fromShellCommandline($command, null, $envVars, null, $this->timeout);
+    }
+
+    /**
+     * @return false|resource
+     */
+    public function getTempFileHandle()
+    {
+        return $this->tempFileHandle;
+    }
+
+    /**
+     * @param false|resource $tempFileHandle
+     */
+    public function setTempFileHandle($tempFileHandle)
+    {
+        $this->tempFileHandle = $tempFileHandle;
+    }
 }
diff --git a/src/Databases/Sqlite.php b/src/Databases/Sqlite.php
@@ -16,9 +16,7 @@ class Sqlite extends DbDumper
      */
     public function dumpToFile(string $dumpFile)
     {
-        $command = $this->getDumpCommand($dumpFile);
-
-        $process = Process::fromShellCommandline($command, null, null, null, $this->timeout);
+        $process = $this->getProcess($dumpFile);
 
         $process->run();
 
@@ -48,4 +46,15 @@ public function getDumpCommand(string $dumpFile): string
 
         return $this->echoToFile($command, $dumpFile);
     }
+
+    /**
+     * @param string $dumpFile
+     * @return Process
+     */
+    public function getProcess(string $dumpFile): Process
+    {
+        $command = $this->getDumpCommand($dumpFile);
+
+        return Process::fromShellCommandline($command, null, null, null, $this->timeout);
+    }
 }
diff --git a/src/DbDumper.php b/src/DbDumper.php
@@ -257,7 +257,7 @@ public function addExtraOptionAfterDbName(string $extraOptionAfterDbName)
 
     abstract public function dumpToFile(string $dumpFile);
 
-    protected function checkIfDumpWasSuccessFul(Process $process, string $outputFile)
+    public function checkIfDumpWasSuccessFul(Process $process, string $outputFile)
     {
         if (! $process->isSuccessful()) {
             throw DumpFailed::processDidNotEndSuccessfully($process);