<!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>[5558] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Replace object caching with stubs when running tests</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 { 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="http://meta.trac.wordpress.org/changeset/5558">5558</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/5558","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-06-08 20:18:20 +0000 (Thu, 08 Jun 2017)</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'>Events: Replace object caching with stubs when running tests
Previously the object cache was enabled during tests, but it was bypassed by adding a cachebuster to the input. That was broken by <a href="http://meta.trac.wordpress.org/changeset/5552">r5552</a>, because the cache keys are no longer built with the entire input. It wasn't immediately apparent, because the tests continued to pass as expected.
This commit changes that approach, so that the tests never load the object cache in the first place, and simply stub its functions instead.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-06-08 18:48:05 UTC (rev 5557)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-06-08 20:18:20 UTC (rev 5558)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,7 +10,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $cache_group, $cache_life;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> bootstrap();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_init();
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuit some requests if a traffic spike is larger than we can handle.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,6 +29,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $cache_group = 'events';
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_life = 12 * 60 * 60;
</span><span class="cx" style="display: block; padding: 0 10px"> $ttl = 12 * 60 * 60; // Time the client should cache the document.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,8 +49,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require( $base_dir . '/init.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( $base_dir . '/includes/hyperdb/bb-10-hyper-db.php' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- include( $base_dir . '/includes/object-cache.php' );
</del><span class="cx" style="display: block; padding: 0 10px"> include( $base_dir . '/includes/wp-json-encode.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! defined( 'RUNNING_TESTS' ) || ! RUNNING_TESTS ) {
+ include( $base_dir . '/includes/object-cache.php' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-06-08 18:48:05 UTC (rev 5557)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-06-08 20:18:20 UTC (rev 5558)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,22 +58,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add a cachebusting parameter to bypass the object cache
- *
- * Cache keys are generated based on the function's input arguments (e.g., get_location()), so adding a unique
- * parameter on every function call ensures that the unit tests will never get a cached result.
- *
- * @param array $arguments
- *
- * @return array
- */
-function add_cachebusting_parameter( $arguments ) {
- $arguments['cachebuster'] = microtime( true );
-
- return $arguments;
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Test `get_location()`
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool The number of failures
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,7 +69,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> printf( "\nRunning %d location tests\n", count( $cases ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $cases as $case_id => $case ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $case['input'] = add_cachebusting_parameter( $case['input'] );
</del><span class="cx" style="display: block; padding: 0 10px"> $actual_result = get_location( $case['input'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Normalize to lowercase to account for inconsistency in the IP database
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -859,4 +842,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $cases;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Stub to simulate cache misses, so that the tests always get fresh results
+ *
+ * @return false
+ */
+function wp_cache_get() {
+ return false;
+}
+
+/**
+ * Stub to simulate cache misses, so that the tests always get fresh results
+ */
+function wp_cache_set() {
+ // Intentionally empty
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> run_tests();
</span></span></pre>
</div>
</div>
</body>
</html>