4 * This file is part of the Behat.
5 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
7 * For the full copyright and license information, please view the LICENSE
8 * file that was distributed with this source code.
11 namespace Behat\Behat\Output\ServiceContainer\Formatter;
13 use Behat\Behat\Definition\ServiceContainer\DefinitionExtension;
14 use Behat\Behat\EventDispatcher\Event\BackgroundTested;
15 use Behat\Behat\EventDispatcher\Event\OutlineTested;
16 use Behat\Behat\EventDispatcher\Event\ScenarioTested;
17 use Behat\Testwork\Exception\ServiceContainer\ExceptionExtension;
18 use Behat\Testwork\Output\ServiceContainer\Formatter\FormatterFactory;
19 use Behat\Testwork\Output\ServiceContainer\OutputExtension;
20 use Behat\Testwork\ServiceContainer\ServiceProcessor;
21 use Behat\Testwork\Translator\ServiceContainer\TranslatorExtension;
22 use Symfony\Component\DependencyInjection\ContainerBuilder;
23 use Symfony\Component\DependencyInjection\Definition;
24 use Symfony\Component\DependencyInjection\Reference;
27 * Behat pretty formatter factory.
29 * @author Konstantin Kudryashov <ever.zet@gmail.com>
31 class PrettyFormatterFactory implements FormatterFactory
34 * @var ServiceProcessor
41 const ROOT_LISTENER_ID = 'output.node.listener.pretty';
42 const RESULT_TO_STRING_CONVERTER_ID = 'output.node.printer.result_to_string';
45 * Available extension points
47 const ROOT_LISTENER_WRAPPER_TAG = 'output.node.listener.pretty.wrapper';
50 * Initializes extension.
52 * @param null|ServiceProcessor $processor
54 public function __construct(ServiceProcessor $processor = null)
56 $this->processor = $processor ? : new ServiceProcessor();
62 public function buildFormatter(ContainerBuilder $container)
64 $this->loadRootNodeListener($container);
66 $this->loadCorePrinters($container);
67 $this->loadTableOutlinePrinter($container);
68 $this->loadExpandedOutlinePrinter($container);
69 $this->loadHookPrinters($container);
70 $this->loadStatisticsPrinter($container);
71 $this->loadPrinterHelpers($container);
73 $this->loadFormatter($container);
79 public function processFormatter(ContainerBuilder $container)
81 $this->processListenerWrappers($container);
85 * Loads pretty formatter node event listener.
87 * @param ContainerBuilder $container
89 protected function loadRootNodeListener(ContainerBuilder $container)
91 $definition = new Definition('Behat\Testwork\Output\Node\EventListener\ChainEventListener', array(
93 new Definition('Behat\Behat\Output\Node\EventListener\AST\SuiteListener', array(
94 new Reference('output.node.printer.pretty.suite_setup')
96 new Definition('Behat\Behat\Output\Node\EventListener\AST\FeatureListener', array(
97 new Reference('output.node.printer.pretty.feature'),
98 new Reference('output.node.printer.pretty.feature_setup')
100 $this->proxySiblingEvents(
101 BackgroundTested::BEFORE,
102 BackgroundTested::AFTER,
104 new Definition('Behat\Behat\Output\Node\EventListener\AST\ScenarioNodeListener', array(
105 BackgroundTested::AFTER_SETUP,
106 BackgroundTested::AFTER,
107 new Reference('output.node.printer.pretty.scenario')
109 new Definition('Behat\Behat\Output\Node\EventListener\AST\StepListener', array(
110 new Reference('output.node.printer.pretty.step'),
111 new Reference('output.node.printer.pretty.step_setup')
115 $this->proxySiblingEvents(
116 ScenarioTested::BEFORE,
117 ScenarioTested::AFTER,
119 new Definition('Behat\Behat\Output\Node\EventListener\AST\ScenarioNodeListener', array(
120 ScenarioTested::AFTER_SETUP,
121 ScenarioTested::AFTER,
122 new Reference('output.node.printer.pretty.scenario'),
123 new Reference('output.node.printer.pretty.scenario_setup')
125 new Definition('Behat\Behat\Output\Node\EventListener\AST\StepListener', array(
126 new Reference('output.node.printer.pretty.step'),
127 new Reference('output.node.printer.pretty.step_setup')
131 $this->proxySiblingEvents(
132 OutlineTested::BEFORE,
133 OutlineTested::AFTER,
135 $this->proxyEventsIfParameterIsSet(
138 new Definition('Behat\Behat\Output\Node\EventListener\AST\OutlineTableListener', array(
139 new Reference('output.node.printer.pretty.outline_table'),
140 new Reference('output.node.printer.pretty.example_row'),
141 new Reference('output.node.printer.pretty.example_setup'),
142 new Reference('output.node.printer.pretty.example_step_setup')
145 $this->proxyEventsIfParameterIsSet(
148 new Definition('Behat\Behat\Output\Node\EventListener\AST\OutlineListener', array(
149 new Reference('output.node.printer.pretty.outline'),
150 new Reference('output.node.printer.pretty.example'),
151 new Reference('output.node.printer.pretty.example_step'),
152 new Reference('output.node.printer.pretty.example_setup'),
153 new Reference('output.node.printer.pretty.example_step_setup')
160 $container->setDefinition(self::ROOT_LISTENER_ID, $definition);
164 * Loads formatter itself.
166 * @param ContainerBuilder $container
168 protected function loadFormatter(ContainerBuilder $container)
170 $definition = new Definition('Behat\Behat\Output\Statistics\TotalStatistics');
171 $container->setDefinition('output.pretty.statistics', $definition);
173 $definition = new Definition('Behat\Testwork\Output\NodeEventListeningFormatter', array(
175 'Prints the feature as is.',
182 $this->createOutputPrinterDefinition(),
183 new Definition('Behat\Testwork\Output\Node\EventListener\ChainEventListener', array(
185 $this->rearrangeBackgroundEvents(
186 new Reference(self::ROOT_LISTENER_ID)
188 new Definition('Behat\Behat\Output\Node\EventListener\Statistics\StatisticsListener', array(
189 new Reference('output.pretty.statistics'),
190 new Reference('output.node.printer.pretty.statistics')
192 new Definition('Behat\Behat\Output\Node\EventListener\Statistics\ScenarioStatsListener', array(
193 new Reference('output.pretty.statistics')
195 new Definition('Behat\Behat\Output\Node\EventListener\Statistics\StepStatsListener', array(
196 new Reference('output.pretty.statistics'),
197 new Reference(ExceptionExtension::PRESENTER_ID)
203 $definition->addTag(OutputExtension::FORMATTER_TAG, array('priority' => 100));
204 $container->setDefinition(OutputExtension::FORMATTER_TAG . '.pretty', $definition);
208 * Loads feature, scenario and step printers.
210 * @param ContainerBuilder $container
212 protected function loadCorePrinters(ContainerBuilder $container)
214 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyFeaturePrinter');
215 $container->setDefinition('output.node.printer.pretty.feature', $definition);
217 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyPathPrinter', array(
218 new Reference('output.node.printer.pretty.width_calculator'),
221 $container->setDefinition('output.node.printer.pretty.path', $definition);
223 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyScenarioPrinter', array(
224 new Reference('output.node.printer.pretty.path'),
226 $container->setDefinition('output.node.printer.pretty.scenario', $definition);
228 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyStepPrinter', array(
229 new Reference('output.node.printer.pretty.step_text_painter'),
230 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
231 new Reference('output.node.printer.pretty.path'),
232 new Reference(ExceptionExtension::PRESENTER_ID)
234 $container->setDefinition('output.node.printer.pretty.step', $definition);
236 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySkippedStepPrinter', array(
237 new Reference('output.node.printer.pretty.step_text_painter'),
238 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
239 new Reference('output.node.printer.pretty.path'),
241 $container->setDefinition('output.node.printer.pretty.skipped_step', $definition);
245 * Loads table outline printer.
247 * @param ContainerBuilder $container
249 protected function loadTableOutlinePrinter(ContainerBuilder $container)
251 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyOutlineTablePrinter', array(
252 new Reference('output.node.printer.pretty.scenario'),
253 new Reference('output.node.printer.pretty.skipped_step'),
254 new Reference(self::RESULT_TO_STRING_CONVERTER_ID)
256 $container->setDefinition('output.node.printer.pretty.outline_table', $definition);
258 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyExampleRowPrinter', array(
259 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
260 new Reference(ExceptionExtension::PRESENTER_ID)
262 $container->setDefinition('output.node.printer.pretty.example_row', $definition);
266 * Loads expanded outline printer.
268 * @param ContainerBuilder $container
270 protected function loadExpandedOutlinePrinter(ContainerBuilder $container)
272 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyOutlinePrinter', array(
273 new Reference('output.node.printer.pretty.scenario'),
274 new Reference('output.node.printer.pretty.skipped_step'),
275 new Reference(self::RESULT_TO_STRING_CONVERTER_ID)
277 $container->setDefinition('output.node.printer.pretty.outline', $definition);
279 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyExamplePrinter', array(
280 new Reference('output.node.printer.pretty.path'),
282 $container->setDefinition('output.node.printer.pretty.example', $definition);
284 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyStepPrinter', array(
285 new Reference('output.node.printer.pretty.step_text_painter'),
286 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
287 new Reference('output.node.printer.pretty.path'),
288 new Reference(ExceptionExtension::PRESENTER_ID),
291 $container->setDefinition('output.node.printer.pretty.example_step', $definition);
295 * Loads hook printers.
297 * @param ContainerBuilder $container
299 protected function loadHookPrinters(ContainerBuilder $container)
301 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
302 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
303 new Reference(ExceptionExtension::PRESENTER_ID),
308 $container->setDefinition('output.node.printer.pretty.suite_setup', $definition);
310 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
311 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
312 new Reference(ExceptionExtension::PRESENTER_ID),
317 $container->setDefinition('output.node.printer.pretty.feature_setup', $definition);
319 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
320 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
321 new Reference(ExceptionExtension::PRESENTER_ID),
324 $container->setDefinition('output.node.printer.pretty.scenario_setup', $definition);
326 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
327 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
328 new Reference(ExceptionExtension::PRESENTER_ID),
331 $container->setDefinition('output.node.printer.pretty.step_setup', $definition);
333 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
334 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
335 new Reference(ExceptionExtension::PRESENTER_ID),
338 $container->setDefinition('output.node.printer.pretty.example_step_setup', $definition);
340 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettySetupPrinter', array(
341 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
342 new Reference(ExceptionExtension::PRESENTER_ID),
345 $container->setDefinition('output.node.printer.pretty.example_setup', $definition);
349 * Loads statistics printer.
351 * @param ContainerBuilder $container
353 protected function loadStatisticsPrinter(ContainerBuilder $container)
355 $definition = new Definition('Behat\Behat\Output\Node\Printer\CounterPrinter', array(
356 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
357 new Reference(TranslatorExtension::TRANSLATOR_ID),
359 $container->setDefinition('output.node.printer.counter', $definition);
361 $definition = new Definition('Behat\Behat\Output\Node\Printer\ListPrinter', array(
362 new Reference(self::RESULT_TO_STRING_CONVERTER_ID),
363 new Reference(ExceptionExtension::PRESENTER_ID),
364 new Reference(TranslatorExtension::TRANSLATOR_ID),
367 $container->setDefinition('output.node.printer.list', $definition);
369 $definition = new Definition('Behat\Behat\Output\Node\Printer\Pretty\PrettyStatisticsPrinter', array(
370 new Reference('output.node.printer.counter'),
371 new Reference('output.node.printer.list')
373 $container->setDefinition('output.node.printer.pretty.statistics', $definition);
377 * Loads printer helpers.
379 * @param ContainerBuilder $container
381 protected function loadPrinterHelpers(ContainerBuilder $container)
383 $definition = new Definition('Behat\Behat\Output\Node\Printer\Helper\WidthCalculator');
384 $container->setDefinition('output.node.printer.pretty.width_calculator', $definition);
386 $definition = new Definition('Behat\Behat\Output\Node\Printer\Helper\StepTextPainter', array(
387 new Reference(DefinitionExtension::PATTERN_TRANSFORMER_ID),
388 new Reference(self::RESULT_TO_STRING_CONVERTER_ID)
390 $container->setDefinition('output.node.printer.pretty.step_text_painter', $definition);
392 $definition = new Definition('Behat\Behat\Output\Node\Printer\Helper\ResultToStringConverter');
393 $container->setDefinition(self::RESULT_TO_STRING_CONVERTER_ID, $definition);
397 * Creates output printer definition.
401 protected function createOutputPrinterDefinition()
403 return new Definition('Behat\Testwork\Output\Printer\StreamOutputPrinter', array(
404 new Definition('Behat\Behat\Output\Printer\ConsoleOutputFactory'),
409 * Creates root listener definition.
411 * @param mixed $listener
415 protected function rearrangeBackgroundEvents($listener)
417 return new Definition('Behat\Behat\Output\Node\EventListener\Flow\FirstBackgroundFiresFirstListener', array(
418 new Definition('Behat\Behat\Output\Node\EventListener\Flow\OnlyFirstBackgroundFiresListener', array(
425 * Creates contextual proxy listener.
427 * @param string $beforeEventName
428 * @param string $afterEventName
429 * @param Definition[] $listeners
433 protected function proxySiblingEvents($beforeEventName, $afterEventName, array $listeners)
435 return new Definition('Behat\Behat\Output\Node\EventListener\Flow\FireOnlySiblingsListener',
439 new Definition('Behat\Testwork\Output\Node\EventListener\ChainEventListener', array($listeners))
445 * Creates contextual proxy listener.
447 * @param string $name
448 * @param mixed $value
449 * @param mixed $listener
453 protected function proxyEventsIfParameterIsSet($name, $value, Definition $listener)
455 return new Definition('Behat\Testwork\Output\Node\EventListener\Flow\FireOnlyIfFormatterParameterListener',
456 array($name, $value, $listener)
461 * Processes all registered pretty formatter node listener wrappers.
463 * @param ContainerBuilder $container
465 protected function processListenerWrappers(ContainerBuilder $container)
467 $this->processor->processWrapperServices($container, self::ROOT_LISTENER_ID, self::ROOT_LISTENER_WRAPPER_TAG);