tests/phpunit/includes/search/SearchEventIngressSpyTrait.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Search;
   4
   5 use SearchEngine;
   6 use SearchEngineFactory;
   7
   8 /**
   9  * Trait providing test spies for asserting that listeners in
  10  * SearchEventIngress do or do not get called during
  11  * certain actions.
  12  */
  13 trait SearchEventIngressSpyTrait {
  14         private function installSearchEventIngressSpys( int $searchEngineCreate ) {
  15                 // Make sure SearchEventIngress is triggered and tries to re-index the page
  16                 $searchEngine = $this->createNoOpMock(
  17                         SearchEngine::class,
  18                         [ 'supports' ]
  19                 );
  20
  21                 $searchEngine->method( 'supports' )->willReturn( false );
  22
  23                 $searchEngineFactory = $this->createNoOpMock(
  24                         SearchEngineFactory::class,
  25                         [ 'create' ]
  26                 );
  27
  28                 // this is the relevant assertion:
  29                 $searchEngineFactory->expects( $this->exactly( $searchEngineCreate ) )
  30                         ->method( 'create' )->willReturn( $searchEngine );
  31
  32                 $this->setService( 'SearchEngineFactory', $searchEngineFactory );
  33         }
  34
  35         private function installSearchEventIngressSpyForEdit() {
  36                 $this->installSearchEventIngressSpys( 1 );
  37         }
  38
  39         private function installSearchEventIngressSpyForDerived() {
  40                 $this->installSearchEventIngressSpys( 1 );
  41         }
  42
  43         private function installSearchEventIngressSpyForPageMove() {
  44                 $this->installSearchEventIngressSpys( 2 );
  45         }
  46
  47         private function installSearchEventIngressSpyForUndeletion() {
  48                 $this->installSearchEventIngressSpys( 1 );
  49         }
  50
  51         private function installSearchEventIngressSpyForImport() {
  52                 $this->installSearchEventIngressSpys( 1 );
  53         }
  54
  55 }