>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #2807237. --> Reported by: [klausi](https://www.drupal.org/user/262198) >>> <h3 id="background">Background</h3> <p>We want to get rid of simpletest.module in Drupal 9. We want to prepare the latest Drupal 8 development branch as much as possible before opening the Drupal 9 development branch (see <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2608062" title="Status: Closed (fixed)">#2608062: [META] Requirements for tagging Drupal 9.0.0-alpha1</a></span>). Therefore we need to convert all web tests to BrowserTestBase or UnitTestBase or KernelTestBase and deprecate WebTestBase.</p> <p>More discussion can be found in the original phpunit conversion issue at <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2735005" title="Status: Closed (fixed)">#2735005: Convert all Simpletest web tests to BrowserTestBase (or UnitTestBase/KernelTestBase)</a></span>.</p> <h3 id="summary-process-big-bang">Process for the big bang conversion patch (DONE!)</h3> <p>Because changing tests to a new system is a disruptive change we want to schedule a date in February 2017 where we commit one "big bang" patch prepared in <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2770921" title="Status: Closed (fixed)">#2770921: Feb 21st: Convert chunk of WTB to BTB by just moving classes, changing use statements adding traits</a></span>. It will contain scripted test case conversions where only files are moved to use BrowsertestBase.</p> <ul> <li>There will be a Drupal core fork on Github that has a branch which contains all the conversions <a href="https://github.com/klausi/drupal/tree/8.3.x-phpunit">https://github.com/klausi/drupal/tree/8.3.x-phpunit</a> </li> <li>klausi and dawehner will regularly push conversions to that branch.</li> <li>We will regularly create patches from that branch and post it to <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2770921" title="Status: Closed (fixed)">#2770921: Feb 21st: Convert chunk of WTB to BTB by just moving classes, changing use statements adding traits</a></span>.</li> <li>We will trigger multiple test runs on all the testbot environments so that we always check for random test fails.</li> <li>We will reach out to the community on groups.drupal.org and social media to inform them of the exact date where we will commit this conversion patch. It will be an announced scheduled change.</li> </ul> <h3>Converting Simpletests per module</h3> <p>After this big bang patch is committed there will be some remaining Simpletests that we need to convert to PHPUnit manually per module. This is coordinated in <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2735005" title="Status: Closed (fixed)">#2735005: Convert all Simpletest web tests to BrowserTestBase (or UnitTestBase/KernelTestBase)</a></span>.</p> <p>We will deprecate Simpletest's WebTestBase in 8.4.x, but not for 8.3.x releases. Between the release of 8.3.0 and 8.4.0 we will polish our PHPUnit browser tests and then WebTestBase will be deprecated and forbidden for new tests with the release of 8.4.0 in October 2017. See <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2847678" title="Status: Closed (fixed)">#2847678: Deprecate WebTestBase and its required classes in favour of BrowserTestBase</a></span>.</p> <h3 id="summary-process-compatibility">Process for compatibility and better tests</h3> <p>As a parallel effort we will improve the compatibility layer between the old WebTestBase and BrowserTestBase. Those issues will be committed to Drupal core immediately when they are ready (no need to wait for them until February 2017.</p> <ul> <li><span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2794285" title="Status: Closed (fixed)">#2794285: [meta] Add backwards compatibility layer to browsertestbase to ease conversion from webtestcase</a></span></li> <li>Convert web tests to kernel tests that don't use a browser at all.</li> <li><span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2809161" title="Status: Closed (fixed)">#2809161: Convert Javascript/AJAX testing to use JavascriptTestBase</a></span></li> <li>Improve AssertLegacyTrait for maximum compatibility with SimpleTest.</li> <li>Experiment with forwards compatible additions to WebTestBase (example: a clone of xpath() method to return Mink DomDocument objects instead of SimpleXML): <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-5"><a href="https://www.drupal.org/project/drupal/issues/2809181" title="Status: Closed (won't fix)">#2809181: Provide forward compatibility layer for BrowserTestBase::xpath</a></span></li> <li>Complex conversions are researched on top of it, for example for upgrade path tests: <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-17"><a href="https://www.drupal.org/project/drupal/issues/2808777" title="Status: Closed (outdated)">#2808777: Research: Complex tests to convert</a></span></li> <li>Monitor random test fails that come up during testing the big bang patch like <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2808085" title="Status: Closed (fixed)">#2808085: Pipe char in locators break Mink and Symfony element search</a></span></li> <li>Evaluate using Selenium and PhantomJS for JavascriptTestBase and alternatives <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2775653" title="Status: Closed (fixed)">#2775653: JavascriptTests with webDriver</a></span></li> <li><span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2809117" title="Status: Closed (fixed)">#2809117: Integrate PHPUnit verbose output in Simpletest UI</a></span></li> <li><span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2850797" title="Status: Closed (fixed)">#2850797: Prepare our phpunit tests to be BC compatible with phpunit 5.x/6.x</a></span></li> </ul> <h3 id="summary-docs">Documentation updates</h3> <ul> <li>Update code comments and in-code documentation to describe phpunit-based browser tests <span class="drupalorg-gitlab-issue-link project-issue-status-info project-issue-status-7"><a href="https://www.drupal.org/project/drupal/issues/2810621" title="Status: Closed (fixed)">#2810621: Improve core.api.php documentation about browsertests and javascript tests</a></span></li> <li>The <a href="https://www.drupal.org/node/2783189">PHPUnit browser test tutorial</a> needs review.</li> <li>Improve the <a href="https://www.drupal.org/docs/8/phpunit/phpunit-javascript-testing-tutorial">tutorial for JavaScript browser tests</a></li> <li>A single high-level overview of Drupal's PHPUnit testing APIs, summarizing what PHPUnit is at a high level, and listing out the four kinds of tests you can add (unit, kernel, browser, and JS) and when to use each. Each would provide links to the more in-depth documentation for that type of test.</li> <li><a href="https://www.drupal.org/contributor-tasks/write-tests">https://www.drupal.org/contributor-tasks/write-tests</a> should be updated (ands probably link relevant D8 documentation so that it doesn't get stale in the future)</li> </ul> <h3 id="summary-not-scope">Not in scope</h3> <p>todo</p> <h3 id="summary-team">Team and resources</h3> <p><strong>Initiative coordinators:</strong></p> <ul> <li><a href="https://www.drupal.org/u/dawehner"></a>Daniel Wehner</li> <li>(likely) <a href="https://www.drupal.org/u/michielnugter">michielnugter</a></li> <li>(likely) <a href="https://www.drupal.org/u/lendude">Lendude</a></li> </ul> <p><strong>Communication and planning:</strong><br> todo</p> <p><strong>Regular contributors</strong></p> <ul> <li>Claudiu Cristea (claudiu.cristea)</li> <li>Matt Glaman (mglaman)</li> <li>Jibran Ijaz (jibran)</li> <li><a href="https://www.drupal.org/u/larowlan">larowlan</a> when time permits</li> <li><a href="https://www.drupal.org/u/naveenvalecha">naveenvalecha</a></li> <li><a href="https://www.drupal.org/u/mile23">Mile23</a></li> <li>Please add yourself ...</li> </ul> <p><strong>Senior advisors</strong><br> oh yeah, we need that too. Maybe @alexpott?</p> <p><strong><a href="https://www.drupal.org/irc">IRC</a>: #drupal-phpunit</strong><br> <strong><a href="https://drupal.slack.com/">slack</a>: #phpunit</strong></p> <h3>Issue creation</h3> <p>Please add the tag 'phpunit initiative' to every issue and add the issue to the correct Component (if it's a test for the comment module, add it to comment.module).</p> <h3 id="summary-singoffs">Signoffs</h3> <p>We have signoffs from a Drupal 8 release manager (xjm) and a Drupal 8 framework manager (alexpott) as well as Dries.</p> > Related issue: [Issue #2834021](https://www.drupal.org/node/2834021) > Related issue: [Issue #2866082](https://www.drupal.org/node/2866082) > Related issue: [Issue #3027952](https://www.drupal.org/node/3027952)