start with functional task tests - add database tests

gaambo · gaambo · commit c52154243e45 · 2025-03-25T16:41:46.000+01:00
rename dump_paths to use dbdump/ prefix
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -46,4 +46,4 @@ jobs:
 
       # Run PHPUnit tests
       - name: Run PHPUnit tests
-        run: composer run-script test 
+        run: composer run-script test
diff --git a/composer.json b/composer.json
@@ -14,7 +14,8 @@
     "phpstan/phpstan": "^2.1",
     "phpunit/phpunit": "^10.5",
     "squizlabs/php_codesniffer": "^3.11",
-    "symfony/console": "^6.4"
+    "symfony/console": "^6.4",
+    "symfony/process": "^6.4"
   },
   "require": {
     "php": "^8.1",
@@ -36,8 +37,19 @@
     "phpcs:fix": "vendor/bin/phpcbf",
     "phpstan": "vendor/bin/phpstan analyse --memory-limit 1G",
     "lint": "find . -type f -name '*.php' -not -path './vendor/*' -exec php -l {} \\;",
-    "test": "vendor/bin/phpunit",
-    "test:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text --filter 'Gaambo\\\\DeployerWordpress\\\\'",
+    "phpunit": "DO_NOT_TRACK=true vendor/bin/phpunit",
+    "tests:unit": "DO_NOT_TRACK=true vendor/bin/phpunit --testsuite Unit",
+    "tests:unit:coverage": "DO_NOT_TRACK=true XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite Unit --coverage-text",
+    "tests:integration": "DO_NOT_TRACK=true vendor/bin/phpunit --testsuite Integration",
+    "tests:integration:coverage": "DO_NOT_TRACK=true XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite Integration --coverage-text",
+    "tests:functional": "DO_NOT_TRACK=true vendor/bin/phpunit --testsuite Functional",
+    "tests:functional:coverage": "DO_NOT_TRACK=true XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite Functional --coverage-text",
+    "tests": [
+      "@test:unit",
+      "@test:integration",
+      "@test:functional"
+    ],
+    "tests:coverage": "DO_NOT_TRACK=true XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text",
     "precommit": [
       "@lint",
       "@phpcs",
diff --git a/composer.lock b/composer.lock
diff --git a/examples/bedrock/deploy.php b/examples/bedrock/deploy.php
@@ -33,7 +33,7 @@
     ->set('themes/dir', 'web/app/themes')
     ->set('plugins/dir', 'web/app/plugins')
     ->set('wp/dir', 'web/wp')
-    ->set('dump_path', __DIR__ . '/data/db_dumps')
+    ->set('dbdump/path', __DIR__ . '/data/db_dumps')
     ->set('backup_path', __DIR__ . '/data/backups');
 
 set('packages', [
diff --git a/examples/bedrock/deploy.yml b/examples/bedrock/deploy.yml
@@ -14,5 +14,5 @@ hosts:
     themes/dir: web/app/themes
     plugins/dir: web/app/plugins
     wp/dir: web/wp
-    dump_path: ~/data/dumps
+    dbdump/path: ~/data/dumps
     backup_path: ~/data/backups
diff --git a/examples/simple/deploy.php b/examples/simple/deploy.php
@@ -26,7 +26,7 @@
     ->set('current_path', function () {
         return Localhost::getConfig('release_path');
     })
-    ->set('dump_path', __DIR__ . '/data/db_dumps')
+    ->set('dbdump/path', __DIR__ . '/data/db_dumps')
     ->set('backup_path', __DIR__ . '/data/backups');
 
 set('packages', [
diff --git a/examples/simple/deploy.yml b/examples/simple/deploy.yml
@@ -10,5 +10,5 @@ hosts:
     public_url: https://test.dev
     deploy_path: "~"
     release_path: "{{deploy_path}}/public_html" # fixed directory, no symlinks
-    dump_path: ~/data/dumps
+    dbdump/path: ~/data/dumps
     backup_path: ~/data/backups
diff --git a/phpunit.xml b/phpunit.xml
@@ -7,10 +7,14 @@
     <testsuite name="Integration">
       <directory>tests/Integration</directory>
     </testsuite>
+    <testsuite name="Functional">
+      <directory>tests/Functional</directory>
+    </testsuite>
   </testsuites>
   <source>
     <include>
       <directory suffix=".php">src</directory>
+      <directory suffix=".php">tasks</directory>
     </include>
     <exclude>
       <directory suffix=".php">tests</directory>
diff --git a/recipes/bedrock.php b/recipes/bedrock.php
@@ -20,7 +20,7 @@
 use function Deployer\test;
 use function Deployer\upload;
 
-require_once __DIR__ . '/common.php';
+require __DIR__ . '/common.php';
 
 add('recipes', ['bedrock-wp']);
 
diff --git a/recipes/common.php b/recipes/common.php
@@ -32,18 +32,27 @@
 
 // Deployer binary sets the include path, so this should work.
 
-$deployerPath = 'vendor/deployer/deployer/';
-require_once $deployerPath . 'recipe/common.php';
+$commonRecipePaths = [
+    __DIR__ . '/../vendor/deployer/deployer/recipe/common.php', // Development/testing
+    __DIR__ . '/../deployer/deployer/recipe/common.php' // Installed via composer
+];
+
+foreach ($commonRecipePaths as $recipePath) {
+    if (file_exists($recipePath)) {
+        require $recipePath;
+        break;
+    }
+}
 
 // Include task definitions
-require_once __DIR__ . '/../tasks/database.php';
-require_once __DIR__ . '/../tasks/files.php';
-require_once __DIR__ . '/../tasks/mu-plugins.php';
-require_once __DIR__ . '/../tasks/packages.php';
-require_once __DIR__ . '/../tasks/plugins.php';
-require_once __DIR__ . '/../tasks/themes.php';
-require_once __DIR__ . '/../tasks/uploads.php';
-require_once __DIR__ . '/../tasks/wp.php';
+require __DIR__ . '/../tasks/database.php';
+require __DIR__ . '/../tasks/files.php';
+require __DIR__ . '/../tasks/mu-plugins.php';
+require __DIR__ . '/../tasks/packages.php';
+require __DIR__ . '/../tasks/plugins.php';
+require __DIR__ . '/../tasks/themes.php';
+require __DIR__ . '/../tasks/uploads.php';
+require __DIR__ . '/../tasks/wp.php';
 
 // BINARIES
 set('bin/npm', function () {
diff --git a/recipes/simple.php b/recipes/simple.php
@@ -15,7 +15,7 @@
 use function Deployer\task;
 use function Deployer\test;
 
-require_once __DIR__ . '/common.php';
+require __DIR__ . '/common.php';
 
 add('recipes', ['simple-wp']);
 
diff --git a/tasks/database.php b/tasks/database.php
@@ -18,58 +18,61 @@
 
 use function Deployer\download;
 use function Deployer\get;
+use function Deployer\has;
 use function Deployer\run;
 use function Deployer\runLocally;
 use function Deployer\set;
 use function Deployer\task;
+use function Deployer\test;
+use function Deployer\testLocally;
 use function Deployer\upload;
 
 /**
  * Create backup of remote database and download locally
  *
  * Configuration:
- * - dump_path: Directory to store database dumps (required on both local and remote)
+ * - dbdump/path: Directory to store database dumps (required on both local and remote)
  * - bin/wp: WP-CLI binary/command to use (automatically configured)
  *
  * Example:
  *     dep db:remote:backup prod
  */
 task('db:remote:backup', function () {
-    $localDumpPath = Localhost::getConfig('dump_path');
+    $localDumpPath = Localhost::getConfig('dbdump/path');
+    $remoteDumpPath = get('dbdump/path');
     $now = date('Y-m-d_H-i', time());
-    set('dump_file', "db_backup-$now.sql");
-    set('dump_filepath', get('dump_path') . '/' . get('dump_file'));
+    set('dbdump/file', "db_backup-$now.sql");
 
-    run('mkdir -p ' . get('dump_path'));
-    WPCLI::runCommand("db export {{dump_filepath}} --add-drop-table", "{{release_or_current_path}}");
+    run('mkdir -p ' . get('dbdump/path'));
+    WPCLI::runCommand("db export $remoteDumpPath/{{dbdump/file}} --add-drop-table", "{{release_or_current_path}}");
 
     runLocally("mkdir -p $localDumpPath");
-    download('{{dump_filepath}}', "$localDumpPath/{{dump_file}}");
+    download("$remoteDumpPath/{{dbdump/file}}", "$localDumpPath/{{dbdump/file}}");
 })->desc('Create backup of remote database and download locally');
 
 /**
  * Create backup of local database and upload to remote
  *
  * Configuration:
- * - dump_path: Directory to store database dumps (required on both local and remote)
+ * - dbdump/path: Directory to store database dumps (required on both local and remote)
  * - bin/wp: WP-CLI binary/command to use (automatically configured)
  *
  * Example:
  *     dep db:local:backup prod
  */
 task('db:local:backup', function () {
-    $localDumpPath = Localhost::getConfig('dump_path');
+    $localDumpPath = Localhost::getConfig('dbdump/path');
+    $remoteDumpPath = get('dbdump/path');
     $now = date('Y-m-d_H-i', time());
-    set('dump_file', "db_backup-$now.sql");
-    set('dump_filepath', '{{dump_path}}/{{dump_file}}');
+    set('dbdump/file', "db_backup-$now.sql");
 
     runLocally("mkdir -p $localDumpPath");
-    WPCLI::runCommandLocally("db export $localDumpPath/{{dump_file}} --add-drop-table");
+    WPCLI::runCommandLocally("db export $localDumpPath/{{dbdump/file}} --add-drop-table");
 
-    run('mkdir -p {{dump_path}}');
+    run('mkdir -p {{dbdump/path}}');
     upload(
-        "$localDumpPath/{{dump_file}}",
-        '{{dump_filepath}}'
+        "$localDumpPath/{{dbdump/file}}",
+        "$remoteDumpPath/{{dbdump/file}}"
     );
 })->desc('Create backup of local database and upload to remote');
 
@@ -85,8 +88,13 @@
  *     dep db:remote:import prod
  */
 task('db:remote:import', function () {
+    // Check if dump file exists
+    if (!has('dbdump/file') || !test('[ -f {{dbdump/path}}/{{dbdump/file}} ]')) {
+        throw new \RuntimeException('Database dump file not found at {{dbdump/path}}/{{dbdump/file}}');
+    }
+
     $localUrl = Localhost::getConfig('public_url');
-    WPCLI::runCommand("db import {{dump_filepath}}", "{{release_or_current_path}}");
+    WPCLI::runCommand("db import {{dbdump/path}}/{{dbdump/file}}", "{{release_or_current_path}}");
     WPCLI::runCommand("search-replace $localUrl {{public_url}}", "{{release_or_current_path}}");
 
     // If the local uploads directory is different from the remote one
@@ -96,7 +104,7 @@
         WPCLI::runCommand("search-replace $localUploadsDir {{uploads/dir}}", "{{release_or_current_path}}");
     }
 
-    run('rm -f {{dump_filepath}}');
+    run('rm -f {{dbdump/path}}/{{dbdump/file}}');
 })->desc('Import database backup on remote host');
 
 /**
@@ -106,15 +114,19 @@
  * - bin/wp: WP-CLI binary/command to use (automatically configured)
  * - public_url: Site URL for both local and remote (required for URL replacement)
  * - uploads/dir: Upload directory path (for path replacement if different between environments)
- * - dump_path: Directory containing database dumps
+ * - dbdump/path: Directory containing database dumps
  *
  * Example:
  *     dep db:local:import prod
  */
 task('db:local:import', function () {
+    // Check if dump file exists
+    $localDumpPath = Localhost::getConfig('dbdump/path');
+    if (!has('dbdump/file') || !testLocally("[ -f $localDumpPath/{{dbdump/file}} ]")) {
+        throw new \RuntimeException("Database dump file not found at $localDumpPath/{{dbdump/file}}");
+    }
     $localUrl = Localhost::getConfig('public_url');
-    $localDumpPath = Localhost::getConfig('dump_path');
-    WPCLI::runCommandLocally("db import $localDumpPath/{{dump_file}}");
+    WPCLI::runCommandLocally("db import $localDumpPath/{{dbdump/file}}");
     WPCLI::runCommandLocally("search-replace {{public_url}} $localUrl");
 
     // If the local uploads directory is different from the remote one
@@ -124,7 +136,7 @@
         WPCLI::runCommandLocally("search-replace {{uploads/dir}} $localUploadsDir");
     }
 
-    runLocally("rm -f $localDumpPath/{{dump_file}}");
+    runLocally("rm -f $localDumpPath/{{dbdump/file}}");
 })->desc('Import database backup on local host');
 
 /**
diff --git a/tests/Fixtures/database/dump.sql b/tests/Fixtures/database/dump.sql
diff --git a/tests/Fixtures/recipes/common.php b/tests/Fixtures/recipes/common.php
diff --git a/tests/Functional/FunctionalTestCase.php b/tests/Functional/FunctionalTestCase.php
diff --git a/tests/Functional/Tasks/DatabaseTasksFunctionalTest.php b/tests/Functional/Tasks/DatabaseTasksFunctionalTest.php
