woocommerce / woocommerce-rest-api

unit-tests/Tests/Version4/Customers.php

<?php
/**
 * Tests for the Customers REST API.
 *
 * @package WooCommerce\Tests\API
 * @since   3.5.0
 */

namespace Automattic\WooCommerce\RestApi\UnitTests\Tests\Version4;

defined( 'ABSPATH' ) || exit;

use \WP_REST_Request;
use \WC_REST_Unit_Test_Case;

The type WC_REST_Unit_Test_Case was not found. Maybe you did not declare it correctly or list all dependencies?

use Automattic\WooCommerce\RestApi\UnitTests\Helpers\CustomerHelper;

/**
 * Tests for the Customers REST API.
 *
 * @package WooCommerce\Tests\API
 * @extends WC_REST_Unit_Test_Case
 */
class Customers extends WC_REST_Unit_Test_Case {

	/**
	 * User variable.
	 *
	 * @var WP_User

The type Automattic\WooCommerce\RestApi\UnitTests\Tests\Version4\WP_User was not found. Did you mean WP_User? If so, make sure to prefix the type with \.

	 */
	protected static $user;

	/**
	 * Setup once before running tests.
	 *
	 * @param object $factory Factory object.
	 */
	public static function wpSetUpBeforeClass( $factory ) {
		self::$user = $factory->user->create(
			array(
				'role' => 'administrator',
			)
		);
	}

	/**
	 * Setup our test server, endpoints, and user info.
	 */
	public function setUp() {
		parent::setUp();
		wp_set_current_user( self::$user );

self::user of type Automattic\WooCommerce\RestApi\UnitTests\Tests\Version4\WP_User is incompatible with the type integer expected by parameter $id of wp_set_current_user().

	}

	/**
	 * Test route registration.
	 *
	 * @since 3.5.0
	 */
	public function test_register_routes() {
		$routes = $this->server->get_routes();

		$this->assertArrayHasKey( '/wc/v4/customers', $routes );
		$this->assertArrayHasKey( '/wc/v4/customers/(?P<id>[\d]+)', $routes );
		$this->assertArrayHasKey( '/wc/v4/customers/batch', $routes );
	}

	/**
	 * Test getting customers.
	 *
	 * @since 3.5.0
	 */
	public function test_get_customers() {
		$customer_1 = CustomerHelper::create_customer();
		CustomerHelper::create_customer( 'test2', 'test2', 'test2@woo.local' );

		$request = new WP_REST_Request( 'GET', '/wc/v4/customers' );
		$request->set_query_params(
			array(
				'orderby' => 'id',
			)
		);
		$response     = $this->server->dispatch( $request );
		$customers    = $response->get_data();
		$date_created = get_date_from_gmt( date( 'Y-m-d H:i:s', strtotime( $customer_1->get_date_created() ) ) );

		$this->assertEquals( 200, $response->get_status() );
		$this->assertEquals( 2, count( $customers ) );

		$this->assertContains(
			array(
				'id'                 => $customer_1->get_id(),
				'date_created'       => wc_rest_prepare_date_response( $date_created, false ),
				'date_created_gmt'   => wc_rest_prepare_date_response( $date_created ),
				'date_modified'      => wc_rest_prepare_date_response( $customer_1->get_date_modified(), false ),
				'date_modified_gmt'  => wc_rest_prepare_date_response( $customer_1->get_date_modified() ),
				'email'              => 'test@woo.local',
				'first_name'         => 'Justin',
				'last_name'          => '',
				'role'               => 'customer',
				'username'           => 'testcustomer',
				'billing'            => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
					'email'      => '',
					'phone'      => '',
				),
				'shipping'           => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
				),
				'is_paying_customer' => false,
				'avatar_url'         => $customer_1->get_avatar_url(),
				'meta_data'          => array(),
				'_links'             => array(
					'self'       => array(
						array(
							'href' => rest_url( '/wc/v4/customers/' . $customer_1->get_id() . '' ),
						),
					),
					'collection' => array(
						array(
							'href' => rest_url( '/wc/v4/customers' ),
						),
					),
				),
			),
			$customers
		);

		update_option( 'timezone_tring', 'America/New York' );
		$customer_3 = CustomerHelper::create_customer( 'timezonetest', 'timezonetest', 'timezonetest@woo.local' );

		$request = new WP_REST_Request( 'GET', '/wc/v4/customers' );
		$request->set_query_params(
			array(
				'orderby' => 'id',
			)
		);
		$response     = $this->server->dispatch( $request );
		$customers    = $response->get_data();
		$date_created = get_date_from_gmt( date( 'Y-m-d H:i:s', strtotime( $customer_3->get_date_created() ) ) );

		$this->assertEquals( 200, $response->get_status() );

		$this->assertContains(
			array(
				'id'                 => $customer_3->get_id(),
				'date_created'       => wc_rest_prepare_date_response( $date_created, false ),
				'date_created_gmt'   => wc_rest_prepare_date_response( $date_created ),
				'date_modified'      => wc_rest_prepare_date_response( $customer_3->get_date_modified(), false ),
				'date_modified_gmt'  => wc_rest_prepare_date_response( $customer_3->get_date_modified() ),
				'email'              => 'timezonetest@woo.local',
				'first_name'         => 'Justin',
				'last_name'          => '',
				'role'               => 'customer',
				'username'           => 'timezonetest',
				'billing'            => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
					'email'      => '',
					'phone'      => '',
				),
				'shipping'           => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
				),
				'is_paying_customer' => false,
				'avatar_url'         => $customer_3->get_avatar_url(),
				'meta_data'          => array(),
				'_links'             => array(
					'self'       => array(
						array(
							'href' => rest_url( '/wc/v4/customers/' . $customer_3->get_id() . '' ),
						),
					),
					'collection' => array(
						array(
							'href' => rest_url( '/wc/v4/customers' ),
						),
					),
				),
			),
			$customers
		);

	}

	/**
	 * Test getting customers without valid permissions.
	 *
	 * @since 3.5.0
	 */
	public function test_get_customers_without_permission() {
		wp_set_current_user( 0 );
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers' ) );
		$this->assertEquals( 401, $response->get_status() );
	}

	/**
	 * Test creating a new customer.
	 *
	 * @since 3.5.0
	 */
	public function test_create_customer() {
		// Test just the basics first..
		$request = new WP_REST_Request( 'POST', '/wc/v4/customers' );
		$request->set_body_params(
			array(
				'username' => 'create_customer_test',
				'password' => 'test123',
				'email'    => 'create_customer_test@woo.local',
			)
		);
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 201, $response->get_status() );
		$this->assertEquals(
			array(
				'id'                 => $data['id'],
				'date_created'       => $data['date_created'],
				'date_created_gmt'   => $data['date_created_gmt'],
				'date_modified'      => $data['date_modified'],
				'date_modified_gmt'  => $data['date_modified_gmt'],
				'email'              => 'create_customer_test@woo.local',
				'first_name'         => '',
				'last_name'          => '',
				'role'               => 'customer',
				'username'           => 'create_customer_test',
				'billing'            => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '',
					'address_2'  => '',
					'city'       => '',
					'state'      => '',
					'postcode'   => '',
					'country'    => '',
					'email'      => '',
					'phone'      => '',
				),
				'shipping'           => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '',
					'address_2'  => '',
					'city'       => '',
					'state'      => '',
					'postcode'   => '',
					'country'    => '',
				),
				'is_paying_customer' => false,
				'meta_data'          => array(),
				'avatar_url'         => $data['avatar_url'],
			),
			$data
		);

		// Test extra data.
		$request = new WP_REST_Request( 'POST', '/wc/v4/customers' );
		$request->set_body_params(
			array(
				'username'   => 'create_customer_test2',
				'password'   => 'test123',
				'email'      => 'create_customer_test2@woo.local',
				'first_name' => 'Test',
				'last_name'  => 'McTestFace',
				'billing'    => array(
					'country' => 'US',
					'state'   => 'WA',
				),
				'shipping'   => array(
					'state'   => 'CA',
					'country' => 'US',
				),
			)
		);
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 201, $response->get_status() );
		$this->assertEquals(
			array(
				'id'                 => $data['id'],
				'date_created'       => $data['date_created'],
				'date_created_gmt'   => $data['date_created_gmt'],
				'date_modified'      => $data['date_modified'],
				'date_modified_gmt'  => $data['date_modified_gmt'],
				'email'              => 'create_customer_test2@woo.local',
				'first_name'         => 'Test',
				'last_name'          => 'McTestFace',
				'role'               => 'customer',
				'username'           => 'create_customer_test2',
				'billing'            => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '',
					'address_2'  => '',
					'city'       => '',
					'state'      => 'WA',
					'postcode'   => '',
					'country'    => 'US',
					'email'      => '',
					'phone'      => '',
				),
				'shipping'           => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '',
					'address_2'  => '',
					'city'       => '',
					'state'      => 'CA',
					'postcode'   => '',
					'country'    => 'US',
				),
				'is_paying_customer' => false,
				'meta_data'          => array(),
				'avatar_url'         => $data['avatar_url'],
			),
			$data
		);

		// Test without required field.
		$request = new WP_REST_Request( 'POST', '/wc/v4/customers' );
		$request->set_body_params(
			array(
				'username'   => 'create_customer_test3',
				'first_name' => 'Test',
				'last_name'  => 'McTestFace',
			)
		);
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 400, $response->get_status() );
	}

	/**
	 * Test creating customers without valid permissions.
	 *
	 * @since 3.5.0
	 */
	public function test_create_customer_without_permission() {
		wp_set_current_user( 0 );
		$request = new WP_REST_Request( 'POST', '/wc/v4/customers' );
		$request->set_body_params(
			array(
				'username' => 'create_customer_test_without_permission',
				'password' => 'test123',
				'email'    => 'create_customer_test_without_permission@woo.local',
			)
		);
		$response = $this->server->dispatch( $request );
		$this->assertEquals( 401, $response->get_status() );
	}

	/**
	 * Test getting a single customer.
	 *
	 * @since 3.5.0
	 */
	public function test_get_customer() {
		$customer = CustomerHelper::create_customer( 'get_customer_test', 'test123', 'get_customer_test@woo.local' );
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/' . $customer->get_id() ) );
		$data     = $response->get_data();

		$this->assertEquals(
			array(
				'id'                 => $data['id'],
				'date_created'       => $data['date_created'],
				'date_created_gmt'   => $data['date_created_gmt'],
				'date_modified'      => $data['date_modified'],
				'date_modified_gmt'  => $data['date_modified_gmt'],
				'email'              => 'get_customer_test@woo.local',
				'first_name'         => 'Justin',
				'billing'            => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
					'email'      => '',
					'phone'      => '',
				),
				'shipping'           => array(
					'first_name' => '',
					'last_name'  => '',
					'company'    => '',
					'address_1'  => '123 South Street',
					'address_2'  => 'Apt 1',
					'city'       => 'Philadelphia',
					'state'      => 'PA',
					'postcode'   => '19123',
					'country'    => 'US',
				),
				'is_paying_customer' => false,
				'meta_data'          => array(),
				'last_name'          => '',
				'role'               => 'customer',
				'username'           => 'get_customer_test',
				'avatar_url'         => $data['avatar_url'],
			),
			$data
		);
	}

	/**
	 * Test getting a single customer without valid permissions.
	 *
	 * @since 3.5.0
	 */
	public function test_get_customer_without_permission() {
		wp_set_current_user( 0 );
		$customer = CustomerHelper::create_customer( 'get_customer_test_without_permission', 'test123', 'get_customer_test_without_permission@woo.local' );
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/' . $customer->get_id() ) );
		$this->assertEquals( 401, $response->get_status() );
	}

	/**
	 * Test getting a single customer with an invalid ID.
	 *
	 * @since 3.5.0
	 */
	public function test_get_customer_invalid_id() {
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/0' ) );
		$this->assertEquals( 404, $response->get_status() );
	}

	/**
	 * Test updating a customer.
	 *
	 * @since 3.5.0
	 */
	public function test_update_customer() {
		$customer = CustomerHelper::create_customer( 'update_customer_test', 'test123', 'update_customer_test@woo.local' );

		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/' . $customer->get_id() ) );
		$data     = $response->get_data();
		$this->assertEquals( 'update_customer_test', $data['username'] );
		$this->assertEquals( 'update_customer_test@woo.local', $data['email'] );

		$request = new WP_REST_Request( 'PUT', '/wc/v4/customers/' . $customer->get_id() );
		$request->set_body_params(
			array(
				'email'      => 'updated_email@woo.local',
				'first_name' => 'UpdatedTest',
			)
		);
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 'updated_email@woo.local', $data['email'] );
		$this->assertEquals( 'UpdatedTest', $data['first_name'] );
	}

	/**
	 * Test updating a customer without valid permissions.
	 *
	 * @since 3.5.0
	 */
	public function test_update_customer_without_permission() {
		wp_set_current_user( 0 );
		$customer = CustomerHelper::create_customer( 'update_customer_test_without_permission', 'test123', 'update_customer_test_without_permission@woo.local' );
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/' . $customer->get_id() ) );
		$this->assertEquals( 401, $response->get_status() );
	}

	/**
	 * Test updating a customer with an invalid ID.
	 *
	 * @since 3.5.0
	 */
	public function test_update_customer_invalid_id() {
		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v4/customers/0' ) );
		$this->assertEquals( 404, $response->get_status() );
	}


	/**
	 * Test deleting a customer.
	 *
	 * @since 3.5.0
	 */
	public function test_delete_customer() {
		$customer = CustomerHelper::create_customer( 'delete_customer_test', 'test123', 'delete_customer_test@woo.local' );
		$request  = new WP_REST_Request( 'DELETE', '/wc/v4/customers/' . $customer->get_id() );
		$request->set_param( 'force', true );
		$response = $this->server->dispatch( $request );
		$this->assertEquals( 200, $response->get_status() );
	}

	/**
	 * Test deleting a customer with an invalid ID.
	 *
	 * @since 3.5.0
	 */
	public function test_delete_customer_invalid_id() {
		$request = new WP_REST_Request( 'DELETE', '/wc/v4/customers/0' );
		$request->set_param( 'force', true );
		$response = $this->server->dispatch( $request );
		$this->assertEquals( 404, $response->get_status() );
	}

	/**
	 * Test deleting a customer without valid permissions.
	 *
	 * @since 3.5.0
	 */
	public function test_delete_customer_without_permission() {
		wp_set_current_user( 0 );
		$customer = CustomerHelper::create_customer( 'delete_customer_test_without_permission', 'test123', 'delete_customer_test_without_permission@woo.local' );
		$request  = new WP_REST_Request( 'DELETE', '/wc/v4/customers/' . $customer->get_id() );
		$request->set_param( 'force', true );
		$response = $this->server->dispatch( $request );
		$this->assertEquals( 401, $response->get_status() );
	}

	/**
	 * Test customer batch endpoint.
	 *
	 * @since 3.5.0
	 */
	public function test_batch_customer() {
		$customer_1 = CustomerHelper::create_customer( 'test_batch_customer', 'test123', 'test_batch_customer@woo.local' );
		$customer_2 = CustomerHelper::create_customer( 'test_batch_customer2', 'test123', 'test_batch_customer2@woo.local' );
		$customer_3 = CustomerHelper::create_customer( 'test_batch_customer3', 'test123', 'test_batch_customer3@woo.local' );
		$customer_4 = CustomerHelper::create_customer( 'test_batch_customer4', 'test123', 'test_batch_customer4@woo.local' );

		$request = new WP_REST_Request( 'POST', '/wc/v4/customers/batch' );
		$request->set_body_params(
			array(
				'update' => array(
					array(
						'id'        => $customer_1->get_id(),
						'last_name' => 'McTest',
					),
				),
				'delete' => array(
					$customer_2->get_id(),
					$customer_3->get_id(),
				),
				'create' => array(
					array(
						'username' => 'newuser',
						'password' => 'test123',
						'email'    => 'newuser@woo.local',
					),
				),
			)
		);
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 'McTest', $data['update'][0]['last_name'] );
		$this->assertEquals( 'newuser', $data['create'][0]['username'] );
		$this->assertEmpty( $data['create'][0]['last_name'] );
		$this->assertEquals( $customer_2->get_id(), $data['delete'][0]['id'] );
		$this->assertEquals( $customer_3->get_id(), $data['delete'][1]['id'] );

		$request  = new WP_REST_Request( 'GET', '/wc/v4/customers' );
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertEquals( 3, count( $data ) );
	}

	/**
	 * Test customer schema.
	 *
	 * @since 3.5.0
	 */
	public function test_customer_schema() {
		$request    = new WP_REST_Request( 'OPTIONS', '/wc/v4/customers' );
		$response   = $this->server->dispatch( $request );
		$data       = $response->get_data();
		$properties = $data['schema']['properties'];

		$this->assertEquals( 16, count( $properties ) );
		$this->assertArrayHasKey( 'id', $properties );
		$this->assertArrayHasKey( 'date_created', $properties );
		$this->assertArrayHasKey( 'date_created_gmt', $properties );
		$this->assertArrayHasKey( 'date_modified', $properties );
		$this->assertArrayHasKey( 'date_modified_gmt', $properties );
		$this->assertArrayHasKey( 'email', $properties );
		$this->assertArrayHasKey( 'first_name', $properties );
		$this->assertArrayHasKey( 'last_name', $properties );
		$this->assertArrayHasKey( 'role', $properties );
		$this->assertArrayHasKey( 'username', $properties );
		$this->assertArrayHasKey( 'password', $properties );
		$this->assertArrayHasKey( 'avatar_url', $properties );
		$this->assertArrayHasKey( 'billing', $properties );
		$this->assertArrayHasKey( 'first_name', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'last_name', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'company', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'address_1', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'address_2', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'city', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'state', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'postcode', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'country', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'email', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'phone', $properties['billing']['properties'] );
		$this->assertArrayHasKey( 'shipping', $properties );
		$this->assertArrayHasKey( 'first_name', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'last_name', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'company', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'address_1', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'address_2', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'city', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'state', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'postcode', $properties['shipping']['properties'] );
		$this->assertArrayHasKey( 'country', $properties['shipping']['properties'] );
	}
}