-
Notifications
You must be signed in to change notification settings - Fork 58
/
report.php
179 lines (157 loc) · 7.7 KB
/
report.php
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
<?php
/**
* This script is responsible for reporting the results of the PHPUnit test runs to WordPress.org.
* It gathers necessary information such as the SVN revision, test run messages, and the junit.xml
* file containing the results. It then uploads these details using the WordPress.org API if an API
* key is provided, or logs the results for later use.
*
* @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( false );
/**
* Retrieves environment variables and sets defaults for test preparation.
* These variables are used to configure SSH connections, file paths, and
* executable commands needed for setting up the test environment.
*/
$WPT_SSH_CONNECT = trim( getenv( 'WPT_SSH_CONNECT' ) );
$WPT_TEST_DIR = trim( getenv( 'WPT_TEST_DIR' ) );
$WPT_PREPARE_DIR = trim( getenv( 'WPT_PREPARE_DIR' ) );
$WPT_SSH_OPTIONS = trim( getenv( 'WPT_SSH_OPTIONS' ) );
$WPT_REPORT_API_KEY = trim( getenv( 'WPT_REPORT_API_KEY' ) );
/**
* Determines if the debug mode is enabled based on the 'WPT_DEBUG' environment variable.
* The debug mode can affect error reporting and other debug-related settings.
*/
$WPT_DEBUG_INI = getenv( 'WPT_DEBUG' );
switch( $WPT_DEBUG_INI ) {
case 0:
case 'false':
$WPT_DEBUG = false;
break;
case 1:
case 'true':
case 'verbose':
$WPT_DEBUG = 'verbose';
break;
default:
$WPT_DEBUG = false;
break;
}
unset( $WPT_DEBUG_INI );
/**
* Retrieves the SVN revision number from the git repository log.
* Logs a message indicating the start of the SVN revision retrieval process.
* Executes a shell command that accesses the git directory specified by the
* WPT_PREPARE_DIR environment variable, retrieves the latest commit message,
* and extracts the SVN revision number using a combination of grep and cut commands.
*/
log_message('Getting SVN Revision');
$rev = exec('git --git-dir=' . escapeshellarg( $WPT_PREPARE_DIR ) . '/.git log -1 --pretty=%B | grep "git-svn-id:" | cut -d " " -f 2 | cut -d "@" -f 2');
/**
* Retrieves the latest SVN commit message from the git repository log.
* Logs a message to indicate the retrieval of the SVN commit message. Executes a shell command
* that accesses the git directory specified by the WPT_PREPARE_DIR environment variable,
* fetches the latest commit message, and trims any whitespace from the message.
*/
log_message('Getting SVN message');
$message = trim( exec('git --git-dir=' . escapeshellarg( $WPT_PREPARE_DIR ) . '/.git log -1 --pretty=%B | head -1') );
/**
* Prepares the file path for copying the junit.xml results.
* Logs a message indicating the start of the operation to copy junit.xml results.
* Constructs the file path to the junit.xml file(s) located in the test directory,
* making use of the WPT_TEST_DIR environment variable. The path is sanitized to be
* safely used in shell commands.
*/
log_message('Copying junit.xml results');
$junit_location = escapeshellarg( $WPT_TEST_DIR ) . '/tests/phpunit/build/logs/*';
/**
* Modifies the junit.xml results file path for a remote location if an SSH connection is available.
* If the WPT_SSH_CONNECT environment variable is not empty, indicating that an SSH connection
* is configured, this snippet adapts the junit_location variable to include the necessary SSH
* command and options for accessing the remote file system. It concatenates SSH options with the
* remote path to ensure that the junit.xml results can be accessed or copied over SSH.
*/
if ( ! empty( $WPT_SSH_CONNECT ) ) {
$junit_location = '-e "ssh ' . $WPT_SSH_OPTIONS . '" ' . escapeshellarg( $WPT_SSH_CONNECT . ':' . $junit_location );
}
/**
* Sets the options for the rsync command based on the debug mode.
* Initializes the rsync options with the recursive flag. If the debug mode is set to 'verbose',
* appends the 'v' flag to the rsync options to enable verbose output during the rsync operation,
* providing more detailed information about the file transfer process.
*/
$rsync_options = '-r';
if ( 'verbose' === $WPT_DEBUG ) {
$rsync_options = $rsync_options . 'v';
}
/**
* Constructs the rsync command for executing the synchronization of junit.xml files.
* Concatenates the rsync command with the previously defined options and the source and
* destination paths. The destination path is sanitized for shell execution. This command is
* then passed to the `perform_operations` function, which executes the command to synchronize
* the junit.xml files from the source to the destination directory.
*/
$junit_exec = 'rsync ' . $rsync_options . ' ' . $junit_location . ' ' . escapeshellarg( $WPT_PREPARE_DIR );
perform_operations( array(
$junit_exec,
) );
/**
* Processes and uploads the junit.xml file.
* First, a log message is recorded to indicate the start of processing the junit.xml file.
* Then, the contents of the junit.xml file are read from the prepared directory into a string.
* This XML string is then passed to a function that processes the XML data, presumably to prepare
* it for upload or to extract relevant test run information.
*/
log_message( 'Processing and uploading junit.xml' );
$xml = file_get_contents( $WPT_PREPARE_DIR . '/junit.xml' );
$results = process_junit_xml( $xml );
/**
* Retrieves environment details from a JSON file or generates them if not available.
* Initializes the environment details string. If an 'env.json' file exists in the prepared
* directory, its contents are read into the environment details string. If the file doesn't
* exist but the prepared directory is the same as the test directory, the environment details
* are generated by calling a function that retrieves these details, then encoded into JSON format.
*/
$env = '';
if ( file_exists( $WPT_PREPARE_DIR . '/env.json' ) ) {
$env = file_get_contents( $WPT_PREPARE_DIR . '/env.json' );
} elseif ( $WPT_PREPARE_DIR === $WPT_TEST_DIR ) {
$env = json_encode( get_env_details(), JSON_PRETTY_PRINT );
}
/**
* Attempts to upload test results if an API key is available, otherwise logs the results locally.
* Checks if an API key for reporting is present. If so, it attempts to upload the test results
* using the `upload_results` function and processes the HTTP response. A success message is logged
* if the upload is successful, indicated by a 20x HTTP status code. If the upload fails, an error
* message is logged along with the HTTP status. If no API key is provided, it logs the test results
* and environment details locally.
*/
if( ! empty( $WPT_REPORT_API_KEY ) ) {
// Upload the results and capture the HTTP status and response body
list( $http_status, $response_body ) = upload_results( $results, $rev, $message, $env, $WPT_REPORT_API_KEY );
// Decode the JSON response body
$response = json_decode( $response_body, true );
if ( 20 == substr( $http_status, 0, 2 ) ) {
// Construct and log a success message with a link if provided in the response
$message = 'Results successfully uploaded';
$message .= isset( $response['link'] ) ? ': ' . $response['link'] : '';
log_message( $message );
} else {
// Construct and log an error message with additional details if provided in the response
$message = 'Error uploading results';
$message .= isset( $response['message'] ) ? ': ' . $response['message'] : '';
$message .= ' (HTTP status ' . (int) $http_status . ')';
error_message( $message );
}
} else {
// Log the test results and environment details locally if no API key is provided
log_message( '[+] TEST RESULTS' . "\n\n" . $results. "\n\n" );
log_message( '[+] ENVIRONMENT' . "\n\n" . $env . "\n\n" );
}