Extension:Selenium.php

<?php

 /**
  * Extension:Selenium Template: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.7.6, 2007-1-09, selenium-core 0.8.3');

$egSeleniumTag = "selenium"; $egSeleniumPath = "/wiki/extensions/Selenium/selenium-core-0/core/TestRunner.html"; $egResultsUrlPath = "../../tmp/results.php"; $egSpecialPath = "/wiki/index.php?title=Special:Selenium&suite="; $egSeleniumCategory = "Selenium"; $egSeleniumNamespace = "";

/**

* http://www.mediawiki.org/wiki/Manual:Special_pages
* $wgSpecialPages['Selenium'] = '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 );

require_once "$IP/includes/SpecialPage.php";

1. Define the seleium tag class

class Selenium {

1. Properties

1. Constructor

 function __construct() {
   global $wgHooks,$wgParser,$egSeleniumTag;

1. Add the tagHook

   $wgParser->setHook($egSeleniumTag,array($this,'tagSelenium'));
 }  

1. Deploy tags to allow additional html table tags

 public function tagSelenium($text,$argv,&$parser) {
   global $wgTitle, $egSeleniumCategory;
   /**
    * Should be a preprocess using first stage of parser
    * $text = $parser->preprocess($text,$wgTitle,$parser->mOptions);	
    */

   /**
    * Want the Selenium tag to strip out ... enclosing tags

* It currently removes everything around the first <table... tags found

    */ 

   $text = eregi_replace('.+.+', '', $text);
    
# Automatically create category as specified in $egSeleniumCategory
    if($egSeleniumCategory) {
      $this->magicCategory($parser, $egSeleniumCategory, $sortkey = '');
    }

# We have not run htmlspecialchars to minimize cross-site scripting vulnerabilities
    return($text);
  }
 
# Expand the category-magic to nothing and parse separately as normal category links
  private function magicCategory(&$parser,$cat,$sortkey = '') {
    if ($sortkey) $sortkey = "|$sortkey";
    $parser->parse("[[Category:$cat$sortkey]]",$parser->mTitle,$parser->mOptions,false,false);
    return '';
  }
 
 
# Needed in some versions to prevent Special:Version from breaking
   private function __toString() { return 'Selenium'; }
}
 
 
# Define a new class based on the SpecialPage class
class SpecialSelenium extends SpecialPage {
 
  /**
   * Need a global for the location of Selenium
   */	
 
# Properties
  var $suite = array(
		     'header' => '',
		     'footer'      => "\n"

);

1. Constructor

 function __construct() {

   SpecialPage::SpecialPage(

'Selenium', # name as seen in links etc , # user rights required true, # listed in special:specialpages false, # function called by execute() - defaults to wfSpecial{$name} false, # file included by execute() - defaults to Special{$name}.php, only used if no function false # includable );

 } 

 /** 
  * -------------------- Create form for Special:Selenium --------------------
  * Override SpecialPage::execute()
  */
  public function execute() {
    global $wgOut, $wgParser, $wgRequest, $egResultsUrlPath;

1. Process suite or test if ?suite=article_name in query string

   if($wgRequest->getText('suite')) {

1. Grab article $param and process contents

     $suiteTitle = Title::newFromText($wgRequest->getText('suite'));

1. print $suiteTitle;
2. print $suiteTitle->getText();
3. print $wgRequest->getText('suite');

     $wikitext = $this->fetchContents($suiteTitle);

1. Expanding braces of any transcluded tests

     $wikitext = $wgParser->preprocess($wikitext,$suiteTitle,new ParserOptions());	

1. 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 {

1. Determine whether suite or test from ?suite=article_name&test=section_num in query string

if($wgRequest->getText('test')) {

1. Grab name of 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()) {

1. 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 {

1. 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;

1. Retrieve articles in category labelled $egSeleniumCategory

     $list = $this->categoryArticles($egSeleniumCategory);

1. Grab article $param and process contents

     $suites = array();
     foreach($list as $articleName) {

$suiteTitle = Title::newFromText($articleName); $wikitext = $this->fetchContents($suiteTitle);

if( $this->articleRegex($wikitext, $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');

     global $egSeleniumPath, $egSpecialPath;
     $path = "$egSeleniumPath?test=" . urlencode($egSpecialPath);

     $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')) {

1. foreach($_REQUEST as $key=>$value) {
2. print "$key>$value" . "
   ";
3. }

$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);

     }
   }
 }

 private function categoryArticles($category) {
   $list   = array();
   $dbr    = &wfGetDB(DB_SLAVE);
   $cl     = $dbr->tableName('categorylinks');
   $res    = $dbr->select($cl,'cl_from',"cl_to = '$category'",__METHOD__,array('ORDER BY' => 'cl_sortkey'));
   while ($row = $dbr->fetchRow($res)){ 
     $list[]   = Title::newFromID($row[0])->getPrefixedText();     
   }
   return($list);

}

 private function fetchContents($title) {
   $article    = new Article($title);
   $contents   = $article->getContent();
   return($contents);
 }

 private function articleRegex(&$wikitext,&$matches) {
   $count = preg_match_all('|^={2,}\s*([^\#\<\>\[\]\|\{\}\n]+?)\s*={2,}(.+?</selenium>)|ms',$wikitext,$matches);
   return($count);
 }

1. Method to bypass $wgOut -must be called early to avoid conflict with other extensions

 static function disableHTML(&$wgOut) {
   $wgOut->disable();
   wfResetOutputBuffers();
   return;
 }

1. Method to 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;
 }

1. Method to build a suite from an array of tests

 private function buildSuite($tests, $article) {

   $html = $this->suite['header'];

$html .= "$article";

   foreach ($tests as $element) {

$html .= "\n<a href=\"/wiki/index.php?title=Special:Selenium&suite=$article&test=$element\">$element</a>";

   }
   $html .= $this->suite['footer'];
   return $html;
 }

}

1. Called from $wgExtensionFunctions array when initialising extensions

function efSetupSelenium() {

 global $wgRequest, $wgOut;

1. Process suite or test if ?suite=article_name in query string

 if($wgRequest->getText('suite')) {

1. Render only Selenium html

   SpecialSelenium::disableHTML($wgOut);
 }

 global $egSelenium, $wgLanguageCode, $wgMessageCache;
 $egSelenium = new Selenium();

1. Add the messages used by the specialpage

   if ($wgLanguageCode == 'en') {
     $wgMessageCache->addMessages(array(

'selenium' => 'Selenium testing environment', # The friendly page title ));

   }

1. Add the specialpage to the environment

 SpecialPage::addPage(new SpecialSelenium());

}

1. Needed in MediaWiki >1.8.0 for magic word hooks to work properly

function efSeleniumLanguageGetMagic(&$magicWords,$langCode = 0) {

 global $egSeleniumMagic;
 $magicWords[$egSeleniumMagic] = array(0,$egSeleniumMagic);
 return true;

}