More adjustments for Playground CLI, e.g. blueprint.resolve filter

Author: adamziel

components/Blueprints/DataReference/DataReferenceResolver.php

@@ -52,7 +52,7 @@ public function __construct( Client $client, ?string $tmpRoot = null ) {
 		$this->tmpRoot = $tmpRoot ?: wp_unix_sys_get_temp_dir();
 	}
 
-	public function setExecutionContext( Filesystem $executionContext ) {
+	public function setExecutionContext( ?Filesystem $executionContext ) {
 		$this->executionContext = $executionContext;
 	}
 

components/Blueprints/Runner.php

@@ -300,7 +300,14 @@ private function loadBlueprint() {
 			$blueprintString                 = $resolved->getStream()->consume_all();
 			$this->blueprintExecutionContext = LocalFilesystem::create( dirname( $reference->get_path() ) );
 		} else {
+			// For the purposes of Blueprint resolution, the execution context is the
+			// current working directory. This way, a path such as ./blueprint.json
+			// will mean "a blueprint.json file in the current working directory" and not
+			// "a ./blueprint.json path without a point of reference".
+			$this->assets->setExecutionContext( LocalFilesystem::create( getcwd() ) );
 			$resolved = $this->assets->resolve( $reference );
+			$this->assets->setExecutionContext( null );
+
 			if ( $resolved instanceof File ) {
 				$stream = $resolved->getStream();
 
@@ -388,6 +395,8 @@ private function validateBlueprint(): void {
 
 		$this->configuration->getLogger()->debug( 'Final resolved Blueprint: ' . json_encode( $this->blueprintArray, JSON_PRETTY_PRINT ) );
 
+		$this->blueprintArray = apply_filters( 'blueprint.resolved', $this->blueprintArray );
+
 		// Assert the Blueprint conforms to the latest JSON schema.
 		$v     = new HumanFriendlySchemaValidator(
 			json_decode( file_get_contents( __DIR__ . '/Versions/Version2/json-schema/schema-v2.json' ), true )
@@ -450,7 +459,7 @@ private function validateBlueprint(): void {
 		// WordPress Version Constraint
 		if ( isset( $this->blueprintArray['wordpressVersion'] ) ) {
 			$wp_version = $this->blueprintArray['wordpressVersion'];
-			$recommended = null;
+			$min = $max = $recommended = null;
 			if ( is_string( $wp_version ) ) {
 				$this->recommendedWpVersion = $wp_version;
 				$recommended = WordPressVersion::fromString( $wp_version );
@@ -500,6 +509,14 @@ private function validateBlueprint(): void {
 			// correctly. The actual version check for WordPress is done in
 			// NewSiteResolver and ExistingSiteResolver.
 		}
+
+		// Validate the override constraint if it was set
+		if ( $this->wpVersionConstraint ) {
+			$wpConstraintErrors = $this->wpVersionConstraint->validate();
+			if ( ! empty( $wpConstraintErrors ) ) {
+				throw new BlueprintExecutionException( 'Invalid WordPress version constraint from CLI override: ' . implode( '; ', $wpConstraintErrors ) );
+			}
+		}
 	}
 
 	private function createExecutionPlan(): array {
@@ -934,14 +951,6 @@ static function () {
 
 				return new WriteFilesStep( $files );
 
-			case 'runPHP':
-				return new RunPHPStep(
-					$this->createDataReference( [
-						'filename' => 'run-php.php',
-						'content'  => $data['code'],
-					] ),
-					$data['env'] ?? []
-				);
 			case 'unzip':
 				$zipFile = $this->createDataReference( $data['zipFile'], [ ExecutionContextPath::class ] );
 

components/Blueprints/VersionStrings/WordPressVersion.php

@@ -46,7 +46,7 @@ class WordPressVersion implements Version {
 	 * @return $this|false|null
 	 */
 	static public function fromString( string $raw ) {
-		if(in_array($raw, ['beta','trunk'], true)) {
+		if(in_array($raw, ['beta','trunk','latest'], true)) {
 			return null;
 		}
 		if(substr($raw, 0, 8) === 'https://') {

components/Blueprints/bin/blueprint.php

@@ -36,6 +36,7 @@
 use WordPress\CLI\CLI;
 use WordPress\Blueprints\DataReference\AbsoluteLocalPath;
 use WordPress\Blueprints\DataReference\DataReference;
+use WordPress\Blueprints\DataReference\ExecutionContextPath;
 use WordPress\Blueprints\Exception\BlueprintExecutionException;
 use WordPress\Blueprints\Exception\PermissionsException;
 use WordPress\Blueprints\Logger\CLILogger;
@@ -255,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|apply)' ],
+			'mode'                        => [ 'm', true, 'create-new-site', 'Execution mode (create-new-site|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' ],
@@ -279,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 --site-path ./site',
+			'php blueprint.php exec my-blueprint.json --execution-context /var/www --site-url https://mysite.test --mode apply-to-existing-site --site-path ./site',
 			'php blueprint.php exec my-blueprint.json --site-url https://mysite.test --site-path ./mysite --truncate-new-site-directory',
 		],
 		'aliases'         => [ 'run' ],
@@ -397,9 +398,10 @@ function cliArgsToRunnerConfiguration( array $positionalArgs, array $options ):
 		$blueprint_reference = $positionalArgs[0];
 		$config->setBlueprint( DataReference::create( $blueprint_reference, [
 			AbsoluteLocalPath::class,
+			ExecutionContextPath::class,
 		] ) );
 	} catch ( InvalidArgumentException $e ) {
-		throw new InvalidArgumentException( "Invalid Blueprint reference: " . $positionalArgs[0] );
+		throw new InvalidArgumentException( sprintf( "Invalid Blueprint reference: %s. Hint: paths must start with ./ or /. URLs must start with http:// or https://.", $positionalArgs[0] ) );
 	}
 
 	if ( ! empty( $options['mode'] ) ) {
@@ -409,6 +411,9 @@ function cliArgsToRunnerConfiguration( array $positionalArgs, array $options ):
 			$config->setExecutionMode( 'create-new-site' );
 		} elseif ( $mode === 'apply-to-existing-site' ) {
 			$config->setExecutionMode( '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." );
+			}
 		} else {
 			throw new InvalidArgumentException( "Invalid execution mode: {$mode}. Supported modes are: create-new-site, apply-to-existing-site" );
 		}