Merge pull request #29518 from woocommerce/fix/29483

Fix logic for including the "payments" task in onboarding wizard
This commit is contained in:
Claudio Sanches 2021-03-29 13:19:50 -03:00 committed by GitHub
commit cb56838d25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 10 deletions

View File

@ -178,7 +178,7 @@ if ( ! class_exists( 'WC_Admin_Dashboard_Setup', false ) ) :
} }
// payments can't be used when woocommerce-payments exists and country is US. // payments can't be used when woocommerce-payments exists and country is US.
if ( $is_woo_payment_installed || 'US' === $country ) { if ( $is_woo_payment_installed && 'US' === $country ) {
unset( $this->tasks['payments'] ); unset( $this->tasks['payments'] );
} }

View File

@ -14,12 +14,22 @@ class WC_Admin_Dashboard_Setup_Test extends WC_Unit_Test_Case {
* Set up * Set up
*/ */
public function setUp() { public function setUp() {
// set default country to US so that 'payments' task does not get added. // Set default country to non-US so that 'payments' task gets added but 'woocommerce-payments' doesn't,
// we want to remove payment tasks as they depend on installation & activation. // by default it won't be considered completed but we can manually change that as needed.
update_option( 'woocommerce_default_country', 'US' ); update_option( 'woocommerce_default_country', 'JP' );
parent::setUp(); parent::setUp();
} }
/**
* Tear down
*/
public function tearDown() {
remove_all_filters( 'woocommerce_available_payment_gateways' );
parent::tearDown();
}
/** /**
* Includes widget class and return the class. * Includes widget class and return the class.
* *
@ -75,13 +85,21 @@ class WC_Admin_Dashboard_Setup_Test extends WC_Unit_Test_Case {
} }
/** /**
* Tests the widget output when 0 task has been completed. * Tests the widget output when 1 task has been completed.
*/ */
public function test_initial_widget_output() { public function test_initial_widget_output() {
// Force the "payments" task to be considered incomplete.
add_filter(
'woocommerce_available_payment_gateways',
function() {
return array();
}
);
$html = $this->get_widget_output(); $html = $this->get_widget_output();
$required_strings = array( $required_strings = array(
'Step 0 of 5', 'Step 0 of 6',
'You're almost there! Once you complete store setup you can start receiving orders.', 'You're almost there! Once you complete store setup you can start receiving orders.',
'Start selling', 'Start selling',
'admin.php\?page=wc-admin&path=%2Fsetup-wizard', 'admin.php\?page=wc-admin&path=%2Fsetup-wizard',
@ -96,9 +114,22 @@ class WC_Admin_Dashboard_Setup_Test extends WC_Unit_Test_Case {
* Tests completed task count as it completes one by one * Tests completed task count as it completes one by one
*/ */
public function test_widget_renders_completed_task_count() { public function test_widget_renders_completed_task_count() {
$completed_tasks = array(); // Force the "payments" task to be considered completed
// by faking a valid payment gateway.
add_filter(
'woocommerce_available_payment_gateways',
function() {
return array(
new class() extends WC_Payment_Gateway {
},
);
}
);
$completed_tasks = array( 'payments' );
$tasks = $this->get_widget()->get_tasks(); $tasks = $this->get_widget()->get_tasks();
$tasks_count = count( $tasks ); $tasks_count = count( $tasks );
unset( $tasks['payments'] ); // That one is completed already.
foreach ( $tasks as $key => $task ) { foreach ( $tasks as $key => $task ) {
array_push( $completed_tasks, $key ); array_push( $completed_tasks, $key );
update_option( 'woocommerce_task_list_tracked_completed_tasks', $completed_tasks ); update_option( 'woocommerce_task_list_tracked_completed_tasks', $completed_tasks );
@ -108,7 +139,7 @@ class WC_Admin_Dashboard_Setup_Test extends WC_Unit_Test_Case {
if ( $completed_tasks_count === $tasks_count ) { if ( $completed_tasks_count === $tasks_count ) {
$this->assertEmpty( $this->get_widget_output() ); $this->assertEmpty( $this->get_widget_output() );
} else { } else {
$this->assertRegexp( "/Step ${completed_tasks_count} of 5/", $this->get_widget_output() ); $this->assertRegexp( "/Step ${completed_tasks_count} of 6/", $this->get_widget_output() );
} }
} }
} }