Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #18505 from liquidweb/feature/post-system-status-tool-hook 

Add a hook after executing a REST system status tool
This commit is contained in:
Claudio Sanches 2018-02-02 14:19:03 -02:00 committed by GitHub
parent 3146f87942 16b59b60a0
commit 0755038e8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 165 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

243
includes/api/class-wc-rest-system-status-tools-controller.php
View File

@ -49,7 +49,7 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
) ); ) );
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\w-]+)', array( register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\w-]+)', array(
'args' => array( 'args' => array(
'id' => array( 'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
@ -117,67 +117,67 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
*/ */
public function get_tools() { public function get_tools() {
$tools = array( $tools = array(
'clear_transients' => array( 'clear_transients' => array(
'name' => __( 'WooCommerce transients', 'woocommerce' ), 'name' => __( 'WooCommerce transients', 'woocommerce' ),
'button' => __( 'Clear transients', 'woocommerce' ), 'button' => __( 'Clear transients', 'woocommerce' ),
'desc' => __( 'This tool will clear the product/shop transients cache.', 'woocommerce' ), 'desc' => __( 'This tool will clear the product/shop transients cache.', 'woocommerce' ),
), ),
'clear_expired_transients' => array( 'clear_expired_transients' => array(
'name' => __( 'Expired transients', 'woocommerce' ), 'name' => __( 'Expired transients', 'woocommerce' ),
'button' => __( 'Clear transients', 'woocommerce' ), 'button' => __( 'Clear transients', 'woocommerce' ),
'desc' => __( 'This tool will clear ALL expired transients from WordPress.', 'woocommerce' ), 'desc' => __( 'This tool will clear ALL expired transients from WordPress.', 'woocommerce' ),
), ),
'delete_orphaned_variations' => array( 'delete_orphaned_variations' => array(
'name' => __( 'Orphaned variations', 'woocommerce' ), 'name' => __( 'Orphaned variations', 'woocommerce' ),
'button' => __( 'Delete orphaned variations', 'woocommerce' ), 'button' => __( 'Delete orphaned variations', 'woocommerce' ),
'desc' => __( 'This tool will delete all variations which have no parent.', 'woocommerce' ), 'desc' => __( 'This tool will delete all variations which have no parent.', 'woocommerce' ),
), ),
'add_order_indexes' => array( 'add_order_indexes' => array(
'name' => __( 'Order address indexes', 'woocommerce' ), 'name' => __( 'Order address indexes', 'woocommerce' ),
'button' => __( 'Index orders', 'woocommerce' ), 'button' => __( 'Index orders', 'woocommerce' ),
'desc' => __( 'This tool will add address indexes to orders that do not have them yet. This improves order search results.', 'woocommerce' ), 'desc' => __( 'This tool will add address indexes to orders that do not have them yet. This improves order search results.', 'woocommerce' ),
), ),
'recount_terms' => array( 'recount_terms' => array(
'name' => __( 'Term counts', 'woocommerce' ), 'name' => __( 'Term counts', 'woocommerce' ),
'button' => __( 'Recount terms', 'woocommerce' ), 'button' => __( 'Recount terms', 'woocommerce' ),
'desc' => __( 'This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog.', 'woocommerce' ), 'desc' => __( 'This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog.', 'woocommerce' ),
), ),
'reset_roles' => array( 'reset_roles' => array(
'name' => __( 'Capabilities', 'woocommerce' ), 'name' => __( 'Capabilities', 'woocommerce' ),
'button' => __( 'Reset capabilities', 'woocommerce' ), 'button' => __( 'Reset capabilities', 'woocommerce' ),
'desc' => __( 'This tool will reset the admin, customer and shop_manager roles to default. Use this if your users cannot access all of the WooCommerce admin pages.', 'woocommerce' ), 'desc' => __( 'This tool will reset the admin, customer and shop_manager roles to default. Use this if your users cannot access all of the WooCommerce admin pages.', 'woocommerce' ),
), ),
'clear_sessions' => array( 'clear_sessions' => array(
'name' => __( 'Clear customer sessions', 'woocommerce' ), 'name' => __( 'Clear customer sessions', 'woocommerce' ),
'button' => __( 'Clear', 'woocommerce' ), 'button' => __( 'Clear', 'woocommerce' ),
'desc' => sprintf( 'desc' => sprintf(
'<strong class="red">%1$s</strong> %2$s', '<strong class="red">%1$s</strong> %2$s',
__( 'Note:', 'woocommerce' ), __( 'Note:', 'woocommerce' ),
__( 'This tool will delete all customer session data from the database, including current carts and saved carts in the database.', 'woocommerce' ) __( 'This tool will delete all customer session data from the database, including current carts and saved carts in the database.', 'woocommerce' )
), ),
), ),
'install_pages' => array( 'install_pages' => array(
'name' => __( 'Create default WooCommerce pages', 'woocommerce' ), 'name' => __( 'Create default WooCommerce pages', 'woocommerce' ),
'button' => __( 'Create pages', 'woocommerce' ), 'button' => __( 'Create pages', 'woocommerce' ),
'desc' => sprintf( 'desc' => sprintf(
'<strong class="red">%1$s</strong> %2$s', '<strong class="red">%1$s</strong> %2$s',
__( 'Note:', 'woocommerce' ), __( 'Note:', 'woocommerce' ),
__( 'This tool will install all the missing WooCommerce pages. Pages already defined and set up will not be replaced.', 'woocommerce' ) __( 'This tool will install all the missing WooCommerce pages. Pages already defined and set up will not be replaced.', 'woocommerce' )
), ),
), ),
'delete_taxes' => array( 'delete_taxes' => array(
'name' => __( 'Delete WooCommerce tax rates', 'woocommerce' ), 'name' => __( 'Delete WooCommerce tax rates', 'woocommerce' ),
'button' => __( 'Delete tax rates', 'woocommerce' ), 'button' => __( 'Delete tax rates', 'woocommerce' ),
'desc' => sprintf( 'desc' => sprintf(
'<strong class="red">%1$s</strong> %2$s', '<strong class="red">%1$s</strong> %2$s',
__( 'Note:', 'woocommerce' ), __( 'Note:', 'woocommerce' ),
__( 'This option will delete ALL of your tax rates, use with caution. This action cannot be reversed.', 'woocommerce' ) __( 'This option will delete ALL of your tax rates, use with caution. This action cannot be reversed.', 'woocommerce' )
), ),
), ),
'reset_tracking' => array( 'reset_tracking' => array(
'name' => __( 'Reset usage tracking', 'woocommerce' ), 'name' => __( 'Reset usage tracking', 'woocommerce' ),
'button' => __( 'Reset', 'woocommerce' ), 'button' => __( 'Reset', 'woocommerce' ),
'desc' => __( 'This will reset your usage tracking settings, causing it to show the opt-in banner again and not sending any data.', 'woocommerce' ), 'desc' => __( 'This will reset your usage tracking settings, causing it to show the opt-in banner again and not sending any data.', 'woocommerce' ),
), ),
); );
@ -227,6 +227,7 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
/** /**
* Update (execute) a tool. * Update (execute) a tool.
*
* @param WP_REST_Request $request * @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response * @return WP_Error|WP_REST_Response
*/ */
@ -238,14 +239,22 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
$tool = $tools[ $request['id'] ]; $tool = $tools[ $request['id'] ];
$tool = array( $tool = array(
'id' => $request['id'], 'id' => $request['id'],
'name' => $tool['name'], 'name' => $tool['name'],
'action' => $tool['button'], 'action' => $tool['button'],
'description' => $tool['desc'], 'description' => $tool['desc'],
); );
$execute_return = $this->execute_tool( $request['id'] ); $execute_return = $this->execute_tool( $request['id'] );
$tool = array_merge( $tool, $execute_return ); $tool = array_merge( $tool, $execute_return );
/**
* Fires after a WooCommerce REST system status tool has been executed.
*
* @param array $tool Details about the tool that has been executed.
* @param WP_REST_Request $request The current WP_REST_Request object.
*/
do_action( 'woocommerce_rest_insert_system_status_tool', $tool, $request );
$request->set_param( 'context', 'edit' ); $request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $tool, $request ); $response = $this->prepare_item_for_response( $tool, $request );
@ -255,8 +264,8 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
/** /**
* Prepare a tool item for serialization. * Prepare a tool item for serialization.
* *
* @param array $item Object. * @param array $item Object.
* @param WP_REST_Request $request Request object. * @param WP_REST_Request $request Request object.
* @return WP_REST_Response $response Response data. * @return WP_REST_Response $response Response data.
*/ */
public function prepare_item_for_response( $item, $request ) { public function prepare_item_for_response( $item, $request ) {
@ -282,48 +291,48 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
'title' => 'system_status_tool', 'title' => 'system_status_tool',
'type' => 'object', 'type' => 'object',
'properties' => array( 'properties' => array(
'id' => array( 'id' => array(
'description' => __( 'A unique identifier for the tool.', 'woocommerce' ), 'description' => __( 'A unique identifier for the tool.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'arg_options' => array( 'arg_options' => array(
'sanitize_callback' => 'sanitize_title', 'sanitize_callback' => 'sanitize_title',
), ),
), ),
'name' => array( 'name' => array(
'description' => __( 'Tool name.', 'woocommerce' ), 'description' => __( 'Tool name.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'arg_options' => array( 'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field', 'sanitize_callback' => 'sanitize_text_field',
), ),
), ),
'action' => array( 'action' => array(
'description' => __( 'What running the tool will do.', 'woocommerce' ), 'description' => __( 'What running the tool will do.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'arg_options' => array( 'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field', 'sanitize_callback' => 'sanitize_text_field',
), ),
), ),
'description' => array( 'description' => array(
'description' => __( 'Tool description.', 'woocommerce' ), 'description' => __( 'Tool description.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'arg_options' => array( 'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field', 'sanitize_callback' => 'sanitize_text_field',
), ),
), ),
'success' => array( 'success' => array(
'description' => __( 'Did the tool run successfully?', 'woocommerce' ), 'description' => __( 'Did the tool run successfully?', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'context' => array( 'edit' ), 'context' => array( 'edit' ),
), ),
'message' => array( 'message' => array(
'description' => __( 'Tool return message.', 'woocommerce' ), 'description' => __( 'Tool return message.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'edit' ), 'context' => array( 'edit' ),
'arg_options' => array( 'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field', 'sanitize_callback' => 'sanitize_text_field',
), ),
), ),
@ -372,31 +381,34 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
global $wpdb; global $wpdb;
$ran = true; $ran = true;
switch ( $tool ) { switch ( $tool ) {
case 'clear_transients' : case 'clear_transients':
wc_delete_product_transients(); wc_delete_product_transients();
wc_delete_shop_order_transients(); wc_delete_shop_order_transients();
WC_Cache_Helper::get_transient_version( 'shipping', true ); WC_Cache_Helper::get_transient_version( 'shipping', true );
$message = __( 'Product transients cleared', 'woocommerce' ); $message = __( 'Product transients cleared', 'woocommerce' );
break; break;
case 'clear_expired_transients' :
case 'clear_expired_transients':
$message = sprintf( __( '%d transients rows cleared', 'woocommerce' ), wc_delete_expired_transients() ); $message = sprintf( __( '%d transients rows cleared', 'woocommerce' ), wc_delete_expired_transients() );
break; break;
case 'delete_orphaned_variations' :
case 'delete_orphaned_variations':
/** /**
* Delete orphans * Delete orphans
*/ */
$result = absint( $wpdb->query( "DELETE products $result = absint( $wpdb->query( "DELETE products
FROM {$wpdb->posts} products FROM {$wpdb->posts} products
LEFT JOIN {$wpdb->posts} wp ON wp.ID = products.post_parent LEFT JOIN {$wpdb->posts} wp ON wp.ID = products.post_parent
WHERE wp.ID IS NULL AND products.post_type = 'product_variation';" ) ); WHERE wp.ID IS NULL AND products.post_type = 'product_variation';" ) );
$message = sprintf( __( '%d orphaned variations deleted', 'woocommerce' ), $result ); $message = sprintf( __( '%d orphaned variations deleted', 'woocommerce' ), $result );
break; break;
case 'add_order_indexes' :
case 'add_order_indexes':
/** /**
* Add billing and shipping address indexes containing the customer name for orders * Add billing and shipping address indexes containing the customer name for orders
* that don't have address indexes yet. * that don't have address indexes yet.
*/ */
$sql = "INSERT INTO {$wpdb->postmeta}( post_id, meta_key, meta_value ) $sql = "INSERT INTO {$wpdb->postmeta}( post_id, meta_key, meta_value )
SELECT post_id, '%s', GROUP_CONCAT( meta_value SEPARATOR ' ' ) SELECT post_id, '%s', GROUP_CONCAT( meta_value SEPARATOR ' ' )
FROM {$wpdb->postmeta} FROM {$wpdb->postmeta}
WHERE meta_key IN ( '%s', '%s' ) WHERE meta_key IN ( '%s', '%s' )
@ -404,57 +416,69 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
WHERE post_id NOT IN ( SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key='%s' ) WHERE post_id NOT IN ( SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key='%s' )
AND post_id IN ( SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key='%s' ) ) AND post_id IN ( SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key='%s' ) )
GROUP BY post_id"; GROUP BY post_id";
$rows = $wpdb->query( $wpdb->prepare( $sql, '_billing_address_index', '_billing_first_name', '_billing_last_name', '_billing_address_index', '_billing_last_name' ) ); $rows = $wpdb->query( $wpdb->prepare( $sql, '_billing_address_index', '_billing_first_name', '_billing_last_name', '_billing_address_index', '_billing_last_name' ) );
$rows += $wpdb->query( $wpdb->prepare( $sql, '_shipping_address_index', '_shipping_first_name', '_shipping_last_name', '_shipping_address_index', '_shipping_last_name') ); $rows += $wpdb->query( $wpdb->prepare( $sql, '_shipping_address_index', '_shipping_first_name', '_shipping_last_name', '_shipping_address_index', '_shipping_last_name' ) );
$message = sprintf( __( '%d indexes added', 'woocommerce' ), $rows ); $message = sprintf( __( '%d indexes added', 'woocommerce' ), $rows );
break; break;
case 'reset_roles' :
case 'reset_roles':
// Remove then re-add caps and roles // Remove then re-add caps and roles
WC_Install::remove_roles(); WC_Install::remove_roles();
WC_Install::create_roles(); WC_Install::create_roles();
$message = __( 'Roles successfully reset', 'woocommerce' ); $message = __( 'Roles successfully reset', 'woocommerce' );
break; break;
case 'recount_terms' :
$product_cats = get_terms( 'product_cat', array( 'hide_empty' => false, 'fields' => 'id=>parent' ) ); case 'recount_terms':
$product_cats = get_terms( 'product_cat', array(
'hide_empty' => false,
'fields' => 'id=>parent',
) );
_wc_term_recount( $product_cats, get_taxonomy( 'product_cat' ), true, false ); _wc_term_recount( $product_cats, get_taxonomy( 'product_cat' ), true, false );
$product_tags = get_terms( 'product_tag', array( 'hide_empty' => false, 'fields' => 'id=>parent' ) ); $product_tags = get_terms( 'product_tag', array(
'hide_empty' => false,
'fields' => 'id=>parent',
) );
_wc_term_recount( $product_tags, get_taxonomy( 'product_tag' ), true, false ); _wc_term_recount( $product_tags, get_taxonomy( 'product_tag' ), true, false );
$message = __( 'Terms successfully recounted', 'woocommerce' ); $message = __( 'Terms successfully recounted', 'woocommerce' );
break; break;
case 'clear_sessions' :
case 'clear_sessions':
$wpdb->query( "TRUNCATE {$wpdb->prefix}woocommerce_sessions" ); $wpdb->query( "TRUNCATE {$wpdb->prefix}woocommerce_sessions" );
$result = absint( $wpdb->query( "DELETE FROM {$wpdb->usermeta} WHERE meta_key='_woocommerce_persistent_cart_" . get_current_blog_id() . "';" ) ); $result = absint( $wpdb->query( "DELETE FROM {$wpdb->usermeta} WHERE meta_key='_woocommerce_persistent_cart_" . get_current_blog_id() . "';" ) );
wp_cache_flush(); wp_cache_flush();
$message = sprintf( __( 'Deleted all active sessions, and %d saved carts.', 'woocommerce' ), absint( $result ) ); $message = sprintf( __( 'Deleted all active sessions, and %d saved carts.', 'woocommerce' ), absint( $result ) );
break; break;
case 'install_pages' :
case 'install_pages':
WC_Install::create_pages(); WC_Install::create_pages();
$message = __( 'All missing WooCommerce pages successfully installed', 'woocommerce' ); $message = __( 'All missing WooCommerce pages successfully installed', 'woocommerce' );
break; break;
case 'delete_taxes' :
case 'delete_taxes':
$wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rates;" ); $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rates;" );
$wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rate_locations;" ); $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rate_locations;" );
WC_Cache_Helper::incr_cache_prefix( 'taxes' ); WC_Cache_Helper::incr_cache_prefix( 'taxes' );
$message = __( 'Tax rates successfully deleted', 'woocommerce' ); $message = __( 'Tax rates successfully deleted', 'woocommerce' );
break; break;
case 'reset_tracking' :
case 'reset_tracking':
delete_option( 'woocommerce_allow_tracking' ); delete_option( 'woocommerce_allow_tracking' );
WC_Admin_Notices::add_notice( 'tracking' ); WC_Admin_Notices::add_notice( 'tracking' );
$message = __( 'Usage tracking settings successfully reset.', 'woocommerce' ); $message = __( 'Usage tracking settings successfully reset.', 'woocommerce' );
break; break;
default :
default:
$tools = $this->get_tools(); $tools = $this->get_tools();
if ( isset( $tools[ $tool ]['callback'] ) ) { if ( isset( $tools[ $tool ]['callback'] ) ) {
$callback = $tools[ $tool ]['callback']; $callback = $tools[ $tool ]['callback'];
$return = call_user_func( $callback ); $return = call_user_func( $callback );
if ( is_string( $return ) ) { if ( is_string( $return ) ) {
$message = $return; $message = $return;
} elseif ( false === $return ) { } elseif ( false === $return ) {
$callback_string = is_array( $callback ) ? get_class( $callback[0] ) . '::' . $callback[1] : $callback; $callback_string = is_array( $callback ) ? get_class( $callback[0] ) . '::' . $callback[1] : $callback;
$ran = false; $ran = false;
$message = sprintf( __( 'There was an error calling %s', 'woocommerce' ), $callback_string ); $message = sprintf( __( 'There was an error calling %s', 'woocommerce' ), $callback_string );
} else { } else {
$message = __( 'Tool ran.', 'woocommerce' ); $message = __( 'Tool ran.', 'woocommerce' );
} }
@ -462,9 +486,12 @@ class WC_REST_System_Status_Tools_Controller extends WC_REST_Controller {
$ran = false; $ran = false;
$message = __( 'There was an error calling this tool. There is no callback present.', 'woocommerce' ); $message = __( 'There was an error calling this tool. There is no callback present.', 'woocommerce' );
} }
break; break;
} }
return array( 'success' => $ran, 'message' => $message ); return array(
'success' => $ran,
'message' => $message,
);
} }
} }

5
phpcs.xml
View File

@ -52,7 +52,10 @@
</rule> </rule>
<rule ref="WordPress.Files.FileName.InvalidClassFileName"> <rule ref="WordPress.Files.FileName.InvalidClassFileName">
<exclude-pattern>includes/**/abstract-*.php</exclude-pattern> <exclude-pattern>includes/**/abstract-*.php</exclude-pattern>
<exclude-pattern>tests/</exclude-pattern> <exclude-pattern>tests/*</exclude-pattern>
</rule>
<rule ref="WordPress.PHP.DevelopmentFunctions.error_log_print_r">
<exclude-pattern>tests/*</exclude-pattern>
</rule> </rule>
<rule ref="Generic.Commenting"> <rule ref="Generic.Commenting">
<exclude-pattern>tests/</exclude-pattern> <exclude-pattern>tests/</exclude-pattern>

40
tests/unit-tests/api/system-status.php
View File

@ -1,6 +1,13 @@
<?php <?php
/** /**
* System Status REST Tests * Class WC_Tests_REST_System_Status file.
*
* @package WooCommerce/Tests
*/
/**
* System Status REST Tests.
*
* @package WooCommerce\Tests\API * @package WooCommerce\Tests\API
* @since 3.0 * @since 3.0
*/ */
@ -12,7 +19,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
public function setUp() { public function setUp() {
parent::setUp(); parent::setUp();
$this->endpoint = new WC_REST_System_Status_Controller(); $this->endpoint = new WC_REST_System_Status_Controller();
$this->user = $this->factory->user->create( array( $this->user = $this->factory->user->create( array(
'role' => 'administrator', 'role' => 'administrator',
) ); ) );
} }
@ -47,7 +54,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
public function test_get_system_status_info_returns_root_properties() { public function test_get_system_status_info_returns_root_properties() {
wp_set_current_user( $this->user ); wp_set_current_user( $this->user );
$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v2/system_status' ) ); $response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v2/system_status' ) );
$data = $response->get_data(); $data = $response->get_data();
$this->assertArrayHasKey( 'environment', $data ); $this->assertArrayHasKey( 'environment', $data );
$this->assertArrayHasKey( 'database', $data ); $this->assertArrayHasKey( 'database', $data );
@ -69,10 +76,10 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
$data = $response->get_data(); $data = $response->get_data();
$environment = (array) $data['environment']; $environment = (array) $data['environment'];
// Make sure all expected data is present // Make sure all expected data is present.
$this->assertEquals( 30, count( $environment ) ); $this->assertEquals( 30, count( $environment ) );
// Test some responses to make sure they match up // Test some responses to make sure they match up.
$this->assertEquals( get_option( 'home' ), $environment['home_url'] ); $this->assertEquals( get_option( 'home' ), $environment['home_url'] );
$this->assertEquals( get_option( 'siteurl' ), $environment['site_url'] ); $this->assertEquals( get_option( 'siteurl' ), $environment['site_url'] );
$this->assertEquals( WC()->version, $environment['version'] ); $this->assertEquals( WC()->version, $environment['version'] );
@ -131,7 +138,10 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
$theme = (array) $data['theme']; $theme = (array) $data['theme'];
$this->assertEquals( 13, count( $theme ) ); $this->assertEquals( 13, count( $theme ) );
// phpcs:disable WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$this->assertEquals( $active_theme->Name, $theme['name'] ); $this->assertEquals( $active_theme->Name, $theme['name'] );
// phpcs:enable
} }
/** /**
@ -194,9 +204,9 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
* @since 3.0.0 * @since 3.0.0
*/ */
public function test_system_status_schema() { public function test_system_status_schema() {
$request = new WP_REST_Request( 'OPTIONS', '/wc/v2/system_status' ); $request = new WP_REST_Request( 'OPTIONS', '/wc/v2/system_status' );
$response = $this->server->dispatch( $request ); $response = $this->server->dispatch( $request );
$data = $response->get_data(); $data = $response->get_data();
$properties = $data['schema']['properties']; $properties = $data['schema']['properties'];
$this->assertEquals( 7, count( $properties ) ); $this->assertEquals( 7, count( $properties ) );
$this->assertArrayHasKey( 'environment', $properties ); $this->assertArrayHasKey( 'environment', $properties );
@ -216,7 +226,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
public function test_get_system_tools() { public function test_get_system_tools() {
wp_set_current_user( $this->user ); wp_set_current_user( $this->user );
$tools_controller = new WC_REST_System_Status_Tools_Controller; $tools_controller = new WC_REST_System_Status_Tools_Controller();
$raw_tools = $tools_controller->get_tools(); $raw_tools = $tools_controller->get_tools();
$response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v2/system_status/tools' ) ); $response = $this->server->dispatch( new WP_REST_Request( 'GET', '/wc/v2/system_status/tools' ) );
@ -259,7 +269,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
public function test_get_system_tool() { public function test_get_system_tool() {
wp_set_current_user( $this->user ); wp_set_current_user( $this->user );
$tools_controller = new WC_REST_System_Status_Tools_Controller; $tools_controller = new WC_REST_System_Status_Tools_Controller();
$raw_tools = $tools_controller->get_tools(); $raw_tools = $tools_controller->get_tools();
$raw_tool = $raw_tools['recount_terms']; $raw_tool = $raw_tools['recount_terms'];
@ -293,7 +303,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
public function test_execute_system_tool() { public function test_execute_system_tool() {
wp_set_current_user( $this->user ); wp_set_current_user( $this->user );
$tools_controller = new WC_REST_System_Status_Tools_Controller; $tools_controller = new WC_REST_System_Status_Tools_Controller();
$raw_tools = $tools_controller->get_tools(); $raw_tools = $tools_controller->get_tools();
$raw_tool = $raw_tools['recount_terms']; $raw_tool = $raw_tools['recount_terms'];
@ -305,6 +315,7 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
$this->assertEquals( 'Recount terms', $data['action'] ); $this->assertEquals( 'Recount terms', $data['action'] );
$this->assertEquals( 'This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog.', $data['description'] ); $this->assertEquals( 'This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog.', $data['description'] );
$this->assertTrue( $data['success'] ); $this->assertTrue( $data['success'] );
$this->assertEquals( 1, did_action( 'woocommerce_rest_insert_system_status_tool' ) );
$response = $this->server->dispatch( new WP_REST_Request( 'POST', '/wc/v2/system_status/tools/not_a_real_tool' ) ); $response = $this->server->dispatch( new WP_REST_Request( 'POST', '/wc/v2/system_status/tools/not_a_real_tool' ) );
$this->assertEquals( 404, $response->get_status() ); $this->assertEquals( 404, $response->get_status() );
@ -327,10 +338,11 @@ class WC_Tests_REST_System_Status extends WC_REST_Unit_Test_Case {
* @since 3.0.0 * @since 3.0.0
*/ */
public function test_system_status_tool_schema() { public function test_system_status_tool_schema() {
$request = new WP_REST_Request( 'OPTIONS', '/wc/v2/system_status/tools' ); $request = new WP_REST_Request( 'OPTIONS', '/wc/v2/system_status/tools' );
$response = $this->server->dispatch( $request ); $response = $this->server->dispatch( $request );
$data = $response->get_data(); $data = $response->get_data();
$properties = $data['schema']['properties']; $properties = $data['schema']['properties'];
$this->assertEquals( 6, count( $properties ) ); $this->assertEquals( 6, count( $properties ) );
$this->assertArrayHasKey( 'id', $properties ); $this->assertArrayHasKey( 'id', $properties );
$this->assertArrayHasKey( 'name', $properties ); $this->assertArrayHasKey( 'name', $properties );