woocommerce/tests/unit-tests/discounts/discounts.php

<?php

/**
 * Test for the discounts class.
 * @package WooCommerce\Tests\Discounts
 */
class WC_Tests_Discounts extends WC_Unit_Test_Case {

	protected function get_items_for_discounts_class() {
		$items     = array();
		$precision = pow( 10, wc_get_price_decimals() );
		foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
			$item                          = (object) array(
				'key'                => '',
				'quantity'           => 0,
				'price'              => 0,
				'product'            => false,
				'price_includes_tax' => wc_prices_include_tax(),
				'subtotal'           => 0,
				'subtotal_tax'       => 0,
				'subtotal_taxes'     => array(),
				'total'              => 0,
				'total_tax'          => 0,
				'taxes'              => array(),
				'discounted_price'   => 0,
			);
			$item->object            = $cart_item;
			$item->quantity          = $cart_item['quantity'];
			$item->subtotal          = $cart_item['data']->get_price() * $precision * $cart_item['quantity'];
			$item->product           = $cart_item['data'];
			$item->tax_rates         = WC_Tax::get_rates( $item->product->get_tax_class() );
			$items[ $cart_item_key ] = $item;
		}
		return $items;
	}

	/**
	 * Test get and set items.
	 */
	public function test_get_set_items() {
		// Create dummy product - price will be 10
		$product = WC_Helper_Product::create_simple_product();

		// Add product to the cart.
		WC()->cart->add_to_cart( $product->get_id(), 1 );

		// Add product to a dummy order.
		$order = new WC_Order();
		$order->add_product( $product, 1 );
		$order->calculate_totals();
		$order->save();

		// Test setting items to the cart.
		$discounts = new WC_Discounts();
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$this->assertEquals( 1, count( $discounts->get_items() ) );

		// Test setting items to an order.
		$discounts = new WC_Discounts();
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$this->assertEquals( 1, count( $discounts->get_items() ) );

		// Empty array of items.
		$discounts = new WC_Discounts();
		$discounts->set_items( array() );
		$this->assertEquals( array(), $discounts->get_items() );

		// Invalid items.
		$discounts = new WC_Discounts();
		$discounts->set_items( false );
		$this->assertEquals( array(), $discounts->get_items() );

		// Cleanup.
		WC()->cart->empty_cart();
		$product->delete( true );
		$order->delete( true );
	}

	/**
	 * test get_applied_coupons
	 */
	public function test_get_applied_coupons() {
		$discounts = new WC_Discounts();
		$product   = WC_Helper_Product::create_simple_product();
		WC()->cart->add_to_cart( $product->get_id(), 1 );
		$discounts->set_items( $this->get_items_for_discounts_class() );

		// Test applying multiple coupons and getting totals.
		$coupon = WC_Helper_Coupon::create_coupon( 'test' );
		$coupon->set_amount( 50 );
		$coupon->set_discount_type( 'percent' );
		$coupon->save();
		$discounts->apply_coupon( $coupon );

		$this->assertEquals( array( 'test' => array( 'discount' => 5, 'discount_tax' => 0 ) ), $discounts->get_applied_coupons() );

		$coupon2 = WC_Helper_Coupon::create_coupon( 'test2' );
		$coupon2->set_code( 'test2' );
		$coupon2->set_amount( 50 );
		$coupon2->set_discount_type( 'percent' );
		$coupon->save();
		$discounts->apply_coupon( $coupon2 );

		$this->assertEquals( array( 'test' => array( 'discount' => 5, 'discount_tax' => 0 ), 'test2' => array( 'discount' => 2.50, 'discount_tax' => 0 ) ), $discounts->get_applied_coupons() );

		$discounts->apply_coupon( $coupon );
		$this->assertEquals( array( 'test' => array( 'discount' => 6.25, 'discount_tax' => 0 ), 'test2' => array( 'discount' => 2.50, 'discount_tax' => 0 ) ), $discounts->get_applied_coupons() );

		// Test different coupon types.
		WC()->cart->empty_cart();
		WC()->cart->add_to_cart( $product->get_id(), 2 );
		$coupon->set_discount_type( 'fixed_product' );
		$coupon->set_amount( 2 );
		$coupon->save();
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$discounts->apply_coupon( $coupon );
		$this->assertEquals( array( 'test' => array( 'discount' => 4, 'discount_tax' => 0 ) ), $discounts->get_applied_coupons() );

		$coupon->set_discount_type( 'fixed_cart' );
		$coupon->save();
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$discounts->apply_coupon( $coupon );
		$this->assertEquals( array( 'test' => array( 'discount' => 2, 'discount_tax' => 0 ) ), $discounts->get_applied_coupons() );

		// Cleanup.
		WC()->cart->empty_cart();
		$product->delete( true );
		$coupon->delete( true );
		$coupon2->delete( true );
	}

	/**
	 * Test applying a coupon (make sure it changes prices).
	 */
	public function test_apply_coupon() {
		$discounts = new WC_Discounts();

		// Create dummy content.
		$product = WC_Helper_Product::create_simple_product();
		$product->set_tax_status( 'taxable' );
		$product->save();
		WC()->cart->empty_cart();
		WC()->cart->add_to_cart( $product->get_id(), 1 );
		$coupon = WC_Helper_Coupon::create_coupon( 'test' );
		$coupon->set_amount( 10 );

		// Apply a percent discount.
		$coupon->set_discount_type( 'percent' );
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$discounts->apply_coupon( $coupon );
		$this->assertEquals( 9, $discounts->get_discounted_price( current( $discounts->get_items() ) ) );

		// Apply a fixed cart coupon.
		$coupon->set_discount_type( 'fixed_cart' );
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$discounts->apply_coupon( $coupon );
		$this->assertEquals( 0, $discounts->get_discounted_price( current( $discounts->get_items() ) ) );

		// Apply a fixed product coupon.
		$coupon->set_discount_type( 'fixed_product' );
		$discounts->set_items( $this->get_items_for_discounts_class() );
		$discounts->apply_coupon( $coupon );
		$this->assertEquals( 0, $discounts->get_discounted_price( current( $discounts->get_items() ) ) );

		// Cleanup.
		WC()->cart->empty_cart();
		$product->delete( true );
		$coupon->delete( true );
	}

	/**
	 * Test various discount calculations are working correctly and produding expected results.
	 */
	public function test_calculations() {
		$tax_rate = array(
			'tax_rate_country'  => '',
			'tax_rate_state'    => '',
			'tax_rate'          => '20.0000',
			'tax_rate_name'     => 'VAT',
			'tax_rate_priority' => '1',
			'tax_rate_compound' => '0',
			'tax_rate_shipping' => '1',
			'tax_rate_order'    => '1',
			'tax_rate_class'    => '',
		);
		$tax_rate_id = WC_Tax::_insert_tax_rate( $tax_rate );
		update_option( 'woocommerce_calc_taxes', 'yes' );

		$tests = array(
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 1,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'percent',
						'amount'        => '20',
					),
				),
				'expected_total_discount' => 2,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 2,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '10',
					),
				),
				'expected_total_discount' => 10,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '10',
					),
				),
				'expected_total_discount' => 10,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '10',
					),
				),
				'expected_total_discount' => 10,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 2,
					),
					array(
						'price' => 10,
						'qty'   => 3,
					),
					array(
						'price' => 10,
						'qty'   => 2,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '10',
					),
				),
				'expected_total_discount' => 10,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
					array(
						'price' => 10,
						'qty'   => 1,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '10',
					),
				),
				'expected_total_discount' => 10,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 1,
						'qty'   => 1,
					),
					array(
						'price' => 1,
						'qty'   => 1,
					),
					array(
						'price' => 1,
						'qty'   => 1,
					),
				),
				'coupons' => array(
					array(
						'code'          => 'test',
						'discount_type' => 'fixed_cart',
						'amount'        => '1',
					),
				),
				'expected_total_discount' => 1,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 2,
					),
				),
				'coupons' => array(
					array(
						'code'                   => 'test',
						'discount_type'          => 'percent',
						'amount'                 => '10',
						'limit_usage_to_x_items' => 1,
					),
				),
				'expected_total_discount' => 1,
			),
			array(
				'prices_include_tax' => false,
				'cart' => array(
					array(
						'price' => 10,
						'qty'   => 2,
					),
					array(
						'price' => 10,
						'qty'   => 2,
					),
				),
				'coupons' => array(
					array(
						'code'                   => 'test',
						'discount_type'          => 'percent',
						'amount'                 => '10',
						'limit_usage_to_x_items' => 1,
					),
				),
				'expected_total_discount' => 1,
			),
		);

		$coupon = WC_Helper_Coupon::create_coupon( 'test' );

		foreach ( $tests as $test_index => $test ) {
			$discounts = new WC_Discounts();
			$products  = array();

			foreach ( $test['cart'] as $item ) {
				$product = WC_Helper_Product::create_simple_product();
				$product->set_regular_price( $item['price'] );
				$product->set_tax_status( 'taxable' );
				$product->save();
				WC()->cart->add_to_cart( $product->get_id(), $item['qty'] );
				$products[] = $product;
			}

			$discounts->set_items( $this->get_items_for_discounts_class() );

			foreach ( $test['coupons'] as $coupon_props ) {
				$coupon->set_props( $coupon_props );
				$discounts->apply_coupon( $coupon );
			}

			$this->assertEquals( $test['expected_total_discount'], array_sum( $discounts->get_discounts() ), 'Test case ' . $test_index . ' failed (' . print_r( $test, true ) . ' - ' . print_r( $discounts->get_discounts(), true ) . ')' );

			// Clean.
			WC()->cart->empty_cart();

			foreach ( $products as $product ) {
				$product->delete( true );
			}
		}

		WC_Tax::_delete_tax_rate( $tax_rate_id );
		update_option( 'woocommerce_calc_taxes', 'no' );
		$coupon->delete( true );
	}

	/**
	 * Test apply_discount method.
	 */
	public function test_apply_discount() {
		$tax_rate = array(
			'tax_rate_country'  => '',
			'tax_rate_state'    => '',
			'tax_rate'          => '20.0000',
			'tax_rate_name'     => 'VAT',
			'tax_rate_priority' => '1',
			'tax_rate_compound' => '0',
			'tax_rate_shipping' => '1',
			'tax_rate_order'    => '1',
			'tax_rate_class'    => '',
		);
		$tax_rate2 = array(
			'tax_rate_country'  => '',
			'tax_rate_state'    => '',
			'tax_rate'          => '20.0000',
			'tax_rate_name'     => 'VAT',
			'tax_rate_priority' => '1',
			'tax_rate_compound' => '0',
			'tax_rate_shipping' => '1',
			'tax_rate_order'    => '1',
			'tax_rate_class'    => 'reduced-rate',
		);
		$tax_rate_id  = WC_Tax::_insert_tax_rate( $tax_rate );
		$tax_rate_id2 = WC_Tax::_insert_tax_rate( $tax_rate2 );
		update_option( 'woocommerce_calc_taxes', 'yes' );

		$product  = WC_Helper_Product::create_simple_product();
		$product2 = WC_Helper_Product::create_simple_product();

		$product->set_tax_class( '' );
		$product2->set_tax_class( 'reduced-rate' );

		$product->save();
		$product2->save();

		// Add product to the cart.
		WC()->cart->add_to_cart( $product->get_id(), 1 );
		WC()->cart->add_to_cart( $product2->get_id(), 1 );

		$discounts = new WC_Discounts();
		$discounts->set_items( $this->get_items_for_discounts_class() );

		$discounts->apply_discount( '50%' );
		$all_discounts = $discounts->get_discounts();
		$this->assertEquals( 10, $all_discounts['discount-50%'] );

		$discounts->apply_discount( '50%' );
		$all_discounts = $discounts->get_discounts();
		$this->assertEquals( 10, $all_discounts['discount-50%'], print_r( $all_discounts, true ) );
		$this->assertEquals( 5, $all_discounts['discount-50%-2'], print_r( $all_discounts, true ) );

		// Test fixed discounts.
		$discounts = new WC_Discounts();
		$discounts->set_items( $this->get_items_for_discounts_class() );

		$discounts->apply_discount( '5' );
		$all_discounts = $discounts->get_discounts();
		$this->assertEquals( 5, $all_discounts['discount-5'] );

		$discounts->apply_discount( '5' );
		$all_discounts = $discounts->get_discounts();
		$this->assertEquals( 5, $all_discounts['discount-5'], print_r( $all_discounts, true ) );
		$this->assertEquals( 5, $all_discounts['discount-5-2'], print_r( $all_discounts, true ) );

		$discounts->apply_discount( '15' );
		$all_discounts = $discounts->get_discounts();
		$this->assertEquals( 5, $all_discounts['discount-5'], print_r( $all_discounts, true ) );
		$this->assertEquals( 5, $all_discounts['discount-5-2'], print_r( $all_discounts, true ) );
		$this->assertEquals( 10, $all_discounts['discount-15'], print_r( $all_discounts, true ) );

		// Cleanup.
		WC()->cart->empty_cart();
		$product->delete( true );
		$product2->delete( true );
		WC_Tax::_delete_tax_rate( $tax_rate_id );
		WC_Tax::_delete_tax_rate( $tax_rate_id2 );
		update_option( 'woocommerce_calc_taxes', 'no' );
	}
}