<!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>[53895] trunk: Build/Test Tools: Move the Memcached container into the Docker Compose config.</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/53895">53895</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/53895","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-08-13 23:23:26 +0000 (Sat, 13 Aug 2022)</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/Test Tools: Move the Memcached container into the Docker Compose config.
This allows a developer to use the persistent Memcached object cache on their local development environment via the `LOCAL_PHP_MEMCACHED` environment variable.
Enable the memcached config via `LOCAL_PHP_MEMCACHED=true` in the `.env` file and then restart the environment with `npm run env:restart`.
Fixes <a href="https://core.trac.wordpress.org/ticket/55700">#55700</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowsphpunittestsyml">trunk/.github/workflows/phpunit-tests.yml</a></li>
<li><a href="#trunkdockercomposeyml">trunk/docker-compose.yml</a></li>
<li><a href="#trunktoolslocalenvscriptsstartjs">trunk/tools/local-env/scripts/start.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowsphpunittestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/phpunit-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/phpunit-tests.yml 2022-08-13 22:44:10 UTC (rev 53894)
+++ trunk/.github/workflows/phpunit-tests.yml 2022-08-13 23:23:26 UTC (rev 53895)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,7 +46,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # - Installs Composer dependencies.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs Docker debug information (about the Docker installation within the runner).
</span><span class="cx" style="display: block; padding: 0 10px"> # - Starts the WordPress Docker container.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Starts the Memcached server after the Docker network has been created (if desired).
</del><span class="cx" style="display: block; padding: 0 10px"> # - Logs general debug information about the runner.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs the running Docker containers.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs debug information from inside the WordPress Docker container.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,13 +158,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> run: |
</span><span class="cx" style="display: block; padding: 0 10px"> npm run env:start
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # The memcached server needs to start after the Docker network has been set up with `npm run env:start`.
- - name: Start the Memcached server.
- if: ${{ matrix.memcached }}
- run: |
- cp tests/phpunit/includes/object-cache.php src/wp-content/object-cache.php
- docker run --name memcached --net $(basename "$PWD")_wpdevnet -d memcached
-
</del><span class="cx" style="display: block; padding: 0 10px"> - name: General debug information
</span><span class="cx" style="display: block; padding: 0 10px"> run: |
</span><span class="cx" style="display: block; padding: 0 10px"> npm --version
</span></span></pre></div>
<a id="trunkdockercomposeyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docker-compose.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docker-compose.yml 2022-08-13 22:44:10 UTC (rev 53894)
+++ trunk/docker-compose.yml 2022-08-13 23:23:26 UTC (rev 53895)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,6 +49,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - ./tools/local-env/php-config.ini:/usr/local/etc/php/conf.d/php-config.ini
</span><span class="cx" style="display: block; padding: 0 10px"> - ./:/var/www
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # Copy or delete the Memcached dropin plugin file as appropriate.
+ command: /bin/sh -c "if [ $LOCAL_PHP_MEMCACHED = true ]; then cp -n /var/www/tests/phpunit/includes/object-cache.php /var/www/src/wp-content/object-cache.php; else rm -f /var/www/src/wp-content/object-cache.php; fi && exec php-fpm"
+
</ins><span class="cx" style="display: block; padding: 0 10px"> depends_on:
</span><span class="cx" style="display: block; padding: 0 10px"> - mysql
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,6 +107,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> extra_hosts:
</span><span class="cx" style="display: block; padding: 0 10px"> - localhost:host-gateway
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ##
+ # The Memcached container.
+ ##
+ memcached:
+ image: memcached
+
+ networks:
+ - wpdevnet
+
+ ports:
+ - 11211:11211
+
</ins><span class="cx" style="display: block; padding: 0 10px"> volumes:
</span><span class="cx" style="display: block; padding: 0 10px"> # So that sites aren't wiped every time containers are restarted, MySQL uses a persistent volume.
</span><span class="cx" style="display: block; padding: 0 10px"> mysql: {}
</span></span></pre></div>
<a id="trunktoolslocalenvscriptsstartjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/local-env/scripts/start.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/local-env/scripts/start.js 2022-08-13 22:44:10 UTC (rev 53894)
+++ trunk/tools/local-env/scripts/start.js 2022-08-13 23:23:26 UTC (rev 53895)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,7 +9,10 @@
</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"> // Start the local-env containers.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-execSync( 'docker-compose up -d wordpress-develop', { stdio: 'inherit' } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const containers = ( process.env.LOCAL_PHP_MEMCACHED === 'true' )
+ ? 'wordpress-develop memcached'
+ : 'wordpress-develop';
+execSync( `docker-compose up -d -- ${containers}`, { stdio: 'inherit' } );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If Docker Toolbox is being used, we need to manually forward LOCAL_PORT to the Docker VM.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) {
</span></span></pre>
</div>
</div>
</body>
</html>