Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit be788ee

Browse files
chalasrchalasr
committed
minor #39997 Use createMock() instead of a getter (OskarStark)
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- Use createMock() instead of a getter | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | --- | License | MIT | Doc PR | --- Before I go on, are you interested in such change @nicolas-grekas ? Commits ------- 9629daf Use createMock() instead of a getter
2 parents e242832 + 9629daf commit be788ee

File tree

14 files changed

+82
-173
lines changed

14 files changed

+82
-173
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Tests/Templating/TimedPhpEngineTest.php

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class TimedPhpEngineTest extends TestCase
2929
{
3030
public function testThatRenderLogsTime()
3131
{
32-
$container = $this->getContainer();
32+
$container = $this->createMock(Container::class);
3333
$templateNameParser = $this->getTemplateNameParser();
3434
$globalVariables = $this->getGlobalVariables();
3535
$loader = $this->getLoader($this->getStorage());
@@ -48,11 +48,6 @@ public function testThatRenderLogsTime()
4848
$engine->render('index.php');
4949
}
5050

51-
private function getContainer(): Container
52-
{
53-
return $this->createMock(Container::class);
54-
}
55-
5651
private function getTemplateNameParser(): TemplateNameParserInterface
5752
{
5853
$templateReference = $this->createMock(TemplateReferenceInterface::class);

‎src/Symfony/Bundle/WebProfilerBundle/Tests/EventListener/WebDebugToolbarListenerTest.php

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public function testHtmlRedirectionIsIntercepted($statusCode, $hasSession)
6565
{
6666
$response = new Response('Some content', $statusCode);
6767
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
68-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(false, 'html', $hasSession), HttpKernelInterface::MASTER_REQUEST, $response);
68+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(false, 'html', $hasSession), HttpKernelInterface::MASTER_REQUEST, $response);
6969

7070
$listener = new WebDebugToolbarListener($this->getTwigMock('Redirection'), true);
7171
$listener->onKernelResponse($event);
@@ -78,7 +78,7 @@ public function testNonHtmlRedirectionIsNotIntercepted()
7878
{
7979
$response = new Response('Some content', '301');
8080
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
81-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(false, 'json', true), HttpKernelInterface::MASTER_REQUEST, $response);
81+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(false, 'json', true), HttpKernelInterface::MASTER_REQUEST, $response);
8282

8383
$listener = new WebDebugToolbarListener($this->getTwigMock('Redirection'), true);
8484
$listener->onKernelResponse($event);
@@ -92,7 +92,7 @@ public function testToolbarIsInjected()
9292
$response = new Response('<html><head></head><body></body></html>');
9393
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
9494

95-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
95+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
9696

9797
$listener = new WebDebugToolbarListener($this->getTwigMock());
9898
$listener->onKernelResponse($event);
@@ -108,7 +108,7 @@ public function testToolbarIsNotInjectedOnNonHtmlContentType()
108108
$response = new Response('<html><head></head><body></body></html>');
109109
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
110110
$response->headers->set('Content-Type', 'text/xml');
111-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
111+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
112112

113113
$listener = new WebDebugToolbarListener($this->getTwigMock());
114114
$listener->onKernelResponse($event);
@@ -124,7 +124,7 @@ public function testToolbarIsNotInjectedOnContentDispositionAttachment()
124124
$response = new Response('<html><head></head><body></body></html>');
125125
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
126126
$response->headers->set('Content-Disposition', 'attachment; filename=test.html');
127-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(false, 'html'), HttpKernelInterface::MASTER_REQUEST, $response);
127+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(false, 'html'), HttpKernelInterface::MASTER_REQUEST, $response);
128128

129129
$listener = new WebDebugToolbarListener($this->getTwigMock());
130130
$listener->onKernelResponse($event);
@@ -140,7 +140,7 @@ public function testToolbarIsNotInjectedOnRedirection($statusCode, $hasSession)
140140
{
141141
$response = new Response('<html><head></head><body></body></html>', $statusCode);
142142
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
143-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(false, 'html', $hasSession), HttpKernelInterface::MASTER_REQUEST, $response);
143+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(false, 'html', $hasSession), HttpKernelInterface::MASTER_REQUEST, $response);
144144

145145
$listener = new WebDebugToolbarListener($this->getTwigMock());
146146
$listener->onKernelResponse($event);
@@ -165,7 +165,7 @@ public function testToolbarIsNotInjectedWhenThereIsNoNoXDebugTokenResponseHeader
165165
{
166166
$response = new Response('<html><head></head><body></body></html>');
167167

168-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
168+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
169169

170170
$listener = new WebDebugToolbarListener($this->getTwigMock());
171171
$listener->onKernelResponse($event);
@@ -181,7 +181,7 @@ public function testToolbarIsNotInjectedWhenOnSubRequest()
181181
$response = new Response('<html><head></head><body></body></html>');
182182
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
183183

184-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::SUB_REQUEST, $response);
184+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::SUB_REQUEST, $response);
185185

186186
$listener = new WebDebugToolbarListener($this->getTwigMock());
187187
$listener->onKernelResponse($event);
@@ -197,7 +197,7 @@ public function testToolbarIsNotInjectedOnIncompleteHtmlResponses()
197197
$response = new Response('<div>Some content</div>');
198198
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
199199

200-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
200+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
201201

202202
$listener = new WebDebugToolbarListener($this->getTwigMock());
203203
$listener->onKernelResponse($event);
@@ -213,7 +213,7 @@ public function testToolbarIsNotInjectedOnXmlHttpRequests()
213213
$response = new Response('<html><head></head><body></body></html>');
214214
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
215215

216-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(true), HttpKernelInterface::MASTER_REQUEST, $response);
216+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(true), HttpKernelInterface::MASTER_REQUEST, $response);
217217

218218
$listener = new WebDebugToolbarListener($this->getTwigMock());
219219
$listener->onKernelResponse($event);
@@ -229,7 +229,7 @@ public function testToolbarIsNotInjectedOnNonHtmlRequests()
229229
$response = new Response('<html><head></head><body></body></html>');
230230
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
231231

232-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(false, 'json'), HttpKernelInterface::MASTER_REQUEST, $response);
232+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(false, 'json'), HttpKernelInterface::MASTER_REQUEST, $response);
233233

234234
$listener = new WebDebugToolbarListener($this->getTwigMock());
235235
$listener->onKernelResponse($event);
@@ -242,15 +242,15 @@ public function testXDebugUrlHeader()
242242
$response = new Response();
243243
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
244244

245-
$urlGenerator = $this->getUrlGeneratorMock();
245+
$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
246246
$urlGenerator
247247
->expects($this->once())
248248
->method('generate')
249249
->with('_profiler', ['token' => 'xxxxxxxx'], UrlGeneratorInterface::ABSOLUTE_URL)
250250
->willReturn('http://mydomain.com/_profiler/xxxxxxxx')
251251
;
252252

253-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
253+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
254254

255255
$listener = new WebDebugToolbarListener($this->getTwigMock(), false, WebDebugToolbarListener::ENABLED, $urlGenerator);
256256
$listener->onKernelResponse($event);
@@ -263,15 +263,15 @@ public function testThrowingUrlGenerator()
263263
$response = new Response();
264264
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
265265

266-
$urlGenerator = $this->getUrlGeneratorMock();
266+
$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
267267
$urlGenerator
268268
->expects($this->once())
269269
->method('generate')
270270
->with('_profiler', ['token' => 'xxxxxxxx'])
271271
->willThrowException(new \Exception('foo'))
272272
;
273273

274-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
274+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
275275

276276
$listener = new WebDebugToolbarListener($this->getTwigMock(), false, WebDebugToolbarListener::ENABLED, $urlGenerator);
277277
$listener->onKernelResponse($event);
@@ -284,15 +284,15 @@ public function testThrowingErrorCleanup()
284284
$response = new Response();
285285
$response->headers->set('X-Debug-Token', 'xxxxxxxx');
286286

287-
$urlGenerator = $this->getUrlGeneratorMock();
287+
$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
288288
$urlGenerator
289289
->expects($this->once())
290290
->method('generate')
291291
->with('_profiler', ['token' => 'xxxxxxxx'])
292292
->willThrowException(new \Exception("This\nmultiline\r\ntabbed text should\tcome out\r on\n \ta single plain\r\nline"))
293293
;
294294

295-
$event = new ResponseEvent($this->getKernelMock(), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
295+
$event = new ResponseEvent($this->createMock(Kernel::class), $this->getRequestMock(), HttpKernelInterface::MASTER_REQUEST, $response);
296296

297297
$listener = new WebDebugToolbarListener($this->getTwigMock(), false, WebDebugToolbarListener::ENABLED, $urlGenerator);
298298
$listener->onKernelResponse($event);
@@ -331,14 +331,4 @@ protected function getTwigMock($render = 'WDT')
331331

332332
return $templating;
333333
}
334-
335-
protected function getUrlGeneratorMock()
336-
{
337-
return $this->createMock(UrlGeneratorInterface::class);
338-
}
339-
340-
protected function getKernelMock()
341-
{
342-
return $this->createMock(Kernel::class);
343-
}
344334
}

‎src/Symfony/Bundle/WebProfilerBundle/Tests/Profiler/TemplateManagerTest.php

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@
2121
use Twig\Loader\SourceContextLoaderInterface;
2222

2323
/**
24-
* Test for TemplateManager class.
25-
*
2624
* @author Artur Wielogórski <[email protected]>
2725
*/
2826
class TemplateManagerTest extends TestCase
@@ -38,23 +36,23 @@ class TemplateManagerTest extends TestCase
3836
protected $profiler;
3937

4038
/**
41-
* @var \Symfony\Bundle\WebProfilerBundle\Profiler\TemplateManager
39+
* @var TemplateManager
4240
*/
4341
protected $templateManager;
4442

4543
protected function setUp(): void
4644
{
4745
parent::setUp();
4846

49-
$profiler = $this->mockProfiler();
47+
$this->profiler = $this->createMock(Profiler::class);
5048
$twigEnvironment = $this->mockTwigEnvironment();
5149
$templates = [
5250
'data_collector.foo' => ['foo', 'FooBundle:Collector:foo'],
5351
'data_collector.bar' => ['bar', 'FooBundle:Collector:bar'],
5452
'data_collector.baz' => ['baz', 'FooBundle:Collector:baz'],
5553
];
5654

57-
$this->templateManager = new TemplateManager($profiler, $twigEnvironment, $templates);
55+
$this->templateManager = new TemplateManager($this->profiler, $twigEnvironment, $templates);
5856
}
5957

6058
public function testGetNameOfInvalidTemplate()
@@ -98,11 +96,6 @@ public function profileHasCollectorCallback($panel)
9896
}
9997
}
10098

101-
protected function mockProfile()
102-
{
103-
return $this->createMock(Profile::class);
104-
}
105-
10699
protected function mockTwigEnvironment()
107100
{
108101
$this->twigEnvironment = $this->createMock(Environment::class);
@@ -121,13 +114,6 @@ protected function mockTwigEnvironment()
121114

122115
return $this->twigEnvironment;
123116
}
124-
125-
protected function mockProfiler()
126-
{
127-
$this->profiler = $this->createMock(Profiler::class);
128-
129-
return $this->profiler;
130-
}
131117
}
132118

133119
class ProfileDummy extends Profile

‎src/Symfony/Component/Console/Tests/EventListener/ErrorListenerTest.php

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,35 @@ public function testOnConsoleError()
3030
{
3131
$error = new \TypeError('An error occurred');
3232

33-
$logger = $this->getLogger();
33+
$logger = $this->createMock(LoggerInterface::class);
3434
$logger
3535
->expects($this->once())
3636
->method('error')
3737
->with('Error thrown while running command "{command}". Message: "{message}"', ['exception' => $error, 'command' => 'test:run --foo=baz buzz', 'message' => 'An error occurred'])
3838
;
3939

4040
$listener = new ErrorListener($logger);
41-
$listener->onConsoleError(new ConsoleErrorEvent(new ArgvInput(['console.php', 'test:run', '--foo=baz', 'buzz']), $this->getOutput(), $error, new Command('test:run')));
41+
$listener->onConsoleError(new ConsoleErrorEvent(new ArgvInput(['console.php', 'test:run', '--foo=baz', 'buzz']), $this->createMock(OutputInterface::class), $error, new Command('test:run')));
4242
}
4343

4444
public function testOnConsoleErrorWithNoCommandAndNoInputString()
4545
{
4646
$error = new \RuntimeException('An error occurred');
4747

48-
$logger = $this->getLogger();
48+
$logger = $this->createMock(LoggerInterface::class);
4949
$logger
5050
->expects($this->once())
5151
->method('error')
5252
->with('An error occurred while using the console. Message: "{message}"', ['exception' => $error, 'message' => 'An error occurred'])
5353
;
5454

5555
$listener = new ErrorListener($logger);
56-
$listener->onConsoleError(new ConsoleErrorEvent(new NonStringInput(), $this->getOutput(), $error));
56+
$listener->onConsoleError(new ConsoleErrorEvent(new NonStringInput(), $this->createMock(OutputInterface::class), $error));
5757
}
5858

5959
public function testOnConsoleTerminateForNonZeroExitCodeWritesToLog()
6060
{
61-
$logger = $this->getLogger();
61+
$logger = $this->createMock(LoggerInterface::class);
6262
$logger
6363
->expects($this->once())
6464
->method('debug')
@@ -71,7 +71,7 @@ public function testOnConsoleTerminateForNonZeroExitCodeWritesToLog()
7171

7272
public function testOnConsoleTerminateForZeroExitCodeDoesNotWriteToLog()
7373
{
74-
$logger = $this->getLogger();
74+
$logger = $this->createMock(LoggerInterface::class);
7575
$logger
7676
->expects($this->never())
7777
->method('debug')
@@ -83,7 +83,7 @@ public function testOnConsoleTerminateForZeroExitCodeDoesNotWriteToLog()
8383

8484
public function testGetSubscribedEvents()
8585
{
86-
$this->assertEquals(
86+
$this->assertSame(
8787
[
8888
'console.error' => ['onConsoleError', -128],
8989
'console.terminate' => ['onConsoleTerminate', -128],
@@ -94,7 +94,7 @@ public function testGetSubscribedEvents()
9494

9595
public function testAllKindsOfInputCanBeLogged()
9696
{
97-
$logger = $this->getLogger();
97+
$logger = $this->createMock(LoggerInterface::class);
9898
$logger
9999
->expects($this->exactly(3))
100100
->method('debug')
@@ -109,7 +109,7 @@ public function testAllKindsOfInputCanBeLogged()
109109

110110
public function testCommandNameIsDisplayedForNonStringableInput()
111111
{
112-
$logger = $this->getLogger();
112+
$logger = $this->createMock(LoggerInterface::class);
113113
$logger
114114
->expects($this->once())
115115
->method('debug')
@@ -120,19 +120,9 @@ public function testCommandNameIsDisplayedForNonStringableInput()
120120
$listener->onConsoleTerminate($this->getConsoleTerminateEvent($this->createMock(InputInterface::class), 255));
121121
}
122122

123-
private function getLogger()
124-
{
125-
return $this->getMockForAbstractClass(LoggerInterface::class);
126-
}
127-
128123
private function getConsoleTerminateEvent(InputInterface $input, $exitCode)
129124
{
130-
return new ConsoleTerminateEvent(new Command('test:run'), $input, $this->getOutput(), $exitCode);
131-
}
132-
133-
private function getOutput()
134-
{
135-
return $this->createMock(OutputInterface::class);
125+
return new ConsoleTerminateEvent(new Command('test:run'), $input, $this->createMock(OutputInterface::class), $exitCode);
136126
}
137127
}
138128

‎src/Symfony/Component/Form/Tests/FormFactoryTest.php

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public function testCreateNamedBuilderWithTypeName()
7777
{
7878
$options = ['a' => '1', 'b' => '2'];
7979
$resolvedOptions = ['a' => '2', 'b' => '3'];
80-
$resolvedType = $this->getMockResolvedType();
80+
$resolvedType = $this->createMock(ResolvedFormTypeInterface::class);
8181

8282
$this->registry->expects($this->once())
8383
->method('getType')
@@ -105,7 +105,7 @@ public function testCreateNamedBuilderFillsDataOption()
105105
$givenOptions = ['a' => '1', 'b' => '2'];
106106
$expectedOptions = array_merge($givenOptions, ['data' => 'DATA']);
107107
$resolvedOptions = ['a' => '2', 'b' => '3', 'data' => 'DATA'];
108-
$resolvedType = $this->getMockResolvedType();
108+
$resolvedType = $this->createMock(ResolvedFormTypeInterface::class);
109109

110110
$this->registry->expects($this->once())
111111
->method('getType')
@@ -132,7 +132,7 @@ public function testCreateNamedBuilderDoesNotOverrideExistingDataOption()
132132
{
133133
$options = ['a' => '1', 'b' => '2', 'data' => 'CUSTOM'];
134134
$resolvedOptions = ['a' => '2', 'b' => '3', 'data' => 'CUSTOM'];
135-
$resolvedType = $this->getMockResolvedType();
135+
$resolvedType = $this->createMock(ResolvedFormTypeInterface::class);
136136

137137
$this->registry->expects($this->once())
138138
->method('getType')
@@ -211,7 +211,7 @@ public function testCreateNamed()
211211
{
212212
$options = ['a' => '1', 'b' => '2'];
213213
$resolvedOptions = ['a' => '2', 'b' => '3'];
214-
$resolvedType = $this->getMockResolvedType();
214+
$resolvedType = $this->createMock(ResolvedFormTypeInterface::class);
215215

216216
$this->registry->expects($this->once())
217217
->method('getType')
@@ -485,9 +485,4 @@ private function getMockFactory(array $methods = [])
485485
->setConstructorArgs([$this->registry])
486486
->getMock();
487487
}
488-
489-
private function getMockResolvedType()
490-
{
491-
return $this->createMock(ResolvedFormTypeInterface::class);
492-
}
493488
}

0 commit comments

Comments
 (0)