woocommerce/tests/legacy/unit-tests/webhooks/functions.php

303 lines
10 KiB
PHP

<?php
/**
* Unit tests for Webhook functions.
* @package WooCommerce\Tests\Webhook
*/
/**
* Class Functions.
* @package WooCommerce\Tests\Webhook
* @since 2.3
*/
class WC_Tests_Webhook_Functions extends WC_Unit_Test_Case {
/**
* Temporarily store webhook delivery counters.
* @var array
*/
protected $delivery_counter = array();
/**
* Data provider for test_wc_is_webhook_valid_topic.
*
* @since 3.2.0
*/
public function data_provider_test_wc_is_webhook_valid_topic() {
return array(
array( true, wc_is_webhook_valid_topic( 'action.woocommerce_add_to_cart' ) ),
array( true, wc_is_webhook_valid_topic( 'action.wc_add_to_cart' ) ),
array( true, wc_is_webhook_valid_topic( 'product.created' ) ),
array( true, wc_is_webhook_valid_topic( 'product.updated' ) ),
array( true, wc_is_webhook_valid_topic( 'product.deleted' ) ),
array( true, wc_is_webhook_valid_topic( 'product.restored' ) ),
array( true, wc_is_webhook_valid_topic( 'order.created' ) ),
array( true, wc_is_webhook_valid_topic( 'order.updated' ) ),
array( true, wc_is_webhook_valid_topic( 'order.deleted' ) ),
array( true, wc_is_webhook_valid_topic( 'order.restored' ) ),
array( true, wc_is_webhook_valid_topic( 'customer.created' ) ),
array( true, wc_is_webhook_valid_topic( 'customer.updated' ) ),
array( true, wc_is_webhook_valid_topic( 'customer.deleted' ) ),
array( true, wc_is_webhook_valid_topic( 'coupon.created' ) ),
array( true, wc_is_webhook_valid_topic( 'coupon.updated' ) ),
array( true, wc_is_webhook_valid_topic( 'coupon.deleted' ) ),
array( true, wc_is_webhook_valid_topic( 'coupon.restored' ) ),
array( false, wc_is_webhook_valid_topic( 'coupon.upgraded' ) ),
array( false, wc_is_webhook_valid_topic( 'wc.product.updated' ) ),
array( false, wc_is_webhook_valid_topic( 'missingdot' ) ),
array( false, wc_is_webhook_valid_topic( 'with space' ) ),
array( false, wc_is_webhook_valid_topic( 'action.woocommerce_login_credentials' ) ),
);
}
/**
* Test wc_is_webhook_valid_topic().
*
* @dataProvider data_provider_test_wc_is_webhook_valid_topic
* @since 3.2.0
* @param bool $assert Expected value.
* @param array $values Values to test.
*/
public function test_wc_is_webhook_valid_topic( $assert, $values ) {
$this->assertEquals( $assert, $values );
}
/**
* Data provider for test_wc_is_webhook_valid_status.
*
* @since 3.5.3
*/
public function data_provider_test_wc_is_webhook_valid_status() {
return array(
array( true, wc_is_webhook_valid_status( 'active' ) ),
array( true, wc_is_webhook_valid_status( 'paused' ) ),
array( true, wc_is_webhook_valid_status( 'disabled' ) ),
array( false, wc_is_webhook_valid_status( 'pending' ) ),
);
}
/**
* Test wc_is_webhook_valid_status
*
* @dataProvider data_provider_test_wc_is_webhook_valid_status
* @since 3.5.3
* @param bool $assert Expected outcome.
* @param array $values Values to test.
* @return void
*/
public function test_wc_is_webhook_valid_status( $assert, $values ) {
$this->assertEquals( $assert, $values );
}
/**
* Test wc_get_webhook_statuses().
*
* @since 3.2.0
*/
public function test_wc_get_webhook_statuses() {
$expected = array(
'active' => 'Active',
'paused' => 'Paused',
'disabled' => 'Disabled',
);
$this->assertEquals( $expected, wc_get_webhook_statuses() );
}
/**
* Test wc_load_webhooks().
*
* @since 3.2.0
*/
public function test_wc_load_webhooks() {
$webhook = $this->create_webhook();
$this->assertTrue( wc_load_webhooks() );
$webhook->delete( true );
$this->assertFalse( wc_load_webhooks() );
}
/**
* Provide webhook statuses for tests.
*
* @since 3.5.0
*/
public function provider_webhook_statuses() {
$webhook_statuses = array();
foreach ( wc_get_webhook_statuses() as $status_key => $status_string ) {
$webhook_statuses[] = array( $status_key );
}
return $webhook_statuses;
}
/**
* Test the $status param on wc_load_webhooks().
*
* @dataProvider provider_webhook_statuses
* @param string $status The status of the webhook to test.
* @since 3.5.0
*/
public function test_wc_load_webhooks_status( $status ) {
$webhook = $this->create_webhook( 'action.woocommerce_some_action', $status );
$this->assertTrue( wc_load_webhooks( '' ) );
$this->assertTrue( wc_load_webhooks( $status ) );
// Find a different, but still valid status.
$other_status = ( 'active' === $status ) ? 'disabled' : 'active';
$this->assertFalse( wc_load_webhooks( $other_status ) );
$webhook->delete( true );
$this->assertFalse( wc_load_webhooks( $status ) );
}
/**
* @expectedException InvalidArgumentException
*/
public function test_wc_load_webhooks_status_invalid() {
wc_load_webhooks( 'invalid_status' );
}
/**
* Test the $limit param on wc_load_webhooks().
*
* @since 3.5.0
*/
public function test_wc_load_webhooks_limit() {
global $wp_filter;
$webhook_one = $this->create_webhook( 'action.woocommerce_one_test' );
$webhook_two = $this->create_webhook( 'action.woocommerce_two_test' );
$this->assertTrue( wc_load_webhooks( '', 1 ) );
$this->assertFalse( isset( $wp_filter['woocommerce_one_test'] ) );
$this->assertTrue( isset( $wp_filter['woocommerce_two_test'] ) );
$webhook_two->delete( true );
$this->assertTrue( wc_load_webhooks( '', 1 ) );
$this->assertTrue( isset( $wp_filter['woocommerce_one_test'] ) );
$webhook_one->delete( true );
$this->assertFalse( wc_load_webhooks( '', 1 ) );
}
/**
* Test the $status and $limit param on wc_load_webhooks().
*
* @dataProvider provider_webhook_statuses
* @param string $status The status of the webhook to test.
*/
public function test_wc_load_webhooks_status_and_limit( $status ) {
global $wp_filter;
$action_one = 'woocommerce_one_test_status_' . $status;
$webhook_one = $this->create_webhook( 'action.' . $action_one, $status );
$action_two = 'woocommerce_two_test_status_' . $status;
$webhook_two = $this->create_webhook( 'action.' . $action_two, $status );
$this->assertTrue( wc_load_webhooks( $status, 1 ) );
$this->assertFalse( isset( $wp_filter[ $action_one ] ) );
$this->assertTrue( isset( $wp_filter[ $action_two ] ) );
$webhook_two->delete( true );
$this->assertTrue( wc_load_webhooks( $status, 1 ) );
$this->assertTrue( isset( $wp_filter[ $action_one ] ) );
$webhook_one->delete( true );
$this->assertFalse( wc_load_webhooks( $status, 1 ) );
}
/**
* Verify that a webhook that has multiple hooks defined (in WC_Webhook::get_topic_hooks()),
* is only delivered once.
*
* This example uses Customer Created (which has 3 hooks defined), to verify that creating a customer
* will only deliver the payload once per webhook.
*/
public function test_woocommerce_webhook_is_delivered_only_once() {
$webhook1 = wc_get_webhook( $this->create_webhook( 'customer.created' )->get_id() );
$webhook2 = wc_get_webhook( $this->create_webhook( 'customer.created' )->get_id() );
wc_load_webhooks( 'active' );
add_action( 'woocommerce_webhook_process_delivery', array( $this, 'woocommerce_webhook_process_delivery' ), 1, 2 );
$customer1 = WC_Helper_Customer::create_customer( 'test1', 'pw1', 'user1@example.com' );
$customer2 = WC_Helper_Customer::create_customer( 'test2', 'pw2', 'user2@example.com' );
$this->assertEquals( 1, $this->delivery_counter[ $webhook1->get_id() . $customer1->get_id() ] );
$this->assertEquals( 1, $this->delivery_counter[ $webhook2->get_id() . $customer1->get_id() ] );
$this->assertEquals( 1, $this->delivery_counter[ $webhook1->get_id() . $customer2->get_id() ] );
$this->assertEquals( 1, $this->delivery_counter[ $webhook2->get_id() . $customer2->get_id() ] );
$webhook1->delete( true );
$webhook2->delete( true );
$customer1->delete( true );
$customer2->delete( true );
remove_action( 'woocommerce_webhook_process_delivery', array( $this, 'woocommerce_webhook_process_delivery' ), 1, 2 );
}
/**
* Verify that a webhook is queued when intended to be delivered synchronously. This allows us to then execute them
* all in a `register_shutdown_function` after the request has processed. Since async jobs are handled in
* this way, we can be more confident that it is consistent.
*/
public function test_woocommerce_webhook_synchronous_is_queued() {
add_filter( 'woocommerce_webhook_deliver_async', '__return_false' );
$webhook = wc_get_webhook( $this->create_webhook( 'customer.created' )->get_id() );
wc_load_webhooks( 'active' );
add_action( 'woocommerce_webhook_process_delivery', array( $this, 'woocommerce_webhook_process_delivery' ), 1, 2 );
$customer = WC_Helper_Customer::create_customer( 'test1', 'pw1', 'user1@example.com' );
global $wc_queued_sync_webhooks;
$this->assertCount( 1, $wc_queued_sync_webhooks );
$this->assertEquals( $webhook->get_id(), $wc_queued_sync_webhooks[0]['webhook']->get_id() );
$this->assertEquals( $customer->get_id(), $wc_queued_sync_webhooks[0]['arg'] );
$wc_queued_sync_webhooks = null;
remove_filter( 'woocommerce_webhook_deliver_async', '__return_false' );
$webhook->delete( true );
$customer->delete( true );
}
/**
* Helper function to keep track of which webhook (and corresponding arg) has been delivered
* within the current request.
*
* @param WC_Webhook $webhook Webhook that is processing delivery.
* @param mixed $arg Webhook arg (usually resource ID).
*/
public function woocommerce_webhook_process_delivery( $webhook, $arg ) {
if ( ! isset( $this->delivery_counter[ $webhook->get_id() . $arg ] ) ) {
$this->delivery_counter[ $webhook->get_id() . $arg ] = 0;
}
$this->delivery_counter[ $webhook->get_id() . $arg ] ++;
}
/**
* Create and save a webhook for testing.
*
* @param string $topic The webhook topic for the test.
* @param string $status The status of the webhook to be tested.
*/
protected function create_webhook( $topic = 'action.woocommerce_some_action', $status = 'active' ) {
$webhook = new WC_Webhook();
$webhook->set_props(
array(
'status' => $status,
'name' => 'Testing webhook',
'user_id' => 0,
'delivery_url' => 'https://requestb.in/17jajv31',
'secret' => 'secret',
'topic' => $topic,
'api_version' => 2,
)
);
$webhook->save();
return $webhook;
}
}