moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 16:36:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-43911 Behat: Save dumps of the page content to disk on scenario failure

Browse source
This commit is contained in:
Andrew Nicols 2014-01-29 23:18:15 +08:00
parent c5a229c2f1
commit b954cb004c
2 changed files with 69 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
config-dist.php
View file

@ -667,9 +667,11 @@ $CFG->admin = 'admin';
// Example: // Example:
// $CFG->behat_extraallowedsettings = array('logsql', 'dblogerror'); // $CFG->behat_extraallowedsettings = array('logsql', 'dblogerror');
// //
// You can make behat save a screenshot when a scenario fails. // You can make behat save several dumps when a scenario fails. The dumps currently saved are:
// * a dump of the DOM in it's state at the time of failure; and
// * a screenshot (JavaScript is required for the screenshot functionality, so not all browsers support this option)
// Example: // Example:
// $CFG->behat_screenshots_path = '/my/path/to/save/screenshots'; // $CFG->behat_faildump_path = '/my/path/to/save/failure/dumps';
// //
//========================================================================= //=========================================================================
// 12. DEVELOPER DATA GENERATOR // 12. DEVELOPER DATA GENERATOR

85
lib/tests/behat/behat_hooks.php
View file

@ -78,11 +78,11 @@ class behat_hooks extends behat_base {
protected static $currentstepexception = null; protected static $currentstepexception = null;
/** /**
* If we are saving screenshots on failures we should use the same parent dir during a run. * If we are saving any kind of dump on failure we should use the same parent dir during a run.
* *
* @var The parent dir name * @var The parent dir name
*/ */
protected static $screenshotsdirname = false; protected static $faildumpdirname = false;
/** /**
* Gives access to moodle codebase, ensures all is ready and sets up the test lock. * Gives access to moodle codebase, ensures all is ready and sets up the test lock.
@ -142,8 +142,8 @@ class behat_hooks extends behat_base {
self::$lastbrowsersessionstart = time(); self::$lastbrowsersessionstart = time();
} }
if (!empty($CFG->behat_screenshots_path) && !is_writable($CFG->behat_screenshots_path)) { if (!empty($CFG->behat_faildump_path) && !is_writable($CFG->behat_faildump_path)) {
throw new Exception('You set $CFG->behat_screenshots_path to a non-writable directory'); throw new Exception('You set $CFG->behat_faildump_path to a non-writable directory');
} }
} }
@ -272,7 +272,7 @@ class behat_hooks extends behat_base {
global $CFG; global $CFG;
// Save a screenshot if the step failed. // Save a screenshot if the step failed.
if (!empty($CFG->behat_screenshots_path) && if (!empty($CFG->behat_faildump_path) &&
$event->getResult() === StepEvent::FAILED) { $event->getResult() === StepEvent::FAILED) {
$this->take_screenshot($event); $this->take_screenshot($event);
} }
@ -297,12 +297,29 @@ class behat_hooks extends behat_base {
} }
/** /**
* Getter for self::$screenshotsdirname * Execute any steps required after the step has finished.
*
* This includes creating an HTML dump of the content if there was a failure.
*
* @AfterStep
*/
public function after_step($event) {
global $CFG;
// Save the page content if the step failed.
if (!empty($CFG->behat_faildump_path) &&
$event->getResult() === StepEvent::FAILED) {
$this->take_contentdump($event);
}
}
/**
* Getter for self::$faildumpdirname
* *
* @return string * @return string
*/ */
protected function get_run_screenshots_dir() { protected function get_run_faildump_dir() {
return self::$screenshotsdirname; return self::$faildumpdirname;
} }
/** /**
@ -312,34 +329,61 @@ class behat_hooks extends behat_base {
* @param StepEvent $event * @param StepEvent $event
*/ */
protected function take_screenshot(StepEvent $event) { protected function take_screenshot(StepEvent $event) {
global $CFG;
// Goutte can't save screenshots. // Goutte can't save screenshots.
if (!$this->running_javascript()) { if (!$this->running_javascript()) {
return false; return false;
} }
// All the run screenshots in the same parent dir. list ($dir, $filename) = $this->get_faildump_filename($event, 'png');
if (!$screenshotsdirname = self::get_run_screenshots_dir()) { $this->saveScreenshot($filename, $dir);
$screenshotsdirname = self::$screenshotsdirname = date('Ymd_His'); }
$dir = $CFG->behat_screenshots_path . DIRECTORY_SEPARATOR . $screenshotsdirname; /**
* Take a dump of the page content when a step fails.
*
* @throws Exception
* @param StepEvent $event
*/
protected function take_contentdump(StepEvent $event) {
list ($dir, $filename) = $this->get_faildump_filename($event, 'html');
if (!mkdir($dir, $CFG->directorypermissions, true)) { $fh = fopen($dir . DIRECTORY_SEPARATOR . $filename, 'w');
fwrite($fh, $this->getSession()->getPage()->getContent());
fclose($fh);
}
/**
* Determine the full pathname to store a failure-related dump.
*
* This is used for content such as the DOM, and screenshots.
*
* @param StepEvent $event
* @param String $filetype The file suffix to use.
*/
protected function get_faildump_filename(StepEvent $event, $filetype) {
global $CFG;
// All the contentdumps should be in the same parent dir.
if (!$faildumpdir = self::get_run_faildump_dir()) {
$faildumpdir = self::$faildumpdirname = date('Ymd_His');
$dir = $CFG->behat_faildump_path . DIRECTORY_SEPARATOR . $faildumpdir;
if (!is_dir($dir) && !mkdir($dir, $CFG->directorypermissions, true)) {
// It shouldn't, we already checked that the directory is writable. // It shouldn't, we already checked that the directory is writable.
throw new Exception('No directories can be created inside $CFG->behat_screenshots_path, check the directory permissions.'); throw new Exception('No directories can be created inside $CFG->behat_faildump_path, check the directory permissions.');
} }
} else { } else {
// We will always need to know the full path. // We will always need to know the full path.
$dir = $CFG->behat_screenshots_path . DIRECTORY_SEPARATOR . $screenshotsdirname; $dir = $CFG->behat_faildump_path . DIRECTORY_SEPARATOR . $faildumpdir;
} }
// The scenario title + the failed step text. // The scenario title + the failed step text.
// We want a i-am-the-scenario-title_i-am-the-failed-step.png format. // We want a i-am-the-scenario-title_i-am-the-failed-step.$filetype format.
$filename = $event->getStep()->getParent()->getTitle() . '_' . $event->getStep()->getText(); $filename = $event->getStep()->getParent()->getTitle() . '_' . $event->getStep()->getText();
$filename = preg_replace('/([^a-zA-Z0-9\_]+)/', '-', $filename) . '.png'; $filename = preg_replace('/([^a-zA-Z0-9\_]+)/', '-', $filename) . '.' . $filetype;
$this->saveScreenshot($filename, $dir); return array($dir, $filename);
} }
/** /**
@ -513,3 +557,4 @@ class behat_hooks extends behat_base {
} }
} }