woocommerce/plugins/woocommerce-admin/tests/api/reports-customers-stats.php

<?php
/**
 * Reports Customers Stats REST API Test
 *
 * @package WooCommerce\Tests\API
 * @since 3.5.0
 */

/**
 * Reports Customers Stats REST API Test Class
 *
 * @package WooCommerce\Tests\API
 * @since 3.5.0
 */
class WC_Tests_API_Reports_Customers_Stats extends WC_REST_Unit_Test_Case {
	/**
	 * Endpoint.
	 *
	 * @var string
	 */
	protected $endpoint = '/wc/v4/reports/customers/stats';

	/**
	 * Setup test reports products data.
	 *
	 * @since 3.5.0
	 */
	public function setUp() {
		parent::setUp();

		$this->user = $this->factory->user->create(
			array(
				'role' => 'administrator',
			)
		);
	}

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

		$this->assertArrayHasKey( $this->endpoint, $routes );
	}

	/**
	 * Test reports schema.
	 *
	 * @since 3.5.0
	 */
	public function test_reports_schema() {
		wp_set_current_user( $this->user );

		$request    = new WP_REST_Request( 'OPTIONS', $this->endpoint );
		$response   = $this->server->dispatch( $request );
		$data       = $response->get_data();
		$properties = $data['schema']['properties'];

		$this->assertCount( 2, $properties );
		$this->assertArrayHasKey( 'totals', $properties );
		$this->assertArrayHasKey( 'intervals', $properties );
		$this->assertCount( 4, $properties['totals']['properties'] );
		$this->assertArrayHasKey( 'customers_count', $properties['totals']['properties'] );
		$this->assertArrayHasKey( 'avg_orders_count', $properties['totals']['properties'] );
		$this->assertArrayHasKey( 'avg_total_spend', $properties['totals']['properties'] );
		$this->assertArrayHasKey( 'avg_avg_order_value', $properties['totals']['properties'] );
	}

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

	/**
	 * Test getting reports.
	 *
	 * @since 3.5.0
	 */
	public function test_get_reports() {
		wp_set_current_user( $this->user );
		WC_Helper_Reports::reset_stats_dbs();

		$test_customers = array();

		// Create 10 test customers.
		for ( $i = 1; $i <= 10; $i++ ) {
			$test_customers[] = WC_Helper_Customer::create_customer( "customer{$i}", 'password', "customer{$i}@example.com" );
		}
		// One differing name.
		$test_customers[2]->set_first_name( 'Jeff' );
		$test_customers[2]->save();

		// Create a test product for use in an order.
		$product = new WC_Product_Simple();
		$product->set_name( 'Test Product' );
		$product->set_regular_price( 25 );
		$product->save();

		// Place some test orders.
		$order = WC_Helper_Order::create_order( $test_customers[0]->get_id(), $product );
		$order->set_status( 'completed' );
		$order->set_total( 100 );
		$order->save();

		$order = WC_Helper_Order::create_order( $test_customers[0]->get_id(), $product );
		$order->set_status( 'completed' );
		$order->set_total( 234 );
		$order->save();

		$order = WC_Helper_Order::create_order( $test_customers[1]->get_id(), $product );
		$order->set_status( 'completed' );
		$order->set_total( 55 );
		$order->save();

		$order = WC_Helper_Order::create_order( $test_customers[2]->get_id(), $product );
		$order->set_status( 'completed' );
		$order->set_total( 9.12 );
		$order->save();

		$request  = new WP_REST_Request( 'GET', $this->endpoint );
		$response = $this->server->dispatch( $request );
		$reports  = $response->get_data();
		$headers  = $response->get_headers();

		$this->assertEquals( 200, $response->get_status() );
		$this->assertEquals( 10, $reports['totals']->customers_count );
		$this->assertEquals( 1.333, round( $reports['totals']->avg_orders_count, 3 ) );
		$this->assertEquals( 132.707, round( $reports['totals']->avg_total_spend, 3 ) );
		$this->assertEquals( 77.04, $reports['totals']->avg_avg_order_value );

		// Test name parameter (case with no matches).
		$request->set_query_params(
			array(
				'name' => 'Nota Customername',
			)
		);
		$response = $this->server->dispatch( $request );
		$reports  = $response->get_data();

		$this->assertEquals( 200, $response->get_status() );
		$this->assertEquals( 0, $reports['totals']->customers_count );
		$this->assertEquals( 0, $reports['totals']->avg_orders_count );
		$this->assertEquals( 0, $reports['totals']->avg_total_spend );
		$this->assertEquals( 0, $reports['totals']->avg_avg_order_value );

		// Test name and last_order parameters.
		$request->set_query_params(
			array(
				'name'             => 'Jeff',
				'last_order_after' => date( 'Y-m-d' ) . 'T00:00:00Z',
			)
		);
		$response = $this->server->dispatch( $request );
		$reports  = $response->get_data();

		$this->assertEquals( 200, $response->get_status() );
		$this->assertEquals( 1, $reports['totals']->customers_count );
		$this->assertEquals( 1, $reports['totals']->avg_orders_count );
		$this->assertEquals( 9.12, $reports['totals']->avg_total_spend );
		$this->assertEquals( 9.12, $reports['totals']->avg_avg_order_value );
	}
}