Skip to content

Commit 62b854a

Browse files
AydinHassanAydinHassan
committed
Update signature and tests for exercise dispatcher
1 parent 49d80d0 commit 62b854a

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

‎src/ExerciseDispatcher.php‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
1414
use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
1515
use PhpSchool\PhpWorkshop\Factory\RunnerFactory;
16+
use PhpSchool\PhpWorkshop\Input\Input;
1617
use PhpSchool\PhpWorkshop\Output\OutputInterface;
1718

1819
/**
@@ -119,46 +120,46 @@ public function requireCheck($requiredCheck)
119120
* correct runner for the exercise based on the exercise type. Various events are triggered throughout the process.
120121
*
121122
* @param ExerciseInterface $exercise The exercise instance.
122-
* @param string $fileName The absolute file name of the students solution.
123+
* @param Input $input The command line arguments passed to the command.
123124
* @return ResultAggregator Contains all the results injected via the runner, checks and events.
124125
* @throws CheckNotApplicableException If the check is not applicable to the exercise type.
125126
* @throws ExerciseNotConfiguredException If the exercise does not implement the correct interface based on
126127
* the checks required.
127128
*/
128-
public function verify(ExerciseInterface $exercise, $fileName)
129+
public function verify(ExerciseInterface $exercise, Input $input)
129130
{
130131
$exercise->configure($this);
131132

132133
$runner = $this->runnerFactory->create($exercise, $this->eventDispatcher, $this);
133-
$this->eventDispatcher->dispatch(new Event('verify.start', compact('exercise', 'fileName')));
134+
$this->eventDispatcher->dispatch(new Event('verify.start', compact('exercise', 'input')));
134135

135136
$this->validateChecks($this->checksToRunBefore, $exercise);
136137
$this->validateChecks($this->checksToRunAfter, $exercise);
137138

138139
foreach ($this->checksToRunBefore as $check) {
139-
$this->results->add($check->check($exercise, $fileName));
140+
$this->results->add($check->check($exercise, $input));
140141

141142
if (!$this->results->isSuccessful()) {
142143
return $this->results;
143144
}
144145
}
145146

146-
$this->eventDispatcher->dispatch(new Event('verify.pre.execute', compact('exercise', 'fileName')));
147+
$this->eventDispatcher->dispatch(new Event('verify.pre.execute', compact('exercise', 'input')));
147148

148149
try {
149-
$this->results->add($runner->verify($fileName));
150+
$this->results->add($runner->verify($input));
150151
} finally {
151-
$this->eventDispatcher->dispatch(new Event('verify.post.execute', compact('exercise', 'fileName')));
152+
$this->eventDispatcher->dispatch(new Event('verify.post.execute', compact('exercise', 'input')));
152153
}
153154

154155
foreach ($this->checksToRunAfter as $check) {
155-
$this->results->add($check->check($exercise, $fileName));
156+
$this->results->add($check->check($exercise, $input));
156157
}
157158

158-
$this->eventDispatcher->dispatch(new Event('verify.post.check', compact('exercise', 'fileName')));
159+
$this->eventDispatcher->dispatch(new Event('verify.post.check', compact('exercise', 'input')));
159160
$exercise->tearDown();
160161

161-
$this->eventDispatcher->dispatch(new Event('verify.finish', compact('exercise', 'fileName')));
162+
$this->eventDispatcher->dispatch(new Event('verify.finish', compact('exercise', 'input')));
162163
return $this->results;
163164
}
164165

@@ -168,21 +169,21 @@ public function verify(ExerciseInterface $exercise, $fileName)
168169
* The output of the solution is written directly to the `OutputInterface` instance.
169170
*
170171
* @param ExerciseInterface $exercise The exercise instance.
171-
* @param string $fileName The absolute file name of the students solution.
172+
* @param Input $input The command line arguments passed to the command.
172173
* @param OutputInterface $output An output instance capable of writing to stdout.
173174
* @return bool Whether the solution ran successfully or not.
174175
*/
175-
public function run(ExerciseInterface $exercise, $fileName, OutputInterface $output)
176+
public function run(ExerciseInterface $exercise, Input $input, OutputInterface $output)
176177
{
177178
$exercise->configure($this);
178-
$this->eventDispatcher->dispatch(new Event('run.start', compact('exercise', 'fileName')));
179+
$this->eventDispatcher->dispatch(new Event('run.start', compact('exercise', 'input')));
179180

180181
try {
181182
$exitStatus = $this->runnerFactory
182183
->create($exercise, $this->eventDispatcher, $this)
183-
->run($fileName, $output);
184+
->run($input, $output);
184185
} finally {
185-
$this->eventDispatcher->dispatch(new Event('run.finish', compact('exercise', 'fileName')));
186+
$this->eventDispatcher->dispatch(new Event('run.finish', compact('exercise', 'input')));
186187
}
187188

188189
return $exitStatus;

‎test/ExerciseDispatcherTest.php‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use PhpSchool\PhpWorkshop\ExerciseDispatcher;
1818
use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
1919
use PhpSchool\PhpWorkshop\Factory\RunnerFactory;
20+
use PhpSchool\PhpWorkshop\Input\Input;
2021
use PhpSchool\PhpWorkshop\Output\OutputInterface;
2122
use PhpSchool\PhpWorkshop\Result\Failure;
2223
use PhpSchool\PhpWorkshop\Result\Success;
@@ -253,7 +254,7 @@ public function testVerifyThrowsExceptionIfCheckDoesNotSupportExerciseType()
253254
$this->expectException(CheckNotApplicableException::class);
254255
$this->expectExceptionMessage($msg);
255256

256-
$this->exerciseDispatcher->verify($this->exercise, '');
257+
$this->exerciseDispatcher->verify($this->exercise, new Input('app'));
257258
}
258259

259260
public function testVerifyThrowsExceptionIfExerciseDoesNotImplementCorrectInterface()
@@ -274,12 +275,13 @@ public function testVerifyThrowsExceptionIfExerciseDoesNotImplementCorrectInterf
274275
$this->expectException(ExerciseNotConfiguredException::class);
275276
$this->expectExceptionMessage('Exercise: "Some Exercise" should implement interface: "LolIDoNotExist"');
276277

277-
$this->exerciseDispatcher->verify($this->exercise, '');
278+
$this->exerciseDispatcher->verify($this->exercise, new Input('app'));
278279
}
279280

280281
public function testVerify()
281282
{
282283
$this->createExercise();
284+
$input = new Input('app', ['program' => $this->file]);
283285
$this->exercise
284286
->expects($this->once())
285287
->method('configure')
@@ -305,19 +307,20 @@ public function testVerify()
305307
$this->runner
306308
->expects($this->once())
307309
->method('verify')
308-
->with($this->file)
310+
->with($input)
309311
->will($this->returnValue($this->createMock(SuccessInterface::class)));
310312

311313
$this->exerciseDispatcher->requireCheck(get_class($this->check));
312314

313-
$result = $this->exerciseDispatcher->verify($this->exercise, $this->file);
315+
$result = $this->exerciseDispatcher->verify($this->exercise, $input);
314316
$this->assertInstanceOf(ResultAggregator::class, $result);
315317
$this->assertTrue($result->isSuccessful());
316318
}
317319

318320
public function testVerifyOnlyRunsRequiredChecks()
319321
{
320322
$this->createExercise();
323+
$input = new Input('app', ['program' => $this->file]);
321324
$this->check
322325
->expects($this->exactly(2))
323326
->method('check')
@@ -346,22 +349,23 @@ public function testVerifyOnlyRunsRequiredChecks()
346349
$this->runner
347350
->expects($this->once())
348351
->method('verify')
349-
->with($this->file)
352+
->with($input)
350353
->will($this->returnValue($this->createMock(SuccessInterface::class)));
351354

352355
$this->checkRepository->registerCheck($doNotRunMe);
353356

354357
$this->exerciseDispatcher->requireCheck(get_class($this->check));
355358
$this->exerciseDispatcher->requireCheck(get_class($this->check));
356359

357-
$result = $this->exerciseDispatcher->verify($this->exercise, $this->file);
360+
$result = $this->exerciseDispatcher->verify($this->exercise, $input);
358361
$this->assertInstanceOf(ResultAggregator::class, $result);
359362
$this->assertTrue($result->isSuccessful());
360363
}
361364

362365
public function testWhenBeforeChecksFailTheyReturnImmediately()
363366
{
364367
$this->createExercise();
368+
$input = new Input('app', ['program' => $this->file]);
365369
$this->check
366370
->expects($this->once())
367371
->method('check')
@@ -406,13 +410,14 @@ public function testWhenBeforeChecksFailTheyReturnImmediately()
406410
$this->exerciseDispatcher->requireCheck(get_class($this->check));
407411
$this->exerciseDispatcher->requireCheck(get_class($doNotRunMe));
408412

409-
$result = $this->exerciseDispatcher->verify($this->exercise, $this->file);
413+
$result = $this->exerciseDispatcher->verify($this->exercise, $input);
410414
$this->assertInstanceOf(ResultAggregator::class, $result);
411415
$this->assertFalse($result->isSuccessful());
412416
}
413417

414418
public function testAllEventsAreDispatched()
415419
{
420+
$input = new Input('app', ['program' => $this->file]);
416421
$this->eventDispatcher
417422
->expects($this->exactly(5))
418423
->method('dispatch')
@@ -429,14 +434,15 @@ public function testAllEventsAreDispatched()
429434
$this->runner
430435
->expects($this->once())
431436
->method('verify')
432-
->with($this->file)
437+
->with($input)
433438
->will($this->returnValue(new Success('test')));
434439

435-
$this->exerciseDispatcher->verify($this->exercise, $this->file);
440+
$this->exerciseDispatcher->verify($this->exercise, $input);
436441
}
437442

438443
public function testVerifyPostExecuteIsStillDispatchedEvenIfRunnerThrowsException()
439444
{
445+
$input = new Input('app', ['program' => $this->file]);
440446
$this->eventDispatcher
441447
->expects($this->exactly(3))
442448
->method('dispatch')
@@ -451,26 +457,27 @@ public function testVerifyPostExecuteIsStillDispatchedEvenIfRunnerThrowsExceptio
451457
$this->runner
452458
->expects($this->once())
453459
->method('verify')
454-
->with($this->file)
460+
->with($input)
455461
->will($this->throwException(new RuntimeException));
456462

457463
$this->expectException(RuntimeException::class);
458-
$this->exerciseDispatcher->verify($this->exercise, $this->file);
464+
$this->exerciseDispatcher->verify($this->exercise, $input);
459465
}
460466

461467
public function testRun()
462468
{
469+
$input = new Input('app', ['program' => $this->file]);
463470
$exercise = $this->createMock(ExerciseInterface::class);
464471
$output = $this->createMock(OutputInterface::class);
465472

466473
$this->mockRunner($exercise);
467474
$this->runner
468475
->expects($this->once())
469476
->method('run')
470-
->with($this->file, $output)
477+
->with($input, $output)
471478
->will($this->returnValue(true));
472479

473-
$this->assertTrue($this->exerciseDispatcher->run($exercise, $this->file, $output));
480+
$this->assertTrue($this->exerciseDispatcher->run($exercise, $input, $output));
474481
}
475482

476483
public function tearDown()

0 commit comments

Comments
 (0)