Database: add support to delete generated database dumps after-scenario.

If WordHat is configured to generate a DB dump during its run, WordHat was
leaving alot of files littering up PHP's temporary folder. Sorry!

See #227

src/Context/Traits/FilesystemAwareContextTrait.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+namespace PaulGibbs\WordpressBehatExtension\Context\Traits;
+
+/**
+ * Provides driver agnostic logic (helper methods) relating to a filesystem or files.
+ */
+trait FilesystemAwareContextTrait
+{
+    use BaseAwarenessTrait;
+
+    /**
+     * Delete specified file.
+     *
+     * @param string $abspath Absolute path to a file, to delete.
+     */
+    public function deleteFile(string $abspath)
+    {
+        $this->getDriver()->filesystem->deleteFile($abspath);
+    }
+}

src/Context/WordpressContext.php

@@ -4,17 +4,19 @@
 
 use Behat\Behat\Hook\Scope\AfterScenarioScope;
 use Behat\Behat\Hook\Scope\BeforeScenarioScope;
+use Behat\Behat\Event;
 use Behat\Mink\Driver\Selenium2Driver;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\CacheAwareContextTrait;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\DatabaseAwareContextTrait;
+use PaulGibbs\WordpressBehatExtension\Context\Traits\FilesystemAwareContextTrait;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\PageObjectAwareContextTrait;
 
 /**
  * Provides step definitions for a range of common tasks. Recommended for all test suites.
  */
 class WordpressContext extends RawWordpressContext
 {
-    use PageObjectAwareContextTrait, CacheAwareContextTrait, DatabaseAwareContextTrait;
+    use PageObjectAwareContextTrait, CacheAwareContextTrait, DatabaseAwareContextTrait, FilesystemAwareContextTrait;
 
     /**
      * Constructor.
@@ -45,7 +47,7 @@ public function maybeBackupDatabase(BeforeScenarioScope $scope)
          * Otherwise, we would use the (static) BeforeSuiteScope hook.
          */
         $backup_file = $this->getWordpress()->getSetting('database_backup_file');
-        if ($backup_file) {
+        if (! empty($backup_file)) {
             return;
         }
 
@@ -55,6 +57,7 @@ public function maybeBackupDatabase(BeforeScenarioScope $scope)
         // If the path specified is not a file, use it as the preferred folder to store a new backup.
         if (! $file || ! is_file($file) || ! is_readable($file)) {
             $file = $this->exportDatabase(['path' => $file]);
+            $this->getWordpress()->setSetting('built_database_backup', true);
         }
 
         // Note: $file may be either an absolute OR relative file path.
@@ -118,10 +121,35 @@ public function maybeRestoreDatabase(AfterScenarioScope $scope)
         }
 
         $file = $this->getWordpress()->getSetting('database_backup_file');
-        if (! $file) {
+        if (empty($file)) {
             return;
         }
 
         $this->importDatabase(['path' => $file]);
     }
+
+    /**
+     * If WordHat created its own database dump, delete it after the test suite has completed.
+     *
+     * @AfterSuite @db
+     *
+     * @param Event\SuiteEvent $scope
+     */
+    public function maybeRemoveDatabaseDump(Event\SuiteEvent $event)
+    {
+        $delete_backup = $this->getWordpress()->getSetting('built_database_backup');
+        if ($delete_backup === null) {
+            return;
+        }
+
+        $file = $this->getWordpress()->getSetting('database_backup_file');
+        if (empty($file)) {
+            return;
+        }
+
+        $this->getWordpress()->setSetting('database_backup_file', null);
+        $this->getWordpress()->setSetting('built_database_backup', null);
+
+        $this->deleteFile($file);
+    }
 }

src/Driver/Element/Wpcli/FilesystemElement.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+namespace PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli;
+
+use RuntimeException;
+use PaulGibbs\WordpressBehatExtension\Driver\Element\BaseElement;
+
+/**
+ * WP-CLI driver element for manipulating the filesystem.
+ */
+class FilesystemElement extends BaseElement
+{
+    /**
+     * Delete specified file.
+     *
+     * @param string $abspath Absolute path to a file, to delete.
+     */
+    public function deleteFile(string $abspath)
+    {
+        if (empty($abspath)) {
+            return;
+        }
+
+        $delete_cmd = sprintf('@unlink(%s);', escapeshellarg($abspath));
+        $this->drivers->getDriver()->wpcli('eval', $delete_cmd, ['--skip-wordpress']);
+    }
+}
+

src/Driver/Element/Wpphp/FilesystemElement.php

@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+namespace PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp;
+
+use RuntimeException;
+use PaulGibbs\WordpressBehatExtension\Driver\Element\BaseElement;
+
+/**
+ * WP-API driver element for manipulating the filesystem.
+ */
+class FilesystemElement extends BaseElement
+{
+    /**
+     * Delete specified file.
+     *
+     * @param string $abspath Absolute path to a file, to delete.
+     */
+    public function deleteFile(string $abspath)
+    {
+        if (empty($abspath) || ! is_file($abspath) || ! is_readable($abspath)) {
+            return;
+        }
+
+        wp_delete_file($abspath);
+    }
+}

src/ServiceContainer/config/drivers/wpcli.yml

@@ -4,6 +4,7 @@ parameters:
   wordpress.element.wpcli.comment.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\CommentElement
   wordpress.element.wpcli.content.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\ContentElement
   wordpress.element.wpcli.database.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\DatabaseElement
+  wordpress.element.wpcli.filesystem.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\FilesystemElement
   wordpress.element.wpcli.plugin.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\PluginElement
   wordpress.element.wpcli.term.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\TermElement
   wordpress.element.wpcli.theme.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpcli\ThemeElement
@@ -49,6 +50,13 @@ services:
     tags:
       - { name: wordpress.element, alias: database, driver: wpcli }
 
+  wordpress.element.wpcli.filesystem:
+    class: "%wordpress.element.wpcli.filesystem.class%"
+    arguments:
+      - "@wordpress.wordpress"
+    tags:
+      - { name: wordpress.element, alias: filesystem, driver: wpcli }
+
   wordpress.element.wpcli.plugin:
     class: "%wordpress.element.wpcli.plugin.class%"
     arguments:

src/ServiceContainer/config/drivers/wpphp.yml

@@ -4,6 +4,7 @@ parameters:
   wordpress.element.wpphp.comment.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\CommentElement
   wordpress.element.wpphp.content.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\ContentElement
   wordpress.element.wpphp.database.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\DatabaseElement
+  wordpress.element.wpphp.filesystem.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\FilesystemElement
   wordpress.element.wpphp.plugin.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\PluginElement
   wordpress.element.wpphp.term.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\TermElement
   wordpress.element.wpphp.theme.class: PaulGibbs\WordpressBehatExtension\Driver\Element\Wpphp\ThemeElement
@@ -46,6 +47,13 @@ services:
     tags:
       - { name: wordpress.element, alias: database, driver: wpphp }
 
+  wordpress.element.wpphp.filesystem:
+    class: "%wordpress.element.wpphp.filesystem.class%"
+    arguments:
+      - "@wordpress.wordpress"
+    tags:
+      - { name: wordpress.element, alias: filesystem, driver: wpphp }
+
   wordpress.element.wpphp.plugin:
     class: "%wordpress.element.wpphp.plugin.class%"
     arguments: