Skip to content

[Blueprints v2] Constraint the Blueprint bundle format #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

[Blueprints v2] Constraint the Blueprint bundle format #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
144 changes: 20 additions & 124 deletions components/Blueprints/Runner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
use WordPress\Blueprints\Steps\WPCLIStep;
use WordPress\Blueprints\Steps\WriteFilesStep;
use WordPress\Blueprints\Validator\HumanFriendlySchemaValidator;
use WordPress\Blueprints\Validator\ValidationError;
use WordPress\Blueprints\Versions\Version1\V1ToV2Transpiler;
use WordPress\Blueprints\VersionStrings\PHPVersion;
use WordPress\Blueprints\VersionStrings\VersionConstraint;
Expand Down Expand Up @@ -166,7 +167,7 @@ private function validateConfiguration( RunnerConfiguration $config ): void {
}

// Validate database credentials
$dbCreds = $config->getDatabaseCredentials();
/*$dbCreds = $config->getDatabaseCredentials();
if ( $dbEngine === 'mysql' ) {
if ( empty( $dbCreds['username'] ) || empty( $dbCreds['databaseName'] ) ) {
throw new BlueprintExecutionException( "MySQL credentials are required when database engine is 'mysql'." );
Expand Down Expand Up @@ -197,7 +198,7 @@ private function validateConfiguration( RunnerConfiguration $config ): void {
if ( empty( $dbCreds['path'] ) ) {
$dbCreds['path'] = 'wp-content/.ht.sqlite';
}
}
}*/
}

public function run(): void {
Expand Down Expand Up @@ -402,127 +403,22 @@ 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 )
);
$error = $v->validate( $this->blueprintArray );
if ( $error ) {
throw new BlueprintExecutionException( 'Blueprint does not conform to the schema.', 0, null, $error );
}

// PHP Version Constraint
if ( isset( $this->blueprintArray['phpVersion'] ) ) {
$min = $max = $recommended = null;

$php_version = $this->blueprintArray['phpVersion'];
if ( is_string( $php_version ) ) {
$parsed_version = PHPVersion::fromString( $php_version );
if ( ! $parsed_version ) {
throw new BlueprintExecutionException( 'Invalid PHP version string in phpVersion: ' . $php_version );
}
$recommended = $parsed_version;
} else {
if ( isset( $php_version['min'] ) ) {
$min = PHPVersion::fromString( $php_version['min'] );
if ( ! $min ) {
throw new BlueprintExecutionException( 'Invalid PHP version string in phpVersion.min: ' . $php_version['min'] );
}
}
if ( isset( $php_version['max'] ) ) {
$max = PHPVersion::fromString( $php_version['max'] );
if ( ! $max ) {
throw new BlueprintExecutionException( 'Invalid PHP version string in phpVersion.max: ' . $php_version['max'] );
}
}
if ( isset( $php_version['recommended'] ) ) {
$recommended = PHPVersion::fromString( $php_version['recommended'] );
if ( ! $recommended ) {
throw new BlueprintExecutionException( 'Invalid PHP version string in phpVersion.recommended: ' . $php_version['recommended'] );
}
}
}
$this->phpVersionConstraint = new VersionConstraint( $min, $max, $recommended );
$phpConstraintErrors = $this->phpVersionConstraint->validate();
if ( ! empty( $phpConstraintErrors ) ) {
throw new BlueprintExecutionException( 'Invalid PHP version constraint: ' . implode( '; ', $phpConstraintErrors ) );
}

// Confirm the environment satisfies the PHP version constraint.
$currentPhpVersion = PHPVersion::fromString( PHP_VERSION );
if ( ! $this->phpVersionConstraint->satisfiedBy( $currentPhpVersion ) ) {
throw new BlueprintExecutionException(
sprintf(
'PHP version requirement not satisfied. Blueprint requires %s, but current version is %s',
$this->phpVersionConstraint->__toString(),
$currentPhpVersion
)
);
}
}

// WordPress Version Constraint
if ( isset( $this->blueprintArray['wordpressVersion'] ) ) {
$wp_version = $this->blueprintArray['wordpressVersion'];
$min = $max = $recommended = null;
if ( is_string( $wp_version ) ) {
$this->recommendedWpVersion = $wp_version;
$recommended = WordPressVersion::fromString( $wp_version );
if ( false === $recommended ) {
throw new BlueprintExecutionException( 'Invalid WordPress version string in wordpressVersion: ' . $wp_version );
}
} else {
if ( isset( $wp_version['min'] ) ) {
if ( $wp_version['min'] === 'latest' ) {
throw new BlueprintExecutionException(
'Setting wordpressVersion.min to "latest" is not allowed and probably not what you want. Either set wordPressVersion.recommended to "latest" or set wordPressVersion.min to a specific version string instead.'
);
}
$min = WordPressVersion::fromString( $wp_version['min'] );
if ( ! $min ) {
throw new BlueprintExecutionException( 'Invalid WordPress version string in wordpressVersion.min: ' . $wp_version['min'] );
}
}
// Latest version is implicitly the default and it's only for resolving
// the WordPress version to install. It's not used for version checks on
// existing sites and VersionConstraint doesn't support it. It doesn't have
// enough information anyway – the meaning of "latest" changes over time.
if ( isset( $wp_version['max'] ) && $wp_version['max'] !== 'latest' ) {
$this->recommendedWpVersion = $wp_version['max'];
$max = WordPressVersion::fromString( $wp_version['max'] );
if ( ! $max ) {
// @TODO: Reuse this error message
// 'Unrecognized WordPress version. Please use "latest", a URL, or a numeric version such as "6.2", "6.0.1", "6.2-beta1", or "6.2-RC1"'
throw new BlueprintExecutionException( 'Invalid WordPress version string in wordpressVersion.max: ' . $wp_version['max'] );
}
}
if ( isset( $wp_version['recommended'] ) && $wp_version['recommended'] !== 'latest' ) {
$this->recommendedWpVersion = $wp_version['recommended'];
$recommended = WordPressVersion::fromString( $wp_version['recommended'] );
if ( false === $recommended ) {
throw new BlueprintExecutionException( 'Invalid WordPress version string in wordpressVersion.recommended: ' . $wp_version['recommended'] );
}
}
}

$this->wpVersionConstraint = new VersionConstraint( $min, $max, $recommended );
$wpConstraintErrors = $this->wpVersionConstraint->validate();
if ( ! empty( $wpConstraintErrors ) ) {
throw new BlueprintExecutionException( 'Invalid WordPress version constraint: ' . implode( '; ', $wpConstraintErrors ) );
}
// Note: In here's we're only checking if the version constraint is defined
// 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 ) );
}
$validator = new \WordPress\Blueprints\Validator\BlueprintValidator( $this->blueprintArray, $this->blueprintExecutionContext );
Copy link
Collaborator

@adamziel adamziel Aug 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice idea separating it! I've been experimenting with co-locating that logic with parsing the Blueprint and it had some ups and downs.

The downside here is that it's separated from parsing the Blueprint. The upside here is that it's separated from parsing the Blueprint. Let's roll with a separate validator and see how it goes.

Copy link
Member Author

@JanJakes JanJakes Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The downside here is that it's separated from parsing the Blueprint. The upside here is that it's separated from parsing the Blueprint.

This. I think that if we can make the parsing logic collect all errors before bailing out while keeping a reasonably nice code, then we should go with that. I'm looking into that.

$report = $validator->validate();
// Capture parsed constraints for later stages
$this->phpVersionConstraint = $validator->getPhpVersionConstraint();
$this->wpVersionConstraint = $validator->getWpVersionConstraint();
$this->recommendedWpVersion = $validator->getRecommendedWpVersion();

if ( !empty($report['errors']) ) {
$parent = new ValidationError(
'/',
'blueprint-validation-failed',
sprintf('Blueprint validation failed with %d issue(s).', count($report['errors'])),
[],
$report['errors']
);
throw new BlueprintExecutionException( 'Blueprint validation failed.', 0, null, $parent );
}
}

Expand Down Expand Up @@ -763,7 +659,7 @@ private function createStepObject( string $stepType, array $data ) {
] );
$active = $data['active'] ?? true;
$options = $data['activationOptions'] ?? null;
$onError = isset( $pluginDef['onError'] ) ? $pluginDef['onError'] : 'throw';
$onError = $data['onError'] ?? 'throw';

return new InstallPluginStep( $source, $active, $options, $onError );
case 'installTheme':
Expand Down
Loading
Loading