vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-03-31 18:54:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Widgets: Introduce media widgets for images, audio, and video with extensible base for additional media widgets in the future.

Browse Source 
The last time a new widget was introduced, Vuvuzelas were a thing, Angry Birds started taking over phones, and WordPress stopped shipping with Kubrick. Seven years and 17 releases without new widgets have been enough, time to spice up your sidebar!

Props westonruter, melchoyce, obenland, timmydcrawford, adamsilverstein, gonom9, wonderboymusic, Fab1en, DrewAPicture, sirbrillig, joen, matias, samikeijonen, afercia, celloexpressions, designsimply, michelleweber, ranh, kjellr, karmatosed.
Fixes #32417, #39993, #39994, #39995.


git-svn-id: https://develop.svn.wordpress.org/trunk@40640 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Weston Ruter
2017-05-11 21:10:54 +00:00
parent 51f545e72a
commit da32c2f630
28 changed files with 6288 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
tests/phpunit/data/images/canola-150x150.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
tests/phpunit/data/images/canola-300x225.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
tests/phpunit/data/uploads/small-audio.mp3 Normal file
View File

Binary file not shown.

BIN
tests/phpunit/data/uploads/small-video.mp4 Normal file
View File

Binary file not shown.

266
tests/phpunit/tests/widgets/media-audio-widget.php Normal file
View File

@@ -0,0 +1,266 @@
<?php
/**
* Unit tests covering WP_Widget_Media_Audio functionality.
*
* @package WordPress
* @subpackage widgets
*/
/**
* Test wp-includes/widgets/class-wp-widget-audio.php
*
* @group widgets
*/
class Test_WP_Widget_Media_Audio extends WP_UnitTestCase {
/**
* Clean up global scope.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
*/
function clean_up_global_scope() {
global $wp_scripts, $wp_styles;
parent::clean_up_global_scope();
$wp_scripts = null;
$wp_styles = null;
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Audio::get_instance_schema
*/
function test_get_instance_schema() {
$wp_widget_audio = new WP_Widget_Media_Audio();
$schema = $wp_widget_audio->get_instance_schema();
$this->assertEqualSets(
array_merge(
array(
'attachment_id',
'preload',
'loop',
'title',
'url',
),
wp_get_audio_extensions()
),
array_keys( $schema )
);
}
/**
* Test constructor.
*
* @covers WP_Widget_Media_Audio::__construct()
*/
function test_constructor() {
$widget = new WP_Widget_Media_Audio();
$this->assertArrayHasKey( 'mime_type', $widget->widget_options );
$this->assertArrayHasKey( 'customize_selective_refresh', $widget->widget_options );
$this->assertArrayHasKey( 'description', $widget->widget_options );
$this->assertTrue( $widget->widget_options['customize_selective_refresh'] );
$this->assertEquals( 'audio', $widget->widget_options['mime_type'] );
$this->assertEqualSets( array(
'add_to_widget',
'replace_media',
'edit_media',
'media_library_state_multi',
'media_library_state_single',
'missing_attachment',
'no_media_selected',
'add_media',
'unsupported_file_type',
), array_keys( $widget->l10n ) );
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Audio::update
*/
function test_update() {
$widget = new WP_Widget_Media_Audio();
$instance = array();
// Should return valid attachment ID.
$expected = array(
'attachment_id' => 1,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment ID.
$result = $widget->update( array(
'attachment_id' => 'media',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid attachment url.
$expected = array(
'url' => 'https://chickenandribs.org',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment url.
$result = $widget->update( array(
'url' => 'not_a_url',
), $instance );
$this->assertNotSame( $result, $instance );
$this->assertStringStartsWith( 'http://', $result['url'] );
// Should return loop setting.
$expected = array(
'loop' => true,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid loop setting.
$result = $widget->update( array(
'loop' => 'not-boolean',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid attachment title.
$expected = array(
'title' => 'An audio sample of parrots',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment title.
$result = $widget->update( array(
'title' => '<h1>Cute Baby Goats</h1>',
), $instance );
$this->assertNotSame( $result, $instance );
// Should return valid preload setting.
$expected = array(
'preload' => 'none',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid preload setting.
$result = $widget->update( array(
'preload' => 'nope',
), $instance );
$this->assertSame( $result, $instance );
// Should filter invalid key.
$result = $widget->update( array(
'h4x' => 'value',
), $instance );
$this->assertSame( $result, $instance );
}
/**
* Test render_media method.
*
* @covers WP_Widget_Media_Audio::render_media
*/
function test_render_media() {
$test_audio_file = __FILE__ . '../../data/uploads/small-audio.mp3';
$widget = new WP_Widget_Media_Audio();
$attachment_id = self::factory()->attachment->create_object( array(
'file' => $test_audio_file,
'post_parent' => 0,
'post_mime_type' => 'audio/mp3',
'post_title' => 'Test Audio',
) );
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $test_audio_file ) );
// Should be empty when there is no attachment_id.
ob_start();
$widget->render_media( array() );
$output = ob_get_clean();
$this->assertEmpty( $output );
// Should be empty when there is an invalid attachment_id.
ob_start();
$widget->render_media( array(
'attachment_id' => 777,
) );
$output = ob_get_clean();
$this->assertEmpty( $output );
// Tests with audio from library.
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
) );
$output = ob_get_clean();
// Check default outputs.
$this->assertContains( 'preload="none"', $output );
$this->assertContains( 'class="wp-audio-shortcode"', $output );
$this->assertContains( 'small-audio.mp3', $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'title' => 'Funny',
'preload' => 'auto',
'loop' => true,
) );
$output = ob_get_clean();
// Custom attributes.
$this->assertContains( 'preload="auto"', $output );
$this->assertContains( 'loop="1"', $output );
}
/**
* Test enqueue_preview_scripts method.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
* @covers WP_Widget_Media_Audio::enqueue_preview_scripts
*/
function test_enqueue_preview_scripts() {
global $wp_scripts, $wp_styles;
$wp_scripts = null;
$wp_styles = null;
$widget = new WP_Widget_Media_Audio();
$this->assertFalse( wp_script_is( 'wp-mediaelement' ) );
$this->assertFalse( wp_style_is( 'wp-mediaelement' ) );
$widget->enqueue_preview_scripts();
$this->assertTrue( wp_script_is( 'wp-mediaelement' ) );
$this->assertTrue( wp_style_is( 'wp-mediaelement' ) );
}
/**
* Test enqueue_admin_scripts method.
*
* @covers WP_Widget_Media_Audio::enqueue_admin_scripts
*/
function test_enqueue_admin_scripts() {
set_current_screen( 'widgets.php' );
$widget = new WP_Widget_Media_Audio();
$widget->enqueue_admin_scripts();
$this->assertTrue( wp_script_is( 'media-audio-widget' ) );
}
/**
* Test render_control_template_scripts method.
*
* @covers WP_Widget_Media_Audio::render_control_template_scripts
*/
function test_render_control_template_scripts() {
$widget = new WP_Widget_Media_Audio();
ob_start();
$widget->render_control_template_scripts();
$output = ob_get_clean();
$this->assertContains( '<script type="text/html" id="tmpl-wp-media-widget-audio-preview">', $output );
}
}

480
tests/phpunit/tests/widgets/media-image-widget.php Normal file
View File

@@ -0,0 +1,480 @@
<?php
/**
* Unit tests covering WP_Widget_Media_Image functionality.
*
* @package WordPress
* @subpackage widgets
*/
/**
* Test wp-includes/widgets/class-wp-widget-image.php
*
* @group widgets
*/
class Test_WP_Widget_Media_Image extends WP_UnitTestCase {
/**
* Clean up global scope.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
*/
function clean_up_global_scope() {
global $wp_scripts, $wp_styles;
parent::clean_up_global_scope();
$wp_scripts = null;
$wp_styles = null;
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Image::get_instance_schema
*/
function test_get_instance_schema() {
$widget = new WP_Widget_Media_Image();
$schema = $widget->get_instance_schema();
$this->assertEqualSets( array(
'alt',
'attachment_id',
'caption',
'height',
'image_classes',
'image_title',
'link_classes',
'link_rel',
'link_target_blank',
'link_type',
'link_url',
'size',
'title',
'url',
'width',
), array_keys( $schema ) );
}
/**
* Test constructor.
*
* @covers WP_Widget_Media_Image::__construct()
*/
function test_constructor() {
$widget = new WP_Widget_Media_Image();
$this->assertArrayHasKey( 'mime_type', $widget->widget_options );
$this->assertArrayHasKey( 'customize_selective_refresh', $widget->widget_options );
$this->assertArrayHasKey( 'description', $widget->widget_options );
$this->assertTrue( $widget->widget_options['customize_selective_refresh'] );
$this->assertEquals( 'image', $widget->widget_options['mime_type'] );
$this->assertEqualSets( array(
'add_to_widget',
'replace_media',
'edit_media',
'media_library_state_multi',
'media_library_state_single',
'missing_attachment',
'no_media_selected',
'add_media',
'unsupported_file_type',
), array_keys( $widget->l10n ) );
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Image::update
*/
function test_update() {
$widget = new WP_Widget_Media_Image();
$instance = array();
// Should return valid attachment ID.
$expected = array(
'attachment_id' => 1,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment ID.
$result = $widget->update( array(
'attachment_id' => 'media',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid attachment url.
$expected = array(
'url' => 'https://example.org',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment url.
$result = $widget->update( array(
'url' => 'not_a_url',
), $instance );
$this->assertNotSame( $result, $instance );
$this->assertStringStartsWith( 'http://', $result['url'] );
// Should return valid attachment title.
$expected = array(
'title' => 'What a title',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment title.
$result = $widget->update( array(
'title' => '<h1>W00t!</h1>',
), $instance );
$this->assertNotSame( $result, $instance );
// Should return valid image size.
$expected = array(
'size' => 'thumbnail',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image size.
$result = $widget->update( array(
'size' => 'big league',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid image width.
$expected = array(
'width' => 300,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image width.
$result = $widget->update( array(
'width' => 'wide',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid image height.
$expected = array(
'height' => 200,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image height.
$result = $widget->update( array(
'height' => 'high',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid image caption.
$expected = array(
'caption' => 'A caption with <a href="#">link</a>',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image caption.
$result = $widget->update( array(
'caption' => '"><i onload="alert(\'hello\')" />',
), $instance );
$this->assertSame( $result, array(
'caption' => '"&gt;<i />',
) );
// Should return valid alt text.
$expected = array(
'alt' => 'A water tower',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid alt text.
$result = $widget->update( array(
'alt' => '"><i onload="alert(\'hello\')" />',
), $instance );
$this->assertSame( $result, array(
'alt' => '">',
) );
// Should return valid link type.
$expected = array(
'link_type' => 'file',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid link type.
$result = $widget->update( array(
'link_type' => 'interesting',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid link url.
$expected = array(
'link_url' => 'https://example.org',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid link url.
$result = $widget->update( array(
'link_url' => 'not_a_url',
), $instance );
$this->assertNotSame( $result, $instance );
$this->assertStringStartsWith( 'http://', $result['link_url'] );
// Should return valid image classes.
$expected = array(
'image_classes' => 'A water tower',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image classes.
$result = $widget->update( array(
'image_classes' => '"><i onload="alert(\'hello\')" />',
), $instance );
$this->assertSame( $result, array(
'image_classes' => 'i onloadalerthello',
) );
// Should return valid link classes.
$expected = array(
'link_classes' => 'A water tower',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid link classes.
$result = $widget->update( array(
'link_classes' => '"><i onload="alert(\'hello\')" />',
), $instance );
$this->assertSame( $result, array(
'link_classes' => 'i onloadalerthello',
) );
// Should return valid rel text.
$expected = array(
'link_rel' => 'previous',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid rel text.
$result = $widget->update( array(
'link_rel' => '"><i onload="alert(\'hello\')" />',
), $instance );
$this->assertSame( $result, array(
'link_rel' => 'i onloadalerthello',
) );
// Should return valid link target.
$expected = array(
'link_target_blank' => false,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid link target.
$result = $widget->update( array(
'link_target_blank' => 'top',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid image title.
$expected = array(
'image_title' => 'What a title',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid image title.
$result = $widget->update( array(
'image_title' => '<h1>W00t!</h1>',
), $instance );
$this->assertNotSame( $result, $instance );
// Should filter invalid key.
$result = $widget->update( array(
'imaginary_key' => 'value',
), $instance );
$this->assertSame( $result, $instance );
}
/**
* Test render_media method.
*
* @covers WP_Widget_Media_Image::render_media
*/
function test_render_media() {
$widget = new WP_Widget_Media_Image();
$attachment_id = self::factory()->attachment->create_object( array(
'file' => DIR_TESTDATA . '/images/canola.jpg',
'post_parent' => 0,
'post_mime_type' => 'image/jpeg',
'post_title' => 'Canola',
) );
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, DIR_TESTDATA . '/images/canola.jpg' ) );
// Should be empty when there is no attachment_id.
ob_start();
$widget->render_media( array() );
$output = ob_get_clean();
$this->assertEmpty( $output );
// Should be empty when there is an invalid attachment_id.
ob_start();
$widget->render_media( array(
'attachment_id' => 666,
) );
$output = ob_get_clean();
$this->assertEmpty( $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
) );
$output = ob_get_clean();
// No default title.
$this->assertNotContains( 'title="', $output );
// Default image classes.
$this->assertContains( 'class="image wp-image-' . $attachment_id, $output );
$this->assertContains( 'style="max-width: 100%; height: auto;"', $output );
$this->assertContains( 'alt=""', $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'image_title' => 'Custom Title',
'image_classes' => 'custom-class',
'alt' => 'A flower',
'size' => 'custom',
'width' => 100,
'height' => 100,
) );
$output = ob_get_clean();
// Custom image title.
$this->assertContains( 'title="Custom Title"', $output );
// Custom image class.
$this->assertContains( 'class="image wp-image-' . $attachment_id . ' custom-class', $output );
$this->assertContains( 'alt="A flower"', $output );
$this->assertContains( 'width="100"', $output );
$this->assertContains( 'height="100"', $output );
// Embeded images.
ob_start();
$widget->render_media( array(
'attachment_id' => null,
'caption' => 'With caption',
'height' => 100,
'link_type' => 'file',
'url' => 'http://example.org/url/to/image.jpg',
'width' => 100,
) );
$output = ob_get_clean();
// Custom image class.
$this->assertContains( 'src="http://example.org/url/to/image.jpg"', $output );
// Link settings.
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'link_type' => 'file',
) );
$output = ob_get_clean();
$link = '<a href="' . wp_get_attachment_url( $attachment_id ) . '"';
$this->assertContains( $link, $output );
$link .= ' class=""';
$this->assertContains( $link, $output );
$link .= ' rel=""';
$this->assertContains( $link, $output );
$link .= ' target=""';
$this->assertContains( $link, $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'link_type' => 'post',
'link_classes' => 'custom-link-class',
'link_rel' => 'attachment',
'link_target_blank' => false,
) );
$output = ob_get_clean();
$this->assertContains( '<a href="' . get_attachment_link( $attachment_id ) . '"', $output );
$this->assertContains( 'class="custom-link-class"', $output );
$this->assertContains( 'rel="attachment"', $output );
$this->assertContains( 'target=""', $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'link_type' => 'custom',
'link_url' => 'https://example.org',
'link_target_blank' => true,
) );
$output = ob_get_clean();
$this->assertContains( '<a href="https://example.org"', $output );
$this->assertContains( 'target="_blank"', $output );
// Caption settings.
wp_update_post( array(
'ID' => $attachment_id,
'post_excerpt' => 'Default caption',
) );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
) );
$output = ob_get_clean();
$this->assertContains( 'class="wp-caption alignnone"', $output );
$this->assertContains( '<p class="wp-caption-text">Default caption</p>', $output );
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'caption' => 'Custom caption',
) );
$output = ob_get_clean();
$this->assertContains( 'class="wp-caption alignnone"', $output );
$this->assertContains( '<p class="wp-caption-text">Custom caption</p>', $output );
}
/**
* Test enqueue_admin_scripts method.
*
* @covers WP_Widget_Media_Image::enqueue_admin_scripts
*/
function test_enqueue_admin_scripts() {
set_current_screen( 'widgets.php' );
$widget = new WP_Widget_Media_Image();
$widget->enqueue_admin_scripts();
$this->assertTrue( wp_script_is( 'media-image-widget' ) );
}
/**
* Test render_control_template_scripts method.
*
* @covers WP_Widget_Media_Image::render_control_template_scripts
*/
function test_render_control_template_scripts() {
$widget = new WP_Widget_Media_Image();
ob_start();
$widget->render_control_template_scripts();
$output = ob_get_clean();
$this->assertContains( '<script type="text/html" id="tmpl-wp-media-widget-image-preview">', $output );
}
}

292
tests/phpunit/tests/widgets/media-video-widget.php Normal file
View File

@@ -0,0 +1,292 @@
<?php
/**
* Unit tests covering WP_Widget_Media_Video functionality.
*
* @package WordPress
* @subpackage widgets
*/
/**
* Test wp-includes/widgets/class-wp-widget-video.php
*
* @group widgets
*/
class Test_WP_Widget_Media_Video extends WP_UnitTestCase {
/**
* Clean up global scope.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
*/
function clean_up_global_scope() {
global $wp_scripts, $wp_styles;
parent::clean_up_global_scope();
$wp_scripts = null;
$wp_styles = null;
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Video::get_instance_schema()
*/
function test_get_instance_schema() {
$widget = new WP_Widget_Media_Video();
$schema = $widget->get_instance_schema();
$this->assertEqualSets(
array_merge(
array(
'attachment_id',
'preload',
'loop',
'title',
'url',
'content',
),
wp_get_video_extensions()
),
array_keys( $schema )
);
}
/**
* Test constructor.
*
* @covers WP_Widget_Media_Video::__construct()
*/
function test_constructor() {
$widget = new WP_Widget_Media_Video();
$this->assertArrayHasKey( 'mime_type', $widget->widget_options );
$this->assertArrayHasKey( 'customize_selective_refresh', $widget->widget_options );
$this->assertArrayHasKey( 'description', $widget->widget_options );
$this->assertTrue( $widget->widget_options['customize_selective_refresh'] );
$this->assertEquals( 'video', $widget->widget_options['mime_type'] );
$this->assertEqualSets( array(
'add_to_widget',
'replace_media',
'unsupported_file_type',
'edit_media',
'media_library_state_multi',
'media_library_state_single',
'missing_attachment',
'no_media_selected',
'add_media',
), array_keys( $widget->l10n ) );
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media_Video::update()
*/
function test_update() {
$widget = new WP_Widget_Media_Video();
$instance = array();
// Should return valid attachment ID.
$expected = array(
'attachment_id' => 1,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment ID.
$result = $widget->update( array(
'attachment_id' => 'media',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid attachment url.
$expected = array(
'url' => 'https://chickenandribs.org',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment url.
$result = $widget->update( array(
'url' => 'not_a_url',
), $instance );
$this->assertNotSame( $result, $instance );
$this->assertStringStartsWith( 'http://', $result['url'] );
// Should return loop setting.
$expected = array(
'loop' => true,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid loop setting.
$result = $widget->update( array(
'loop' => 'not-boolean',
), $instance );
$this->assertSame( $result, $instance );
// Should return valid attachment title.
$expected = array(
'title' => 'A video of goats',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment title.
$result = $widget->update( array(
'title' => '<h1>Cute Baby Goats</h1>',
), $instance );
$this->assertNotSame( $result, $instance );
// Should return valid preload setting.
$expected = array(
'preload' => 'none',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid preload setting.
$result = $widget->update( array(
'preload' => 'nope',
), $instance );
$this->assertSame( $result, $instance );
// Should filter invalid key.
$result = $widget->update( array(
'h4x' => 'value',
), $instance );
$this->assertSame( $result, $instance );
}
/**
* Test render_media method.
*
* @covers WP_Widget_Media_Video::render_media()
* @covers WP_Widget_Media_Video::inject_video_max_width_style()
*/
function test_render_media() {
$test_movie_file = __FILE__ . '../../data/uploads/small-video.m4v';
$widget = new WP_Widget_Media_Video();
$attachment_id = self::factory()->attachment->create_object( array(
'file' => $test_movie_file,
'post_parent' => 0,
'post_mime_type' => 'video/mp4',
'post_title' => 'Test Video',
) );
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $test_movie_file ) );
// Should be empty when there is no attachment_id.
ob_start();
$widget->render_media( array() );
$output = ob_get_clean();
$this->assertEmpty( $output );
// Should be empty when there is an invalid attachment_id.
ob_start();
$widget->render_media( array(
'attachment_id' => 777,
) );
$output = ob_get_clean();
$this->assertEmpty( $output );
// Tests with video from library.
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
) );
$output = ob_get_clean();
// Check default outputs.
$this->assertContains( 'preload="metadata"', $output );
$this->assertContains( 'class="wp-video"', $output );
$this->assertContains( 'width:100%', $output );
$this->assertNotContains( 'height=', $output );
$this->assertNotContains( 'width="', $output );
$this->assertContains( 'small-video.m4v', $output );// Auto parses dimensions.
ob_start();
$widget->render_media( array(
'attachment_id' => $attachment_id,
'title' => 'Open Source Cartoon',
'preload' => 'metadata',
'loop' => true,
) );
$output = ob_get_clean();
// Custom attributes.
$this->assertContains( 'preload="metadata"', $output );
$this->assertContains( 'loop="1"', $output );
// Externally hosted video.
ob_start();
$content = '<track srclang="en" label="English" kind="subtitles" src="http://example.com/wp-content/uploads/2017/04/subtitles-en.vtt">';
$widget->render_media( array(
'attachment_id' => null,
'loop' => false,
'url' => 'https://www.youtube.com/watch?v=OQSNhk5ICTI',
'content' => $content,
) );
$output = ob_get_clean();
// Custom attributes.
$this->assertContains( 'preload="metadata"', $output );
$this->assertContains( 'src="https://www.youtube.com/watch?v=OQSNhk5ICTI', $output );
$this->assertContains( $content, $output );
}
/**
* Test enqueue_preview_scripts method.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
* @covers WP_Widget_Media_Video::enqueue_preview_scripts()
*/
function test_enqueue_preview_scripts() {
global $wp_scripts, $wp_styles;
$widget = new WP_Widget_Media_Video();
$wp_scripts = null;
$wp_styles = null;
$widget->enqueue_preview_scripts();
$this->assertTrue( wp_script_is( 'wp-mediaelement' ) );
$this->assertTrue( wp_style_is( 'wp-mediaelement' ) );
$this->assertTrue( wp_script_is( 'froogaloop' ) );
$wp_scripts = null;
$wp_styles = null;
add_filter( 'wp_video_shortcode_library', '__return_empty_string' );
$widget->enqueue_preview_scripts();
$this->assertFalse( wp_script_is( 'wp-mediaelement' ) );
$this->assertFalse( wp_style_is( 'wp-mediaelement' ) );
$this->assertTrue( wp_script_is( 'froogaloop' ) );
}
/**
* Test enqueue_admin_scripts method.
*
* @covers WP_Widget_Media_Video::enqueue_admin_scripts()
*/
function test_enqueue_admin_scripts() {
set_current_screen( 'widgets.php' );
$widget = new WP_Widget_Media_Video();
$widget->enqueue_admin_scripts();
$this->assertTrue( wp_script_is( 'media-video-widget' ) );
}
/**
* Test render_control_template_scripts method.
*
* @covers WP_Widget_Media_Video::render_control_template_scripts()
*/
function test_render_control_template_scripts() {
$widget = new WP_Widget_Media_Video();
ob_start();
$widget->render_control_template_scripts();
$output = ob_get_clean();
$this->assertContains( '<script type="text/html" id="tmpl-wp-media-widget-video-preview">', $output );
}
}

467
tests/phpunit/tests/widgets/media-widget.php Normal file
View File

@@ -0,0 +1,467 @@
<?php
/**
* Unit tests covering WP_Widget_Media functionality.
*
* @package WordPress
* @subpackage widgets
*/
/**
* Class Test_WP_Widget_Media
*
* @group widgets
*/
class Test_WP_Widget_Media extends WP_UnitTestCase {
/**
* Clean up global scope.
*
* @global WP_Scripts $wp_scripts
* @global WP_Styles $wp_styles
*/
function clean_up_global_scope() {
global $wp_scripts, $wp_styles;
parent::clean_up_global_scope();
$wp_scripts = null;
$wp_styles = null;
}
/**
* Get instance for mocked media widget class.
*
* @param string $id_base Base ID for the widget, lowercase and unique.
* @param string $name Name for the widget displayed on the configuration page.
* @param array $widget_options Optional. Widget options.
* @param array $control_options Optional. Widget control options.
* @return PHPUnit_Framework_MockObject_MockObject|WP_Widget_Media Mocked instance.
*/
function get_mocked_class_instance( $id_base = 'mocked', $name = 'Mocked', $widget_options = array(), $control_options = array() ) {
$original_class_name = 'WP_Widget_Media';
$arguments = array( $id_base, $name, $widget_options, $control_options );
$mock_class_name = '';
$call_original_constructor = true;
$call_original_clone = true;
$call_autoload = true;
$mocked_methods = array( 'render_media' );
return $this->getMockForAbstractClass( $original_class_name, $arguments, $mock_class_name, $call_original_constructor, $call_original_clone, $call_autoload, $mocked_methods );
}
/**
* Test constructor.
*
* @covers WP_Widget_Media::__construct()
* @covers WP_Widget_Media::_register()
*/
function test_constructor() {
$widget = $this->get_mocked_class_instance();
$widget->_register();
$this->assertArrayHasKey( 'mime_type', $widget->widget_options );
$this->assertArrayHasKey( 'customize_selective_refresh', $widget->widget_options );
$this->assertArrayHasKey( 'description', $widget->widget_options );
$this->assertTrue( $widget->widget_options['customize_selective_refresh'] );
$this->assertEmpty( $widget->widget_options['mime_type'] );
$this->assertEqualSets( array(
'add_to_widget',
'replace_media',
'edit_media',
'media_library_state_multi',
'media_library_state_single',
'missing_attachment',
'no_media_selected',
'add_media',
'unsupported_file_type',
), array_keys( $widget->l10n ) );
$this->assertEquals( count( $widget->l10n ), count( array_filter( $widget->l10n ) ), 'Expected all translation strings to be defined.' );
$this->assertEquals( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
$this->assertFalse( has_action( 'wp_enqueue_scripts', array( $widget, 'enqueue_preview_scripts' ) ), 'Did not expect preview scripts to be enqueued when not in customize preview context.' );
$this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( $widget, 'render_control_template_scripts' ) ) );
// With non-default args.
$id_base = 'media_pdf';
$name = 'PDF';
$widget_options = array(
'mime_type' => 'application/pdf',
);
$control_options = array(
'width' => 850,
'height' => 1100,
);
$widget = $this->get_mocked_class_instance( $id_base, $name, $widget_options, $control_options );
$this->assertEquals( $id_base, $widget->id_base );
$this->assertEquals( $name, $widget->name );
// Method assertArraySubset doesn't exist in phpunit versions compatible with PHP 5.2.
if ( method_exists( $this, 'assertArraySubset' ) ) {
$this->assertArraySubset( $widget_options, $widget->widget_options );
$this->assertArraySubset( $control_options, $widget->control_options );
}
}
/**
* Test constructor in customize preview.
*
* @global WP_Customize_Manager $wp_customize
* @covers WP_Widget_Media::__construct()
* @covers WP_Widget_Media::_register()
*/
function test_constructor_in_customize_preview() {
global $wp_customize;
wp_set_current_user( $this->factory()->user->create( array(
'role' => 'administrator',
) ) );
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
$wp_customize = new WP_Customize_Manager( array(
'changeset_uuid' => wp_generate_uuid4(),
) );
$wp_customize->start_previewing_theme();
$widget = $this->get_mocked_class_instance();
$widget->_register();
$this->assertEquals( 10, has_action( 'wp_enqueue_scripts', array( $widget, 'enqueue_preview_scripts' ) ) );
}
/**
* Test is_attachment_with_mime_type method.
*
* @covers WP_Widget_Media::is_attachment_with_mime_type
*/
function test_is_attachment_with_mime_type() {
$attachment_id = self::factory()->attachment->create_object( array(
'file' => DIR_TESTDATA . '/images/canola.jpg',
'post_parent' => 0,
'post_mime_type' => 'image/jpeg',
'post_title' => 'Canola',
) );
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, DIR_TESTDATA . '/images/canola.jpg' ) );
$widget = $this->get_mocked_class_instance();
$this->assertFalse( $widget->is_attachment_with_mime_type( 0, 'image' ) );
$this->assertFalse( $widget->is_attachment_with_mime_type( -123, 'image' ) );
$post_id = $this->factory()->post->create();
$this->assertFalse( $widget->is_attachment_with_mime_type( $post_id, 'image' ) );
$this->assertFalse( $widget->is_attachment_with_mime_type( $attachment_id, 'video' ) );
$this->assertTrue( $widget->is_attachment_with_mime_type( $attachment_id, 'image' ) );
}
/**
* Test sanitize_token_list method.
*
* @covers WP_Widget_Media::sanitize_token_list
*/
function test_sanitize_token_list_string() {
$widget = $this->get_mocked_class_instance();
$result = $widget->sanitize_token_list( 'What A false class with-token <a href="#">and link</a>' );
$this->assertEquals( 'What A false class with-token a hrefand linka', $result );
$result = $widget->sanitize_token_list( array( 'foo', '<i>bar', '">NO' ) );
$this->assertEquals( $result, 'foo ibar NO' );
}
/**
* Test get_instance_schema method.
*
* @covers WP_Widget_Media::get_instance_schema
*/
function test_get_instance_schema() {
$widget = $this->get_mocked_class_instance();
$schema = $widget->get_instance_schema();
$this->assertEqualSets( array(
'attachment_id',
'title',
'url',
), array_keys( $schema ) );
}
/**
* Test update method.
*
* @covers WP_Widget_Media::update()
*/
function test_update() {
$widget = $this->get_mocked_class_instance();
$instance = array();
// Should return valid attachment ID.
$expected = array(
'attachment_id' => 1,
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment ID.
$result = $widget->update(
array(
'attachment_id' => 'media',
),
$instance
);
$this->assertSame( $result, $instance );
// Should return valid attachment url.
$expected = array(
'url' => 'https://example.org',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment url.
$result = $widget->update(
array(
'url' => 'not_a_url',
),
$instance
);
$this->assertNotSame( $result, $instance );
// Should return valid attachment title.
$expected = array(
'title' => 'What a title',
);
$result = $widget->update( $expected, $instance );
$this->assertSame( $result, $expected );
// Should filter invalid attachment title.
$result = $widget->update(
array(
'title' => '<h1>W00t!</h1>',
),
$instance
);
$this->assertNotSame( $result, $instance );
// Should filter invalid key.
$result = $widget->update(
array(
'imaginary_key' => 'value',
),
$instance
);
$this->assertSame( $result, $instance );
add_filter( 'sanitize_text_field', array( $this, '_return_wp_error' ) );
$result = $widget->update(
array(
'title' => 'Title',
),
$instance
);
remove_filter( 'sanitize_text_field', array( $this, '_return_wp_error' ) );
$this->assertSame( $result, $instance );
}
/**
* Helper function for Test_WP_Widget_Media::test_update().
*
* @return \WP_Error
*/
function _return_wp_error() {
return new WP_Error( 'some-error', 'This is not valid!' );
}
/**
* Test widget method.
*
* @covers WP_Widget_Media::widget()
* @covers WP_Widget_Media::render_media()
*/
function test_widget() {
$args = array(
'before_title' => '<h2>',
'after_title' => "</h2>\n",
'before_widget' => '<section>',
'after_widget' => "</section>\n",
);
$instance = array(
'title' => 'Foo',
'url' => 'http://example.com/image.jpg',
'attachment_id' => 0,
);
add_filter( 'widget_mocked_instance', array( $this, 'filter_widget_mocked_instance' ), 10, 3 );
ob_start();
$widget = $this->get_mocked_class_instance();
$widget->expects( $this->atLeastOnce() )->method( 'render_media' )->with( $instance );
$this->widget_instance_filter_args = array();
$widget->widget( $args, $instance );
$this->assertCount( 3, $this->widget_instance_filter_args );
$this->assertEquals( $instance, $this->widget_instance_filter_args[0] );
$this->assertEquals( $args, $this->widget_instance_filter_args[1] );
$this->assertEquals( $widget, $this->widget_instance_filter_args[2] );
$output = ob_get_clean();
$this->assertContains( '<h2>Foo</h2>', $output );
$this->assertContains( '<section>', $output );
$this->assertContains( '</section>', $output );
// No title.
ob_start();
$widget = $this->get_mocked_class_instance();
$instance['title'] = '';
$widget->expects( $this->atLeastOnce() )->method( 'render_media' )->with( $instance );
$widget->widget( $args, $instance );
$output = ob_get_clean();
$this->assertNotContains( '<h2>Foo</h2>', $output );
// No attachment_id nor url.
$instance['url'] = '';
$instance['attachment_id'] = 0;
ob_start();
$widget = $this->get_mocked_class_instance();
$widget->widget( $args, $instance );
$output = ob_get_clean();
$this->assertEmpty( $output );
}
/**
* Args passed to the widget_{$id_base}_instance filter.
*
* @var array
*/
protected $widget_instance_filter_args = array();
/**
* Filters the media widget instance prior to rendering the media.
*
* @param array $instance Instance data.
* @param array $args Widget args.
* @param WP_Widget_Media $object Widget object.
* @return array Instance.
*/
function filter_widget_mocked_instance( $instance, $args, $object ) {
$this->widget_instance_filter_args = func_get_args();
return $instance;
}
/**
* Test form method.
*
* @covers WP_Widget_Media::form()
*/
function test_form() {
$widget = $this->get_mocked_class_instance();
ob_start();
$widget->form( array() );
$output = ob_get_clean();
$this->assertContains( 'name="widget-mocked[][attachment_id]"', $output );
$this->assertContains( 'name="widget-mocked[][title]"', $output );
$this->assertContains( 'name="widget-mocked[][url]"', $output );
}
/**
* Test display_media_state method.
*
* @covers WP_Widget_Media::display_media_state()
*/
function test_display_media_state() {
$widget = $this->get_mocked_class_instance();
$attachment_id = self::factory()->attachment->create_object( array(
'file' => DIR_TESTDATA . '/images/canola.jpg',
'post_parent' => 0,
'post_mime_type' => 'image/jpeg',
) );
$result = $widget->display_media_state( array(), get_post( $attachment_id ) );
$this->assertEqualSets( array(), $result );
$widget->save_settings( array(
array(
'attachment_id' => $attachment_id,
),
) );
$result = $widget->display_media_state( array(), get_post( $attachment_id ) );
$this->assertEqualSets( array( $widget->l10n['media_library_state_single'] ), $result );
$widget->save_settings( array(
array(
'attachment_id' => $attachment_id,
),
array(
'attachment_id' => $attachment_id,
),
) );
$result = $widget->display_media_state( array(), get_post( $attachment_id ) );
$this->assertEqualSets( array( sprintf( $widget->l10n['media_library_state_multi']['singular'], 2 ) ), $result );
}
/**
* Test enqueue_admin_scripts method.
*
* @covers WP_Widget_Media::enqueue_admin_scripts()
*/
function test_enqueue_admin_scripts() {
set_current_screen( 'widgets.php' );
$widget = $this->get_mocked_class_instance();
$widget->enqueue_admin_scripts();
$this->assertTrue( wp_script_is( 'media-widgets' ) );
}
/**
* Test render_control_template_scripts method.
*
* @covers WP_Widget_Media::render_control_template_scripts
*/
function test_render_control_template_scripts() {
$widget = $this->get_mocked_class_instance();
ob_start();
$widget->render_control_template_scripts();
$output = ob_get_clean();
$this->assertContains( '<script type="text/html" id="tmpl-widget-media-mocked-control">', $output );
}
/**
* Test has_content method.
*
* @covers WP_Widget_Media::has_content()
*/
function test_has_content() {
if ( version_compare( PHP_VERSION, '5.3', '<' ) ) {
$this->markTestSkipped( 'ReflectionMethod::setAccessible is only available for PHP 5.3+' );
return;
}
$attachment_id = self::factory()->attachment->create_object( array(
'file' => DIR_TESTDATA . '/images/canola.jpg',
'post_parent' => 0,
'post_mime_type' => 'image/jpeg',
) );
$wp_widget_media = new ReflectionClass( 'WP_Widget_Media' );
$has_content = $wp_widget_media->getMethod( 'has_content' );
$has_content->setAccessible( true );
$result = $has_content->invokeArgs( $this->get_mocked_class_instance(), array(
array(
'attachment_id' => 0,
'url' => '',
),
) );
$this->assertFalse( $result );
$result = $has_content->invokeArgs( $this->get_mocked_class_instance(), array(
array(
'attachment_id' => $attachment_id,
'url' => '',
),
) );
$this->assertTrue( $result );
$result = $has_content->invokeArgs( $this->get_mocked_class_instance(), array(
array(
'attachment_id' => 0,
'url' => 'http://example.com/image.jpg',
),
) );
$this->assertTrue( $result );
}
}

4
tests/phpunit/tests/widgets/text-widget.php
View File

@@ -178,15 +178,15 @@ class Test_WP_Widget_Text extends WP_UnitTestCase {
$expected['text'] = $instance['text'];
$result = $widget->update( $instance, array() );
$this->assertEquals( $result, $expected );
remove_filter( 'map_meta_cap', array( $this, 'grant_unfiltered_html_cap' ) );
add_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
$this->assertFalse( current_user_can( 'unfiltered_html' ) );
$instance['text'] = '<script>alert( "Howdy!" );</script>';
$expected['text'] = wp_kses_post( $instance['text'] );
$result = $widget->update( $instance, array() );
$this->assertEquals( $result, $expected );
remove_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
remove_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10 );
}
/**