<!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>[5034] sites/trunk/api.wordpress.org/public_html/events/1.0: Events API: Add automated tests for `get_location()`</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/5034">5034</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/5034","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-03-01 23:13:18 +0000 (Wed, 01 Mar 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 API: Add automated tests for `get_location()`</pre>

<h3>Added Paths</h3>
<ul>
<li>sites/trunk/api.wordpress.org/public_html/events/1.0/tests/</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_htmlevents10teststestindexphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: 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                         (rev 0)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php   2017-03-01 23:13:18 UTC (rev 5034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,252 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace Dotorg\API\Events;
+
+/**
+ * Main entry point
+ */
+function run_tests() {
+       define( 'RUNNING_TESTS', true );
+       require_once( dirname( __DIR__ ) . '/index.php' );
+
+       $failed = 0;
+       $failed += test_get_location();
+
+       printf( "\n\nFinished running all tests. %d failed.\n", $failed );
+}
+
+/**
+ * Output the results of an individual test
+ *
+ * @param int   $case_id
+ * @param bool  $passed
+ * @param mixed $expected_result
+ * @param mixed $actual_result
+ */
+function output_results( $case_id, $passed, $expected_result, $actual_result ) {
+       printf(
+               "\n* %s: %s",
+               $case_id,
+               $passed ? 'PASSED' : '_FAILED_'
+       );
+
+       if ( ! $passed ) {
+               $expected_output = is_scalar( $expected_result ) ? var_export( $expected_result, true ) : print_r( $expected_result, true );
+               $actual_output   = is_scalar( $actual_result   ) ? var_export( $actual_result,   true ) : print_r( $actual_result,   true );
+
+               printf(
+                       "\n\nExpected result: %s\nActual result: %s",
+                       $expected_output,
+                       $actual_output
+               );
+       }
+}
+
+/**
+ * Test `get_location()`
+ *
+ * @return bool The number of failures
+ */
+function test_get_location() {
+       $failed = 0;
+       $cases  = get_location_test_cases();
+
+       printf( "\nRunning %d location tests\n", count( $cases ) );
+
+       foreach ( $cases as $case_id => $case ) {
+               $actual_result = get_location( $case['input'] );
+
+               // Normalize to lowercase to account for inconsistency in the IP database
+               if ( isset( $actual_result['description'] ) && is_string( $actual_result['description'] ) ) {
+                       $actual_result['description'] = strtolower( $actual_result['description'] );
+               }
+
+               $differences = array_diff_assoc( $case['expected'], $actual_result );
+               $passed      = empty( $differences );
+
+               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_location_test_cases() {
+        $cases = array(
+               /*
+                * Only the country is given
+                */
+               'country-australia' => array(
+                       'input' => array(
+                               'country' => 'AU',
+                       ),
+                       'expected' => array(
+                               'country' => 'AU'
+                       ),
+               ),
+
+
+               /*
+                * The city, locale, and timezone are given
+                */
+               'city-africa' => array(
+                       'input' => array(
+                               'location_name' => 'Nairobi',
+                               'locale'        => 'en_GB',
+                               'timezone'      => 'Africa/Nairobi',
+                       ),
+                       'expected' => array(
+                               'description' => 'nairobi',
+                               'latitude'    => '-1.2833300',
+                               'longitude'   => '36.8166700',
+                               'country'     => 'KE',
+                       ),
+               ),
+
+               'city-asia' => array(
+                       'input' => array(
+                               'location_name' => 'Tokyo',
+                               'locale'        => 'ja',
+                               'timezone'      => 'Asia/Tokyo',
+                       ),
+                       'expected' => array(
+                               'description' => 'tokyo',
+                               'latitude'    => '35.6895000',
+                               'longitude'   => '139.6917100',
+                               'country'     => 'JP',
+                       ),
+               ),
+
+               'city-europe' => array(
+                       'input' => array(
+                               'location_name' => 'Berlin',
+                               'locale'        => 'de_DE',
+                               'timezone'      => 'Europe/Berlin',
+                       ),
+                       'expected' => array(
+                               'description' => 'berlin',
+                               'latitude'    => '52.5243700',
+                               'longitude'   => '13.4105300',
+                               'country'     => 'DE',
+                       ),
+               ),
+
+               'city-north-america' => array(
+                       'input' => array(
+                               'location_name' => 'Vancouver',
+                               'locale'        => 'en_CA',
+                               'timezone'      => 'America/Vancouver',
+                       ),
+                       'expected' => array(
+                               'description' => 'vancouver',
+                               'latitude'    => '49.2496600',
+                               'longitude'   => '-123.1193400',
+                               'country'     => 'CA',
+                       ),
+               ),
+
+               'city-oceania' => array(
+                       'input' => array(
+                               'location_name' => 'Brisbane',
+                               'locale'        => 'en_AU',
+                               'timezone'      => 'Australia/Brisbane',
+                       ),
+                       'expected' => array(
+                               'description' => 'brisbane',
+                               'latitude'    => '-27.4679400',
+                               'longitude'   => '153.0280900',
+                               'country'     => 'AU',
+                       ),
+               ),
+
+               'city-south-america' => array(
+                       'input' => array(
+                               'location_name' => 'Sao Paulo',
+                               'locale'        => 'pt_BR',
+                               'timezone'      => 'America/Sao_Paulo',
+                       ),
+                       'expected' => array(
+                               'description' => 'são paulo',
+                               'latitude'    => '-23.5475000',
+                               'longitude'   => '-46.6361100',
+                               'country'     => 'BR',
+                       ),
+               ),
+
+
+               /*
+                * Only the IP is given
+                */
+               'ip-africa' => array(
+                       'input' => array( 'ip' => '41.191.232.22' ),
+                       'expected' => array(
+                               'description' => 'harare',
+                               'latitude'    => '-17.82935',
+                               'longitude'   => '31.05389',
+                               'country'     => 'ZW',
+                       ),
+               ),
+
+               'ip-asia' => array(
+                       'input' => array( 'ip' => '86.108.55.28' ),
+                       'expected' => array(
+                               'description' => 'amman',
+                               'latitude'    => '31.95522',
+                               'longitude'   => '35.94503',
+                               'country'     => 'JO',
+                       ),
+               ),
+
+               'ip-europe' => array(
+                       'input' => array( 'ip' => '80.95.186.144' ),
+                       'expected' => array(
+                               'description' => 'belfast',
+                               'latitude'    => '54.58333',
+                               'longitude'   => '-5.93333',
+                               'country'     => 'GB',
+                       ),
+               ),
+
+               'ip-north-america' => array(
+                       'input' => array( 'ip' => '189.147.186.0' ),
+                       'expected' => array(
+                               'description' => 'mexico city',
+                               'latitude'    => '19.42847',
+                               'longitude'   => '-99.12766',
+                               'country'     => 'MX',
+                       ),
+               ),
+
+               'ip-oceania' => array(
+                       'input' => array( 'ip' => '116.12.57.122' ),
+                       'expected' => array(
+                               'description' => 'auckland',
+                               'latitude'    => '-36.86667',
+                               'longitude'   => '174.76667',
+                               'country'     => 'NZ',
+                       ),
+               ),
+
+               'ip-south-america' => array(
+                       'input' => array( 'ip' => '189.147.186.0' ),
+                       'expected' => array(
+                               'description' => 'mexico city',
+                               'latitude'    => '19.42847',
+                               'longitude'   => '-99.12766',
+                               'country'     => 'MX',
+                       ),
+               ),
+       );
+
+        return $cases;
+}
+
+run_tests();
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.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>