MediaWiki  REL1_31
ShellTest.php
Go to the documentation of this file.
1 <?php
2 
5 use Wikimedia\TestingAccessWrapper;
6 
12 
13  use MediaWikiCoversValidator;
14 
15  public function testIsDisabled() {
16  $this->assertInternalType( 'bool', Shell::isDisabled() ); // sanity
17  }
18 
22  public function testEscape( $args, $expected ) {
23  if ( wfIsWindows() ) {
24  $this->markTestSkipped( 'This test requires a POSIX environment.' );
25  }
26  $this->assertSame( $expected, call_user_func_array( [ Shell::class, 'escape' ], $args ) );
27  }
28 
29  public function provideEscape() {
30  return [
31  'simple' => [ [ 'true' ], "'true'" ],
32  'with args' => [ [ 'convert', '-font', 'font name' ], "'convert' '-font' 'font name'" ],
33  'array' => [ [ [ 'convert', '-font', 'font name' ] ], "'convert' '-font' 'font name'" ],
34  'skip nulls' => [ [ 'ls', null ], "'ls'" ],
35  ];
36  }
37 
49  public function testMakeScriptCommand(
50  $expected,
51  $expectedWin,
52  $script,
53  $parameters,
54  $options = [],
55  $hook = null
56  ) {
57  // Running tests under Vagrant involves MWMultiVersion that uses the below hook
58  $this->setMwGlobals( 'wgHooks', [] );
59 
60  if ( $hook ) {
61  $this->setTemporaryHook( 'wfShellWikiCmd', $hook );
62  }
63 
64  $command = Shell::makeScriptCommand( $script, $parameters, $options );
65  $command->params( 'safe' )
66  ->unsafeParams( 'unsafe' );
67 
69 
70  $wrapper = TestingAccessWrapper::newFromObject( $command );
71 
72  if ( wfIsWindows() ) {
73  $this->assertEquals( $expectedWin, $wrapper->command );
74  } else {
75  $this->assertEquals( $expected, $wrapper->command );
76  }
77  $this->assertSame( 0, $wrapper->restrictions & Shell::NO_LOCALSETTINGS );
78  }
79 
80  public function provideMakeScriptCommand() {
82 
83  return [
84  [
85  "'$wgPhpCli' 'maintenance/foobar.php' 'bar'\\''\"baz' 'safe' unsafe",
86  '"' . $wgPhpCli . '" "maintenance/foobar.php" "bar\'\\"baz" "safe" unsafe',
87  'maintenance/foobar.php',
88  [ 'bar\'"baz' ],
89  ],
90  [
91  "'$wgPhpCli' 'changed.php' '--wiki=somewiki' 'bar'\\''\"baz' 'safe' unsafe",
92  '"' . $wgPhpCli . '" "changed.php" "--wiki=somewiki" "bar\'\\"baz" "safe" unsafe',
93  'maintenance/foobar.php',
94  [ 'bar\'"baz' ],
95  [],
96  function ( &$script, array &$parameters ) {
97  $script = 'changed.php';
98  array_unshift( $parameters, '--wiki=somewiki' );
99  }
100  ],
101  [
102  "'/bin/perl' 'maintenance/foobar.php' 'bar'\\''\"baz' 'safe' unsafe",
103  '"/bin/perl" "maintenance/foobar.php" "bar\'\\"baz" "safe" unsafe',
104  'maintenance/foobar.php',
105  [ 'bar\'"baz' ],
106  [ 'php' => '/bin/perl' ],
107  ],
108  [
109  "'$wgPhpCli' 'foobinize' 'maintenance/foobar.php' 'bar'\\''\"baz' 'safe' unsafe",
110  '"' . $wgPhpCli . '" "foobinize" "maintenance/foobar.php" "bar\'\\"baz" "safe" unsafe',
111  'maintenance/foobar.php',
112  [ 'bar\'"baz' ],
113  [ 'wrapper' => 'foobinize' ],
114  ],
115  ];
116  }
117 }
$wgPhpCli
$wgPhpCli
Executable path of the PHP cli binary.
Definition: DefaultSettings.php:8301
ShellTest\testEscape
testEscape( $args, $expected)
provideEscape
Definition: ShellTest.php:22
MediaWiki\Shell\Shell
Executes shell commands.
Definition: Shell.php:44
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MediaWiki\Shell\Command
Class used for executing shell commands.
Definition: Command.php:35
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
ShellTest
\MediaWiki\Shell\Shell Shell
Definition: ShellTest.php:11
ShellTest\testMakeScriptCommand
testMakeScriptCommand( $expected, $expectedWin, $script, $parameters, $options=[], $hook=null)
\MediaWiki\Shell\Shell::makeScriptCommand provideMakeScriptCommand
Definition: ShellTest.php:49
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
$command
$command
Definition: cdb.php:65
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:2019
ShellTest\provideEscape
provideEscape()
Definition: ShellTest.php:29
$args
if( $line===false) $args
Definition: cdb.php:64
ShellTest\testIsDisabled
testIsDisabled()
Definition: ShellTest.php:15
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
MediaWikiTestCase\setTemporaryHook
setTemporaryHook( $hookName, $handler)
Create a temporary hook handler which will be reset by tearDown.
Definition: MediaWikiTestCase.php:2014
MediaWikiTestCase\assertType
assertType( $type, $actual, $message='')
Asserts the type of the provided value.
Definition: MediaWikiTestCase.php:1878
ShellTest\provideMakeScriptCommand
provideMakeScriptCommand()
Definition: ShellTest.php:80