HERDOC PHP 7.2 compat

Author: adamziel

components/Blueprints/Runner.php

@@ -52,14 +52,20 @@
 use WordPress\Filesystem\LocalFilesystem;
 use WordPress\HttpClient\ByteStream\RequestReadStream;
 use WordPress\HttpClient\Client;
-use WordPress\HttpClient\Request;
 use WordPress\Zip\ZipFilesystem;
 
 use function WordPress\Encoding\utf8_is_valid_byte_stream;
 use function WordPress\Filesystem\wp_unix_sys_get_temp_dir;
 use function WordPress\Zip\is_zip_file_stream;
 
 class Runner {
+	const EXECUTION_MODE_CREATE_NEW_SITE = 'create-new-site';
+	const EXECUTION_MODE_APPLY_TO_EXISTING_SITE = 'apply-to-existing-site';
+	const EXECUTION_MODES = [
+		self::EXECUTION_MODE_CREATE_NEW_SITE,
+		self::EXECUTION_MODE_APPLY_TO_EXISTING_SITE,
+	];
+	
 	/**
 	 * @var RunnerConfiguration
 	 */
@@ -135,17 +141,17 @@ private function validateConfiguration( RunnerConfiguration $config ): void {
 
 		// Validate execution mode
 		$mode = $config->getExecutionMode();
-		if ( ! in_array( $mode, [ 'create-new-site', 'apply-to-existing-site' ], true ) ) {
-			throw new BlueprintExecutionException( "Execution mode must be either 'create-new-site' or 'apply-to-existing-site'." );
+		if ( ! in_array( $mode, self::EXECUTION_MODES, true ) ) {
+			throw new BlueprintExecutionException( "Execution mode must be one of: " . implode( ', ', self::EXECUTION_MODES ) );
 		}
 
 		// Validate site URL
 		// Note: $options is not defined in this context, so we skip this block.
 		// If you want to validate the site URL, you should use $config->getTargetSiteUrl().
 		$siteUrl = $config->getTargetSiteUrl();
-		if ( $mode === 'create-new-site' ) {
+		if ( $mode === self::EXECUTION_MODE_CREATE_NEW_SITE ) {
 			if ( empty( $siteUrl ) ) {
-				throw new BlueprintExecutionException( "Site URL is required when the execution mode is 'create-new-site'." );
+				throw new BlueprintExecutionException( sprintf( "Site URL is required when the execution mode is '%s'.", self::EXECUTION_MODE_CREATE_NEW_SITE ) );
 			}
 		}
 		if ( ! empty( $siteUrl ) && ! filter_var( $siteUrl, FILTER_VALIDATE_URL ) ) {
@@ -253,7 +259,7 @@ public function run(): void {
 			], $progress['wpCli'] );
 
 			$progress['targetResolution']->setCaption( 'Resolving target site' );
-			if ( $this->configuration->getExecutionMode() === 'apply-to-existing-site' ) {
+			if ( $this->configuration->getExecutionMode() === self::EXECUTION_MODE_APPLY_TO_EXISTING_SITE ) {
 				ExistingSiteResolver::resolve( $this->runtime, $progress['targetResolution'], $this->wpVersionConstraint );
 			} else {
 				NewSiteResolver::resolve( $this->runtime, $progress['targetResolution'], $this->wpVersionConstraint, $this->recommendedWpVersion );

components/Blueprints/RunnerConfiguration.php

@@ -23,7 +23,7 @@ class RunnerConfiguration {
 	/**
 	 * @var string
 	 */
-	private $mode = 'create-new-site';    // or apply-to-existing-site
+	private $mode = Runner::EXECUTION_MODE_CREATE_NEW_SITE;
 	/**
 	 * @var string
 	 */

components/Blueprints/SiteResolver/NewSiteResolver.php

@@ -67,6 +67,10 @@ static public function resolve( Runtime $runtime, Tracker $progress, ?VersionCon
 
 		// If SQLite integration zip provided, unzip into appropriate folder
 		if ( $runtime->getConfiguration()->getDatabaseEngine() === 'sqlite' ) {
+			/*
+			 * @TODO: Ensure DB_NAME gets defined in wp-config.php before installing the SQLite plugin.
+			 */
+
 			$progress['resolve_assets']->setCaption( 'Downloading SQLite integration plugin' );
 			$resolved = $runtime->resolve( $assets['sqlite-integration'] );
 			if ( ! $resolved instanceof File ) {
@@ -115,7 +119,7 @@ static public function resolve( Runtime $runtime, Tracker $progress, ?VersionCon
 				$wp_cli_path,
 				'core',
 				'install',
-				'--path=' . getenv('DOCROOT'),
+				'--path=' . $runtime->getConfiguration()->getTargetSiteRoot(),
 
 				// For Docker compatibility. If we got this far, Blueprint runner was already
 				// allowed to run as root.
@@ -149,7 +153,8 @@ static private function isWordPressInstalled( Runtime $runtime, Tracker $progres
 			require $wp_load;
 
 			append_output( function_exists('is_blog_installed') && is_blog_installed() ? '1' : '0' );
-PHP,
+PHP
+			,
 			[
 				'DOCROOT' => getenv('DOCROOT'),
 			],

components/Blueprints/Steps/WPCLIStep.php

@@ -43,7 +43,7 @@ public function run( Runtime $runtime, Tracker $tracker ) {
 			// For Docker compatibility. If we got this far, the Blueprint runner was already
 			// allowed to run as root.
 			'--allow-root',
-			'--path=/wordpress', // . (getenv('DOCROOT') ?? '/wordpress'),
+			'--path=' . $runtime->getConfiguration()->getTargetSiteRoot(),
 			substr($command, 3),
 		]);
 		$process = $runtime->startShellCommand( $command );

components/Blueprints/bin/blueprint.php

@@ -256,7 +256,7 @@ function createProgressReporter(): ProgressReporter {
 			'site-url'                    => [ 'u', true, null, 'Public site URL (https://example.com)' ],
 			'site-path'                   => [ null, true, null, 'Target directory with WordPress install context)' ],
 			'execution-context'           => [ 'x', true, null, 'Source directory with Blueprint context files' ],
-			'mode'                        => [ 'm', true, 'create-new-site', 'Execution mode (create-new-site|apply-to-existing-site)' ],
+			'mode'                        => [ 'm', true, Runner::EXECUTION_MODE_CREATE_NEW_SITE, sprintf( 'Execution mode (%s|%s)', Runner::EXECUTION_MODE_CREATE_NEW_SITE, Runner::EXECUTION_MODE_APPLY_TO_EXISTING_SITE ) ],
 			'db-engine'                   => [ 'd', true, 'mysql', 'Database engine (mysql|sqlite)' ],
 			'db-host'                     => [ null, true, '127.0.0.1', 'MySQL host' ],
 			'db-user'                     => [ null, true, 'root', 'MySQL user' ],
@@ -280,7 +280,7 @@ function createProgressReporter(): ProgressReporter {
 		] ),
 		'examples'        => [
 			'php blueprint.php exec my-blueprint.json --site-url https://mysite.test --site-path /var/www/mysite.com',
-			'php blueprint.php exec my-blueprint.json --execution-context /var/www --site-url https://mysite.test --mode apply-to-existing-site --site-path ./site',
+			sprintf( 'php blueprint.php exec my-blueprint.json --execution-context /var/www --site-url https://mysite.test --mode %s --site-path ./site', Runner::EXECUTION_MODE_APPLY_TO_EXISTING_SITE ),
 			'php blueprint.php exec my-blueprint.json --site-url https://mysite.test --site-path ./mysite --truncate-new-site-directory',
 		],
 		'aliases'         => [ 'run' ],
@@ -350,7 +350,7 @@ function handleExecCommand( array $positionalArgs, array $options, array $comman
 		$runner = new Runner( $config );
 
 		// Execute the Blueprint
-		if ( $config->getExecutionMode() === 'create-new-site' ) {
+		if ( $config->getExecutionMode() === Runner::EXECUTION_MODE_CREATE_NEW_SITE ) {
 			$progressReporter->reportProgress(0, 'Creating a new site');
 		} else {
 			$progressReporter->reportProgress(0, 'Updating an existing site');
@@ -405,24 +405,23 @@ function cliArgsToRunnerConfiguration( array $positionalArgs, array $options ):
 	}
 
 	if ( ! empty( $options['mode'] ) ) {
-		// Accept 'create-new-site' or 'apply-to-existing-site' as CLI values, map to internal values
 		$mode = $options['mode'];
-		if ( $mode === 'create-new-site' ) {
-			$config->setExecutionMode( 'create-new-site' );
-		} elseif ( $mode === 'apply-to-existing-site' ) {
-			$config->setExecutionMode( 'apply-to-existing-site' );
+		if ( $mode === Runner::EXECUTION_MODE_CREATE_NEW_SITE ) {
+			$config->setExecutionMode( Runner::EXECUTION_MODE_CREATE_NEW_SITE );
+		} elseif ( $mode === Runner::EXECUTION_MODE_APPLY_TO_EXISTING_SITE ) {
+			$config->setExecutionMode( Runner::EXECUTION_MODE_APPLY_TO_EXISTING_SITE );
 			if(!empty($options['wp'])) {
-				throw new InvalidArgumentException( "The --wp option cannot be used with --mode=apply-to-existing-site. The WordPress version is whatever the existing site has." );
+				throw new InvalidArgumentException( sprintf( "The --wp option cannot be used with --mode=%s. The WordPress version is whatever the existing site has.", Runner::EXECUTION_MODE_APPLY_TO_EXISTING_SITE ) );
 			}
 		} else {
-			throw new InvalidArgumentException( "Invalid execution mode: {$mode}. Supported modes are: create-new-site, apply-to-existing-site" );
+			throw new InvalidArgumentException( sprintf( "Invalid execution mode: '{$mode}'. Supported modes are: %s", implode( ', ', Runner::EXECUTION_MODES ) ) );
 		}
 	}
 
 	$targetSiteRoot         = $options['site-path'];
 	if ( $options['truncate-new-site-directory'] ) {
-		if ( $options['mode'] !== 'create-new-site' ) {
-			throw new InvalidArgumentException( "--truncate-new-site-directory can only be used with --mode=create-new-site" );
+		if ( $options['mode'] !== Runner::EXECUTION_MODE_CREATE_NEW_SITE ) {
+			throw new InvalidArgumentException( sprintf( "--truncate-new-site-directory can only be used with --mode=%s", Runner::EXECUTION_MODE_CREATE_NEW_SITE ) );
 		}
 		$absoluteTargetSiteRoot = realpath( $targetSiteRoot );
 		if ( false === $absoluteTargetSiteRoot) {