Add script to resolve semver for `WP_VERSION` env #207

thelovekesh · 2024-05-24T16:00:36Z

Summary

This PR aims to add a script which helps to determine the semver for passed WP_VERSION env variable. To do so correctly, this script uses composer/semver package.

Example cases:

Versions data

'5.4'   => 'insecure',
'5.9'   => 'insecure',
'5.9.1' => 'insecure',
'5.9.2' => 'insecure',
'6.0'   => 'insecure',
'6.0.1' => 'insecure',
'6.0.2' => 'insecure',
'6.1'   => 'insecure',
'6.1.1' => 'insecure',
'6.1.2' => 'insecure',
'6.2'   => 'insecure',
'6.2.1' => 'insecure',
'6.2.2' => 'insecure',
'6.5'   => 'insecure',
'6.5.2' => 'latest',

// Input => Output
array( '5.0', '5.0' ), // Does not match any version. So return as it is.
array( '5', '5.9.2' ), // Return the latest major version.
array( '5.9', '5.9.2' ), // Return the latest patch version.
array( '5.9.1', '5.9.1' ), // Return the exact version.
array( '6', '6.5.2' ), // Return the latest minor version.
array( '6.0', '6.0.2' ), // Return the latest patch version.
array( '6.0.0', '6.0' ), // Return the requested version.
array( '', '6.5.2' ), // Return the latest version.
array( 'latest', '6.5.2' ), // Return the latest version.
array( 'some-mismatched-version', 'some-mismatched-version' ), // Does not match any version. So return as it is.
array( '6.5-alpha', '6.5.2' ), // Return the latest version.
array( '6.5-beta', '6.5.2' ), // Return the latest version.
array( '6.5-rc', '6.5.2' ), // Return the latest version.
array( '6.5-nightly', '6.5-nightly' ), // Does not match any version. So return as it is.
array( '6.5.0.0', '6.5' ), // Return the latest version.
array( '6.5.2.0', '6.5.2' ), // Return the latest version.

Fixes: #51

thelovekesh · 2024-05-24T16:08:44Z

~~One aspect I'm uncertain about is:~~

Should passing a single version string resolve to the latest version of the major release? For instance, if someone passes 5, should it resolve to the latest minor version within that major version, like "5.x.x", or should it resolve to the absolute latest version available?

Seems like some bug with my logic. It should resolve the latest minor version.

tests/test-wp-version-resolver.php

Co-authored-by: Pascal Birchler <pascalb@google.com>

tests/tests/TestWPVersionResolverTest.php

Co-authored-by: Pascal Birchler <pascalb@google.com>

thelovekesh · 2024-05-24T16:37:26Z

utils/wp-version-resolver.php

+if ( 1 === $version_count ) {
+	$constraint = "^$wp_version_env"; // Get the latest minor version.
+} elseif ( 2 === $version_count ) {
+	$constraint = "~$wp_version_env.0"; // Get the latest patch version.


Added .0 as patch version due to semver package API behavior:

The ~ operator is best explained by example: ~1.2 is equivalent to >=1.2 <2.0.0, while ~1.2.3 is equivalent to >=1.2.3 <1.3.0. Ref: https://getcomposer.org/doc/articles/versions.md#tilde-version-range-

codecov · 2025-05-17T11:47:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

This PR adds a PHP-based script to resolve semantic versions for the WP_VERSION environment variable using the composer/semver package. The new resolver downloads a JSON mapping of WordPress versions, uses semver constraints to match version patterns (e.g., "5" → "5.9.2", "6.0" → "6.0.2"), and replaces the previous bash+jq-based implementation.

Key changes:

Implements semver-based version resolution with support for major, minor, and patch version matching
Replaces API call with cached JSON file approach for version lookup
Adds comprehensive test coverage for various version input formats

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
utils/wp-version-resolver.php	New script implementing semver-based WordPress version resolution with JSON caching
tests/tests/TestWPVersionResolverTest.php	Unit tests covering 15 different version resolution scenarios
phpcs.xml.dist	Adds PHPCS exclusions for the new utility script
composer.json	Adds composer/semver dependency (^3.4)
bin/run-behat-tests	Integrates new PHP resolver, removes old bash+jq implementation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-09T10:46:11Z

tests/tests/TestWPVersionResolverTest.php

+	 */
+	#[DataProvider( 'data_wp_version_resolver' )] // phpcs:ignore PHPCompatibility.Attributes.NewAttributes.PHPUnitAttributeFound
+	public function test_wp_version_resolver( $env, $expected ): void {
+		if ( $env ) {
+			putenv( "WP_VERSION=$env" );
+		}
+
+		$output = exec( 'php ' . dirname( dirname( __DIR__ ) ) . '/utils/wp-version-resolver.php' );
+
+		// Reset the environment variable.
+		putenv( 'WP_VERSION' );
+


The test doesn't verify the actual error handling behavior when the JSON file doesn't exist initially. While the setup creates the file, consider adding a test case that verifies the script correctly downloads the JSON file when it's missing.

Copilot · 2025-12-09T10:46:12Z

utils/wp-version-resolver.php

+	curl_exec( $ch );
+	if ( PHP_VERSION_ID < 80000 ) { // curl_close() has no effect as of PHP 8.0.
+		// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.curl_closeDeprecated,Generic.PHP.DeprecatedFunctions.Deprecated
+		curl_close( $ch );
+	}
+	fclose( $fp );


The return value of curl_exec() is not checked. If the curl request fails, the script will continue and potentially read an empty or invalid JSON file. Consider checking the return value and handling failure cases appropriately.

Suggested change

curl_exec( $ch );

if ( PHP_VERSION_ID < 80000 ) { // curl_close() has no effect as of PHP 8.0.

// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.curl_closeDeprecated,Generic.PHP.DeprecatedFunctions.Deprecated

curl_close( $ch );

}

fclose( $fp );

$result = curl_exec( $ch );

if ( PHP_VERSION_ID < 80000 ) { // curl_close() has no effect as of PHP 8.0.

// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.curl_closeDeprecated,Generic.PHP.DeprecatedFunctions.Deprecated

curl_close( $ch );

}

fclose( $fp );

if ( $result === false ) {

// Remove incomplete file if it exists.

if ( file_exists( $wp_versions_file_path ) ) {

unlink( $wp_versions_file_path );

}

fwrite( STDERR, "Error: Failed to download WP versions JSON from " . WP_VERSIONS_JSON_URL . "\n" );

exit( 1 );

}

Copilot · 2025-12-09T10:46:12Z

utils/wp-version-resolver.php

+if ( ! file_exists( $wp_versions_file_path ) ) {
+	$ch = curl_init( WP_VERSIONS_JSON_URL );
+	$fp = fopen( $wp_versions_file_path, 'w' );
+


The return value of curl_init() is not checked. If curl fails to initialize, $ch will be false, causing subsequent curl_setopt() calls to fail. Consider checking if $ch is valid before using it.

Suggested change

if ( $ch === false ) {

if ( $fp ) {

fclose( $fp );

}

echo "Error: Failed to initialize cURL to fetch WP versions.\n";

exit( 1 );

}

Copilot · 2025-12-09T10:46:13Z

utils/wp-version-resolver.php

+}
+
+$wp_versions_json = json_decode( file_get_contents( $wp_versions_file_path ), true );
+


The return value of json_decode() is not checked. If the JSON file is invalid or corrupted, this will result in null, causing errors in subsequent operations. Consider checking if decoding was successful and handle the error case appropriately.

Suggested change

if ( !is_array( $wp_versions_json ) ) {

echo "Error: Failed to decode WP versions JSON file.\n";

echo $wp_version_env;

exit( 1 );

}

Copilot · 2025-12-09T10:46:13Z

utils/wp-version-resolver.php

+}
+
+$wp_version = end( $wp_satisfied_versions );
+echo $wp_version ? : $wp_version_env;


[nitpick] Missing space before the ternary operator. The expression should be $wp_version ? $wp_version : $wp_version_env with proper spacing for readability.

Suggested change

echo $wp_version ? : $wp_version_env;

echo $wp_version ? $wp_version : $wp_version_env;

Copilot · 2025-12-09T10:46:14Z

tests/tests/TestWPVersionResolverTest.php

+use WP_CLI\Tests\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+class TestWPVersionResolverTest extends TestCase {


The class name has a redundant "Test" suffix. The class is already named TestWPVersionResolverTest, which is redundant. Consider renaming to TestWPVersionResolver or WPVersionResolverTest.

Suggested change

class TestWPVersionResolverTest extends TestCase {

class WPVersionResolverTest extends TestCase {

Copilot · 2025-12-09T10:46:14Z

tests/tests/TestWPVersionResolverTest.php

+			array( '6.5.0.0', '6.5' ), // Return the latest version.
+			array( '6.5.2.0', '6.5.2' ), // Return the latest version.


The comment incorrectly states "Return the latest version" for versions with 4 segments. The actual behavior based on the constraint logic is to return as-is (constraint = $wp_version_env at line 54). The comment should say "Does not match standard semver. Return as normalized version." or similar.

Suggested change

array( '6.5.0.0', '6.5' ), // Return the latest version.

array( '6.5.2.0', '6.5.2' ), // Return the latest version.

array( '6.5.0.0', '6.5' ), // Does not match standard semver. Return as normalized version.

array( '6.5.2.0', '6.5.2' ), // Does not match standard semver. Return as normalized version.

Copilot · 2025-12-09T10:46:14Z

utils/wp-version-resolver.php

+if ( empty( $wp_version_env ) || 'latest' === $wp_version_env ) {
+	$wp_version = array_search( 'latest', $wp_versions_json, true );
+
+	if ( empty( $wp_version ) ) {
+		$wp_version = $wp_version_env;
+	}
+
+	echo $wp_version;
+	exit( 0 );
+}


The script doesn't handle the trunk value for WP_VERSION, which was previously supported according to the README documentation. The script should either handle trunk as a special case (similar to latest) or the documentation should be updated to reflect this breaking change.

Copilot · 2025-12-09T10:46:15Z

utils/wp-version-resolver.php

+
+if ( ! file_exists( $wp_versions_file_path ) ) {
+	$ch = curl_init( WP_VERSIONS_JSON_URL );
+	$fp = fopen( $wp_versions_file_path, 'w' );


The return value of fopen() is not checked. If the file cannot be created (e.g., due to permissions), this will cause a fatal error when passed to curl_setopt(). Consider checking if $fp is valid before proceeding.

Suggested change

$fp = fopen( $wp_versions_file_path, 'w' );

$fp = fopen( $wp_versions_file_path, 'w' );

if ( false === $fp ) {

echo "Error: Unable to open file for writing: $wp_versions_file_path" . PHP_EOL;

exit( 1 );

}

Copilot · 2025-12-09T10:46:15Z

tests/tests/TestWPVersionResolverTest.php

+		$output = exec( 'php ' . dirname( dirname( __DIR__ ) ) . '/utils/wp-version-resolver.php' );
+
+		// Reset the environment variable.
+		putenv( 'WP_VERSION' );


The environment variable is not properly unset. Using putenv('WP_VERSION') without a value may not work correctly on all systems. Consider using putenv('WP_VERSION=') with an empty string or checking if the variable needs to be restored to its previous value.

Suggested change

putenv( 'WP_VERSION' );

putenv( 'WP_VERSION=' );

thelovekesh added 8 commits April 26, 2024 16:14

Add composer/semver package

c57ce93

Remove latest WP version resolving from run-behat-tests bin file

7ed37f3

Add util file to be ignored from WPCS

d0aecb9

Add PHP script to resolve minor and patch WP version

fd79fd6

Add step to update WP_VERSION

213e968

Add .phpunit.result.cache

5296351

Fix incorrect return condition

801b601

Add test cases for WP version resolver

7d8b671

thelovekesh requested a review from a team as a code owner May 24, 2024 16:00

Fix PHPCS errors

52c024b

thelovekesh requested a review from schlessera May 24, 2024 16:03

swissspidy reviewed May 24, 2024

View reviewed changes

tests/test-wp-version-resolver.php Show resolved Hide resolved

swissspidy reviewed May 24, 2024

View reviewed changes

tests/test-wp-version-resolver.php Outdated Show resolved Hide resolved

swissspidy and others added 5 commits May 24, 2024 18:14

Merge branch 'main' into feature/wp-version-resolve

43f7a29

Update assertion method to check for same values

b1f3131

Co-authored-by: Pascal Birchler <pascalb@google.com>

Fix minor version constraint

5911717

Update test file name

4dc3431

Update test cases for minor version assertions

df2d133

swissspidy reviewed May 24, 2024

View reviewed changes

tests/tests/TestWPVersionResolverTest.php Outdated Show resolved Hide resolved

Fix data provider visibility

aee3d2f

Co-authored-by: Pascal Birchler <pascalb@google.com>

thelovekesh commented May 24, 2024

View reviewed changes

thelovekesh and others added 2 commits May 24, 2024 22:48

Make the data providers static

2faa3d1

Merge branch 'main' into feature/wp-version-resolve

9fd76dd

swissspidy added the scope:testing label May 17, 2025

swissspidy added 2 commits December 9, 2025 11:34

Merge branch 'main' into feature/wp-version-resolve

ed1adba

Lint fix

de04095

swissspidy requested a review from Copilot December 9, 2025 10:39

Copilot started reviewing on behalf of swissspidy December 9, 2025 10:39 View session

Add data provider attribute

739021f

Copilot AI reviewed Dec 9, 2025

View reviewed changes

+	if ( $ch === false ) {
+		if ( $fp ) {
+			fclose( $fp );
+		}
+		echo "Error: Failed to initialize cURL to fetch WP versions.\n";
+		exit( 1 );
+	}

		}

		$wp_versions_json = json_decode( file_get_contents( $wp_versions_file_path ), true );

+if ( !is_array( $wp_versions_json ) ) {
+	echo "Error: Failed to decode WP versions JSON file.\n";
+	echo $wp_version_env;
+	exit( 1 );
+}

	echo $wp_version ? : $wp_version_env;
	echo $wp_version ? $wp_version : $wp_version_env;

	class TestWPVersionResolverTest extends TestCase {
	class WPVersionResolverTest extends TestCase {

		array( '6.5.0.0', '6.5' ), // Return the latest version.
		array( '6.5.2.0', '6.5.2' ), // Return the latest version.

Add script to resolve semver for WP_VERSION env #207

Are you sure you want to change the base?

Add script to resolve semver for WP_VERSION env #207

Conversation

thelovekesh commented May 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

thelovekesh commented May 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thelovekesh May 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add script to resolve semver for `WP_VERSION` env #207

Add script to resolve semver for `WP_VERSION` env #207

thelovekesh commented May 24, 2024 •

edited

Loading

thelovekesh commented May 24, 2024 •

edited

Loading

thelovekesh May 24, 2024 •

edited

Loading

codecov bot commented May 17, 2025 •

edited

Loading