Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions features/COVERAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Legend: covered / partial / not covered (reason). Feature files are abbreviated:
| restart (no flag, `--nginx`, `--all`), unknown service flag | covered | rr: Restart the site containers (outline); Restart rejects services... |
| restart refuses a broken nginx config | covered | rr: Restart refuses a broken nginx config and keeps the site serving |
| reload (no flag, `--nginx`, `--all`), custom config applied | covered | rr: Reload nginx... (outline); Custom nginx config is applied on reload |
| reload with a broken config | not covered yet | reload exits 0 when `nginx -t` fails (its scenario comes back with the fix) |
| reload with a broken config | covered | rr: Reload fails when the nginx config test fails |
| `custom-compose` config branch of restart/enable | not covered | needs a custom compose setup (config change) |
| clean: no flags, `--object`, `--page`, `--proxy` without proxy cache | covered | clean: first four scenarios |
| clean `--proxy` with proxy cache | covered (@destructive, regression check for the purge without a terminal) | clean: Cleaning the proxy cache empties it |
Expand Down Expand Up @@ -224,10 +224,10 @@ DB and container migrations under `migrations/` (core upgrade flow), the AcmePhp

## Coverage estimate

Counting the rows above as items: 124 items, 91 covered, 1 partial, 32 not covered (8 of them, marked "not covered yet", are open bugs whose scenarios come back with their fixes), i.e. about 73% of the inventory. Every user-facing subcommand and option of the html type has at least one scenario except `ssl-renew --force`, `clone --ssl/--wildcard` and a live `share`.
Counting the rows above as items: 124 items, 92 covered, 1 partial, 31 not covered (7 of them, marked "not covered yet", are open bugs whose scenarios come back with their fixes), i.e. about 74% of the inventory. Every user-facing subcommand and option of the html type has at least one scenario except `ssl-renew --force`, `clone --ssl/--wildcard` and a live `share`.

## Known bugs left out

13 scenarios that expose open bugs are not part of this suite; each comes back with the PR that fixes its bug. They cover: the www redirect of a site whose next label starts with `w`, and the redirect after re-enabling a site when the www check fails; the owner lookup of an alias that contains another alias; `update --ssl=inherit` skipping the parent check; the inherit error message dumping the parent site object; the self-signed certificate leaving out alias domains; `ssl-info --get-dns-records` on self-signed sites; `ssl-verify` on a valid Let's Encrypt site; `site reload` exiting 0 when `nginx -t` fails; `site clean` without flags on html sites; invalid `--proxy-cache` values; the removed EE v3 cache flags message; and `update --php` on html sites failing late.
12 scenarios that expose open bugs are not part of this suite; each comes back with the PR that fixes its bug. They cover: the www redirect of a site whose next label starts with `w`, and the redirect after re-enabling a site when the www check fails; the owner lookup of an alias that contains another alias; `update --ssl=inherit` skipping the parent check; the inherit error message dumping the parent site object; the self-signed certificate leaving out alias domains; `ssl-info --get-dns-records` on self-signed sites; `ssl-verify` on a valid Let's Encrypt site; `site clean` without flags on html sites; invalid `--proxy-cache` values; the removed EE v3 cache flags message; and `update --php` on html sites failing late.

PRs that change what passing scenarios assert, to revisit when they merge: EasyEngine/site-command#480 keeps `<site>.lock` after a successful backup/restore (drop the two "lock should not exist" lines in backup).
7 changes: 7 additions & 0 deletions features/restart-reload.feature
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,10 @@ Feature: Restart and reload site services
When I write "# Custom Nginx configuration can be put here\n" to the file "{SITES_DIR}/bh-site-command-58.test/config/nginx/custom/user.conf"
And I run 'bin/ee site reload bh-site-command-58.test'
Then the command should succeed

Scenario: Reload fails when the nginx config test fails
Given the html site "bh-site-command-57.test" exists
And I write "# Custom Nginx configuration can be put here\nbh_invalid_directive on;\n" to the file "{SITES_DIR}/bh-site-command-57.test/config/nginx/custom/user.conf"
When I run 'bin/ee site reload bh-site-command-57.test'
And I write "# Custom Nginx configuration can be put here\n" to the file "{SITES_DIR}/bh-site-command-57.test/config/nginx/custom/user.conf"
Then the command should fail
62 changes: 56 additions & 6 deletions src/helper/Site_Backup_Restore.php
Original file line number Diff line number Diff line change
Expand Up @@ -431,26 +431,60 @@ private function run_restore( $backup_dir ) {
}

// Once per restore (BKP-13), after the commit like the restart below: it recreates the containers.
if ( $this->restore_custom_compose ) {
EE::log( 'Custom docker-compose file(s) updated.' );
EE::run_command( [ 'site', 'enable', $this->site_data['site_url'] ], [ 'force' => true ] );
}
$enabled = ! $this->restore_custom_compose || $this->enable_restored_custom_compose();

$this->clear_download_dir();
$this->restore_in_progress = false;

$this->finish_restore( $enabled );
}

/**
* Recreate the containers for the restored custom compose files, without exiting: the restore is already committed.
*
* @return bool Whether `ee site enable --force` succeeded.
*/
private function enable_restored_custom_compose() {
EE::log( 'Custom docker-compose file(s) updated.' );

return \EE\Site\Utils\run_without_exit(
function () {
EE::run_command( [ 'site', 'enable', $this->site_data['site_url'] ], [ 'force' => true ] );
}
);
}

/**
* Restart or reload the restored site. The restore is committed, so a failure here must say so rather than exit from inside the restart.
*
* @param bool $enabled False when recreating the containers for restored custom compose files failed: no restart then.
*/
private function finish_restore( $enabled = true ) {
if ( ! $enabled ) {
$this->release_site_lock();
EE::error( sprintf( 'The site was restored, but it did not start again. Fix the error above, then run: ee site enable %s --force', $this->site_data['site_url'] ) );
}

$action = 'reload';
if ( $this->restore_replaced_app ) {
// Mounts inside the containers below /var/www/htdocs (admin-tools' ee-admin, custom compose volumes) stay on the old
// directory until the containers start again.
EE::log( 'Restarting the site containers.' );
EE::run_command( [ 'site', 'restart', $this->site_data['site_url'] ], [], [] );
$action = 'restart';
} else {
EE::log( 'Reloading site.' );
EE::run_command( [ 'site', 'reload', $this->site_data['site_url'] ], [], [] );
}
$started = \EE\Site\Utils\run_without_exit(
function () use ( $action ) {
EE::run_command( [ 'site', $action, $this->site_data['site_url'] ], [], [] );
}
);

$this->release_site_lock();

if ( ! $started ) {
EE::error( sprintf( 'The site was restored, but it did not start again. Fix the error above, then run: ee site restart %s', $this->site_data['site_url'] ) );
}
EE::success( 'Site restored successfully.' );
}

Expand Down Expand Up @@ -1941,6 +1975,7 @@ private function apply_restore_transaction( $backup_dir ) {
$this->restore_nginx_conf( $backup_dir );
if ( in_array( $this->site_data['site_type'], [ 'php', 'wp' ], true ) ) {
$this->restore_php_conf( $backup_dir );
$this->check_restored_php_conf();
}
$this->check_restored_nginx_conf();
$this->restore_custom_docker_compose( $backup_dir );
Expand All @@ -1965,6 +2000,21 @@ private function check_restored_nginx_conf() {
}
}

/**
* Like the nginx check: php-fpm would not start after the commit. A php.ini syntax error doesn't fail `php-fpm -t`, but
* php then runs without the rest of that file.
*/
private function check_restored_php_conf() {
$test = EE::launch( 'docker-compose -f docker-compose.yml exec -T php php-fpm -t', false, true, [], null, $this->site_data['site_fs_path'] );
$output = trim( $test->stdout . "\n" . $test->stderr );
if ( $test->return_code ) {
EE::error( 'The restored php configuration fails `php-fpm -t` in the php container: ' . $output );
}
if ( preg_match_all( '/^PHP:\s+syntax error.*$/m', $output, $matches ) ) {
EE::error( 'The restored php configuration has a syntax error: ' . implode( ' ', $matches[0] ) );
}
}

/**
* Dump the current DB so a failed restore can put it back.
*/
Expand Down
38 changes: 29 additions & 9 deletions src/helper/class-ee-site.php
Original file line number Diff line number Diff line change
Expand Up @@ -1020,7 +1020,14 @@ protected function update_php( $args, $assoc_args ) {
}
EE::error( $e->getMessage() );
}
$this->restart( $args, [ 'php' => true ] );
$restarted = \EE\Site\Utils\run_without_exit(
function () use ( $args ) {
$this->restart( $args, [ 'php' => true ] );
}
);
if ( ! $restarted ) {
EE::error( sprintf( 'Updated site %1$s to PHP version %2$s, but its php container did not restart. Fix the error above, then run: ee site restart %1$s --php', $this->site_data['site_url'], $php_version ) );
}
EE::success( 'Updated site ' . $this->site_data['site_url'] . ' to PHP version: ' . $php_version );
delem_log( 'site php version update end' );
}
Expand Down Expand Up @@ -1560,19 +1567,22 @@ public function restart( $args, $assoc_args, $whitelisted_containers = [] ) {
$containers = array_keys( $assoc_args );
}

$failed = [];
foreach ( $containers as $container ) {
if ( 'nginx' === $container ) {
if ( EE::exec( \EE_DOCKER::docker_compose_with_custom() . " exec $container nginx -t", true, true ) ) {
\EE\Site\Utils\run_compose_command( 'restart', $container );
} else {
if ( ! EE::exec( \EE_DOCKER::docker_compose_with_custom() . " exec $container nginx -t", true, true ) ) {
\EE\Utils\delem_log( 'site restart stop due to Nginx test failure' );
\EE::error( 'Nginx test failed' );
}
} else {
\EE\Site\Utils\run_compose_command( 'restart', $container );
}
if ( ! \EE\Site\Utils\run_compose_command( 'restart', $container ) ) {
$failed[] = $container;
}
}
\EE\Utils\delem_log( 'site restart stop' );
if ( $failed ) {
\EE::error( sprintf( 'Could not restart %s of %s. See the docker-compose output above.', implode( ', ', $failed ), $this->site_data['site_url'] ) );
}
}

/**
Expand Down Expand Up @@ -1717,24 +1727,34 @@ public function reload( $args, $assoc_args, $whitelisted_containers = [], $reloa
chdir( $this->site_data['site_fs_path'] );

if ( $all || $no_service_specified ) {
$this->reload_services( $whitelisted_containers, $reload_commands );
$failed = $this->reload_services( $whitelisted_containers, $reload_commands );
} else {
$this->reload_services( array_keys( $assoc_args ), $reload_commands );
$failed = $this->reload_services( array_keys( $assoc_args ), $reload_commands );
}
\EE\Utils\delem_log( 'site reload stop' );
if ( $failed ) {
\EE::error( sprintf( 'Could not reload %s of %s. See the docker-compose output above.', implode( ', ', $failed ), $this->site_data['site_url'] ) );
}
}

/**
* Executes reload commands. It needs separate handling as commands to reload each service is different.
*
* @param array $services Services to reload.
* @param array $reload_commands Commands to reload the services.
*
* @return string[] The services whose reload command failed.
*/
private function reload_services( $services, $reload_commands ) {

$failed = [];
foreach ( $services as $service ) {
\EE\Site\Utils\run_compose_command( 'exec', $reload_commands[ $service ], 'reload', $service );
if ( ! \EE\Site\Utils\run_compose_command( 'exec', $reload_commands[ $service ], 'reload', $service ) ) {
$failed[] = $service;
}
}

return $failed;
}

/**
Expand Down
26 changes: 25 additions & 1 deletion src/helper/site-utils.php
Original file line number Diff line number Diff line change
Expand Up @@ -848,14 +848,38 @@ function stop_site_containers( $site_fs_path, $containers ) {
* @param string $container The container on which action has to be run.
* @param string $action_to_display The action message to be displayed.
* @param string $service_to_display The service message to be displayed.
*
* @return bool Whether docker-compose exited with 0.
*/
function run_compose_command( $action, $container, $action_to_display = null, $service_to_display = null ) {

$display_action = $action_to_display ? $action_to_display : $action;
$display_service = $service_to_display ? $service_to_display : $container;

EE::log( ucfirst( $display_action ) . 'ing ' . $display_service );
EE::exec( \EE_DOCKER::docker_compose_with_custom() . " $action $container", true, true );

return EE::exec( \EE_DOCKER::docker_compose_with_custom() . " $action $container", true, true );
}

/**
* Call $fn with EE::error() and EE::halt() throwing instead of exiting, for a step after a change that is already done.
*
* @param callable $fn Step to run.
*
* @return bool False when the step exited with a non-zero code.
*/
function run_without_exit( callable $fn ) {

$previous = EE::set_capture_exit( true );
try {
$fn();
} catch ( \EE\ExitException $e ) {
return 0 === $e->getCode();
} finally {
EE::set_capture_exit( $previous );
}

return true;
}

/**
Expand Down