mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-01-30 04:58:37 +01:00
Code Issues Releases Wiki Activity

[ticket/12273] Add a basic set of tests for the exporter

Browse Source 
PHPBB3-12273
This commit is contained in:
Joas Schilling 2014-04-17 15:00:14 +02:00
parent 0da5e3bee9
commit 22de4a5927
5 changed files with 794 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

424
phpBB/develop/event_exporter.php Normal file
View File

@ -0,0 +1,424 @@
<?php
/**
*
* @package phpBB3
* @copyright (c) 2014 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
class event_exporter
{
/** @var string */
protected $root_path;
/**
* @param string $phpbb_root_path
*/
public function __construct($phpbb_root_path)
{
$this->root_path = $phpbb_root_path;
}
function export_from_eventsmd($filter)
{
$file_content = file_get_contents($this->root_path . 'docs/events.md');
$events = explode("\n\n", $file_content);
foreach ($events as $event)
{
// Last row of the file
if (strpos($event, "\n===\n") === false) continue;
list($event_name, $details) = explode("\n===\n", $event);
if ($filter == 'acp' && strpos($event_name, 'acp_') !== 0) continue;
if ($filter == 'styles' && strpos($event_name, 'acp_') === 0) continue;
list($file_details, $details) = explode("\n* Since: ", $details);
list($version, $explanition) = explode("\n* Purpose: ", $details);
echo "|- id=\"{$event_name}\"\n";
echo "| [[#{$event_name}|{$event_name}]] || ";
if (strpos($file_details, "* Locations:\n + ") === 0)
{
$file_details = substr($file_details, strlen("* Locations:\n + "));
$files = explode("\n + ", $file_details);
$prosilver = $subsilver2 = $adm = array();
foreach ($files as $file)
{
if (strpos($file, 'styles/prosilver/template/') === 0)
{
$prosilver[] = substr($file, strlen('styles/prosilver/template/'));
}
if (strpos($file, 'styles/subsilver2/template/') === 0)
{
$subsilver2[] = substr($file, strlen('styles/subsilver2/template/'));
}
if (strpos($file, 'adm/style/') === 0)
{
$adm[] = substr($file, strlen('adm/style/'));
}
}
if ($filter == 'acp')
{
echo implode(', ', $adm);
}
else
{
echo implode(', ', $prosilver) . ' || ' . implode(', ', $subsilver2);
}
}
else if ($filter == 'acp')
{
echo substr($file_details, strlen("* Location: adm/style/"));
}
echo " || {$version} || " . str_replace("\n", ' ', $explanition) . "\n";
}
}
function export_from_php()
{
$files = $this->get_file_list($this->root_path);
$events = array();
foreach ($files as $file)
{
$file_events = $this->check_for_events($file);
if (!empty($file_events))
{
$events = array_merge($events, $file_events);
}
}
ksort($events);
foreach ($events as $event)
{
echo '|- id="' . $event['event'] . '"' . "\n";
echo '| [[#' . $event['event'] . '|' . $event['event'] . ']] || ' . $event['file'] . ' || ' . implode(', ', $event['arguments']) . ' || ' . $event['since'] . ' || ' . $event['description'] . "\n";
}
}
public function check_for_events($file)
{
$events = array();
$content = file_get_contents($this->root_path . $file);
if (strpos($content, "phpbb_dispatcher->trigger_event('") || strpos($content, "phpbb_dispatcher->dispatch('"))
{
$lines = explode("\n", $content);
for ($i = 0, $num_lines = sizeof($lines); $i < $num_lines; $i++)
{
$event_line = 0;
$found_trigger_event = strpos($lines[$i], "phpbb_dispatcher->trigger_event('");
if ($found_trigger_event !== false)
{
$event_line = $i;
$event_name = $lines[$event_line];
$event_name = substr($event_name, $found_trigger_event + strlen("phpbb_dispatcher->trigger_event('"));
$event_name = substr($event_name, 0, strpos($event_name, "'"));
$current_line = trim($lines[$event_line]);
$arguments = array();
$found_inline_array = strpos($current_line, "', compact(array('");
if ($found_inline_array !== false)
{
$varsarray = substr($current_line, $found_inline_array + strlen("', compact(array('"), -6);
$arguments = explode("', '", $varsarray);
}
if (empty($arguments))
{
// Find $vars array lines
$find_varsarray_line = 1;
while (strpos($lines[$event_line - $find_varsarray_line], "\$vars = array('") === false)
{
$find_varsarray_line++;
if ($find_varsarray_line > min(50, $event_line))
{
throw new LogicException('Can not find "$vars = array()"-line for event "' . $event_name . '" in file "' . $file . '"');
}
}
$varsarray = substr(trim($lines[$event_line - $find_varsarray_line]), strlen("\$vars = array('"), -3);
$arguments = explode("', '", $varsarray);
}
// Validate $vars array with @var
$find_vars_line = 3;
$doc_vars = array();
while (strpos(trim($lines[$event_line - $find_vars_line]), '*') === 0)
{
$var_line = trim($lines[$event_line - $find_vars_line]);
$var_line = preg_replace('!\s+!', ' ', $var_line);
if (strpos($var_line, '* @var ') === 0)
{
$doc_line = explode(' ', $var_line);
if (isset($doc_line[3]))
{
$doc_vars[] = $doc_line[3];
}
}
$find_vars_line++;
}
if (sizeof($arguments) !== sizeof($doc_vars) && array_intersect($arguments, $doc_vars))
{
throw new LogicException('$vars array does not match the list of @var tags for event "' . $event_name . '" in file "' . $file . '"');
}
}
$found_dispatch = strpos($lines[$i], "phpbb_dispatcher->dispatch('");
if ($found_dispatch !== false)
{
$event_line = $i;
$event_name = $lines[$event_line];
$event_name = substr($event_name, $found_dispatch + strlen("phpbb_dispatcher->dispatch('"));
$event_name = substr($event_name, 0, strpos($event_name, "'"));
$arguments = array();
}
if ($event_line)
{
// Validate @event
$event_line_num = $this->find_event($file, $event_name, $lines, $event_line);
$this->validate_event($file, $event_name, $lines[$event_line_num]);
// Validate @since
$since_line_num = $this->find_since($file, $event_name, $lines, $event_line);
$since = $this->validate_since($file, $event_name, $lines[$since_line_num]);
// Find event description line
$description_line_num = $this->find_description($file, $event_name, $lines, $event_line);
$description = substr(trim($lines[$description_line_num]), strlen('* '));
$events[$event_name] = array(
'event' => $event_name,
'file' => $file,
'arguments' => $arguments,
'since' => $since,
'description' => $description,
);
}
}
}
return $events;
}
/**
* Find the "@since" Information line
*
* @param string $file
* @param string $event_name
* @param string $lines
* @param int $event_line Index of the event call in $lines
* @return int Absolute line number
*/
public function find_since($file, $event_name, $lines, $event_line)
{
return $this->find_tag($file, $event_name, $lines, $event_line, 'since', array('event', 'var'));
}
/**
* Find the "@event" Information line
*
* @param string $file
* @param string $event_name
* @param string $lines
* @param int $event_line Index of the event call in $lines
* @return int Absolute line number
*/
public function find_event($file, $event_name, $lines, $event_line)
{
return $this->find_tag($file, $event_name, $lines, $event_line, 'event', array());
}
/**
* Find a "@*" Information line
*
* @param string $file
* @param string $event_name
* @param string $lines
* @param int $event_line Index of the event call in $lines
* @param string $find_tag Name of the tag we are trying to find
* @param array $disallowed_tags List of tags that must not appear between
* the tag and the actual event
* @return int Absolute line number
*/
public function find_tag($file, $event_name, $lines, $event_line, $find_tag, $disallowed_tags)
{
$find_tag_line = 0;
$found_comment_end = false;
while (strpos(ltrim($lines[$event_line - $find_tag_line], "\t"), '* @' . $find_tag . ' ') !== 0)
{
if ($found_comment_end && ltrim($lines[$event_line - $find_tag_line], "\t") === '/**')
{
// Reached the start of this doc block
throw new LogicException('Can not find @' . $find_tag . ' information for event "' . $event_name . '" in file "' . $file . '"', 1);
}
foreach ($disallowed_tags as $disallowed_tag)
{
if ($found_comment_end && strpos(ltrim($lines[$event_line - $find_tag_line], "\t"), '* @' . $disallowed_tag) === 0)
{
// Found @var after the @since
throw new LogicException('Found @' . $disallowed_tag . ' information after @' . $find_tag . ' for event "' . $event_name . '" in file "' . $file . '"', 3);
}
}
if (ltrim($lines[$event_line - $find_tag_line], "\t") === '*/')
{
$found_comment_end = true;
}
$find_tag_line++;
if ($find_tag_line >= $event_line)
{
// Reached the start of the file
throw new LogicException('Can not find @' . $find_tag . ' information for event "' . $event_name . '" in file "' . $file . '"', 2);
}
}
return $event_line - $find_tag_line;
}
/**
* Find a "@*" Information line
*
* @param string $file
* @param string $event_name
* @param string $lines
* @param int $event_line Index of the event call in $lines
* @return int Absolute line number
*/
public function find_description($file, $event_name, $lines, $event_line)
{
$find_desc_line = 0;
while (ltrim($lines[$event_line - $find_desc_line], "\t") !== '/**')
{
$find_desc_line++;
if ($find_desc_line > $event_line)
{
// Reached the start of the file
throw new LogicException('Can not find a description for event "' . $event_name . '" in file "' . $file . '"', 1);
}
}
$find_desc_line = $event_line - $find_desc_line + 1;
$desc = trim($lines[$find_desc_line]);
if (strpos($desc, '* @') === 0 || $desc[0] !== '*' || substr($desc, 1) == '')
{
// First line of the doc block is a @-line, empty or only contains "*"
throw new LogicException('Can not find a description for event "' . $event_name . '" in file "' . $file . '"', 2);
}
return $find_desc_line;
}
/**
* Validate "@since" Information
*
* @param string $file
* @param string $event_name
* @param string $line
* @return string
*/
public function validate_since($file, $event_name, $line)
{
$since = substr(ltrim($line, "\t"), strlen('* @since '));
if ($since !== trim($since))
{
throw new LogicException('Invalid @since information for event "' . $event_name . '" in file "' . $file . '"', 1);
}
$since = ($since === '3.1-A1') ? '3.1.0-a1' : $since;
if (!preg_match('#^\d+\.\d+\.\d+(?:-(?:a|b|rc|pl)\d+)?$#', $since))
{
throw new LogicException('Invalid @since information for event "' . $event_name . '" in file "' . $file . '"', 2);
}
return $since;
}
/**
* Validate "@event" Information
*
* @param string $file
* @param string $event_name
* @param string $line
* @return string
*/
public function validate_event($file, $event_name, $line)
{
$event = substr(ltrim($line, "\t"), strlen('* @event '));
if ($event !== trim($event))
{
throw new LogicException('Invalid @event information for event "' . $event_name . '" in file "' . $file . '"', 1);
}
if ($event !== $event_name)
{
throw new LogicException('Event name does not match @event tag for event "' . $event_name . '" in file "' . $file . '"', 2);
}
return $event;
}
/**
* Returns a list of files in that directory
*
* Works recursive with any depth
*
* @param string $dir Directory to go through
* @return array List of files (including directories from within $dir
*/
function get_file_list($dir, $path = '')
{
try
{
$iterator = new \DirectoryIterator($dir);
}
catch (Exception $e)
{
return array();
}
$files = array();
foreach ($iterator as $file_info)
{
if ($file_info->isDot())
{
continue;
}
// Do not scan some directories
if ($file_info->isDir() && (
($path == '' && in_array($file_info->getFilename(), array('cache', 'develop', 'ext', 'files', 'language', 'store', 'vendor')))
|| ($path == '/includes' && in_array($file_info->getFilename(), array('utf')))
|| ($path == '/phpbb/db/migration' && in_array($file_info->getFilename(), array('data')))
|| ($path == '/phpbb' && in_array($file_info->getFilename(), array('event')))
))
{
continue;
}
else if ($file_info->isDir())
{
$sub_dir = $this->get_file_list($file_info->getPath() . '/' . $file_info->getFilename(), $path . '/' . $file_info->getFilename());
foreach ($sub_dir as $file)
{
$files[] = $file_info->getFilename() . '/' . $file;
}
}
else if (substr($file_info->getFilename(), -4) == '.php')
{
$files[] = $file_info->getFilename();
}
}
return $files;
}
}

341
tests/event/exporter_test.php Normal file
View File

@ -0,0 +1,341 @@
<?php
/**
*
* @package testing
* @copyright (c) 2014 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
require_once dirname(__FILE__) . '/../../phpBB/develop/event_exporter.php';
class phpbb_event_exporter_test extends phpbb_test_case
{
/** @var \event_exporter */
protected $exporter;
public function setUp()
{
parent::setUp();
$this->exporter = new \event_exporter(dirname(__FILE__) . '/fixtures/');
}
static public function check_for_events_data()
{
return array(
array(
'default.test',
array(
'default.dispatch' => array(
'event' => 'default.dispatch',
'file' => 'default.test',
'arguments' => array(),
'since' => '3.1.0-b2',
'description' => 'Description',
),
),
),
array(
'extra_description.test',
array(
'extra_description.dispatch' => array(
'event' => 'extra_description.dispatch',
'file' => 'extra_description.test',
'arguments' => array(),
'since' => '3.1.0-b2',
'description' => 'Description',
),
),
),
array(
'legacy_alpha1_version.test',
array(
'legacy_alpha1_version.dispatch' => array(
'event' => 'legacy_alpha1_version.dispatch',
'file' => 'legacy_alpha1_version.test',
'arguments' => array(),
'since' => '3.1.0-a1',
'description' => 'Description',
),
),
),
);
}
/**
* @dataProvider check_for_events_data
*/
public function test_check_for_events($file, $expected)
{
$this->assertEquals($expected, $this->exporter->check_for_events($file));
}
static public function validate_since_data()
{
return array(
array('* @since 3.1.0-a1', '3.1.0-a1'),
array('* @since 3.1.0-b3', '3.1.0-b3'),
array(' * @since 3.1.0-b3', '3.1.0-b3'),
array('* @since 3.1-A1', '3.1.0-a1'),
);
}
/**
* @dataProvider validate_since_data
*/
public function test_validate_since($since, $expected)
{
$this->assertEquals($expected, $this->exporter->validate_since('', '', $since));
}
static public function validate_since_throws_data()
{
return array(
array(' * @since 3.1.0-a1', 1),
array('* @since 3.1.0-a1 ', 1),
array('* @since 3.1.0-a1 bertie is cool', 2),
array('bertie* @since 3.1.0-a1', 2),
array('* @since 3.1-A2', 2),
array('* @since 3.1-B3', 2),
);
}
/**
* @dataProvider validate_since_throws_data
* @expectedException LogicException
*/
public function test_validate_since_throws($since, $exception_code)
{
$this->setExpectedException('LogicException', '', $exception_code);
$this->exporter->validate_since('', '', $since);
}
static public function validate_event_data()
{
return array(
array('test.event', '* @event test.event', 'test.event'),
array('test.event2', ' * @event test.event2', 'test.event2'),
);
}
/**
* @dataProvider validate_event_data
*/
public function test_validate_event($event_name, $event, $expected)
{
$this->assertEquals($expected, $this->exporter->validate_event('', $event_name, $event));
}
static public function validate_event_throws_data()
{
return array(
array('test.event', ' * @event test.event', 1),
array('test.event', '* @event test.event bertie is cool', 2),
array('test.event', 'bertie* @event test.event', 2),
);
}
/**
* @dataProvider validate_event_throws_data
* @expectedException LogicException
*/
public function test_validate_event_throws($event_name, $event, $exception_code)
{
$this->setExpectedException('LogicException', '', $exception_code);
$this->exporter->validate_event('', $event_name, $event);
}
static public function find_since_data()
{
return array(
array(
array(
'/**',
'* @since 3.1.0-a1',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
3,
1,
),
array(
array(
'* @since 3.1.0-a1',
'/**',
'* @since 3.1.0-a1',
'* @changed 3.1.0-a2',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
5,
2,
),
);
}
/**
* @dataProvider find_since_data
*/
public function test_find_since($lines, $event_line, $expected)
{
$this->assertEquals($expected, $this->exporter->find_since('', '', $lines, $event_line));
}
static public function find_since_throws_data()
{
return array(
array(
array(
'/**',
'* @since 3.1.0-a1',
'*/',
'/**',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
5,
1,
),
array(
array(
'/**',
'* @changed 3.1.0-a1',
'* @changed 3.1.0-a2',
'* @changed 3.1.0-a3',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
5,
2,
),
array(
array(
'/**',
'* @since 3.1.0-a2',
'* @var',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
4,
3,
),
array(
array(
'/**',
'* @since 3.1.0-a2',
'* @event',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
4,
3,
),
);
}
/**
* @dataProvider find_since_throws_data
* @expectedException LogicException
*/
public function test_find_since_throws($lines, $event_line, $exception_code)
{
$this->setExpectedException('LogicException', '', $exception_code);
$this->exporter->find_since('', '', $lines, $event_line);
}
static public function find_description_data()
{
return array(
array(
array(
'/**',
'* Hello Bertie!',
'* @since 3.1.0-a1',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
4,
1,
),
array(
array(
' /**',
' * Hello Bertie!',
' *',
' * @since 3.1.0-a1',
' * @changed 3.1.0-a2',
' */',
' $phpbb_dispatcher->dispatch(\'test\');',
),
6,
1,
),
);
}
/**
* @dataProvider find_description_data
*/
public function test_find_description($lines, $event_line, $expected)
{
$this->assertEquals($expected, $this->exporter->find_description('', '', $lines, $event_line));
}
static public function find_description_throws_data()
{
return array(
array(
array(
'$vars = array();',
'$phpbb_dispatcher->dispatch(\'test\');',
),
1,
1,
),
array(
array(
'/**',
'* @changed 3.1.0-a1',
'* @changed 3.1.0-a2',
'* @changed 3.1.0-a3',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
5,
2,
),
array(
array(
'/**',
'*',
'* @since 3.1.0-a2',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
4,
2,
),
array(
array(
'/**',
'* ',
'* @event',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
4,
2,
),
);
}
/**
* @dataProvider find_description_throws_data
* @expectedException LogicException
*/
public function test_find_description_throws($lines, $event_line, $exception_code)
{
$this->setExpectedException('LogicException', '', $exception_code);
$this->exporter->find_description('', '', $lines, $event_line);
}
}

9
tests/event/fixtures/default.test Normal file
View File

@ -0,0 +1,9 @@
<?php
/**
* Description
*
* @event default.dispatch
* @since 3.1.0-b2
*/
$phpbb_dispatcher->dispatch('default.dispatch');

11
tests/event/fixtures/extra_description.test Normal file
View File

@ -0,0 +1,11 @@
<?php
/**
* Description
*
* NOTE: This will not be exported
*
* @event extra_description.dispatch
* @since 3.1.0-b2
*/
$phpbb_dispatcher->dispatch('extra_description.dispatch');

9
tests/event/fixtures/legacy_alpha1_version.test Normal file
View File

@ -0,0 +1,9 @@
<?php
/**
* Description
*
* @event legacy_alpha1_version.dispatch
* @since 3.1-A1
*/
$phpbb_dispatcher->dispatch('legacy_alpha1_version.dispatch');