woocommerce/tests/php/includes/settings/class-wc-settings-payment-gateways-test.php

<?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 ) );
	}
}