Merge pull request #101 from akkspros/akkspros

fix typos and doc standards

Author: getsource

cleanup.php

@@ -6,25 +6,25 @@
 
 require __DIR__ . '/functions.php';
 
-// Check required environment variables
+// Check required environment variables.
 check_required_env();
 
-// Bring some environment variables into scope
+// Bring some environment variables into scope.
 $WPT_PREPARE_DIR = getenv( 'WPT_PREPARE_DIR' );
 $WPT_SSH_CONNECT = getenv( 'WPT_SSH_CONNECT' );
 $WPT_SSH_OPTIONS = getenv( 'WPT_SSH_OPTIONS' ) ? : '-o StrictHostKeyChecking=no';
 $WPT_TEST_DIR = getenv( 'WPT_TEST_DIR' );
 $WPT_RM_TEST_DIR_CMD = getenv( 'WPT_RM_TEST_DIR_CMD' ) ? : 'rm -r ' . $WPT_TEST_DIR;
 
-// Clean up the preparation directory
-// Only forcefully delete the .git directory, to prevent disasters otherwise
+// Clean up the preparation directory.
+// Only forcefully delete the .git directory, to prevent disasters otherwise.
 perform_operations( array(
 	'rm -rf ' . escapeshellarg( $WPT_PREPARE_DIR . '/.git' ),
 	'rm -rf ' . escapeshellarg( $WPT_PREPARE_DIR . '/node_modules/.cache' ),
 	'rm -r ' . escapeshellarg( $WPT_PREPARE_DIR ),
 ) );
 
-// Clean up the test directory in remote environments
+// Clean up the test directory in remote environments.
 if ( ! empty( $WPT_SSH_CONNECT ) ) {
 	perform_operations( array(
 		'ssh ' . $WPT_SSH_OPTIONS . ' ' . escapeshellarg( $WPT_SSH_CONNECT ) . ' ' . escapeshellarg( $WPT_RM_TEST_DIR_CMD ),

functions.php

@@ -97,21 +97,21 @@ function process_junit_xml( $xml_string )
 	$results = array();
 
 	$results = array(
-		'tests' => (string) $project['tests'],
+		'tests'    => (string) $project['tests'],
 		'failures' => (string) $project['failures'],
-		'errors' => (string) $project['errors'],
-		'time' => (string) $project['time'],
+		'errors'   => (string) $project['errors'],
+		'time'     => (string) $project['time'],
 	);
 
 	$results['testsuites'] = array();
 	foreach ( $project->testsuite as $testsuite ) {
 		// Handle nested testsuites like tests with data providers.
 		$testsuite = isset( $testsuite->testsuite ) ? $testsuite->testsuite : $testsuite;
 		$result = array(
-			'name' => (string) $testsuite['name'],
-			'tests' => (string) $testsuite['tests'],
+			'name'     => (string) $testsuite['name'],
+			'tests'    => (string) $testsuite['tests'],
 			'failures' => (string) $testsuite['failures'],
-			'errors' => (string) $testsuite['errors']
+			'errors'   => (string) $testsuite['errors']
 		);
 		if ( empty( $result['failures'] ) && empty( $result['errors'] ) ) {
 			continue;
@@ -124,7 +124,7 @@ function process_junit_xml( $xml_string )
 				if ( isset( $testcase->{$key} ) ) {
 					$results['testsuites'][ (string) $testsuite['name'] ]['testcases'][ (string) $testcase['name'] ] = array(
 						'name' => (string) $testcase['name'],
-						$key => (string) $testcase->{$key},
+						$key   => (string) $testcase->{$key},
 					);
 				}
 			}
@@ -153,9 +153,9 @@ function upload_results( $results, $rev, $message, $env, $api_key ) {
 	$access_token = base64_encode( $api_key );
 	$data = array(
 		'results' => $results,
-		'commit' => $rev,
+		'commit'  => $rev,
 		'message' => $message,
-		'env' => $env,
+		'env'     => $env,
 	);
 	$data_string = json_encode( $data );
 

prepare.php

@@ -6,17 +6,17 @@
 
 require __DIR__ . '/functions.php';
 
-// Check required environment variables
+// Check required environment variables.
 check_required_env();
 
-// Bring some environment variables into scope
+// Bring some environment variables into scope.
 $WPT_PREPARE_DIR = getenv( 'WPT_PREPARE_DIR' );
 $WPT_SSH_CONNECT = getenv( 'WPT_SSH_CONNECT' );
 $WPT_SSH_OPTIONS = getenv( 'WPT_SSH_OPTIONS' ) ? : '-o StrictHostKeyChecking=no';
 $WPT_TEST_DIR = getenv( 'WPT_TEST_DIR' );
 $WPT_PHP_EXECUTABLE = getenv( 'WPT_PHP_EXECUTABLE') ? : 'php';
 
-// Set the ssh private key if it's set
+// Set the ssh private key if it's set.
 $WPT_SSH_PRIVATE_KEY_BASE64 = getenv( 'WPT_SSH_PRIVATE_KEY_BASE64' );
 if ( ! empty( $WPT_SSH_PRIVATE_KEY_BASE64 ) ) {
 	log_message( 'Securely extracting WPT_SSH_PRIVATE_KEY_BASE64 into ~/.ssh/id_rsa' );
@@ -27,7 +27,7 @@
 	) );
 }
 
-// Create the prepation directory and fetch corresponding files
+// Create the preparation directory and fetch corresponding files
 perform_operations( array(
 	'mkdir -p ' . escapeshellarg( $WPT_PREPARE_DIR ),
 	'git clone --depth=1 https://github.com/WordPress/wordpress-develop.git ' . escapeshellarg( $WPT_PREPARE_DIR ),
@@ -37,10 +37,10 @@
 	'cd ' . escapeshellarg( $WPT_PREPARE_DIR ) . '; npm install && grunt build',
 ) );
 
-// Replace variables in the wp-config.php file
+// Replace variables in the wp-config.php file.
 log_message( 'Replacing variables in wp-tests-config.php' );
 $contents = file_get_contents( $WPT_PREPARE_DIR . '/wp-tests-config-sample.php' );
-// Log system information to same directory as test run log
+// Log system information to same directory as test run log.
 $system_logger = <<<EOT
 // Create the log directory to store test results
 if ( ! is_dir(  __DIR__ . '/tests/phpunit/build/logs/' ) ) {
@@ -103,7 +103,7 @@
 $contents = str_replace( array_keys( $search_replace ), array_values( $search_replace ), $contents );
 file_put_contents( $WPT_PREPARE_DIR . '/wp-tests-config.php', $contents );
 
-// Deliver all files to test environment
+// Deliver all files to test environment.
 if ( ! empty( $WPT_SSH_CONNECT ) ) {
 	perform_operations( array(
 		'rsync -rv --exclude=".git/" -e "ssh ' . $WPT_SSH_OPTIONS . '" ' . escapeshellarg( trailingslashit( $WPT_PREPARE_DIR )  ) . ' ' . escapeshellarg( $WPT_SSH_CONNECT . ':' . $WPT_TEST_DIR ),

report.php

@@ -6,7 +6,7 @@
 
 require __DIR__ . '/functions.php';
 
-// Check required environment variables
+// Check required environment variables.
 check_required_env( false );
 
 $WPT_SSH_CONNECT = getenv( 'WPT_SSH_CONNECT' );

test.php

@@ -6,7 +6,7 @@
 
 require __DIR__ . '/functions.php';
 
-// Check required environment variables
+// Check required environment variables.
 check_required_env();
 
 $WPT_SSH_CONNECT = getenv( 'WPT_SSH_CONNECT' );
@@ -15,7 +15,7 @@
 $WPT_PHP_EXECUTABLE = getenv( 'WPT_PHP_EXECUTABLE' ) ? : 'php';
 $WPT_PHPUNIT_CMD = getenv( 'WPT_PHPUNIT_CMD' ) ? : 'cd ' . escapeshellarg( $WPT_TEST_DIR ) . '; ' . $WPT_PHP_EXECUTABLE . ' phpunit.phar';
 
-// Run phpunit in the test environment
+// Run phpunit in the test environment.
 if ( ! empty( $WPT_SSH_CONNECT ) ) {
 	$WPT_PHPUNIT_CMD = 'ssh ' . $WPT_SSH_OPTIONS . ' ' . escapeshellarg( $WPT_SSH_CONNECT ) . ' ' . escapeshellarg( $WPT_PHPUNIT_CMD );
 }