Extension:Selenium.php

<?php

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

1. Category:SeleniumCategory:Extensions created with Template:SpecialPage
2. - Licenced under LGPL http://www.gnu.org/copyleft/lesser.html
3. - Author: http://www.organicdesign.co.nz/User:Sven

if (!defined('MEDIAWIKI')) die('Not an entry point.');

define('SELENIUM_VERSION','0.1.1, 2007-12-03 (selenium-core version 0.8.3');

$egSeleniumTag = "selenium"; $wgExtensionFunctions[] = 'efSetupSelenium'; $wgExtensionFunctions[] = 'efSetupSpecialSelenium'; $wgHooks['LanguageGetMagic'][] = 'efSeleniumLanguageGetMagic';

$wgExtensionCredits['specialpage'][] = array( 'name' => 'Special:Selenium', 'author' => 'User:Sven', 'description' => 'Incorporating Selenium tests into the MediaWiki environment', 'url' => 'http://www.mediawiki.org/wiki/Extension:Selenium', 'version' => SELENIUM_VERSION );

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

class Selenium {

1. Properties

var $prop1 = 'default value'; var $prop2 = 'default value';

1. Constructor

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

1. Add the tagHook

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

}

1. Deploy tags to allow additional html table tags

function tagSelenium($text,$argv,&$parser) {

         global $wgTitle;

1. Should be a preprocess using first stage of parser
2. $text = $parser->preprocess($text,$wgTitle,$parser->mOptions);

1. Want the selenium tag to strip out and ... enclosing tags

$text = eregi_replace('.+.+', '', $text); return($text); } # Needed in some versions to prevent Special:Version from breaking function __toString() { return 'Selenium'; } } # Called from $wgExtensionFunctions array when initialising extensions function efSetupSelenium() { global $egSelenium; $egSelenium = new Selenium(); } # 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; } # Define a new class based on the SpecialPage class class SpecialSelenium extends SpecialPage { # Properties var $suiteTitle = 'Selenium suite'; # just sets the browser title var $testName = 'Selenium test'; var $htmlSnippet = array( 'suiteHeader' => '', 'testHeader' => '', 'Footer' => '', );

1. Constructor

function SpecialSelenium() {

SpecialPage::SpecialPage( 'Selenium', # name as seen in links etc 'sysop', # 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 ); }

1. -------------------- Create form for Special:Selenium --------------------
2. Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param

function execute($param) { global $wgOut; global $wgParser;

if($param) {

1. Note: Need to bypass $wgOut and render only Selenium html here

1. Grab article $param and process contents

$paramTitle = Title::newFromText($param); $article = new Article($paramTitle); $wikitext = $article->getContent();

1. Tranclusion expanding braces

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

1. -------------------- TODO: flow control on article name --------------------------- #
2. 1) Process $wikitext into sections
3. 2) if a section hash (#) is present in $param, check it is valid in the processed matches
4. 3) Process depending on whether Suite or Test

1. if($param match /(.+?#(.+?)/ ) { # pseudo code
2. ---- Process an article section as a selenium test
3. } else {
4. ---- Process an article as a selenium test suite
5. }
6.  !------------------- TODO: flow control on article name --------------------------- #

1. Match sections

preg_match_all('/^=+\\s*(.+?)\\s*=+$/m',$wikitext,$sectionNames);

1. Split wikitext on sections

$sections = preg_split('/^=+\\s*(.+?)\\s*=+$/ms', $wikitext); # remove content above first header array_shift($sections);

1. ---------------- DEBUG --------------- #

$suiteHtml = '

<tbody> ';

while (count($sectionNames[1])) {

1. 1.1 for each section

$sName = array_shift($sectionNames[1]); $section = array_shift($sections);

1. 1.2 determine if selenium tag is present

if(preg_match("|<selenium>.+?</selenium>|si", $section)) {

1. 1.3 build output html

$suiteHtml .= "";

}

1. print("M1: $sName
   ");
2. print("M2: $section
   ");
3. fwrite($fh, "\n$sName");
4. fwrite($fh, "\n$section");

}

$suiteHtml .= "

Flouzo Test Suite

<a href=\"/wiki/Special:Selenium/$param\">$sName</a>

";

$fh = fopen("/tmp/MWdump",'w');

fwrite($fh, "Suite:\n$suiteHtml");

1. ---------------- DEBUG --------------- #

} else {

1. B) Render Special:Selenium form

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

$wgOut->addWikiText(wfMsg('example-message','exampleParameter')); $wgOut->addHTML( wfElement('form',array('action' => $title->getLocalURL('action=submit'),'method' => 'post'),null) . '<textarea name="target" cols=25 rows=10></textarea>' . wfElement('input',array('type' => 'submit')) . '</form>' ); } }

1. 3) -- Create rendering on the fly of a test article to the suite html code -- #

1. 4) ---------------- Some sort of validation of article ---------------------- #

}

1. Called from $wgExtensionFunctions array when initialising extensions

function efSetupSpecialSelenium() { global $wgLanguageCode,$wgMessageCache;

1. Add the messages used by the specialpage

if ($wgLanguageCode == 'en') { $wgMessageCache->addMessages(array( 'selenium' => 'Example Specialpage', # The friendly page title 'exampleMessage' => "Example message: $1", )); }

1. Add the specialpage to the environment

SpecialPage::addPage(new SpecialSelenium()); }