woocommerce/plugins/woocommerce-blocks/tests/php/Domain/Services/CreateAccount.php

<?php

namespace Automattic\WooCommerce\Blocks\Tests\Library;

use Yoast\PHPUnitPolyfills\Polyfills\ExpectException;
use Automattic\WooCommerce\Blocks\Package;
use Automattic\WooCommerce\Blocks\Domain\Package as NewPackage;
use Automattic\WooCommerce\Blocks\Domain\Services\FeatureGating;
use Automattic\WooCommerce\Blocks\Domain\Services\Email\CustomerNewAccount;

use Automattic\WooCommerce\Blocks\Domain\Services\CreateAccount as TestedCreateAccount;

/**
 * Tests CreateAccount service class.
 *
 * Note: this feature is currently feature gated. This test class assumes
 * that woocommerce_blocks_phase===3, i.e. dev build. Tests will fail
 * with other builds (release feature plugin, woo core package).
 * Related: https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/3211
 *
 * @since $VID:$
 */
class CreateAccount extends \WP_UnitTestCase {
	use ExpectException;

	private function get_test_instance() {
		return new TestedCreateAccount( new NewPackage( 'test', './', new FeatureGating( 2 ) ) );
	}

	/**
	 * Generalised routine for setting up test input and store state
	 * and calling from_order_request. Used for all tests.
	 *
	 * Note – this requires (assumes) that there is no logged-in user.
	 *
	 * @return assoc array with keys [ 'user_id', 'order' ] if successful.
	 */
	private function execute_create_customer_from_order( $email, $first_name, $last_name, $options = [] ) {
		/// -- Test-specific setup start.

		$tmp_enable_guest_checkout = get_option( 'woocommerce_enable_guest_checkout' );
		$tmp_can_register = get_option('woocommerce_enable_signup_and_login_from_checkout');
		$enable_guest_checkout = array_key_exists( 'enable_guest_checkout', $options ) ? $options['enable_guest_checkout'] : 'no';
		$can_register = array_key_exists( 'can_register', $options ) ? $options['can_register'] : 'yes';
		update_option( 'woocommerce_enable_guest_checkout', $enable_guest_checkout );
		update_option( 'woocommerce_enable_signup_and_login_from_checkout', $can_register );

		$test_request = new \WP_REST_Request();
		$should_create_account = array_key_exists( 'should_create_account', $options ) ? $options['should_create_account'] : 'no';
		$test_request->set_param( 'should_create_account', $should_create_account );
		$test_request->set_param( 'billing_address', [
			'email'      => $email,
			'first_name' => $first_name,
			'last_name'  => $last_name
		] );

		$test_order = new \WC_Order();

		/// -- End test-specific setup.

		$user_id = $this->get_test_instance()->from_order_request( $test_request );
		$test_order->set_customer_id( $user_id );

		/// -- Undo test-specific setup; restore previous state.
		update_option( 'woocommerce_enable_guest_checkout', $tmp_enable_guest_checkout );
		update_option( 'woocommerce_enable_signup_and_login_from_checkout', $tmp_can_register );

		return [
			'user_id' => $user_id,
			'order' => $test_order,
		];
	}

	/**
	 * Test successful user signup cases.
	 *
	 * @dataProvider create_customer_data
	 */
	public function test_create_customer_from_order( $email, $first_name, $last_name, $options ) {
		$result = $this->execute_create_customer_from_order(
			$email,
			$first_name,
			$last_name,
			$options
		);

		$test_user = $this->factory()->user->get_object_by_id( $result['user_id'] );
		$test_order = $result['order'];

		$this->assertEquals( get_current_user_id(), $result['user_id'] );

		$this->assertEquals( $test_user->first_name, $first_name );
		$this->assertEquals( $test_user->last_name, $last_name );
		$this->assertEquals( $test_user->user_email, $email );
		$this->assertArraySubset( $test_user->roles, [ 'customer' ] );

		$this->assertEquals( $test_order->get_customer_id(), $result['user_id'] );
	}

	public function create_customer_data() {
		return [
			// User requested an account.
			[
				'maryjones@testperson.net',
				'Mary',
				'Jones',
				[
					'should_create_account' => 'yes',
					'enable_guest_checkout' => 'yes',
				],
			],
			// User requested an account + site doesn't allow guest.
			[
				'maryjones@testperson.net',
				'Mary',
				'Jones',
				[
					'should_create_account' => 'yes',
					'enable_guest_checkout' => 'no',
				],
			],
			// User requested an account; name fields are not required.
			[
				'private_person@hotmail.com',
				'',
				'',
				[
					'should_create_account' => 'yes',
					'enable_guest_checkout' => 'yes',
				],
			],
			// Store does not allow guest - signup is required (automatic).
			[
				'henrykissinger@fbi.gov',
				'Henry',
				'Kissinger',
				[
					'should_create_account' => 'no',
					'enable_guest_checkout' => 'no',
				],
			],
		];
	}

	/**
	 * Test exception is thrown if user already signed up.
	 */
	public function test_customer_already_exists() {
		$user_id = $this->factory()->user->create( [
			'user_email' => 'maryjones@testperson.net',
		] );

		$this->expectException( \Exception::class );

		$result = $this->execute_create_customer_from_order(
			'maryjones@testperson.net',
			'Mary',
			'Jones',
			[
				'should_create_account' => 'yes',
				'enable_guest_checkout' => 'yes',
			],
		);
	}

	/**
	 * Test exception is thrown if email is invalid or malformed.
	 *
	 * @dataProvider invalid_email_data
	 */
	public function test_invalid_email( $email ) {
		$this->expectException( \Exception::class );

		$result = $this->execute_create_customer_from_order(
			$email,
			'Mary',
			'Jones',
			[
				'should_create_account' => 'yes',
				'enable_guest_checkout' => 'yes',
			],
		);
	}

	public function invalid_email_data() {
		return [
			[ 'maryjones AT testperson DOT net' ],
			[ 'lean@fast' ],
			[ '' ],
			[ '   ' ],
		];
	}

	/**
	 * Test cases where a user should not be created (no signup should occur).
	 */
	public function test_no_account_created() {
		$site_user_counts = count_users();

		$this->execute_create_customer_from_order(
			'maryjones@testperson.net',
			'Mary',
			'Jones',
			[
				'should_create_account' => 'no',
				'enable_guest_checkout' => 'yes',
			],
		);


		// test with explicitly turning off global registration
		$this->execute_create_customer_from_order(
			'maryjones@testperson.net',
			'Mary',
			'Jones',
			[
				'can_register' => 'no',
				'should_create_account' => 'yes',
				'enable_guest_checkout' => 'yes',
			],
		);

		// test with guest checkout off and global registration off.
		$this->execute_create_customer_from_order(
			'maryjones@testperson.net',
			'Mary',
			'Jones',
			[
				'can_register' => 'no',
				'should_create_account' => 'yes',
				'enable_guest_checkout' => 'no',
			],
		);

		$site_user_counts_after = count_users();

		$this->assertEquals( $site_user_counts['total_users'], $site_user_counts_after['total_users'] );
	}

}