Skip to content

Commit

Permalink
Update tests format
Browse files Browse the repository at this point in the history
  • Loading branch information
@renatho
renatho committed Apr 8, 2024
1 parent 564fdde commit 2d7b8eb
Showing 1 changed file with 77 additions and 21 deletions.
98 changes: 77 additions & 21 deletions tests/unit-tests/admin/test-class-sensei-setup-wizard.php
View file
Expand Up @@ -58,159 +58,185 @@ public function tearDown(): void {
/**
* Testing the setup wizard class to make sure it is loaded.
*/
public function testClassInstance() {
public function testClassInstance_Always_Exists() {
// Assert.
$this->assertTrue( class_exists( 'Sensei_Setup_Wizard' ), 'Sensei Setup Wizard class does not exist' );
}

/**
* Test setup wizard notice in dashboard.
*/
public function testSetupWizardNoticeInDashboard() {
public function testSetupWizardNotice_WhenSuggestSetupWizardOptionIsOneAndScreenIsDashboard_DisplaysNotice() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

set_current_screen( 'dashboard' );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 1 );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

$pos_setup_button = strpos( $html, 'Run the Setup Wizard' );

// Assert.
$this->assertNotFalse( $pos_setup_button, 'Should return the notice HTML' );
}

/**
* Test setup wizard notice in screen with Sensei prefix.
*/
public function testSetupWizardNoticeInSenseiScreen() {
public function testSetupWizardNotice_WhenSuggestSetupWizardOptionIsOneAndScreenIsSenseiPage_DisplaysNotice() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

set_current_screen( 'sensei-lms_page_sensei_test' );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 1 );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

$pos_setup_button = strpos( $html, 'Run the Setup Wizard' );

// Assert.
$this->assertNotFalse( $pos_setup_button, 'Should return the notice HTML' );
}

/**
* Test setup wizard notice in no Sensei screen.
*/
public function testSetupWizardNoticeInOtherScreen() {
public function testSetupWizardNotice_WhenInOtherScreen_DoesNotDisplayNotice() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

set_current_screen( 'other' );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 1 );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

// Assert.
$this->assertEmpty( $html, 'Should return empty string' );
}

/**
* Test setup wizard notice with suggest option as 0.
*/
public function testSetupWizardNoticeSuggestOptionAsZero() {
public function testSetupWizardNotice_WhenSuggestOptionIsZero_DoesNotDisplayNotice() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

set_current_screen( 'dashboard' );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 0 );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

// Assert.
$this->assertEmpty( $html, 'Should return empty string' );
}

/**
* Test setup wizard notice with suggest option empty.
*/
public function testSetupWizardNoticeSuggestOptionEmpty() {
public function testSetupWizardNotice_WhenSuggestOptionIsEmpty_DoesNotDisplayNotice() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

set_current_screen( 'dashboard' );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

// Assert.
$this->assertEmpty( $html, 'Should return empty string' );
}

/**
* Test setup wizard notice for no admin user.
*/
public function testSetupWizardNoticeNoAdmin() {
public function testSetupWizardNotice_WhenUserIsNoAdmin_DoesNotDisplayNotice() {
// Arrange.
// Create and login as teacher.
$teacher_id = $this->factory->user->create( array( 'role' => 'teacher' ) );
wp_set_current_user( $teacher_id );

set_current_screen( 'dashboard' );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 0 );
update_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, 1 );

// Act.
ob_start();
Sensei()->setup_wizard->setup_wizard_notice();
$html = ob_get_clean();

// Assert.
$this->assertEmpty( $html, 'Should return empty string' );
}

/**
* Test skip setup wizard.
*/
public function testSkipSetupWizard() {
public function testSkipSetupWizard_WhenArgumentsAreSet_UpdatesOptionToZero() {
// Arrange.
// Create and login as admin.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );

$_GET['sensei_skip_setup_wizard'] = '1';
$_GET['_wpnonce'] = wp_create_nonce( 'sensei_skip_setup_wizard' );

// Act.
Sensei()->setup_wizard->skip_setup_wizard();
$option_value = get_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, false );

// Assert.
$this->assertEquals( '0', $option_value, 'Should update option to 0' );
}

/**
* Test skip setup wizard.
*/
public function testSkipSetupWizardNoAdmin() {
public function testSkipSetupWizard_WhenUserIsNoAdmin_DoesNotUpdateOption() {
// Arrange.
// Create and login as teacher.
$teacher_id = $this->factory->user->create( array( 'role' => 'teacher' ) );
wp_set_current_user( $teacher_id );

$_GET['sensei_skip_setup_wizard'] = '1';
$_GET['_wpnonce'] = wp_create_nonce( 'sensei_skip_setup_wizard' );

// Act.
Sensei()->setup_wizard->skip_setup_wizard();
$option_value = get_option( \Sensei_Setup_Wizard::SUGGEST_SETUP_WIZARD_OPTION, false );

// Assert.
$this->assertFalse( $option_value, 'Should not update option' );
}

/*
* Testing if activation redirect works properly.
*/
public function testActivationRedirect() {
public function testActivationRedirect_WhenRedirectOptionIsOne_CallsRedirect() {
// Arrange.
// Create and login as administrator.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );
Expand All @@ -222,16 +248,19 @@ public function testActivationRedirect() {
->setMethods( [ 'redirect_to_setup_wizard' ] )
->getMock();

// Assert.
$setup_wizard_mock->expects( $this->once() )
->method( 'redirect_to_setup_wizard' );

// Act.
$setup_wizard_mock->activation_redirect();
}

/*
* Testing if activation doesn't redirect for no Sensei screens.
*/
public function testActivationRedirectNoSenseiScreen() {
public function testActivationRedirect_WhenInAPageNotRelatedToSensei_DoesNotCallRedirect() {
// Arrange.
// Create and login as administrator.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );
Expand All @@ -243,16 +272,19 @@ public function testActivationRedirectNoSenseiScreen() {
->setMethods( [ 'redirect_to_setup_wizard' ] )
->getMock();

// Assert.
$setup_wizard_mock->expects( $this->never() )
->method( 'redirect_to_setup_wizard' );

// Act.
$setup_wizard_mock->activation_redirect();
}

/**
* Testing if activation doesn't redirect for no admin user.
*/
public function testActivationRedirectNoAdmin() {
public function testActivationRedirect_WhenUserIsNoAdmin_DoesNotCallRedirect() {
// Arrange.
// Create and login as subscriber.
$subscriber_id = $this->factory->user->create( array( 'role' => 'subscriber' ) );
wp_set_current_user( $subscriber_id );
Expand All @@ -263,16 +295,19 @@ public function testActivationRedirectNoAdmin() {
->setMethods( [ 'redirect_to_setup_wizard' ] )
->getMock();

// Assert.
$setup_wizard_mock->expects( $this->never() )
->method( 'redirect_to_setup_wizard' );

// Act.
$setup_wizard_mock->activation_redirect();
}

/**
* Testing if activation doesn't redirect when transient is not defined.
* Testing if activation doesn't redirect when option does not exist.
*/
public function testActivationRedirectWithoutTransient() {
public function testActivationRedirect_WhenRedirectOptionDoesNotExist_DoesNotCallRedirect() {
// Arrange.
// Create and login as administrator.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );
Expand All @@ -281,29 +316,36 @@ public function testActivationRedirectWithoutTransient() {
->setMethods( [ 'redirect_to_setup_wizard' ] )
->getMock();

// Assert.
$setup_wizard_mock->expects( $this->never() )
->method( 'redirect_to_setup_wizard' );

// Act.
$setup_wizard_mock->activation_redirect();
}

/**
* Testing if redirect option is cleared on setup wizard rendering.
*/
public function testRenderWizardPageClearsRedirectOption() {
public function testRenderWizardPage_WhenRendered_ClearsRedirectOption() {
// Arrange.
update_option( 'sensei_activation_redirect', 1 );

// Act.
Sensei()->setup_wizard->render_wizard_page();

// Assert.
$this->assertFalse( get_option( 'sensei_activation_redirect', false ) );
}

/**
* Test if WooCommerce help tab is being prevented in the Sensei pages.
*/
public function testShouldEnableWooCommerceHelpTab() {
public function testWooCommerceHelpTab_WhenOnCoursePage_ShouldNotPreventTab() {
// Arrange.
$_GET['post_type'] = 'course';

// Act & Assert.
$this->assertFalse(
Sensei()->setup_wizard->should_enable_woocommerce_help_tab( true ),
'Should not allow WooCommerce help tab for course post type'
Expand All @@ -313,9 +355,11 @@ public function testShouldEnableWooCommerceHelpTab() {
/**
* Test if WooCommerce help tab is being untouched in no Sensei pages.
*/
public function testShouldEnableWooCommerceHelpTabNoSenseiPage() {
public function testWooCommerceHelpTab_WhenOnNoSenseiPage_ShouldNotChangeValue() {
// Arrange.
$_GET['post_type'] = 'woocommerce';

// Act & Assert.
$this->assertTrue(
Sensei()->setup_wizard->should_enable_woocommerce_help_tab( true ),
'Should not touch WooCommerce help tab for no Sensei pages'
Expand All @@ -325,7 +369,8 @@ public function testShouldEnableWooCommerceHelpTabNoSenseiPage() {
/**
* Test add setup wizard help tab to edit course screen.
*/
public function testAddSetupWizardHelpTab() {
public function testAddSetupWizardHelpTab_WhenInEditCourse_ShouldAddTab() {
// Arrange.
// Create and login as administrator.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );
Expand All @@ -334,16 +379,20 @@ public function testAddSetupWizardHelpTab() {
$screen = get_current_screen();

$screen->remove_help_tab( 'sensei_lms_setup_wizard_tab' );

// Act.
Sensei()->setup_wizard->add_setup_wizard_help_tab( $screen );
$created_tab = $screen->get_help_tab( 'sensei_lms_setup_wizard_tab' );

// Assert.
$this->assertNotNull( $created_tab, 'Should create the setup wizard tab to edit course screens.' );
}

/**
* Test add setup wizard help tab in non edit course screens.
*/
public function testAddSetupWizardHelpTabNonEditCourseScreen() {
public function testAddSetupWizardHelpTab_WhenNotInEditCourse_ShouldNotAddTab() {
// Arrange.
// Create and login as administrator.
$admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $admin_id );
Expand All @@ -352,16 +401,20 @@ public function testAddSetupWizardHelpTabNonEditCourseScreen() {
$screen = get_current_screen();

$screen->remove_help_tab( 'sensei_lms_setup_wizard_tab' );

// Act.
Sensei()->setup_wizard->add_setup_wizard_help_tab( $screen );
$created_tab = $screen->get_help_tab( 'sensei_lms_setup_wizard_tab' );

// Assert.
$this->assertNull( $created_tab, 'Should not create the setup wizard tab to non edit course screens.' );
}

/**
* Test add setup wizard help tab for no admin user.
*/
public function testAddSetupWizardHelpTabNoAdmin() {
public function testAddSetupWizardHelpTab_WhenUserIsNoAdmin_ShouldNotAddTab() {
// Arrange.
// Create and login as teacher.
$teacher_id = $this->factory->user->create( array( 'role' => 'teacher' ) );
wp_set_current_user( $teacher_id );
Expand All @@ -370,9 +423,12 @@ public function testAddSetupWizardHelpTabNoAdmin() {
$screen = get_current_screen();

$screen->remove_help_tab( 'sensei_lms_setup_wizard_tab' );

// Act.
Sensei()->setup_wizard->add_setup_wizard_help_tab( $screen );
$created_tab = $screen->get_help_tab( 'sensei_lms_setup_wizard_tab' );

// Assert.
$this->assertNull( $created_tab, 'Should not create the setup wizard tab to no admin user.' );
}

Expand Down

0 comments on commit 2d7b8eb

Please sign in to comment.