Add a method to JavascriptTestBase to help users debug HTML [#2773763]

Problem/Motivation

When I write FunctionalJavascript tests using the JavascriptTestBase, I often find myself writing the same code over and over again to save the headless browser's HTML at an arbitrary point and debug it after a test fails. It would be helpful is this was an actual method in JavascriptTestBase so that users could easily debug their tests.

Proposed resolution

Add a debug method to JavascriptTestBase which saves the browser's current (as opposed to the original HTML response from drupalGet) HTML to a file.

Remaining tasks

Review.

User interface changes

None.

API changes

A new protected method is added to JavascriptTestBase.

Data model changes

None.

Comment	File	Size	Author
	drupal-js-testing-save-html.patch	1.99 KB	samuel.mortenson
	8.2.x: PHP 5.5 & MySQL 5.5 18,722 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

27 July 2016 at 21:11

samuel.mortenson created an issue. See original summary.

Comment #2

samuel.mortenson

he/him

English

CreditAttribution: samuel.mortenson at Acquia commented 27 July 2016 at 21:29

Issue tags:

+JavaScript, +JavaScriptTest

Comment #3

dawehner

German

CreditAttribution: dawehner at Chapter Three commented 27 July 2016 at 21:51

+++ b/core/tests/Drupal/FunctionalJavascriptTests/JavascriptTestBase.php
@@ -109,4 +109,15 @@ public function assertSession($name = NULL) {
 
+  /**
+   * Saves the current HTML from our headless browser.
+   *
+   * @param string $filename
+   *   The file name of the resulting HTML file.
+   */
+  protected function saveCurrentHTML($filename) {
+    $html = $this->getSession()->getDriver()->getHtml('/html');
+    file_put_contents($filename, $html);
+  }
+
 }

Actually ... this is useful even in BrowserTestBase itself, but then I guess we could have different tests for this test helper :) One for the classical browser test, and one for the javascript one, as you have already.

Comment #4

27 July 2016 at 21:51

Version:

8.2.x-dev

» 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #5

27 July 2016 at 21:51

Version:

8.3.x-dev

» 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #6

27 July 2016 at 21:51

Version:

8.4.x-dev

» 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #7

27 July 2016 at 21:51

Version:

8.5.x-dev

» 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #8

27 July 2016 at 21:51

Version:

8.6.x-dev

» 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #9

27 July 2016 at 21:51

Version:

8.7.x-dev

» 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Comment #10

27 July 2016 at 21:51

Version:

8.8.x-dev

» 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Comment #11

27 July 2016 at 21:51

Version:

8.9.x-dev

» 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Comment #12

27 July 2016 at 21:51

Version:

9.1.x-dev

» 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Comment #13

27 July 2016 at 21:51

Version:

9.2.x-dev

» 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Comment #14

27 July 2016 at 21:51

Version:

9.3.x-dev

» 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.