<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[50789] trunk/tests/phpunit/tests/bookmark/getBookmark.php: Build/Tests tools: Improve `get_bookmark()` test coverage.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/50789">50789</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/50789","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-26 00:58:14 +0000 (Mon, 26 Apr 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Build/Tests tools: Improve `get_bookmark()` test coverage.
Props hellofromtonya, peterwilsoncc.
See <a href="https://core.trac.wordpress.org/ticket/52988">#52988</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsbookmarkgetBookmarkphp">trunk/tests/phpunit/tests/bookmark/getBookmark.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsbookmarkgetBookmarkphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/bookmark/getBookmark.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/bookmark/getBookmark.php (rev 0)
+++ trunk/tests/phpunit/tests/bookmark/getBookmark.php 2021-04-26 00:58:14 UTC (rev 50789)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,398 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group bookmark
+ * @covers ::get_bookmark
+ */
+class Tests_Bookmark_GetBookmark extends WP_UnitTestCase {
+ /**
+ * Instance of the bookmark object.
+ *
+ * @var stdClass
+ */
+ private static $bookmark;
+
+ /**
+ * Create and get a bookmark for the tests.
+ *
+ * @param WP_UnitTest_Factory $factory
+ */
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$bookmark = $factory->bookmark->create_and_get();
+ // Delete the bookmark that was cached when the factory invoked get_bookmark().
+ wp_cache_delete( self::$bookmark->link_id, 'bookmark' );
+ }
+
+ /**
+ * Delete the bookmark before existing the test class.
+ */
+ public static function wpTearDownAfterClass() {
+ wp_delete_link( self::$bookmark->link_id );
+ }
+
+ /**
+ * Reset globals after each test.
+ */
+ public function tearDown() {
+ unset( $GLOBALS['link'] );
+ parent::tearDown();
+ }
+
+ /**
+ * Path 1A: Given empty bookmark and global link exists.
+ *
+ * @dataProvider data_when_empty_bookmark
+ */
+ public function test_should_return_global_link_in_requested_output_format( $args ) {
+ $GLOBALS['link'] = self::$bookmark;
+ $args = $this->init_func_args( $args, 0 );
+ $actual_bookmark = get_bookmark( ...$args );
+
+ $expected = $this->maybe_format_expected_data( $args, $GLOBALS['link'] );
+
+ $this->assertArrayHasKey( 'link', $GLOBALS );
+ $this->assertSame( $expected, $actual_bookmark );
+ // Should bypass the cache.
+ $this->assertFalse( wp_cache_get( self::$bookmark->link_id, 'bookmark' ) );
+ }
+
+ /**
+ * Path 1B: Given empty bookmark and global link does not exist.
+ *
+ * @dataProvider data_when_empty_bookmark
+ */
+ public function test_should_return_null( $args ) {
+ $args = $this->init_func_args( $args, 0 );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ $this->assertArrayNotHasKey( 'link', $GLOBALS );
+ $this->assertNull( $actual_bookmark );
+ $this->assertFalse( wp_cache_get( self::$bookmark->link_id, 'bookmark' ) );
+ }
+
+ /**
+ * Path 1 data provider, i.e. when given empty bookmark.
+ */
+ public function data_when_empty_bookmark() {
+ return array(
+ // Unhappy path.
+ 'with bookmark type mismatch' => array(
+ array(
+ 'bookmark' => '',
+ ),
+ ),
+ 'with invalid output' => array(
+ array(
+ 'bookmark' => 0,
+ 'output' => 'invalid',
+ ),
+ ),
+ 'with bookmark type mismatch and invalid output' => array(
+ array(
+ 'bookmark' => null,
+ 'output' => 'invalid',
+ ),
+ ),
+ // Happy path.
+ 'with defaults' => array(
+ array(
+ 'bookmark' => 0,
+ ),
+ ),
+ 'with non-default output' => array(
+ array(
+ 'bookmark' => 0,
+ 'output' => ARRAY_A,
+ ),
+ ),
+ 'with non-default filter' => array(
+ array(
+ 'bookmark' => 0,
+ 'filter' => 'display',
+ ),
+ ),
+ 'with non-default output and filter' => array(
+ array(
+ 'bookmark' => 0,
+ 'output' => ARRAY_N,
+ 'filter' => 'display',
+ ),
+ ),
+ );
+ }
+
+ /**
+ * Path 2: Bookmark instance is given.
+ *
+ * @dataProvider data_when_instance_bookmark
+ */
+ public function test_should_cache_bookmark_when_given_instance( $args ) {
+ $args = $this->init_func_args( $args );
+ $bookmark = $args[0];
+ $expected = $this->maybe_format_expected_data( $args, $bookmark );
+
+ // Check the cache does not exist before the test.
+ $this->assertFalse( wp_cache_get( $bookmark->link_id, 'bookmark' ) );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ $this->assertSame( $expected, $actual_bookmark );
+
+ // Check the bookmark was cached.
+ $actual_cache = wp_cache_get( $bookmark->link_id, 'bookmark' );
+ $this->assertEquals( $bookmark, $actual_cache );
+ }
+
+ /**
+ * Path 2 data provider, i.e. when bookmark instance is given.
+ */
+ public function data_when_instance_bookmark() {
+ return array(
+ // Unhappy path.
+ 'with incomplete bookmark data' => array(
+ array(
+ 'bookmark' => (object) array(
+ 'link_id' => '100',
+ ),
+ ),
+ ),
+ 'with invalid output' => array(
+ array(
+ 'output' => 'invalid',
+ ),
+ ),
+ 'with invalid filter' => array(
+ array(
+ 'filter' => 'invalid',
+ ),
+ ),
+ // Happy path.
+ 'with defaults' => array(
+ array(),
+ ),
+ 'with non-default output' => array(
+ array(
+ 'output' => ARRAY_A,
+ ),
+ ),
+ 'with non-default filter' => array(
+ array(
+ 'filter' => 'display',
+ ),
+ ),
+ 'with non-default output and filter' => array(
+ array(
+ 'output' => ARRAY_N,
+ 'filter' => 'display',
+ ),
+ ),
+ );
+ }
+
+ /**
+ * Path 3A: Uses the global link when exists and the given bookmark link ID matches the global link.
+ *
+ * @dataProvider data_when_else
+ *
+ * @param array $args Function argument list.
+ */
+ public function test_should_return_global_when_else( $args ) {
+ $args = $this->init_func_args( $args, self::$bookmark->link_id );
+ $GLOBALS['link'] = self::$bookmark;
+ $expected = $this->maybe_format_expected_data( $args, $GLOBALS['link'] );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ $this->assertSame( $expected, $actual_bookmark );
+ $this->assertFalse( wp_cache_get( self::$bookmark->link_id, 'bookmark' ) );
+ }
+
+ /**
+ * Path 3B: Pulls from cache when given existing bookmark link ID.
+ *
+ * @dataProvider data_when_else
+ *
+ * @param array $args Function argument list.
+ */
+ public function test_should_return_cached_bookmark_when_given_existing_link_id( $args ) {
+ // Cache the bookmark instance to setup the test.
+ wp_cache_add( self::$bookmark->link_id, self::$bookmark, 'bookmark' );
+ $args = $this->init_func_args( $args, self::$bookmark->link_id );
+ $expected = $this->maybe_format_expected_data( $args, self::$bookmark );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ /*
+ * For non-array output type, use assetEquals. Why? The object pulled from cache will have the same
+ * property values but will be a different object than the expected object.
+ */
+ if ( is_object( $expected ) ) {
+ $this->assertEquals( $expected, $actual_bookmark );
+ } else {
+ $this->assertSameSets( $expected, $actual_bookmark );
+ }
+
+ // Check the bookmark was cached.
+ $actual_cache = wp_cache_get( self::$bookmark->link_id, 'bookmark' );
+ $this->assertEquals( self::$bookmark, $actual_cache );
+ }
+
+ /**
+ * Path 3C: Attempts to pull non-existent bookmark from database.
+ *
+ * @dataProvider data_when_else
+ *
+ * @param array $args Function argument list.
+ */
+ public function test_should_return_null_when_bookmark_not_in_database( $args ) {
+ $bookmark_link_id = self::$bookmark->link_id * 100;
+ $args = $this->init_func_args( $args, $bookmark_link_id );
+
+ // Validate it will run path 6.
+ $this->assertFalse( wp_cache_get( $bookmark_link_id, 'bookmark' ) );
+ $this->assertArrayNotHasKey( 'link', $GLOBALS );
+ global $wpdb;
+ $db_actual = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark_link_id ) );
+ $this->assertNull( $db_actual );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ $this->assertNull( $actual_bookmark );
+ $this->assertFalse( wp_cache_get( $bookmark_link_id, 'bookmark' ) );
+ }
+
+ /**
+ * Path 3D: Pulls existing bookmark from the database.
+ *
+ * @dataProvider data_when_else
+ *
+ * @param array $args Function argument list.
+ */
+ public function test_should_return_existing_bookmark_from_database( $args ) {
+ $args = $this->init_func_args( $args, self::$bookmark->link_id );
+ $expected = $this->maybe_format_expected_data( $args, self::$bookmark );
+
+ // Validate it will run path 5.
+ $this->assertFalse( wp_cache_get( self::$bookmark->link_id, 'bookmark' ) );
+ $this->assertArrayNotHasKey( 'link', $GLOBALS );
+
+ // Run the function and test results.
+ $actual_bookmark = get_bookmark( ...$args );
+
+ /*
+ * For non-array output type, use assetEquals. Why? The object pulled from the database will have the same
+ * property values but will be a different object than the expected object.
+ */
+ if ( is_object( $expected ) ) {
+ $this->assertEquals( $expected, $actual_bookmark );
+ } else {
+ $this->assertSameSets( $expected, $actual_bookmark );
+ }
+
+ // Check the bookmark was cached.
+ $actual_cache = wp_cache_get( self::$bookmark->link_id, 'bookmark' );
+ $this->assertEquals( self::$bookmark, $actual_cache );
+ }
+
+ /**
+ * Path 3's data provider which covers the "else" branch, i.e. when the bookmark argument is not empty and
+ * not an object.
+ */
+ public function data_when_else() {
+ return array(
+ // Unhappy path.
+ 'with invalid output' => array(
+ array(
+ 'output' => 'invalid',
+ ),
+ ),
+ 'with invalid filter' => array(
+ array(
+ 'filter' => 'invalid',
+ ),
+ ),
+ // Happy path.
+ 'with defaults' => array(
+ array(),
+ ),
+ 'with non-default output' => array(
+ array(
+ 'output' => ARRAY_A,
+ ),
+ ),
+ 'with non-default filter' => array(
+ array(
+ 'filter' => 'display',
+ ),
+ ),
+ 'with non-default output and filter' => array(
+ array(
+ 'output' => ARRAY_N,
+ 'filter' => 'display',
+ ),
+ ),
+ );
+ }
+
+ /**
+ * Initialize the get_bookmark's function arguments to match the order of the function's signature and
+ * reduce code in the tests.
+ *
+ * @param array $args Function argument list.
+ * @param int|stdClass $bookmark Optional. Bookmark's cache key or instance.
+ * @return array Ordered argument list.
+ */
+ private function init_func_args( array $args, $bookmark = null ) {
+ // The defaults sets the order to match the function's arguments as well as setting the default values.
+ $defaults = array(
+ 'bookmark' => self::$bookmark,
+ 'output' => OBJECT,
+ 'filter' => 'raw',
+ );
+ $args = array_merge( $defaults, $args );
+
+ // When given a bookmark, use it.
+ if ( ! is_null( $bookmark ) ) {
+ $args['bookmark'] = $bookmark;
+ }
+
+ /*
+ * Strip out the keys. Why? The splat operator (...) does not work with associative arrays,
+ * except for in PHP 8 where the keys are named arguments.
+ */
+ return array_values( $args );
+ }
+
+ /**
+ * Maybe format the bookmark's expected data.
+ *
+ * @param array $args Function argument list.
+ * @param int|stdClass|null $bookmark Optional. Bookmark's cache key or instance.
+ * @return array|stdClass bookmark's data.
+ */
+ private function maybe_format_expected_data( array $args, $bookmark = null ) {
+ if ( is_null( $bookmark ) ) {
+ $bookmark = self::$bookmark;
+ }
+
+ switch ( $args[1] ) {
+ case ARRAY_A:
+ case ARRAY_N:
+ $expected = get_object_vars( $bookmark );
+
+ if ( ARRAY_N === $args[1] ) {
+ $expected = array_values( $expected );
+ }
+
+ return $expected;
+ default:
+ return $bookmark;
+ }
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/bookmark/getBookmark.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>