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

Adding PHP unit tests for tasks rest endpoints (https://github.com/woocommerce/woocommerce-admin/pull/7747)

This commit is contained in:
Joel Thiessen 2021-10-21 07:49:30 -07:00 committed by GitHub
parent b8f4d035cb
commit ded7a4b3e3
3 changed files with 414 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
plugins/woocommerce-admin/src/API/OnboardingTasks.php
View File

@ -768,8 +768,12 @@ class OnboardingTasks extends \WC_REST_Data_Controller {
*/
public function get_tasks( $request ) {
$extended_tasks = $request->get_param( 'extended_tasks' );
$lists = TaskLists::get_lists( $extended_tasks );
$json = array_map(
TaskLists::maybe_add_extended_tasks( $extended_tasks );
$lists = TaskLists::get_lists();
$json = array_map(
function( $list ) {
return $list->sort_tasks()->get_json();
},
@ -874,7 +878,7 @@ class OnboardingTasks extends \WC_REST_Data_Controller {
if ( ! $task || ! $task->is_snoozeable ) {
return new \WP_Error(
'woocommerce_tasks_invalid_task',
'woocommerce_rest_invalid_task',
__( 'Sorry, no snoozeable task with that ID was found.', 'woocommerce-admin' ),
array(
'status' => 404,
@ -908,7 +912,7 @@ class OnboardingTasks extends \WC_REST_Data_Controller {
if ( ! $task || ! $task->is_snoozeable ) {
return new \WP_Error(
'woocommerce_tasks_invalid_task',
'woocommerce_rest_invalid_task',
__( 'Sorry, no snoozeable task with that ID was found.', 'woocommerce-admin' ),
array(
'status' => 404,
@ -933,7 +937,7 @@ class OnboardingTasks extends \WC_REST_Data_Controller {
if ( ! $task_list ) {
return new \WP_Error(
'woocommerce_tasks_invalid_task_list',
'woocommerce_rest_invalid_task_list',
__( 'Sorry, that task list was not found', 'woocommerce-admin' ),
array(
'status' => 404,

85
plugins/woocommerce-admin/src/Features/OnboardingTasks/TaskLists.php
View File

@ -26,6 +26,13 @@ class TaskLists {
*/
protected static $lists = array();
/**
* Boolean value to indicate if default tasks have been added.
*
* @var boolean
*/
protected static $default_tasks_loaded = false;
/**
* Array of default tasks.
*
@ -57,10 +64,41 @@ class TaskLists {
* Initialize the task lists.
*/
public static function init() {
self::init_default_lists();
add_action( 'init', array( __CLASS__, 'maybe_add_default_tasks' ) );
add_action( 'admin_init', array( __CLASS__, 'set_active_task' ), 5 );
add_action( 'admin_init', array( __CLASS__, 'init_tasks' ) );
}
/**
* Initialize default lists.
*/
public static function init_default_lists() {
self::add_list(
array(
'id' => 'setup',
'title' => __( 'Get ready to start selling', 'woocommerce-admin' ),
)
);
self::add_list(
array(
'id' => 'extended',
'title' => __( 'Things to do next', 'woocommerce-admin' ),
'sort_by' => array(
array(
'key' => 'is_complete',
'order' => 'asc',
),
array(
'key' => 'level',
'order' => 'asc',
),
),
)
);
}
/**
* Initialize tasks.
*/
@ -133,35 +171,11 @@ class TaskLists {
* Add default task lists.
*/
public static function maybe_add_default_tasks() {
$added = isset( self::$lists['setup'] );
if ( ! apply_filters( 'woocommerce_admin_onboarding_tasks_add_default_tasks', ! $added ) ) {
if ( ! apply_filters( 'woocommerce_admin_onboarding_tasks_add_default_tasks', ! self::$default_tasks_loaded ) ) {
return;
}
self::add_list(
array(
'id' => 'setup',
'title' => __( 'Get ready to start selling', 'woocommerce-admin' ),
)
);
self::add_list(
array(
'id' => 'extended',
'title' => __( 'Things to do next', 'woocommerce-admin' ),
'sort_by' => array(
array(
'key' => 'is_complete',
'order' => 'asc',
),
array(
'key' => 'level',
'order' => 'asc',
),
),
)
);
self::$default_tasks_loaded = true;
foreach ( self::DEFAULT_TASKS as $task ) {
$class = 'Automattic\WooCommerce\Admin\Features\OnboardingTasks\Tasks\\' . $task;
@ -174,8 +188,10 @@ class TaskLists {
*
* @param array $extended_tasks list of extended tasks.
*/
public static function maybe_add_extended_tasks( $extended_tasks = array() ) {
foreach ( $extended_tasks as $extended_task ) {
public static function maybe_add_extended_tasks( $extended_tasks ) {
$tasks = $extended_tasks ? $extended_tasks : array();
foreach ( $tasks as $extended_task ) {
self::add_task( $extended_task['list_id'], $extended_task );
}
}
@ -183,12 +199,17 @@ class TaskLists {
/**
* Get all task lists.
*
* @param array $extended_tasks array of optional extended tasks.
* @return array
*/
public static function get_lists( $extended_tasks = array() ) {
self::maybe_add_default_tasks();
self::maybe_add_extended_tasks( $extended_tasks );
public static function get_lists() {
return self::$lists;
}
/**
* Clear all task lists.
*/
public static function clear_lists() {
self::$lists = array();
return self::$lists;
}

352
plugins/woocommerce-admin/tests/api/onboarding-tasks.php
View File

@ -6,6 +6,8 @@
*/
use \Automattic\WooCommerce\Admin\API\OnboardingTasks;
use Automattic\WooCommerce\Admin\Features\OnboardingTasks\TaskLists;
use Automattic\WooCommerce\Admin\Features\OnboardingTasks\Task;
/**
* WC Tests API Onboarding Tasks
@ -37,6 +39,12 @@ class WC_Tests_API_Onboarding_Tasks extends WC_REST_Unit_Test_Case {
foreach ( $products as $product ) {
$product->delete( true );
}
// Resetting task list options and lists.
update_option( Task::DISMISSED_OPTION, array() );
update_option( Task::SNOOZED_OPTION, array() );
TaskLists::clear_lists();
}
/**
@ -167,4 +175,348 @@ class WC_Tests_API_Onboarding_Tasks extends WC_REST_Unit_Test_Case {
}
/**
* Test that a task can be snoozed.
* @group tasklist
*/
public function test_task_can_be_snoozed() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_snoozeable' => true,
)
);
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/snooze' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task = TaskLists::get_task( 'test-task' );
$this->assertEquals( $data['isSnoozed'], true );
$this->assertEquals( isset( $data['snoozedUntil'] ), true );
$this->assertEquals( $task->is_snoozed(), true );
$this->assertEquals( isset( $task->snoozed_until ), true );
}
/**
* Test that a task can be snoozed with determined list ID.
* @group tasklist
*/
public function test_task_can_be_snoozed_with_list_id() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_snoozeable' => true,
)
);
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/snooze' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$request->set_body( wp_json_encode( array( 'task_list_id' => 'test-list' ) ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task = TaskLists::get_task( 'test-task' );
$this->assertEquals( $data['isSnoozed'], true );
$this->assertEquals( isset( $data['snoozedUntil'] ), true );
$this->assertEquals( $task->is_snoozed(), true );
$this->assertEquals( isset( $task->snoozed_until ), true );
}
/**
* Test that a task can be snoozed with determined duration.
* @group tasklist
*/
public function test_task_can_be_snoozed_with_duration() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_snoozeable' => true,
)
);
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/snooze' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$request->set_body( wp_json_encode( array( 'duration' => 'week' ) ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task = TaskLists::get_task( 'test-task' );
$week_in_ms = WEEK_IN_SECONDS * 1000;
$this->assertEquals( $data['snoozedUntil'] >= ( ( time() * 1000 ) + $week_in_ms ), true );
}
/**
* Test that a snoozed task can be undone.
* @group tasklist
*/
public function test_snoozed_task_can_be_undone() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_snoozeable' => true,
)
);
$task = TaskLists::get_task( 'test-task' );
$task->snooze();
$this->assertEquals( $task->is_snoozed(), true );
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/undo_snooze' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task_after_request = TaskLists::get_task( 'test-task' );
$this->assertEquals( $task_after_request->is_snoozed(), false );
}
/**
* Test that snooze endpoint returns error for invalid task.
* @group tasklist
*/
public function test_snoozed_task_invalid() {
$this->markTestSkipped( 'Skipped temporarily due to change in endpoint behavior.' );
wp_set_current_user( $this->user );
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/snooze' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$response_data = $response->get_data();
$this->assertEquals( $response_data['data']['status'], 404 );
$this->assertEquals( $response_data['code'], 'woocommerce_rest_invalid_task' );
}
/**
* Test that a task can be dismissed.
* @group tasklist
*/
public function test_task_can_be_dismissed() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_dismissable' => true,
)
);
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/dismiss' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task = TaskLists::get_task( 'test-task' );
$this->assertEquals( $data['isDismissed'], true );
$this->assertEquals( $task->is_dismissed(), true );
}
/**
* Test that a dismissed task can be undone.
* @group tasklist
*/
public function test_dismissed_task_can_be_undone() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_dismissable' => true,
)
);
$task = TaskLists::get_task( 'test-task' );
$task->dismiss();
$this->assertEquals( $task->is_dismissed(), true );
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/undo_dismiss' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$task_after_request = TaskLists::get_task( 'test-task' );
$this->assertEquals( $task_after_request->is_dismissed(), false );
}
/**
* Test that dismiss endpoint returns error for invalid task.
* @group tasklist
*/
public function test_dismissed_task_invalid() {
$this->markTestSkipped( 'Skipped temporarily due to change in endpoint behavior.' );
wp_set_current_user( $this->user );
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-task/dismiss' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$response_data = $response->get_data();
$this->assertEquals( $response_data['data']['status'], 404 );
$this->assertEquals( $response_data['code'], 'woocommerce_rest_invalid_task' );
}
/**
* Test that a task list can be hidden.
* @group tasklist
*/
public function test_task_list_can_be_hidden() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_dismissable' => true,
)
);
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-list/hide' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$response_data = $response->get_data();
$list = TaskLists::get_list( 'test-list' );
$this->assertEquals( $list->is_hidden(), true );
$this->assertEquals( $response_data['isHidden'], true );
}
/**
* Test that hide endpoint returns error for invalid task.
* @group tasklist
*/
public function test_task_list_hidden_invalid_list() {
wp_set_current_user( $this->user );
$request = new WP_REST_Request( 'POST', $this->endpoint . '/test-list/hide' );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$response_data = $response->get_data();
$this->assertEquals( $response_data['data']['status'], 404 );
$this->assertEquals( $response_data['code'], 'woocommerce_rest_invalid_task_list' );
}
/**
* Test that task lists can be fetched.
* @group tasklist
*/
public function test_task_list_can_be_fetched() {
wp_set_current_user( $this->user );
TaskLists::add_list(
array(
'id' => 'test-list',
)
);
TaskLists::add_task(
'test-list',
array(
'id' => 'test-task',
'title' => 'Test Task',
'is_dismissable' => true,
)
);
$request = new WP_REST_Request( 'GET', $this->endpoint );
$request->set_headers( array( 'content-type' => 'application/json' ) );
$response = $this->server->dispatch( $request );
$response_data = $response->get_data();
$test_list = null;
foreach ( $response_data as $task_list ) {
if ( 'test-list' === $task_list['id'] ) {
$test_list = $task_list;
}
}
$test_task = $test_list['tasks'][0];
$this->assertEquals( $test_task['id'], 'test-task' );
$this->assertEquals( $test_task['isDismissable'], true );
}
}