MaintenanceBaseTestCase.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Tests\Maintenance;
 
use Maintenance;
use MediaWikiTestCase;
use Wikimedia\TestingAccessWrapper;
 
abstract class MaintenanceBaseTestCase extends MediaWikiTestCase {
 
    protected $maintenance;
 
    protected function setUp() {
        parent::setUp();
 
        $this->maintenance = $this->createMaintenance();
    }
 
    protected function tearDown() {
        if ( $this->maintenance ) {
            $this->maintenance->cleanupChanneled();
        }
 
        // This is smelly, but maintenance scripts usually produce output, so
        // we anticipate and ignore with a regex that will catch everything.
        //
        // If you call $this->expectOutputRegex in your subclass, this guard
        // won't be triggered, and your specific pattern will be respected.
        if ( !$this->hasExpectationOnOutput() ) {
            $this->expectOutputRegex( '/.*/' );
        }
 
        parent::tearDown();
    }
 
    abstract protected function getMaintenanceClass();
 
    protected function createMaintenance() {
        $className = $this->getMaintenanceClass();
        $obj = new $className();
 
        // We use TestingAccessWrapper in order to access protected internals
        // such as `output()`.
        return TestingAccessWrapper::newFromObject( $obj );
    }
 
    protected function assertOutputPrePostShutdown( $preShutdownOutput, $expectNLAppending ) {
        $this->assertEquals( $preShutdownOutput, $this->getActualOutput(),
                "Output before shutdown simulation" );
 
        $this->maintenance->cleanupChanneled();
 
        $postShutdownOutput = $preShutdownOutput . ( $expectNLAppending ? "\n" : "" );
        $this->expectOutputString( $postShutdownOutput );
    }
 
}