Extension:Selenium.php

<?php /**

* Extension:SeleniumTemplate:Php

These are the MediaWiki extensions we're using and/or developing. Please refer to the information on the mediawiki.org wiki for installation and usage details. Extensions here which have no corresponding mediawiki article are either not ready for use or have been superseded. You can also browse our extension code in our local Subversion repository or our GitHub mirror.

* Category:SeleniumCategory:Extensions created with Template:SpecialPage
* - Licenced under LGPL http://www.gnu.org/copyleft/lesser.html
* - Author: http://www.organicdesign.co.nz/User:Sven (M Davy)
*/

if (!defined('MEDIAWIKI')) die('Not an entry point.'); define('SELENIUM_VERSION', '0.8.0, 2008-08-01');

$egSeleniumPath = preg_replace('|^.+(?=[/\\\\]extensions)|', $wgScriptPath, dirname(__FILE__)) . 'selenium-core'; $egResultsUrlPath = "../../tmp/results.php"; $egSeleniumCategory = "Selenium";

$wgExtensionFunctions[] = 'efSetupSelenium'; $wgHooks['LanguageGetMagic'][] = 'efSeleniumLanguageGetMagic';

$wgExtensionCredits['specialpage'][] = array( 'name' => 'Special:Selenium', 'author' => 'Sven (M Davy)', 'description' => 'Incorporating Selenium tests into the MediaWiki environment', 'url' => 'http://www.organicdesign.co.nz/Extension:Selenium.php', 'version' => SELENIUM_VERSION );

/**

* Define the class for rendering selenium test tables
*/

class Selenium {

# Constructor function __construct() { global $wgParser;

# Add the tag hooks $wgParser->setHook('body', array($this, 'tagBody')); $wgParser->setHook('head', array($this, 'tagHead')); $wgParser->setHook('html', array($this, 'tagParseContent')); $wgParser->setHook('thead', array($this, 'tagParseContent')); $wgParser->setHook('tbody', array($this, 'tagParseContent'));

# todo: check the schedule and see if any test-runs should be spawned

}

/** * Body tags surround the main test table and should be converted to a div of class "selenium" * - this tag also handles the categorisation of the article into Category:Selenium */ public function tagBody($text, &$argv, &$parser) { global $egSeleniumCategory; $text .= ""; $text = $parser->parse($text, $parser->mTitle, $parser->mOptions, false, false)->getText();

return "

$text

";

}

/** * The head tag of a selenium test doesn't need to be rendered, so simply returns an empty string */ public function tagHead(&$text, &$argv, &$parser) { return ; }

/** * The html, thead and tbody tags need to parse and return their content */ public function tagParseContent(&$text, &$argv, &$parser) { return $parser->parse($text, $parser->mTitle, $parser->mOptions, false, false)->getText(); }

/** * Needed in some versions to prevent Special:Version from breaking */ private function __toString() { return __CLASS__; } }

/**

* Define a new class based on the SpecialPage class
*/

require_once "$IP/includes/SpecialPage.php"; class SpecialSelenium extends SpecialPage {

function __construct() { SpecialPage::SpecialPage('Selenium', , true, false, false, false); }

public function execute() { global $wgOut, $wgParser, $wgRequest, $egResultsUrlPath;

# Process suite or test if ?suite=article_name in query string if ($wgRequest->getText('suite')) {

# Grab article $param and process contents $suiteTitle = Title::newFromText($wgRequest->getText('suite'));

# get the content of the suite article and expand braces $suiteArticle = new Article($suiteTitle); $wikitext = $wgParser->preprocess($suiteArticle->getContent(), $suiteTitle, new ParserOptions());

# Preparse encapsulations around Selenium tags e.g. <selenium> $wikitext = preg_replace("|</?selenium>|", "<selenium>", $wikitext);

$matches = array(); if (!$this->articleRegex($wikitext, $matches)) { $this -> build404('Specified suite contains no selenium test tags'); } else {

# Determine whether suite or test from ?suite=article_name&test=section_num in query string if ($wgRequest->getText('test')) { $testTitle = Title::newFromText($wgRequest->getText('test')); if (in_array($testTitle->getText(), $matches[1])) { $counter = 0; foreach ($matches[1] as $value) { if ($value == $testTitle->getText()) { # Generating test html $matches[2][$counter] = preg_replace( '|.+?<selenium>\n?(.+?)</selenium>|ms', "$1", $matches[2][$counter] ); print $matches[2][$counter]; break; #exit foreach loop when test is found } $counter++; } } else $this->build404("Specified test does not exist in ".$wgRequest->getText('suite')); } else { # Obtain suite section headers $suite_urls = array(); foreach ($matches[1] as $value) array_push($suite_urls, $value); print $this->buildSuite($suite_urls, $wgRequest->getText('suite')); } } }

else { global $egSeleniumCategory, $egSeleniumPath;

# Retrieve articles in category labelled $egSeleniumCategory $list = array(); $dbr = &wfGetDB(DB_SLAVE); $cl = $dbr->tableName('categorylinks'); $res = $dbr->select($cl, 'cl_from', "cl_to = '$egSeleniumCategory'", __METHOD__, array('ORDER BY' => 'cl_sortkey')); while ($row = $dbr->fetchRow($res)) $list[] = Title::newFromID($row[0])->getPrefixedText();

# Grab article $param and process contents $suites = array(); foreach ($list as $articleName) { $suiteTitle = Title::newFromText($articleName); $suiteArticle = new Article($suiteTitle); if ($this->articleRegex($suiteTitle->getContent(), $matches)) $suites[] = $articleName; }

$selectTag = '<select name="selenium">'; foreach ($suites as $suite) $selectTag .= "<option>$suite</option>"; $selectTag .= '</select>';

$this->setHeaders(); $title = Title::makeTitle(NS_SPECIAL, 'Selenium');

$path = "$egSeleniumPath?test=".urlencode($title->getLocalURL());

$form = wfElement('form', array('action' => $title->getLocalURL('action=submit'), 'method' => 'post'), null); $form .= '<fieldset><legend>Select a suite to run</legend>'; $form .= "$selectTag
"; $form .= wfElement('input', array('type' => 'submit')); $form .= "

" . wfCheckLabel("Run automatically", "wfRunAuto" , "wfRunAuto", $checked = false); $form .= '</fieldset></form>';

$wgOut->addHTML($form);

if ($wgRequest->getText('action')) { # foreach($_REQUEST as $key=>$value) { # print "$key>$value" . "
"; } $path .= urlencode($wgRequest->getText('selenium'));

if ($wgRequest->getBool('wfRunAuto')) $path .= "&auto=true&resultsUrl=$egResultsUrlPath";

$form_link = '<fieldset><legend>Click link to run selenium-core</legend>'; $form_link .= "<a href=\"$path\">" . $wgRequest->getText('selenium') . '</a></fieldset>'; $wgOut->addHTML($form_link); } }

/** * Bypass $wgOut -must be called early to avoid conflict with other extensions */ static function disableHTML(&$wgOut) { $wgOut->disable(); wfResetOutputBuffers(); return; }

/** * Generate 404 error */ private function build404($message) { header('HTTP/1.0 404 not Found'); $err = "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">

$message

The requested URL was not found on this server.

"; print $err; return; }

/** * Build a suite from an array of tests */ private function buildSuite($tests, $article) { $html = "

"; $title = Title::makeTitle(NS_SPECIAL, 'Selenium'); foreach ($tests as $element) { $url = $title->getLocalURL("suite=$article&test=$element"); $html .= "\n"; } return "$html\n

$article

$element

"; } }

/**

* Called from $wgExtensionFunctions array when initialising extensions
*/

function efSetupSelenium() { global $wgRequest, $wgOut, $egSelenium, $wgLanguageCode, $wgMessageCache;

# Process suite or test if ?suite=article_name in query string if ($wgRequest->getText('suite')) SpecialSelenium::disableHTML($wgOut);

$egSelenium = new Selenium();

# Add the messages used by the specialpage if ($wgLanguageCode == 'en') { $wgMessageCache->addMessages(array('selenium' => 'Selenium testing environment')); }

# Add the specialpage to the environment SpecialPage::addPage(new SpecialSelenium()); }

/**

* Needed in MediaWiki >1.8.0 for magic word hooks to work properly
*/

function efSeleniumLanguageGetMagic(&$magicWords, $langCode = 0) { global $egSeleniumMagic; $magicWords[$egSeleniumMagic] = array($langCode, $egSeleniumMagic); return true; }