Skip to content

Commit

Permalink
Merge pull request #125 from woocommerce/24-01/api-e2e-test-type
Browse files Browse the repository at this point in the history 
Rename "api" to "woo-api" and "e2e" to "woo-e2e"
  • Loading branch information
@Luc45
Luc45 authored Feb 11, 2024
2 parents 12cacf6 + 3bd4584 commit 7fb1938
Show file tree
Hide file tree
Showing 48 changed files with 61 additions and 62 deletions.
26 changes: 1 addition & 25 deletions _tests/ParallelOutput.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public function __construct() {
$this->processStatus = [];
$this->startTimes = [];
$this->nonJsonOutput = [];
register_shutdown_function( [ $this, 'onShutdown' ] );
register_shutdown_function( [ $this, 'displayBufferedOutputs' ] );
}

public function addRawOutput( string $output ) {
Expand Down Expand Up @@ -96,28 +96,4 @@ protected function displayBufferedOutputs() {
echo "$status\n";
}
}

public function onShutdown() {
if ( getenv( "CI" ) ) {
echo $this->rawOutput . "\n";

// Print the accumulated output for each task in CI environment
foreach ( $this->outputBuffer as $taskId => $output ) {
echo "\033[1;33m" . $this->headers[ $taskId ] . "\033[0m\n"; // Yellow for headers
echo $output . "\n"; // Print the accumulated output

if ( ! empty( $this->nonJsonOutput[ $taskId ] ) && file_exists( $this->nonJsonOutput[ $taskId ] ) ) {
echo file_get_contents( $this->nonJsonOutput[ $taskId ] ) . "\n";
} else {
echo "No non-json output file found for task $taskId\n";
}
}

// Print the summary section
echo "\n\033[1;32mSummary Section:\033[0m\n"; // Green for summary section header
foreach ( $this->processStatus as $status ) {
echo "$status\n";
}
}
}
}
17 changes: 11 additions & 6 deletions _tests/QITSelfTests.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class Context {

Context::$action = $params[1] ?? 'run';

# Comma-separated list of test-types to run, eg: e2e,api
# Comma-separated list of test-types to run, eg: woo-e2e,woo-api
if ( isset( $params[2] ) ) {
Context::$test_types = array_map( 'trim', explode( ',', $params[2] ) );
} else {
Expand Down Expand Up @@ -105,7 +105,7 @@ class Context {

if ( getenv( 'QIT_SKIP_E2E' ) === 'yes' ) {
$test_types = array_filter( $test_types, function ( $test_type_path ) {
return basename( $test_type_path ) !== 'e2e';
return basename( $test_type_path ) !== 'woo-e2e';
} );
}

Expand Down Expand Up @@ -345,14 +345,15 @@ function run_test_runs( array $test_runs ) {

$normalized_t = $t;
unset( $normalized_t['path'] );
$normalized_t['type'] = str_replace( '-', '_', $normalized_t['type'] );

/*
* Here we need a unique name that is human-readable, so that we can easily identify the test in the output.
* We use the md5 of the test data to make sure it's unique.
*/
$t['test_function_name'] = sprintf(
'test_%s_%s_woo%s_php%s_wp%s_%s',
$t['type'],
$normalized_t['type'],
$t['slug'],
str_replace( '.', '', $t['woo'] ),
str_replace( '.', '', $t['php'] ),
Expand Down Expand Up @@ -473,6 +474,10 @@ function make_test_result_json_filepath( Process $process ): string {
return sprintf( '%s/%s', $process->getEnv()['QIT_TEST_PATH'], make_test_result_json_filename( $process ) );
}

function generate_test_file_name( string $test_type ) {
return ucfirst( str_replace( '-', '', $test_type ) ) . 'Test.php';
}

function handle_qit_response( Process $qit_process, string $out, array &$failed_tests ): void {
$result = json_decode( $out, true );

Expand Down Expand Up @@ -502,7 +507,7 @@ function handle_qit_response( Process $qit_process, string $out, array &$failed_
//php ./vendor/bin/phpunit tests/ActivationTest.php --filter=test_php81_activation -d --update-snapshots
$args = [
__DIR__ . '/vendor/bin/phpunit',
__DIR__ . '/tests/' . ucfirst( $qit_process->getEnv()['QIT_TEST_TYPE'] ) . 'Test.php',
__DIR__ . '/tests/' . generate_test_file_name( $qit_process->getEnv()['QIT_TEST_TYPE'] ),
/*
* Match a single test method by regex.
* Example test method: TestNamespace\TestCaseClass::testMethod
Expand Down Expand Up @@ -538,8 +543,8 @@ function handle_qit_response( Process $qit_process, string $out, array &$failed_
}

function generate_phpunit_files( string $test_type, array &$test_runs ): void {
$name = ucfirst( $test_type ) . 'Test';
$filepath = __DIR__ . '/tests/' . $name . '.php';
$name = str_replace( '.php', '', generate_test_file_name( $test_type ) );
$filepath = __DIR__ . '/tests/' . generate_test_file_name( $test_type );
$tests = '';

foreach ( $test_runs as &$test_run ) {
Expand Down
10 changes: 5 additions & 5 deletions _tests/tests/QITE2ETestCase.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,11 @@ public function validate_and_normalize( string $file_path, ?callable $callback =
return $value;
}

if ( stripos( $file_path, 'e2e/delete_products' ) !== false ) {
if ( stripos( $file_path, 'woo-e2e/delete_products' ) !== false ) {
return [
[
'count' => '0',
'message' => 'Debug log is ignored for e2e/delete_products tests.',
'message' => 'Debug log is ignored for woo-e2e/delete_products tests.',
],
];
}
Expand All @@ -141,7 +141,7 @@ public function validate_and_normalize( string $file_path, ?callable $callback =

$debug_log['message'] = str_replace( 'compatibility-dashboard', 'qit-runner', $debug_log['message'] );

if ( stripos( $file_path, 'api/delete_products' ) !== false ) {
if ( stripos( $file_path, 'woo-api/delete_products' ) !== false ) {
$pos = stripos( $debug_log['message'], 'Stack Trace:' );

if ( $pos !== false ) {
Expand Down Expand Up @@ -209,8 +209,8 @@ public function validate_and_normalize( string $file_path, ?callable $callback =
}
}

// Handle E2E Delete Products tests with more wiggle room.
if ( stripos( $file_path, 'e2e/delete_products' ) !== false ) {
// Handle Woo E2E Delete Products tests with more wiggle room.
if ( stripos( $file_path, 'woo-e2e/delete_products' ) !== false ) {
if ( $debug_log['count'] <= 10 ) {
$debug_log['count'] = 'Less than 10';
}
Expand Down
2 changes: 1 addition & 1 deletion ...e_f7b5299ab1de0d9626bdbc5ac73b64b5__1.php → ...e_440db7a70e471458f49b3c2aca2ba623__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_d0892e467248158ea184d46bc57eadcd__1.php → ...c_ca644c3f45a3d92971d7c34b17b9bf40__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_1d253e81de4952cfb87b849097a3ccda__1.php → ...c_8ddcb1dd26e5c14fcd0a28ef812daa5c__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_2bc1713b0bc63cb0df8e99eab5bbe98c__1.php → ...c_c35449740535ad91e8942f8f0ed05b72__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_83ab5f1a3e55846b905fee9eec1ccc58__1.php → ...c_f53670e03588ff82e9c536ab4127fb87__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_437300183b2174e1ba88cec48b2eb51e__1.php → ...c_346c5f1d46bbec1721f5bbf11816a5c0__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_13a325388c3836cb57a9e3c724bf7296__1.php → ...c_2b7d6254596db2c73939e0d764cc4ba3__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_dd1ed47f28dce1f8e6489f04f76079d7__1.php → ...c_7362ffe83e2b60ebc0cf5c63b3856976__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_f44507d9c453eb0c343b24e3f83f61e8__1.php → ...c_5e58227b55849b8c7239a9971ae5d264__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_55199af99596d0d17f85e569a2af8eda__1.php → ...c_a6529ab79fa04ae8b847cfd8480802e9__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_da90ec1121cd91c8fc7d3de99e542d78__1.php → ...c_2d42a2bf6a893323495c02b92696088d__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_1364a052255646f336e48e175517896b__1.php → ...c_48746c7a930b33fed2d8863a3e95fbcb__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_ce0ad7cc015aaf21ce07034581af5684__1.php → ...c_a0fbb1af13e49b936b643bb31baf14d0__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...e_c658702a8947742740d96ec1685cf657__1.php → ...e_4fea9b07dff27b783d26f0b4b90cc6e4__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_f9ada2c57918cfe01de5152833b21a49__1.php → ...c_21a3b603b13d883e8f40e55359c849d2__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_402357abae3d61377123c9dab2d9008e__1.php → ...c_c2dbc31700c141424142df97ef29db7c__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_33d9da3bca5d9e624c4ac028f9d60070__1.php → ...c_ceca12f824cfabbcf4666dac2b91d97a__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_c341ff7f23dc984ee0b462960f779c19__1.php → ...c_13b593e34978b9296b52ff856b9c897d__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "api",
"test_type": "woo-api",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
4 changes: 2 additions & 2 deletions ...c_8fa60e0c410bf78ac92eef30fb3977c5__1.php → ...c_b153920e11128a2003ccfabb5a1c2b66__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down Expand Up @@ -1919,7 +1919,7 @@
"debug_log": [
{
"count": "0",
"message": "Debug log is ignored for e2e\\/delete_products tests."
"message": "Debug log is ignored for woo-e2e\\/delete_products tests."
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions ...c_ee9b6a92e66c13b1a14b864a61894e2e__1.php → ...c_2a952a960085a76868033dc54aa96159__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down Expand Up @@ -1723,7 +1723,7 @@
"debug_log": [
{
"count": "0",
"message": "Debug log is ignored for e2e\\/delete_products tests."
"message": "Debug log is ignored for woo-e2e\\/delete_products tests."
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion ...c_3352128ddc0d4673fd435b1c6c1e9d15__1.php → ...c_4ee1157429027befae37425348f5bd84__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_ae506535d29d54780f2157e86026a711__1.php → ...c_960168535790f3a7eff463fb11517d63__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "8.2",
Expand Down
2 changes: 1 addition & 1 deletion ...c_3ca3234b24887d2b86c56ac59b5b4ceb__1.php → ...c_818ebdd6b04d0991fd37d3414ff14307__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
2 changes: 1 addition & 1 deletion ...c_a9c30cbd9b7ec3a64233707209e2c66a__1.php → ...c_865de3b217a16a96d42609a9ca8ebcf0__1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"test_run_id": 123456,
"run_id": 123456,
"test_type": "e2e",
"test_type": "woo-e2e",
"wordpress_version": "6.0.0-normalized",
"woocommerce_version": "6.0.0-normalized",
"php_version": "7.4",
Expand Down
0 _tests/api/childtheme/bistro/style.css → _tests/woo-api/childtheme/bistro/style.css
View file
File renamed without changes.
0 _tests/api/childtheme/env.php → _tests/woo-api/childtheme/env.php
View file
File renamed without changes.
0 _tests/api/delete_products/env.php → _tests/woo-api/delete_products/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/api/no_op/env.php → _tests/woo-api/no_op/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/api/order_cache_bug/env.php → _tests/woo-api/order_cache_bug/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/api/parenttheme/bistro/index.php → _tests/woo-api/parenttheme/bistro/index.php
View file
File renamed without changes.
0 _tests/api/parenttheme/bistro/style.css → _tests/woo-api/parenttheme/bistro/style.css
View file
File renamed without changes.
0 _tests/api/parenttheme/env.php → _tests/woo-api/parenttheme/env.php
View file
File renamed without changes.
0 _tests/api/valid_features/env.php → _tests/woo-api/valid_features/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/e2e/delete_products/env.php → _tests/woo-e2e/delete_products/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/e2e/no_op/env.php → _tests/woo-e2e/no_op/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
0 _tests/e2e/no_op_php82/env.php → _tests/woo-e2e/no_op_php82/env.php
View file
File renamed without changes.
0 ...oduct-feeds/woocommerce-product-feeds.php → ...oduct-feeds/woocommerce-product-feeds.php
View file
File renamed without changes.
Binary file modified qit
View file
Binary file not shown.
18 changes: 18 additions & 0 deletions src/src/Commands/CreateRunCommands.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,24 @@ public function execute( InputInterface $input, OutputInterface $output ) {

$command->add_option_to_send( 'zip' );

if ( $test_type === 'api' ) {
$command->setHidden( true );
}

// This will be hidden while custom test type is in development, but kept as an alias to "woo-e2e".
if ( $test_type === 'e2e' ) {
try {
$hide_e2e = $this->environment->get_cache()->get_manager_sync_data( 'hide_e2e' );
} catch ( \Exception $e ) {
// If it throws it's because it's not set, so we hide it.
$hide_e2e = true;
}

if ( $hide_e2e ) {
$command->setHidden( true );
}
}

$application->add( $command );
}
}

0 comments on commit 7fb1938

Please sign in to comment.