<!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>[6076] sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php: Events: Add tests for `get_events()` and `build_response()`.</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/6076">6076</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/6076","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-11-05 03:06:14 +0000 (Sun, 05 Nov 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: Add tests for `get_events()` and `build_response()`.</pre>
<h3>Modified Paths</h3>
<ul>
<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_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-11-05 03:06:10 UTC (rev 6075)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-11-05 03:06:14 UTC (rev 6076)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +18,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_location();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tests_failed += test_get_events();
+ $tests_failed += test_build_response();
</ins><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $wpdb->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_time = array_sum( array_column( $wpdb->queries, 1 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +41,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $actual_result
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function output_results( $case_id, $passed, $expected_result, $actual_result ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $passed ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> printf(
</span><span class="cx" style="display: block; padding: 0 10px"> "\n* %s: %s",
</span><span class="cx" style="display: block; padding: 0 10px"> $case_id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -843,6 +849,175 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test `get_events()`
+ *
+ * @return bool The number of failures
+ */
+function test_get_events() {
+ $failed = 0;
+ $cases = get_events_test_cases();
+
+ printf( "\n\nRunning %d events tests\n", count( $cases ) );
+
+ foreach ( $cases as $case_id => $case ) {
+ $actual_result = get_events( $case['input'] );
+
+ $passed = $case['expected']['count'] === count( $actual_result ) &&
+ ! empty( $actual_result[0]['url'] ) &&
+ strtotime( $actual_result[0]['date'] ) > time() - ( 2 * 24 * 60 * 60 ) &&
+ $case['expected']['country'] === strtoupper( $actual_result[0]['location']['country'] );
+
+ output_results( $case_id, $passed, $case['expected'], $actual_result );
+
+ if ( ! $passed ) {
+ $failed++;
+ }
+ }
+
+ return $failed;
+}
+
+/**
+ * Get the cases for testing `get_location()`
+ *
+ * @return array
+ */
+function get_events_test_cases() {
+ $cases = array(
+ '2-near-mumbai' => array(
+ 'input' => array(
+ 'number' => '2',
+ 'nearby' => array(
+ 'latitude' => '19.024704',
+ 'longitude' => '72.853966',
+ ),
+ ),
+ 'expected' => array(
+ 'count' => 2,
+ 'country' => 'IN',
+ ),
+ ),
+
+ '1-in-australia' => array(
+ 'input' => array(
+ 'number' => '1',
+ 'country' => 'AU',
+ ),
+ 'expected' => array(
+ 'count' => 1,
+ 'country' => 'AU',
+ ),
+ ),
+ );
+
+ return $cases;
+}
+
+/**
+ * Test `build_response()`
+ *
+ * @todo It might be better to do more abstracted tests of `main()`, rather than coupling to the
+ * internals of `build_request()`.
+ *
+ * @return bool The number of failures
+ */
+function test_build_response() {
+ $failed = 0;
+ $cases = build_response_test_cases();
+
+ printf( "\n\nRunning %d build_response() tests\n", count( $cases ) );
+
+ foreach ( $cases as $case_id => $case ) {
+ $actual_result = build_response( $case['input']['location'], $case['input']['location_args'] );
+
+ $passed = $case['expected']['location'] === $actual_result['location'] &&
+ isset( $case['expected']['error'] ) === isset( $actual_result['error'] );
+
+ if ( $passed && $case['expected']['events'] ) {
+ $passed = ! empty( $actual_result['events'] ) &&
+ ! empty( $actual_result['events'][0]['url'] ) &&
+ strtotime( $actual_result['events'][0]['date'] ) > time() - ( 2 * 24 * 60 * 60 );
+ }
+
+ if ( $passed && isset( $case['expected']['error'] ) ) {
+ $passed = $case['expected']['error'] === $actual_result['error'];
+ }
+
+ output_results( $case_id, $passed, $case['expected'], $actual_result );
+
+ if ( ! $passed ) {
+ $failed++;
+ }
+ }
+
+ return $failed;
+}
+
+/**
+ * Get the cases for testing `build_response()`
+ *
+ * @return array
+ */
+function build_response_test_cases() {
+ $cases = array(
+ 'utrecht-ip' => array(
+ 'input' => array(
+ 'location' => array(
+ 'latitude' => '52.090284',
+ 'longitude' => '5.124719',
+ 'internal' => true,
+ ),
+ 'location_args' => array( 'ip' => '84.31.177.21' ),
+ ),
+ 'expected' => array(
+ 'location' => array(
+ 'ip' => '84.31.177.21',
+ ),
+ 'events' => true,
+ ),
+ ),
+
+ 'canada-country' => array(
+ 'input' => array(
+ 'location' => array(
+ 'country' => 'CA',
+ ),
+ ),
+ 'expected' => array(
+ 'location' => array(
+ 'country' => 'CA',
+ ),
+ 'events' => true,
+ ),
+ ),
+
+ 'throttled' => array(
+ 'input' => array(
+ 'location' => 'temp-request-throttled',
+ ),
+ 'expected' => array(
+ 'location' => array(),
+ 'error' => 'temp-request-throttled',
+ 'events' => false,
+ ),
+ ),
+
+ 'no-location' => array(
+ 'input' => array(
+ 'location' => array(),
+ ),
+ 'expected' => array(
+ 'location' => array(),
+ 'error' => 'no_location_available',
+ 'events' => false,
+ ),
+ ),
+ );
+
+ return $cases;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Stub to simulate cache misses, so that the tests always get fresh results
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false
</span></span></pre>
</div>
</div>
</body>
</html>