woocommerce/tests/php/includes/settings/class-wc-settings-payment-g...

180 lines
5.4 KiB
PHP
Raw Normal View History

Refactor the settings pages, and add unit tests for them. This commit fixes some inconsistencies in the settings pages, and makes all the existing pages extensible by adding new sections (that was possible in some pages, but not in others). Main changes: 1. Modify the 'get_sections' method so that it invokes a new protected 'get_own_sections' method and then triggers the 'woocommerce_get_sections_' . id filter. This way the filter is triggered only in the base class and not in each of the derived classes too. 2. Change the get_settings() method so that it has its signature changed to get_settings( $current_section = '' ) in the base class and in all the derived class. Some derived classes were already using this signature, but others (those not having multiple sections natively) weren't, making then effectively impossible to define multiple sections for these pages via filters. With this change all the section pages act consistently and allow both adding new settings to the default "General" section and creating new sections via filters. 3. Change the implementation of 'get_settings' in the base class so that it searches for a 'get_settings_for_{section_id}_section' method in the class and executes it, otherwise it executes the new protected method get_settings_for_section( $current_section ); then it triggers the 'woocommerce_get_settings_' . id filter. This makes it easier to separate the code that returns the list of filters in multiple methods, one per section, instead of using one big if-else-else... block. So now instead of overriding get_settings($current_section='') derived classes need to implement get_settings_for_{$current_section}_section for each section, or override get_settings_for_section($current_section) or both. 'get_settings_for_section' returns an empty array by default. Also, 'woocommerce_get_settings_' . id is triggered in one single place too. Other improvements: * Remove duplicated code from 'output' in 'WC_Settings_Page' children. Some classes inherited from 'WC_Settings_Page' override the 'output' method with custom code, which in all cases ended up repeating the code of the original method as a fallback. These repetitions have been replaced with 'parent::output()'. * Fix inconsistencies for 'save' and 'output' in WC_Settings_Tax/Emails The 'WC_Settings_Tax' and 'WC_Settings_Emails' classes had some inconsistencies in their 'save' and 'output' methods that prevented the proper creation new sections and the addition of new settings via the 'woocommerce_get_sections_' and 'woocommerce_get_settings_' filters. Now they work as expected. * Deduplicate parts of 'save' in 'WC_Settings_Page' and children. Two methods have been added to 'WC_Settings_Page' class: 'save_settings_for_current_section' and 'do_update_options_action'. These are intended to be invoked by derived classes in their 'save' methods, in order to remove code repetition. * Add some helper methods to WC_Unit_Test_Case. Methods added: - assertOutputsHTML - assertEqualsHTML - normalize_html - capture_output_from
2020-09-16 10:27:05 +00:00
<?php
/**
* Class WC_Settings_Payment_Gateways_Test file.
*
* @package WooCommerce\Tests\Settings
*/
use Automattic\WooCommerce\Testing\Tools\CodeHacking\Hacks\FunctionsMockerHack;
use Automattic\WooCommerce\Testing\Tools\CodeHacking\Hacks\StaticMockerHack;
require_once __DIR__ . '/class-wc-settings-unit-test-case.php';
/**
* Unit tests for the WC_Settings_Payment_Gateways class.
*/
class WC_Settings_Payment_Gateways_Test extends WC_Settings_Unit_Test_Case {
/**
* @testdox get_sections should get all the existing sections.
*/
public function test_get_sections() {
$sut = new WC_Settings_Payment_Gateways();
$section_names = array_keys( $sut->get_sections() );
$expected = array(
'',
);
$this->assertEquals( $expected, $section_names );
}
/**
* get_settings should trigger the appropriate filter depending on the requested section name.
*
* @testWith ["", "woocommerce_payment_gateways_settings"]
* ["woocommerce_com", "woocommerce_get_settings_checkout"]
*
* @param string $section_name The section name to test getting the settings for.
* @param string $filter_name The name of the filter that is expected to be triggered.
*/
public function test_get_settings_triggers_filter( $section_name, $filter_name ) {
$actual_settings_via_filter = null;
add_filter(
$filter_name,
function ( $settings ) use ( &$actual_settings_via_filter ) {
$actual_settings_via_filter = $settings;
return $settings;
},
10,
1
);
$sut = new WC_Settings_Payment_Gateways();
$actual_settings_returned = $sut->get_settings( $section_name );
remove_all_filters( $filter_name );
$this->assertSame( $actual_settings_returned, $actual_settings_via_filter );
}
/**
* @testdox get_settings('') should return all the settings for the default section.
*/
public function test_get_default_settings_returns_all_settings() {
$sut = new WC_Settings_Payment_Gateways();
$settings = $sut->get_settings( '' );
$settings_ids_and_types = $this->get_ids_and_types( $settings );
$expected = array(
'payment_gateways_options' => array( 'title', 'sectionend' ),
'' => 'payment_gateways',
);
$this->assertEquals( $expected, $settings_ids_and_types );
}
/**
* @testDox When the current section is the name of an existing gateway, 'output' invokes that gateway's 'admin_options' method.
*
* @testWith ["bacs"]
* ["wc_gateway_bacs"]
*
* @param string $section_name The name of the current section.
*/
public function test_output_is_done_via_admin_options_method_of_gateway_specified_as_settings_section( $section_name ) {
global $current_section;
$current_section = $section_name;
$admin_options_invoked = false;
$actual_gateway = null;
$sut = $this->getMockBuilder( WC_Settings_Payment_Gateways::class )
->setMethods( array( 'run_gateway_admin_options' ) )
->getMock();
$sut->method( 'run_gateway_admin_options' )
->will(
$this->returnCallback(
function( $gateway ) use ( &$admin_options_invoked, &$actual_gateway ) {
$admin_options_invoked = true;
$actual_gateway = $gateway;
}
)
);
$sut->output();
$this->assertTrue( $admin_options_invoked );
$this->assertInstanceOf( WC_Gateway_BACS::class, $actual_gateway );
}
/**
* @testDox 'save' will trigger 'init' (and 'process_admin_options' if current section is the name of an existing gateway), and the appropriate actions.
*
* @testWith ["bacs", false]
* ["wc_gateway_bacs", false]
* ["", true]
*
* @param string $section_name The current section name.
* @param bool $expect_to_run_process_admin_options Whether 'admin_options' is expected to be invoked in WC_Payment_Gateways or not.
*/
public function test_save_triggers_appropriate_gateway_methods_and_actions( $section_name, $expect_to_run_process_admin_options ) {
global $current_section;
$current_section = $section_name;
$process_admin_options_invoked = false;
$init_invoked = false;
$gateway = WC_Payment_Gateways::instance()->payment_gateways()['bacs'];
$payment_gateways = $this->getMockBuilder( WC_Payment_Gateways::class )
->setMethods( array( 'process_admin_options', 'init', 'payment_gateways' ) )
->getMock();
$payment_gateways->method( 'process_admin_options' )
->will(
$this->returnCallback(
function() use ( &$process_admin_options_invoked ) {
$process_admin_options_invoked = true;
}
)
);
$payment_gateways->method( 'init' )
->will(
$this->returnCallback(
function() use ( &$init_invoked ) {
$init_invoked = true;
}
)
);
$payment_gateways->method( 'payment_gateways' )
->willReturn( array( $gateway ) );
StaticMockerHack::add_method_mocks(
array(
'WC_Payment_Gateways' => array(
'instance' => function() use ( $payment_gateways ) {
return $payment_gateways;
},
),
)
);
$sut = new WC_Settings_Payment_Gateways();
$sut->save();
$this->assertTrue( $init_invoked );
$this->assertEquals( $expect_to_run_process_admin_options, $process_admin_options_invoked );
$this->assertEquals( '' === $section_name ? 0 : 1, did_action( 'woocommerce_update_options_payment_gateways_bacs' ) );
$this->assertEquals( '' === $section_name ? 0 : 1, did_action( 'woocommerce_update_options_checkout_' . $section_name ) );
}
}