Repository navigation
Expand file tree
/
Copy pathprepare.php
More file actions
574 lines (501 loc) · 19.6 KB
/
Copy pathprepare.php
File metadata and controls
574 lines (501 loc) · 19.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
<?php
/**
* WordPress PHPUnit Test Runner: Prepare script
*
* This script is responsible for preparing the environment to run the
* WordPress Core PHPUnit test suite.
*
* @link https://github.com/wordpress/phpunit-test-runner/ Original source repository
*
* @package WordPress
*/
require __DIR__ . '/functions.php';
/*
* Check for the presence of required environment variables.
*
* This function should be defined in functions.php and should throw an
* exception or exit if any required variables are missing.
*/
check_required_env();
/**
* Ensure that optional environment variables are present with default values.
*/
$runner_vars = setup_runner_env_vars();
/*
* Configure a private SSH key for remote testing.
*
* A base64-encoded private SSH key can be provided through the
* 'WPT_SSH_PRIVATE_KEY_BASE64' environment variable to support executing the
* test runner on a remote server.
*
* When provided, the key is decoded and saved to the user's .ssh directory as
* an 'id_rsa' key file.
*
* @throws Exception If there is an issue creating the .ssh directory or
* writing the key file.
*/
// Set the SSH private key if it's provided in the environment.
$wpt_ssh_private_key_base64 = trim( getenv( 'WPT_SSH_PRIVATE_KEY_BASE64' ) );
if ( ! empty( $wpt_ssh_private_key_base64 ) ) {
// Log the action of securely extracting the private key.
log_message( 'Securely extracting WPT_SSH_PRIVATE_KEY_BASE64 into ~/.ssh/id_rsa' );
// Check if the .ssh directory exists in the home directory, and create it if it does not.
if ( ! is_dir( getenv( 'HOME' ) . '/.ssh' ) ) {
// The mkdir function creates the directory with the specified permissions and the recursive flag set to true.
mkdir( getenv( 'HOME' ) . '/.ssh', 0777, true );
}
// Write the decoded private key into the id_rsa file within the .ssh directory.
file_put_contents( getenv( 'HOME' ) . '/.ssh/id_rsa', base64_decode( $wpt_ssh_private_key_base64 ) );
// Define the array of operations to perform, depending on the SSH connection availability.
// When an SSH connection string is not provided, add a local operation to the array.
// When an SSH connection string is provided, add a remote operation to the array.
// Execute the operations defined in the operations array.
if ( empty( $runner_vars['WPT_SSH_CONNECT'] ) ) {
perform_operations(
array(
'chmod 600 ~/.ssh/id_rsa',
'wp cli info',
)
);
} else {
perform_operations(
array(
'chmod 600 ~/.ssh/id_rsa',
'ssh -q ' . $runner_vars['WPT_SSH_OPTIONS'] . ' ' . escapeshellarg( $runner_vars['WPT_SSH_CONNECT'] ) . ' wp cli info',
)
);
}
}
/*
* When debug mode is enabled, run npm at its most verbose logging level, so a
* hung or slow npm command shows what it is doing instead of sitting silent.
* The same debug mode adds verbosity to the rsync operations further down.
*/
$npm_verbosity = $runner_vars['WPT_DEBUG'] ? ' --loglevel=silly' : '';
/*
* Checkout and prepare wordpress-develop for testing.
*
* The following actions are performed:
* - Creates a directory to prepare wordpress-develop.
* - Clones the WordPress/wordpress-develop repository from GitHub.
* - Install npm dependencies and run the development build script.
*/
// Prepare an array of shell commands to set up the testing environment.
perform_operations(
array(
// Create the preparation directory if it doesn't exist. The '-p' flag creates intermediate directories as required.
'mkdir -p ' . escapeshellarg( $runner_vars['WPT_PREPARE_DIR'] ),
// Clone the WordPress develop repository from GitHub into the preparation directory.
// The '--depth=1' flag creates a shallow clone with a history truncated to the last commit.
'git clone --depth=1 https://github.com/WordPress/wordpress-develop.git ' . escapeshellarg( $runner_vars['WPT_PREPARE_DIR'] ),
/*
* Change directory to the preparation directory, install npm dependencies, and build the project.
* The development build writes the built files into `src/`, which is the directory the test suite
* runs against. It is the same build that WordPress core's own PHPUnit workflow runs.
*/
'cd ' . escapeshellarg( $runner_vars['WPT_PREPARE_DIR'] ) . '; npm install' . $npm_verbosity . ' && npm run build:dev' . $npm_verbosity,
)
);
// Log a message indicating the start of the variable replacement process for configuration.
log_message( 'Replacing variables in wp-tests-config.php' );
// Don't validate the TLS certificate. Useful for local environments.
$contents = file_get_contents( $runner_vars['WPT_PREPARE_DIR'] . '/wp-tests-config-sample.php' );
/*
* Prepare a script for logging system information.
*
* The versions of PHP, PHP modules, database software, and system utilities
* can impact the results of the test suite. This gathers the relevant details
* and stores them in a JSON file for later reference.
*
* The script performs the following actions:
* - Confirms the presence of the `tests/phpunit/build/logs/` directory,
* creating one when it does not exist.
* - Collects information about the environment.
* - The info is written to the /tests/phpunit/build/logs/env.json file.
*
* When running from the command line during the WordPress installation
* process, the PHP version and executable path are also output.
*/
$system_logger = <<<'EOT'
// Create the log directory to store test results
if ( ! is_dir( __DIR__ . '/tests/phpunit/build/logs/' ) ) {
mkdir( __DIR__ . '/tests/phpunit/build/logs/', 0777, true );
}
// Log environment details that are useful to have reported.
$gd_info = array();
if ( extension_loaded( 'gd' ) ) {
$gd_info = gd_info();
}
$imagick_info = array();
if ( extension_loaded( 'imagick' ) ) {
$imagick_info = Imagick::queryFormats();
}
if ( ! function_exists( 'wpt_runner_parse_db_host' ) ) {
function wpt_runner_parse_db_host( $host ) {
$host = (string) $host;
$socket = null;
$port = null;
$is_ipv6 = false;
if ( '' === $host ) {
return false;
}
$socket_pos = strpos( $host, ':/' );
if ( false !== $socket_pos ) {
$socket = substr( $host, $socket_pos + 1 );
$host = substr( $host, 0, $socket_pos );
}
if ( substr_count( $host, ':' ) > 1 ) {
if ( 1 !== preg_match( '/^(?:\[(?P<host>[0-9a-fA-F:.]+)\](?::(?P<port>[0-9]+))?|(?P<host_unbracketed>[0-9a-fA-F:.]+))$/', $host, $matches ) ) {
return false;
}
$parsed_host = ! empty( $matches['host'] ) ? $matches['host'] : ( isset( $matches['host_unbracketed'] ) ? $matches['host_unbracketed'] : '' );
$is_ipv6 = true;
} else {
if ( 1 !== preg_match( '/^(?P<host>[^:]*)(?::(?P<port>[0-9]+))?$/', $host, $matches ) ) {
return false;
}
$parsed_host = $matches['host'];
}
if ( '' === $parsed_host ) {
return false;
}
if ( isset( $matches['port'] ) && '' !== $matches['port'] ) {
$port = (int) $matches['port'];
}
return array(
'host' => $parsed_host,
'port' => $port,
'socket' => $socket,
'is_ipv6' => $is_ipv6,
);
}
}
if ( ! function_exists( 'wpt_runner_get_db_server_version' ) ) {
// wp-tests-config.php is read before WordPress creates the global $wpdb.
// Using $wpdb here can leave the database server version empty during bootstrap.
// phpcs:disable WordPress.DB.RestrictedFunctions -- Direct mysqli is limited to database version reporting.
function wpt_runner_get_db_server_version( $db_host, $db_user, $db_password, $db_name ) {
$db_host = trim( (string) $db_host );
$db_user = trim( (string) $db_user );
$db_password = (string) $db_password;
$db_name = trim( (string) $db_name );
if ( '' === $db_host ) {
$db_host = 'localhost';
}
if ( '' === $db_user || '' === $db_name ) {
return '';
}
if ( ! class_exists( 'mysqli' ) ) {
return '';
}
$required_functions = array(
'mysqli_close',
'mysqli_fetch_row',
'mysqli_free_result',
'mysqli_init',
'mysqli_options',
'mysqli_query',
'mysqli_real_connect',
);
foreach ( $required_functions as $function_name ) {
if ( ! function_exists( $function_name ) ) {
return '';
}
}
$parsed_host = wpt_runner_parse_db_host( $db_host );
if ( false === $parsed_host ) {
return '';
}
$connect_host = $parsed_host['host'];
// mysqlnd expects IPv6 hosts in brackets, matching WordPress core's connection handling.
if ( $parsed_host['is_ipv6'] && extension_loaded( 'mysqlnd' ) ) {
$connect_host = '[' . $connect_host . ']';
}
$mysqli = null;
$mysqli_report_mode = null;
try {
if ( class_exists( 'mysqli_driver' ) ) {
$mysqli_driver = new mysqli_driver();
$mysqli_report_mode = $mysqli_driver->report_mode;
}
if ( function_exists( 'mysqli_report' ) ) {
mysqli_report( MYSQLI_REPORT_OFF );
}
$mysqli = mysqli_init();
if ( false === $mysqli ) {
return '';
}
if ( defined( 'MYSQLI_OPT_CONNECT_TIMEOUT' ) ) {
mysqli_options( $mysqli, MYSQLI_OPT_CONNECT_TIMEOUT, 5 );
}
if ( ! @mysqli_real_connect(
$mysqli,
$connect_host,
$db_user,
$db_password,
$db_name,
$parsed_host['port'],
$parsed_host['socket']
) ) {
return '';
}
$result = @mysqli_query( $mysqli, 'SELECT VERSION()' );
if ( ! is_object( $result ) ) {
return '';
}
$row = mysqli_fetch_row( $result );
mysqli_free_result( $result );
if ( ! is_array( $row ) || ! isset( $row[0] ) || '' === (string) $row[0] ) {
return '';
}
return (string) $row[0];
} catch ( Throwable $e ) {
return '';
} finally {
if ( $mysqli instanceof mysqli ) {
@mysqli_close( $mysqli );
}
if ( null !== $mysqli_report_mode && function_exists( 'mysqli_report' ) ) {
mysqli_report( $mysqli_report_mode );
}
}
}
// phpcs:enable WordPress.DB.RestrictedFunctions
}
$env = array(
'php_version' => phpversion(),
'php_modules' => array(),
'gd_info' => $gd_info,
'imagick_info' => $imagick_info,
'mysql_version' => wpt_runner_get_db_server_version( DB_HOST, DB_USER, DB_PASSWORD, DB_NAME ),
'system_utils' => array(),
'os_name' => trim( shell_exec( 'uname -s' ) ),
'os_version' => trim( shell_exec( 'uname -r' ) ),
);
$php_modules = array(
'bcmath',
'ctype',
'curl',
'date',
'dom',
'exif',
'fileinfo',
'filter',
'ftp',
'gd',
'gettext',
'gmagick',
'hash',
'iconv',
'imagick',
'imap',
'intl',
'json',
'libsodium',
'libxml',
'mbstring',
'mcrypt',
'mod_xml',
'mysqli',
'mysqlnd',
'openssl',
'pcre',
'pdo_mysql',
'soap',
'sockets',
'sodium',
'xml',
'xmlreader',
'zip',
'zlib',
);
foreach ( $php_modules as $php_module ) {
$env['php_modules'][ $php_module ] = phpversion( $php_module );
}
function curl_selected_bits( $k ) {
return in_array( $k, array( 'version', 'ssl_version', 'libz_version' ), true );
}
$curl_bits = curl_version();
$env['system_utils']['curl'] = implode( ' ', array_values( array_filter( $curl_bits, 'curl_selected_bits', ARRAY_FILTER_USE_KEY ) ) );
if ( class_exists( 'Imagick' ) ) {
$imagick = new Imagick();
$version = $imagick->getVersion();
preg_match( '/Magick (\d+\.\d+\.\d+-\d+|\d+\.\d+\.\d+|\d+\.\d+\-\d+|\d+\.\d+)/', $version['versionString'], $version );
$env['system_utils']['imagemagick'] = $version[1];
} elseif ( class_exists( 'Gmagick' ) ) {
$gmagick = new Gmagick();
$version = $gmagick->getversion();
preg_match( '/Magick (\d+\.\d+\.\d+-\d+|\d+\.\d+\.\d+|\d+\.\d+\-\d+|\d+\.\d+)/', $version['versionString'], $version );
$env['system_utils']['graphicsmagick'] = $version[1];
}
$env['system_utils']['openssl'] = str_replace( 'OpenSSL ', '', trim( shell_exec( 'openssl version' ) ) );
file_put_contents( __DIR__ . '/tests/phpunit/build/logs/env.json', json_encode( $env, JSON_PRETTY_PRINT ) );
if ( 'cli' === php_sapi_name() && defined( 'WP_INSTALLING' ) && WP_INSTALLING ) {
echo PHP_EOL;
echo 'PHP version: ' . phpversion() . ' (' . realpath( $_SERVER['_'] ) . ')' . PHP_EOL;
echo PHP_EOL;
}
EOT;
// Initialize a string that will be used to identify the post-database-settings section in the configuration file.
$logger_replace_string = 'define( \'DB_COLLATE\', \'\' );' . PHP_EOL;
if ( false === strpos( $contents, $logger_replace_string ) ) {
error_message( 'Unable to insert the system logger after the database constants in wp-tests-config.php.' );
}
// Append the logger script to the database settings constants to ensure DB_* constants are available.
$system_logger = $logger_replace_string . $system_logger;
// Define a string that will set the 'WP_PHP_BINARY' constant to the path of the PHP executable.
$php_binary_string = 'define( \'WP_PHP_BINARY\', \'' . addcslashes( $runner_vars['WPT_PHP_EXECUTABLE'], "\\'" ) . '\' );';
/*
* Map configuration file placeholders to environment-specific values.
*
* The values are written into single-quoted PHP strings, so their backslashes
* and single quotes are escaped, as WordPress does when it writes wp-config.php
* in wp-admin/setup-config.php. Without that, a database password containing a
* single quote, or ending with a backslash, makes wp-tests-config.php a parse
* error, and a double backslash is silently turned into one.
*/
$wpt_table_prefix = trim( getenv( 'WPT_TABLE_PREFIX' ) );
$search_replace = array(
'wptests_' => addcslashes( '' !== $wpt_table_prefix ? $wpt_table_prefix : 'wptests_', "\\'" ),
'youremptytestdbnamehere' => addcslashes( trim( getenv( 'WPT_DB_NAME' ) ), "\\'" ),
'yourusernamehere' => addcslashes( trim( getenv( 'WPT_DB_USER' ) ), "\\'" ),
'yourpasswordhere' => addcslashes( trim( getenv( 'WPT_DB_PASSWORD' ) ), "\\'" ),
'localhost' => addcslashes( trim( getenv( 'WPT_DB_HOST' ) ), "\\'" ),
'define( \'WP_PHP_BINARY\', \'php\' );' => $php_binary_string,
$logger_replace_string => $system_logger,
);
/*
* Replace the placeholders in a single pass. str_replace() runs each pair over
* the result of the previous ones, so a value that contains a later placeholder,
* such as a password containing "localhost", would be rewritten. strtr() never
* revisits replaced text.
*/
$contents = strtr( $contents, $search_replace );
/*
* Point the test suite's temporary directory inside the test directory, so
* concurrent runs with their own WPT_TEST_DIR do not share the system temp
* directory. Core's get_temp_dir() checks the WP_TEMP_DIR constant first,
* and several tests write fixed file names into that directory, so two runs
* sharing it can delete or overwrite each other's files mid test.
*
* The path is anchored to the config file's own location, so it stays
* correct after the config is copied to a remote test environment, and the
* directory is removed together with the test directory during cleanup.
*/
$contents .= <<<'EOT'
if ( ! defined( 'WP_TEMP_DIR' ) ) {
define( 'WP_TEMP_DIR', __DIR__ . '/wp-temp/' );
}
if ( ! is_dir( WP_TEMP_DIR ) ) {
mkdir( WP_TEMP_DIR, 0777, true );
}
if ( ! is_dir( WP_TEMP_DIR ) || ! is_writable( WP_TEMP_DIR ) ) {
echo 'The temporary directory ' . WP_TEMP_DIR . ' could not be created or is not writable. Fix the permissions on the test directory and run again.' . PHP_EOL;
exit( 1 );
}
EOT;
// Write the modified content to the wp-tests-config.php file, which will be used by the test suite.
file_put_contents( $runner_vars['WPT_PREPARE_DIR'] . '/wp-tests-config.php', $contents );
/*
* Construct a command that generates a PHP version string compatible with
* PHPUnit version requirements.
*/
$php_version_cmd = $runner_vars['WPT_PHP_EXECUTABLE'] . " -r \"print PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION . '.' . PHP_RELEASE_VERSION;\"";
/**
* If an SSH connection string is provided, the command to determine the PHP version is modified
* to execute remotely over SSH. This is required if the test environment is not the local machine.
*/
if ( ! empty( $runner_vars['WPT_SSH_CONNECT'] ) ) {
// The PHP version check command is prefixed with the SSH command, including SSH options,
// and the connection string, ensuring the command is executed on the remote machine.
$php_version_cmd = 'ssh ' . $runner_vars['WPT_SSH_OPTIONS'] . ' ' . escapeshellarg( $runner_vars['WPT_SSH_CONNECT'] ) . ' ' . escapeshellarg( $php_version_cmd );
}
// Initialize return value variable for the exec function call.
$retval = 0;
/*
* Execute the constructed command to obtain the PHP version of the test
* environment.
*
* The output is stored in $env_php_version and the return value of the
* command execution is stored in $retval.
*/
$env_php_version = exec( $php_version_cmd, $output, $retval );
// Check if the command execution was successful by inspecting the return value.
if ( 0 !== $retval ) {
error_message( 'Could not retrieve the environment PHP Version.' );
}
// Log the obtained PHP version for confirmation and debugging purposes.
log_message( 'Environment PHP Version: ' . $env_php_version );
/*
* Confirm that the environment meets the minimum PHP version requirement.
*
* When the requirements are not met, execution will end with an error message.
*/
if ( version_compare( $env_php_version, '7.2', '<' ) ) {
// Logs an error message indicating the test runner's incompatibility with PHP versions below 7.2.
error_message( 'The test runner is not compatible with PHP < 7.2.' );
}
// Check if Composer is installed and available in the PATH.
$composer_cmd = 'cd ' . escapeshellarg( $runner_vars['WPT_PREPARE_DIR'] ) . ' && ';
$retval = 0;
$composer_path = escapeshellarg( system( 'which composer', $retval ) );
if ( 0 === $retval ) {
// If Composer is available, prepare the command to use the Composer binary.
$composer_cmd .= $composer_path . ' ';
} else {
// If Composer is not available, download the Composer phar file.
log_message( 'Local Composer not found. Downloading latest stable ...' );
perform_operations(
array(
'wget -O ' . escapeshellarg( $runner_vars['WPT_PREPARE_DIR'] . '/composer.phar' ) . ' https://getcomposer.org/composer-stable.phar',
)
);
// Update the command to use the downloaded Composer phar file.
$composer_cmd .= $runner_vars['WPT_PHP_EXECUTABLE'] . ' composer.phar ';
}
// Set the PHP version for Composer to ensure compatibility and update dependencies.
perform_operations(
array(
$composer_cmd . 'config platform.php ' . escapeshellarg( $env_php_version ),
$composer_cmd . 'update',
)
);
/*
* Transfer the built WordPress codebase to the remote test environment.
*
* When an SSH connection is configured, rsync is used to copy the files
* required to run the WordPress PHPUnit test suite.
*
* The -r option for rsync enables recursive copying to handle nested directory
* structures.
*/
if ( ! empty( $runner_vars['WPT_SSH_CONNECT'] ) ) {
// Initialize rsync options with recursive copying.
$rsync_options = '-r';
// If debug mode is set to verbose, append 'v' to rsync options for verbose output.
if ( $runner_vars['WPT_DEBUG'] ) {
$rsync_options = $rsync_options . 'v';
}
// Perform the rsync operation with the configured options and exclude patterns.
// This operation synchronizes the test environment with the prepared files, excluding
// version control directories and other non-essential files for test execution.
perform_operations(
array(
'rsync ' . $rsync_options
. ' --exclude=".git/"'
. ' --exclude="node_modules/"'
. ' --exclude="composer.phar"'
. ' --exclude=".cache/"'
. ' --exclude=".devcontainer/"'
. ' --exclude=".github/"'
. ' --exclude="tools/"'
// Exclude all subdirectories in tests/ except phpunit/.
. ' --exclude="tests/*" --include="tests/phpunit/**"'
. ' -e "ssh ' . $runner_vars['WPT_SSH_OPTIONS'] . '" '
. escapeshellarg( trailingslashit( $runner_vars['WPT_PREPARE_DIR'] ) )
. ' ' . escapeshellarg( $runner_vars['WPT_SSH_CONNECT'] . ':' . $runner_vars['WPT_TEST_DIR'] ),
)
);
}
// Log a success message indicating that the environment has been prepared.
log_message( 'Success: Prepared environment.' );