<!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>[30658] trunk/tests/phpunit: `wp_upload_dir()` has a (little-known?) side effect: if you call it, it will attempt to create an uploads directory for the current month.</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="https://core.trac.wordpress.org/changeset/30658">30658</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/30658","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-30 19:05:52 +0000 (Sun, 30 Nov 2014)</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'>`wp_upload_dir()` has a (little-known?) side effect: if you call it, it will attempt to create an uploads directory for the current month. As such, `tearDown()` and cleanup routines have to be in sync with this behavior when deleting bogus directories used in unit tests.
Examples: if you clean up directories in a test, or a test fails before the directories are cleaned, or a test fails before the `'upload_path'` option is reset, the next call to `wp_upload_dir()` will recreate the directories you just tried to delete.
These changes ensure that `src/foo` and `/tmp/wp-unit-test` directories are deleted immediately after `wp_upload_dir()` is fired in the tests.
Fixes <a href="https://core.trac.wordpress.org/ticket/30513">#30513</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludestestcasephp">trunk/tests/phpunit/includes/testcase.php</a></li>
<li><a href="#trunktestsphpunittestsuploadphp">trunk/tests/phpunit/tests/upload.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludestestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase.php 2014-11-30 12:20:04 UTC (rev 30657)
+++ trunk/tests/phpunit/includes/testcase.php 2014-11-30 19:05:52 UTC (rev 30658)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -483,6 +483,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $files;
</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">+ function delete_folders( $path ) {
+ $this->matched_dirs = array();
+ if ( ! is_dir( $path ) ) {
+ return;
+ }
+
+ $this->scandir( $path );
+ foreach ( array_reverse( $this->matched_dirs ) as $dir ) {
+ rmdir( $dir );
+ }
+ rmdir( $path );
+ }
+
+ function scandir( $dir ) {
+ foreach ( scandir( $dir ) as $path ) {
+ if ( 0 !== strpos( $path, '.' ) && is_dir( $dir . '/' . $path ) ) {
+ $this->matched_dirs[] = $dir . '/' . $path;
+ $this->scandir( $dir . '/' . $path );
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Helper to Convert a microtime string into a float
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsuploadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/upload.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/upload.php 2014-11-30 12:20:04 UTC (rev 30657)
+++ trunk/tests/phpunit/tests/upload.php 2014-11-30 19:05:52 UTC (rev 30658)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,6 +1,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group upload
</span><span class="cx" style="display: block; padding: 0 10px"> * @group media
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,23 +8,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var $siteurl;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function setUp() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_multisite() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->knownUTBug( 35 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->_reset_options();
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+
+ function _reset_options() {
</ins><span class="cx" style="display: block; padding: 0 10px"> // system defaults
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_path', 'wp-content/uploads' );
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_url_path', '' );
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'uploads_use_yearmonth_folders', 1 );
</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">- function tearDown() {
- $this->remove_added_uploads();
-
- parent::tearDown();
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_default() {
</span><span class="cx" style="display: block; padding: 0 10px"> // wp_upload_dir() with default parameters
</span><span class="cx" style="display: block; padding: 0 10px"> $info = wp_upload_dir();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,6 +36,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // wp_upload_dir() with a relative upload path that is not 'wp-content/uploads'
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_path', 'foo/bar' );
</span><span class="cx" style="display: block; padding: 0 10px"> $info = wp_upload_dir();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->delete_folders( ABSPATH . 'foo' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( get_option( 'siteurl' ) . '/foo/bar/' . gmstrftime('%Y/%m'), $info['url'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( ABSPATH . 'foo/bar/' . gmstrftime('%Y/%m'), $info['path'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +54,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // doesn't make sense to use an absolute file path without setting the url path
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_url_path', '/baz' );
</span><span class="cx" style="display: block; padding: 0 10px"> $info = wp_upload_dir();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->delete_folders( $path );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '/baz/' . gmstrftime('%Y/%m'), $info['url'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( "$path/" . gmstrftime('%Y/%m'), $info['path'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
</span></span></pre>
</div>
</div>
</body>
</html>