tests/phpunit/includes/actions/ActionTest.php

   1 <?php
   2
   3 /**
   4  * @covers Action
   5  *
   6  * @author Thiemo Mättig
   7  *
   8  * @group Action
   9  * @group Database
  10  */
  11 class ActionTest extends MediaWikiTestCase {
  12
  13         protected function setUp() {
  14                 parent::setUp();
  15
  16                 $context = $this->getContext();
  17                 $this->setMwGlobals( 'wgActions', [
  18                         'null' => null,
  19                         'disabled' => false,
  20                         'view' => true,
  21                         'edit' => true,
  22                         'revisiondelete' => 'SpecialPageAction',
  23                         'dummy' => true,
  24                         'string' => 'NamedDummyAction',
  25                         'declared' => 'NonExistingClassName',
  26                         'callable' => [ $this, 'dummyActionCallback' ],
  27                         'object' => new InstantiatedDummyAction( $context->getWikiPage(), $context ),
  28                 ] );
  29         }
  30
  31         private function getPage() {
  32                 return WikiPage::factory( Title::makeTitle( 0, 'Title' ) );
  33         }
  34
  35         private function getContext( $requestedAction = null ) {
  36                 $request = new FauxRequest( [ 'action' => $requestedAction ] );
  37
  38                 $context = new DerivativeContext( RequestContext::getMain() );
  39                 $context->setRequest( $request );
  40                 $context->setWikiPage( $this->getPage() );
  41
  42                 return $context;
  43         }
  44
  45         public function actionProvider() {
  46                 return [
  47                         [ 'dummy', 'DummyAction' ],
  48                         [ 'string', 'NamedDummyAction' ],
  49                         [ 'callable', 'CalledDummyAction' ],
  50                         [ 'object', 'InstantiatedDummyAction' ],
  51
  52                         // Capitalization is ignored
  53                         [ 'DUMMY', 'DummyAction' ],
  54                         [ 'STRING', 'NamedDummyAction' ],
  55
  56                         // Null and non-existing values
  57                         [ 'null', null ],
  58                         [ 'undeclared', null ],
  59                         [ '', null ],
  60                         [ false, null ],
  61                 ];
  62         }
  63
  64         /**
  65          * @dataProvider actionProvider
  66          * @param string $requestedAction
  67          * @param string|null $expected
  68          */
  69         public function testActionExists( $requestedAction, $expected ) {
  70                 $exists = Action::exists( $requestedAction );
  71
  72                 $this->assertSame( $expected !== null, $exists );
  73         }
  74
  75         public function testActionExists_doesNotRequireInstantiation() {
  76                 // The method is not supposed to check if the action can be instantiated.
  77                 $exists = Action::exists( 'declared' );
  78
  79                 $this->assertTrue( $exists );
  80         }
  81
  82         /**
  83          * @dataProvider actionProvider
  84          * @param string $requestedAction
  85          * @param string|null $expected
  86          */
  87         public function testGetActionName( $requestedAction, $expected ) {
  88                 $context = $this->getContext( $requestedAction );
  89                 $actionName = Action::getActionName( $context );
  90
  91                 $this->assertEquals( $expected ?: 'nosuchaction', $actionName );
  92         }
  93
  94         public function testGetActionName_editredlinkWorkaround() {
  95                 // See https://phabricator.wikimedia.org/T22966
  96                 $context = $this->getContext( 'editredlink' );
  97                 $actionName = Action::getActionName( $context );
  98
  99                 $this->assertEquals( 'edit', $actionName );
 100         }
 101
 102         public function testGetActionName_historysubmitWorkaround() {
 103                 // See https://phabricator.wikimedia.org/T22966
 104                 $context = $this->getContext( 'historysubmit' );
 105                 $actionName = Action::getActionName( $context );
 106
 107                 $this->assertEquals( 'view', $actionName );
 108         }
 109
 110         public function testGetActionName_revisiondeleteWorkaround() {
 111                 // See https://phabricator.wikimedia.org/T22966
 112                 $context = $this->getContext( 'historysubmit' );
 113                 $context->getRequest()->setVal( 'revisiondelete', true );
 114                 $actionName = Action::getActionName( $context );
 115
 116                 $this->assertEquals( 'revisiondelete', $actionName );
 117         }
 118
 119         public function testGetActionName_whenCanNotUseWikiPage_defaultsToView() {
 120                 $request = new FauxRequest( [ 'action' => 'edit' ] );
 121                 $context = new DerivativeContext( RequestContext::getMain() );
 122                 $context->setRequest( $request );
 123                 $actionName = Action::getActionName( $context );
 124
 125                 $this->assertEquals( 'view', $actionName );
 126         }
 127
 128         /**
 129          * @dataProvider actionProvider
 130          * @param string $requestedAction
 131          * @param string|null $expected
 132          */
 133         public function testActionFactory( $requestedAction, $expected ) {
 134                 $context = $this->getContext();
 135                 $action = Action::factory( $requestedAction, $context->getWikiPage(), $context );
 136
 137                 $this->assertType( $expected ?: 'null', $action );
 138         }
 139
 140         public function testNull_doesNotExist() {
 141                 $exists = Action::exists( null );
 142
 143                 $this->assertFalse( $exists );
 144         }
 145
 146         public function testNull_defaultsToView() {
 147                 $context = $this->getContext( null );
 148                 $actionName = Action::getActionName( $context );
 149
 150                 $this->assertEquals( 'view', $actionName );
 151         }
 152
 153         public function testNull_canNotBeInstantiated() {
 154                 $page = $this->getPage();
 155                 $action = Action::factory( null, $page );
 156
 157                 $this->assertNull( $action );
 158         }
 159
 160         public function testDisabledAction_exists() {
 161                 $exists = Action::exists( 'disabled' );
 162
 163                 $this->assertTrue( $exists );
 164         }
 165
 166         public function testDisabledAction_isNotResolved() {
 167                 $context = $this->getContext( 'disabled' );
 168                 $actionName = Action::getActionName( $context );
 169
 170                 $this->assertEquals( 'nosuchaction', $actionName );
 171         }
 172
 173         public function testDisabledAction_factoryReturnsFalse() {
 174                 $page = $this->getPage();
 175                 $action = Action::factory( 'disabled', $page );
 176
 177                 $this->assertFalse( $action );
 178         }
 179
 180         public function dummyActionCallback() {
 181                 $context = $this->getContext();
 182                 return new CalledDummyAction( $context->getWikiPage(), $context );
 183         }
 184
 185 }
 186
 187 class DummyAction extends Action {
 188
 189         public function getName() {
 190                 return static::class;
 191         }
 192
 193         public function show() {
 194         }
 195
 196         public function execute() {
 197         }
 198 }
 199
 200 class NamedDummyAction extends DummyAction {
 201 }
 202
 203 class CalledDummyAction extends DummyAction {
 204 }
 205
 206 class InstantiatedDummyAction extends DummyAction {
 207 }