Merge pull request #61 from kasimi/reverse-schema

Added reverse_schema test

Author: paul999

src/Tests/Tests/epv_test_validate_revert_schema.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ *
+ * EPV :: The phpBB Forum Extension Pre Validator.
+ *
+ * @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
+ * @license       GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+namespace Phpbb\Epv\Tests\Tests;
+
+use Phpbb\Epv\Files\FileInterface;
+use Phpbb\Epv\Files\Type\MigrationFile;
+use Phpbb\Epv\Output\Output;
+use Phpbb\Epv\Output\OutputInterface;
+use Phpbb\Epv\Tests\BaseTest;
+use Phpbb\Epv\Tests\Exception\TestException;
+use Phpbb\Epv\Tests\Type;
+use PhpParser\Error;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\ParserFactory;
+
+class epv_test_validate_revert_schema extends BaseTest
+{
+	/**
+     * @var \PhpParser\Parser
+     */
+	private $parser;
+
+	/**
+	 * @param bool            $debug if debug is enabled
+	 * @param OutputInterface $output
+	 * @param string          $basedir
+	 * @param string          $namespace
+	 * @param boolean         $titania
+	 * @param string          $opendir
+	 */
+	public function __construct($debug, OutputInterface $output, $basedir, $namespace, $titania, $opendir)
+	{
+		parent::__construct($debug, $output, $basedir, $namespace, $titania, $opendir);
+
+		$this->fileTypeFull = Type::TYPE_MIGRATION;
+		$this->parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+	}
+
+	/**
+	 * @param FileInterface $file
+	 *
+	 * @throws TestException
+	 */
+	public function validateFile(FileInterface $file)
+	{
+		if (!$file instanceof MigrationFile)
+		{
+			throw new TestException(sprintf('This test expects a migration file, got %s (%s).', get_class($file), $file->getFilename()));
+		}
+
+		try
+		{
+			$nodes = $this->parser->parse($file->getFile());
+
+			if ($this->isMissingRevertSchema($nodes))
+			{
+				$this->output->addMessage(Output::ERROR, sprintf('Migration file %s is missing the revert_schema() method.', $file->getSaveFilename()));
+			}
+		}
+		catch (Error $e)
+		{
+			$this->output->addMessage(Output::FATAL, 'PHP parse error in file ' . $file->getSaveFilename() . '. Message: ' . $e->getMessage());
+		}
+	}
+
+	/**
+	 * @param Node[] $nodes
+	 * @return bool
+	 */
+	protected function isMissingRevertSchema($nodes)
+	{
+		foreach ($nodes as $node)
+		{
+			if ($node instanceof Class_ && $this->hasMethod($node, 'update_schema') && !$this->hasMethod($node, 'revert_schema'))
+			{
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param Class_ $node
+	 * @param string $methodName
+	 * @return bool
+	 */
+	protected function hasMethod($node, $methodName)
+	{
+		foreach ($node->stmts as $node)
+		{
+			if ($node instanceof ClassMethod && $node->name === $methodName)
+			{
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function testName()
+	{
+		return 'Validate presence of revert_schema()';
+	}
+}

tests/testFiles/migrations/existing_revert_schema.php

@@ -0,0 +1,14 @@
+<?php
+
+class existing_revert_schema_migration extends \phpbb\db\migration\migration
+{
+	public function update_schema()
+	{
+
+	}
+
+	public function revert_schema()
+	{
+
+	}
+}

tests/testFiles/migrations/missing_revert_schema.php

@@ -0,0 +1,9 @@
+<?php
+
+class missing_revert_schema_migration extends \phpbb\db\migration\migration
+{
+	public function update_schema()
+	{
+
+	}
+}

tests/testFiles/migrations/missing_update_schema.php

@@ -0,0 +1,9 @@
+<?php
+
+class missing_update_schema_migration extends \phpbb\db\migration\migration
+{
+	public function dummy()
+	{
+
+	}
+}

tests/validate_revert_schema_test.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ *
+ * EPV :: The phpBB Forum Extension Pre Validator.
+ *
+ * @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+use Phpbb\Epv\Files\FileLoader;
+use Phpbb\Epv\Output\OutputInterface;
+use Phpbb\Epv\Tests\Mock\Output;
+use Phpbb\Epv\Tests\Tests\epv_test_validate_revert_schema;
+
+class validate_revert_schema_test extends PHPUnit_Framework_TestCase
+{
+	public static function setUpBeforeClass()
+	{
+		require_once('./tests/Mock/Output.php');
+	}
+
+	/**
+	 * @param string $file
+	 * @param callable $configure
+	 */
+	private function validateFile($file, $configure) {
+		/** @var OutputInterface $output */
+		$output = $this->getMock('Phpbb\Epv\Output\OutputInterface');
+		$configure($output);
+
+		$file_loader = new FileLoader(new Output(), false, '.', '.');
+		$file = $file_loader->loadFile($file);
+
+		$tester = new epv_test_validate_revert_schema(false, $output, '/a/b/', 'epv/test', false, '/a/');
+		$tester->validateFile($file);
+	}
+
+	public function test_missing_update_schema()
+	{
+		$this->validateFile('tests/testFiles/migrations/missing_update_schema.php', function($output)
+		{
+			/** @var PHPUnit_Framework_MockObject_MockObject $output */
+			$output->expects($this->never())
+				->method('addMessage');
+		});
+	}
+
+	public function test_existing_revert_schema()
+	{
+		$this->validateFile('tests/testFiles/migrations/existing_revert_schema.php', function($output)
+		{
+			/** @var PHPUnit_Framework_MockObject_MockObject $output */
+			$output->expects($this->never())
+				->method('addMessage');
+		});
+	}
+
+	public function test_missing_revert_schema()
+	{
+		$this->validateFile('tests/testFiles/migrations/missing_revert_schema.php', function($output)
+		{
+			/** @var PHPUnit_Framework_MockObject_MockObject $output */
+			$output->expects($this->once())
+				->method('addMessage')
+				->with(OutputInterface::ERROR, 'Migration file tests/testFiles/migrations/missing_revert_schema.php is missing the revert_schema() method.');
+		});
+	}
+}