LuaEngineUnitTestBase.php

Go to the documentation of this file.

<?php
 
abstract class Scribunto_LuaEngineUnitTestBase extends \PHPUnit\Framework\TestCase {
    use MediaWikiCoversValidator;
    use PHPUnit4And6Compat;
    use Scribunto_LuaEngineTestHelper;
 
    private static $staticEngineName = null;
    private $engineName = null;
    private $engine = null;
    private $luaDataProvider = null;
 
    protected $luaTestName = null;
 
    protected static $moduleName = null;
 
    protected static $dataProviderClass = 'Scribunto_LuaDataProvider';
 
    protected $skipTests = [];
 
    public function __construct(
        $name = null, array $data = [], $dataName = '', $engineName = null
    ) {
        if ( $engineName === null ) {
            $engineName = self::$staticEngineName;
        }
        $this->engineName = $engineName;
        parent::__construct( $name, $data, $dataName );
    }
 
    public static function suite( $className ) {
        return self::makeSuite( $className );
    }
 
    protected function tearDown() {
        if ( $this->luaDataProvider ) {
            $this->luaDataProvider->destroy();
            $this->luaDataProvider = null;
        }
        if ( $this->engine ) {
            $this->engine->destroy();
            $this->engine = null;
        }
        parent::tearDown();
    }
 
    public function toString() {
        // When running tests written in Lua, return a nicer representation in
        // the failure message.
        if ( $this->luaTestName ) {
            return $this->engineName . ': ' . $this->luaTestName;
        }
        return $this->engineName . ': ' . parent::toString();
    }
 
    protected function getTestModules() {
        return [
            'TestFramework' => __DIR__ . '/TestFramework.lua',
        ];
    }
 
    public function provideLuaData() {
        if ( !$this->luaDataProvider ) {
            $class = static::$dataProviderClass;
            $this->luaDataProvider = new $class ( $this->getEngine(), static::$moduleName );
        }
        return $this->luaDataProvider;
    }
 
    public function testLua( $key, $testName, $expected ) {
        $this->luaTestName = static::$moduleName . "[$key]: $testName";
        if ( isset( $this->skipTests[$testName] ) ) {
            $this->markTestSkipped( $this->skipTests[$testName] );
        } else {
            try {
                $actual = $this->provideLuaData()->run( $key );
            } catch ( Scribunto_LuaError $ex ) {
                if ( substr( $ex->getLuaMessage(), 0, 6 ) === 'SKIP: ' ) {
                    $this->markTestSkipped( substr( $ex->getLuaMessage(), 6 ) );
                } else {
                    throw $ex;
                }
            }
            $this->assertSame( $expected, $actual );
        }
        $this->luaTestName = null;
    }
}