Difference between revisions of "Extension:Selenium.php"

From Organic Design wiki
(raw output for both suite and test)
(Add 404 error if test is not found)
Line 9: Line 9:
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
  
define('SELENIUM_VERSION','0.2.1, 2007-12-03 (selenium-core version 0.8.3');
+
define('SELENIUM_VERSION','0.3.1, 2007-12-03 (selenium-core version 0.8.3');
  
 
$egSeleniumTag              = "selenium";
 
$egSeleniumTag              = "selenium";
Line 107: Line 107:
 
      
 
      
 
# Process suite or test if ?suite=article_name in query string
 
# Process suite or test if ?suite=article_name in query string
     if(array_key_exists('suite', $_REQUEST) || array_key_exists('test', $_REQUEST)) {
+
     if(array_key_exists('suite', $_REQUEST)) {
 
# Bypass $wgOut and render only Selenium html  
 
# Bypass $wgOut and render only Selenium html  
 
       $wgOut->disable();
 
       $wgOut->disable();
 
       wfResetOutputBuffers();
 
       wfResetOutputBuffers();
# echo $output;
+
 
 +
/**
 +
* header('HTTP/1.0 404 Not Found');
 +
* $err = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
 +
 
 +
* <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"><html><head><title>404 Not Found</title></head>
 +
* <body><h1>Not Found</h1><p>The requested URL was not found on this server.</p></body></html>
 +
* echo $err;
 +
*/
  
 
       $param = $_REQUEST['suite'];
 
       $param = $_REQUEST['suite'];
Line 146: Line 154:
 
# Determine whether suite or test from ?suite=article_name&test=section_num in query string       
 
# Determine whether suite or test from ?suite=article_name&test=section_num in query string       
 
       if( array_key_exists('test', $_REQUEST)) {  
 
       if( array_key_exists('test', $_REQUEST)) {  
+
if(in_array(preg_replace("/_/", " ", $_REQUEST['test']), $matches[1])) {
 +
  header('HTTP/1.0 404 200 OK');
 +
  print "Test exists, now process...";
 +
} else {
 +
  header('HTTP/1.0 404 Not Found');
 +
  $err = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"><html><head><title>404 Not Found</title></head>
 +
<body><h1>Not Found</h1><p>The requested URL was not found on this server.</p></body></html>';
 +
  echo $err;
 +
  }
 +
 
 +
 
 +
 
 
/**
 
/**
 
* Generating test html
 
* Generating test html
 
*/
 
*/
 
print "Need to process test here!";
 
  
 
# print $matches[2][1];
 
# print $matches[2][1];
Line 158: Line 175:
 
# Process test
 
# Process test
 
       } else {
 
       } else {
 +
header('HTTP/1.0 404 200 OK');
 
/*Process suite
 
/*Process suite
 
* foreach ($matches[2] as $value) {
 
* foreach ($matches[2] as $value) {

Revision as of 21:19, 25 December 2007

<?php /**

Info.svg 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:Extensions in progress

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

define('SELENIUM_VERSION','0.3.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 __construct() {
   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;
   /**
    * Should be a preprocess using first stage of parser
    * $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'; 
  var $testName   = 'Selenium test';
  var $htmlSnippet = array(
			   'suiteHeader' => '$suiteTitle',
			   'testHeader'  => '$testName
', 'Footer' => '
',

);

  1. Constructor
 function __construct() {
   
   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 );

 } 
 
 /** 
  * -------------------- Create form for Special:Selenium --------------------
  * Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param
  */
 function execute() {
   global $wgOut;
   global $wgParser;
   
  1. Process suite or test if ?suite=article_name in query string
   if(array_key_exists('suite', $_REQUEST)) {
  1. Bypass $wgOut and render only Selenium html
     $wgOut->disable();
     wfResetOutputBuffers();

/**

* header('HTTP/1.0 404 Not Found');
* $err = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
* <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">404 Not Found
 * 

Not Found

The requested URL was not found on this server.

* echo $err; */
     $param = $_REQUEST['suite'];
     
  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());	
     
     /** 
      * -------- Debugging the execute function --------
      * 1) Process $wikitext into sections
      * Need to catch encapsulations around selenium tags e.g. <selenium>
      * This match grabs is greedy finding last complete match
      * $count = preg_match_all('|^={2,}\s*(.+?)\s*={2,}.*<selenium>(.+?)</selenium>|ms',$wikitext,$matches);
      */
     
     # Preparse article removing  content
#      print $wikitext;
      $wikitext = preg_replace("|<nowiki><selenium>|", "selenium", $wikitext);
  1. print $wikitext;
     $count = preg_match_all('|^={2,}\s*(.+?)\s*={2,}(.+?</selenium>)|ms',$wikitext,$matches);
     
     /**
      * $count equals 0 if articles contain no sections and corresponding tags		  
      */
     if($count==0) {

print "There were no matches";

     }
  1. Determine whether suite or test from ?suite=article_name&test=section_num in query string
     if( array_key_exists('test', $_REQUEST)) { 

if(in_array(preg_replace("/_/", " ", $_REQUEST['test']), $matches[1])) { header('HTTP/1.0 404 200 OK'); print "Test exists, now process..."; } else { header('HTTP/1.0 404 Not Found'); $err = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">404 Not Found

Not Found

The requested URL was not found on this server.

'; echo $err; }


/** * Generating test html */

  1. print $matches[2][1];
  2. $matches[2][1] = preg_replace('|.+?<selenium>(.+?)</selenium>|ms', "\\1", $matches[2][1]);
  3. print $matches[2][1];
  4. Process test
     } else {

header('HTTP/1.0 404 200 OK'); /*Process suite * foreach ($matches[2] as $value) { * print "$value
"; * Search and replace the leading text for each test * } */

print $this->buildSuite(array('foo', 'fodda'), $param); $file = "/tmp/Suite.html"; $fh = fopen($file,'w'); fwrite($fh, $this->buildSuite(array('foo', 'fodda'), $param)); #$this->buildSuite(array('foo', 'fodda'), $param);

     }
     
     /**
      * foreach($_SERVER as $key=>$value){
      * print "\$_SERVER: $key:$value
"; * } */ /** * !-------- End of debugging --------- */ } else { $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>' );

   }
 }
 
 function buildSuite($tests, $param) {
  1. return "SUCCESSFULLY ACCESSED!";
   $html = $this->htmlSnippet['suiteHeader'];

$html .= "$param";

   foreach ($tests as $element) {

$html .= "<a href=\"/wiki/special:Selenium/$param?section=$element\">$element</a>";

   }
   $html .= $this->htmlSnippet['Footer'];
   return $html;
 }

}

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

}