/reports/reviews/totals unit tests

tests/unit-tests/api/reports-reviews-totals.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Tests for the reports reviews totals REST API.
+ *
+ * @package WooCommerce\Tests\API
+ * @since 3.5.0
+ */
+
+class WC_Tests_API_Reports_Reviews_Totals extends WC_REST_Unit_Test_Case {
+
+	/**
+	 * Setup our test server, endpoints, and user info.
+	 */
+	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( '/wc/v3/reports/reviews/totals', $routes );
+	}
+
+	/**
+	 * Test getting all product reviews.
+	 *
+	 * @since 3.5.0
+	 */
+	public function test_get_reports() {
+		global $wpdb;
+		wp_set_current_user( $this->user );
+
+		$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v3/reports/reviews/totals' ) );
+		$report   = $response->get_data();
+		$data     = array();
+
+		$query_data = array(
+			'count'      => true,
+			'post_type'  => 'product',
+			'meta_key'   => 'rating', // WPCS: slow query ok.
+			'meta_value' => '', // WPCS: slow query ok.
+		);
+
+		for ( $i = 1; $i <= 5; $i++ ) {
+			$query_data['meta_value'] = $i;
+
+			$data[] = array(
+				'slug'  => 'rated_' . $i . '_out_of_5',
+				/* translators: %s: average rating */
+				'name'  => sprintf( __( 'Rated %s out of 5', 'woocommerce' ), $i ),
+				'total' => (int) get_comments( $query_data ),
+			);
+		}
+
+		$this->assertEquals( 200, $response->get_status() );
+		$this->assertEquals( count( $data ), count( $report ) );
+		$this->assertEquals( $data, $report );
+	}
+
+	/**
+	 * Tests to make sure product reviews cannot be viewed 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', '/wc/v3/reports/reviews/totals' ) );
+		$this->assertEquals( 401, $response->get_status() );
+	}
+
+	/**
+	 * Test the product review schema.
+	 *
+	 * @since 3.5.0
+	 */
+	public function test_product_review_schema() {
+		wp_set_current_user( $this->user );
+		$product    = WC_Helper_Product::create_simple_product();
+		$request    = new WP_REST_Request( 'OPTIONS', '/wc/v3/reports/reviews/totals' );
+		$response   = $this->server->dispatch( $request );
+		$data       = $response->get_data();
+		$properties = $data['schema']['properties'];
+
+		$this->assertEquals( 3, count( $properties ) );
+		$this->assertArrayHasKey( 'slug', $properties );
+		$this->assertArrayHasKey( 'name', $properties );
+		$this->assertArrayHasKey( 'total', $properties );
+	}
+}