Store the step element name instead of classname

gquemener · gquemener · commit 255b94af55dc · 2013-10-16T12:28:54.000+02:00
This is more usefull for displaying purpose. Classname is still sent
into the InvalidItemEvent, thus being displayed in the log.
diff --git a/Entity/StepExecution.php b/Entity/StepExecution.php
@@ -7,7 +7,6 @@
 use Oro\Bundle\BatchBundle\Item\ExecutionContext;
 use Oro\Bundle\BatchBundle\Job\BatchStatus;
 use Oro\Bundle\BatchBundle\Job\ExitStatus;
-use Oro\Bundle\BatchBundle\Item\ItemReaderInterface;
 
 /**
  * Batch domain object representation the execution of a step. Unlike
@@ -137,7 +136,6 @@ class StepExecution
      */
     private $warnings = array();
 
-
     /**
      * Constructor with mandatory properties.
      *
@@ -498,10 +496,10 @@ public function getErrors()
      * @param string $reason
      * @param mixed  $item
      */
-    public function addWarning($class, $reason, $item)
+    public function addWarning($name, $reason, $item)
     {
         $this->warnings[] = array(
-            'class'  => $class,
+            'name'   => sprintf('oro_batch.%s.title', $name),
             'reason' => $reason,
             'item'   => $item,
         );
diff --git a/Step/ItemStep.php b/Step/ItemStep.php
@@ -176,7 +176,7 @@ public function doExecute(StepExecution $stepExecution)
                     continue;
                 }
             } catch (InvalidItemException $e) {
-                $this->handleStepExecutionWarning($stepExecution, get_class($this->reader), $e);
+                $this->handleStepExecutionWarning($stepExecution, $this->reader, $e);
 
                 continue;
             }
@@ -193,7 +193,7 @@ public function doExecute(StepExecution $stepExecution)
                     );
                 }
             } catch (InvalidItemException $e) {
-                $this->handleStepExecutionWarning($stepExecution, get_class($this->processor), $e);
+                $this->handleStepExecutionWarning($stepExecution, $this->processor, $e);
 
                 continue;
             }
@@ -205,7 +205,7 @@ public function doExecute(StepExecution $stepExecution)
                     $this->writer->write($itemsToWrite);
                     $itemsToWrite = array();
                 } catch (InvalidItemException $e) {
-                    $this->handleStepExecutionWarning($stepExecution, get_class($this->writer), $e);
+                    $this->handleStepExecutionWarning($stepExecution, $this->writer, $e);
 
                     continue;
                 }
@@ -217,7 +217,7 @@ public function doExecute(StepExecution $stepExecution)
                 $this->writer->write($itemsToWrite);
                 $itemsToWrite = array();
             } catch (InvalidItemException $e) {
-                $this->handleStepExecutionWarning($stepExecution, get_class($this->writer), $e);
+                $this->handleStepExecutionWarning($stepExecution, $this->writer, $e);
             }
         }
     }
@@ -247,9 +247,12 @@ protected function initializeStepComponents(StepExecution $stepExecution)
      * @param string               $class
      * @param InvalidItemException $e
      */
-    private function handleStepExecutionWarning(StepExecution $stepExecution, $class, InvalidItemException $e)
-    {
-        $stepExecution->addWarning($class, $e->getMessage(), $e->getItem());
-        $this->dispatchInvalidItemEvent($class, $e->getMessage(), $e->getItem());
+    private function handleStepExecutionWarning(
+        StepExecution $stepExecution,
+        AbstractConfigurableStepElement $element,
+        InvalidItemException $e
+    ) {
+        $stepExecution->addWarning($element->getName(), $e->getMessage(), $e->getItem());
+        $this->dispatchInvalidItemEvent(get_class($element), $e->getMessage(), $e->getItem());
     }
 }
diff --git a/Tests/Unit/Entity/StepExecutionTest.php b/Tests/Unit/Entity/StepExecutionTest.php
@@ -171,25 +171,25 @@ public function testToString()
     public function testAddWarning()
     {
         $this->stepExecution->addWarning(
-            'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+            'foo',
             'something is wrong on line 1',
             array('foo' => 'bar')
         );
         $this->stepExecution->addWarning(
-            'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+            'bar',
             'something is wrong on line 2',
             array('baz' => false)
         );
 
         $this->assertEquals(
             array(
                 array(
-                    'class'  => 'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+                    'name'   => 'oro_batch.foo.title',
                     'reason' => 'something is wrong on line 1',
                     'item'   => array('foo' => 'bar')
                 ),
                 array(
-                    'class'  => 'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+                    'name'   => 'oro_batch.bar.title',
                     'reason' => 'something is wrong on line 2',
                     'item'   => array('baz' => false)
                 )
diff --git a/Tests/Unit/Step/ItemStepTest.php b/Tests/Unit/Step/ItemStepTest.php
@@ -151,7 +151,7 @@ public function testExecute()
         $this->itemStep->execute($stepExecution);
     }
 
-    public function testDispatchReaderInvalidItemException()
+    public function testDispatchReadInvalidItemException()
     {
         $stepExecution = $this->getMockBuilder('Oro\\Bundle\\BatchBundle\\Entity\\StepExecution')
             ->disableOriginalConstructor()
@@ -166,25 +166,28 @@ public function testDispatchReaderInvalidItemException()
             ->with(
                 EventInterface::INVALID_ITEM,
                 $this->logicalAnd(
-                    $this->isInstanceOf('Oro\Bundle\BatchBundle\Event\InvalidItemEvent'),
+                    $this->isInstanceOf('Oro\\Bundle\\BatchBundle\\Event\\InvalidItemEvent'),
                     $this->attributeEqualTo('reason', 'The read item is invalid'),
                     $this->attributeEqualTo('item', array('foo' => 'bar'))
                 )
             );
 
-        $reader = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemReaderInterface');
+        $reader = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemReaderTestHelper');
         $reader->expects($this->exactly(2))
             ->method('read')
             ->will($this->onConsecutiveCalls(
                 $this->throwException(new InvalidItemException('The read item is invalid', array('foo' => 'bar'))),
                 $this->returnValue(null)
             ));
+        $reader->expects($this->any())
+            ->method('getName')
+            ->will($this->returnValue('stub_reader'));
 
-        $processor = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemProcessorInterface');
+        $processor = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemProcessorTestHelper');
         $processor->expects($this->never())
             ->method('process');
 
-        $writer = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemWriterInterface');
+        $writer = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemWriterTestHelper');
         $writer->expects($this->never())
             ->method('write');
 
@@ -195,7 +198,7 @@ public function testDispatchReaderInvalidItemException()
         $stepExecution->expects($this->once())
             ->method('addWarning')
             ->with(
-                get_class($reader),
+                'stub_reader',
                 'The read item is invalid',
                 array('foo' => 'bar')
             );
@@ -219,30 +222,33 @@ public function testDispatchProcessInvalidItemException()
             ->with(
                 EventInterface::INVALID_ITEM,
                 $this->logicalAnd(
-                    $this->isInstanceOf('Oro\Bundle\BatchBundle\Event\InvalidItemEvent'),
+                    $this->isInstanceOf('Oro\\Bundle\\BatchBundle\\Event\\InvalidItemEvent'),
                     $this->attributeEqualTo('reason', 'The processed item is invalid'),
                     $this->attributeEqualTo('item', array('foo' => 'bar'))
                 )
             );
 
-        $reader = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemReaderInterface');
+        $reader = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemReaderTestHelper');
         $reader->expects($this->exactly(2))
             ->method('read')
             ->will($this->onConsecutiveCalls(
                 $this->returnValue(array('foo' => 'bar')),
                 $this->returnValue(null)
             ));
 
-        $processor = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemProcessorInterface');
+        $processor = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemProcessorTestHelper');
         $processor->expects($this->exactly(1))
             ->method('process')
             ->will(
                 $this->throwException(
                     new InvalidItemException('The processed item is invalid', array('foo' => 'bar'))
                 )
             );
+        $processor->expects($this->any())
+            ->method('getName')
+            ->will($this->returnValue('stub_processor'));
 
-        $writer = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemWriterInterface');
+        $writer = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemWriterTestHelper');
         $writer->expects($this->never())
             ->method('write');
 
@@ -253,7 +259,7 @@ public function testDispatchProcessInvalidItemException()
         $stepExecution->expects($this->once())
             ->method('addWarning')
             ->with(
-                get_class($processor),
+                'stub_processor',
                 'The processed item is invalid',
                 array('foo' => 'bar')
             );
@@ -277,35 +283,38 @@ public function testDispatchWriteInvalidItemException()
             ->with(
                 EventInterface::INVALID_ITEM,
                 $this->logicalAnd(
-                    $this->isInstanceOf('Oro\Bundle\BatchBundle\Event\InvalidItemEvent'),
+                    $this->isInstanceOf('Oro\\Bundle\\BatchBundle\\Event\\InvalidItemEvent'),
                     $this->attributeEqualTo('reason', 'The written item is invalid'),
                     $this->attributeEqualTo('item', array('foo' => 'bar'))
                 )
             );
 
-        $reader = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemReaderInterface');
+        $reader = $this->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemReaderInterface');
         $reader->expects($this->exactly(2))
             ->method('read')
             ->will($this->onConsecutiveCalls(
                 $this->returnValue(array('foo' => 'bar')),
                 $this->returnValue(null)
             ));
 
-        $processor = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemProcessorInterface');
+        $processor = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemProcessorTestHelper');
         $processor->expects($this->exactly(1))
             ->method('process')
             ->will(
                 $this->returnValue(array('foo' => 'bar'))
             );
 
-        $writer = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemWriterInterface');
+        $writer = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemWriterTestHelper');
         $writer->expects($this->exactly(1))
             ->method('write')
             ->will(
                 $this->throwException(
                     new InvalidItemException('The written item is invalid', array('foo' => 'bar'))
                 )
             );
+        $writer->expects($this->any())
+            ->method('getName')
+            ->will($this->returnValue('stub_writer'));
 
         $this->itemStep->setReader($reader);
         $this->itemStep->setProcessor($processor);
@@ -314,7 +323,7 @@ public function testDispatchWriteInvalidItemException()
         $stepExecution->expects($this->once())
             ->method('addWarning')
             ->with(
-                get_class($writer),
+                'stub_writer',
                 'The written item is invalid',
                 array('foo' => 'bar')
             );
@@ -335,7 +344,6 @@ public function testProcessShouldNotReturnNull()
         $stepExecution->expects($this->once())
             ->method('addFailureException');
 
-
         $this->eventDispatcher
             ->expects($this->at(1))
             ->method('dispatch')
@@ -344,18 +352,17 @@ public function testProcessShouldNotReturnNull()
                 $this->anything()
             );
 
-
-        $reader = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemReaderInterface');
+        $reader = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemReaderTestHelper');
         $reader->expects($this->any())
             ->method('read')
             ->will($this->returnValue(array('foo' => 'bar')));
 
-        $processor = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemProcessorInterface');
+        $processor = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemProcessorTestHelper');
         $processor->expects($this->any())
             ->method('process')
             ->will($this->returnValue(null));
 
-        $writer = $this ->getMock('Oro\\Bundle\\BatchBundle\\Item\\ItemWriterInterface');
+        $writer = $this->getMock('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemWriterTestHelper');
 
         $this->itemStep->setReader($reader);
         $this->itemStep->setProcessor($processor);
@@ -371,12 +378,13 @@ public function testProcessShouldNotReturnNull()
      */
     protected function assertEntity($entity)
     {
-        $this->assertInstanceOf('Oro\Bundle\BatchBundle\Step\ItemStep', $entity);
+        $this->assertInstanceOf('Oro\\Bundle\\BatchBundle\\Step\\ItemStep', $entity);
     }
+
     private function getReaderMock(array $configuration, array $fields = array())
     {
         $reader = $this
-            ->getMockBuilder('Oro\Bundle\BatchBundle\Tests\Unit\Item\ItemReaderTestHelper')
+            ->getMockBuilder('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemReaderTestHelper')
             ->disableOriginalConstructor()
             ->getMock();
 
@@ -394,7 +402,7 @@ private function getReaderMock(array $configuration, array $fields = array())
     private function getProcessorMock(array $configuration, array $fields = array())
     {
         $processor = $this
-            ->getMockBuilder('Oro\Bundle\BatchBundle\Tests\Unit\Item\ItemProcessorTestHelper')
+            ->getMockBuilder('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemProcessorTestHelper')
             ->disableOriginalConstructor()
             ->getMock();
 
@@ -412,7 +420,7 @@ private function getProcessorMock(array $configuration, array $fields = array())
     private function getWriterMock(array $configuration, array $fields = array())
     {
         $writer = $this
-            ->getMockBuilder('Oro\Bundle\BatchBundle\Tests\Unit\Item\ItemWriterTestHelper')
+            ->getMockBuilder('Oro\\Bundle\\BatchBundle\\Tests\\Unit\\Item\\ItemWriterTestHelper')
             ->disableOriginalConstructor()
             ->getMock();
 

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ public function doExecute(StepExecution $stepExecution)`
`176`	`176`	`continue;`
`177`	`177`	`}`
`178`	`178`	`} catch (InvalidItemException $e) {`
`179`		`- $this->handleStepExecutionWarning($stepExecution, get_class($this->reader), $e);`
	`179`	`+ $this->handleStepExecutionWarning($stepExecution, $this->reader, $e);`
`180`	`180`
`181`	`181`	`continue;`
`182`	`182`	`}`
`@@ -193,7 +193,7 @@ public function doExecute(StepExecution $stepExecution)`
`193`	`193`	`);`
`194`	`194`	`}`
`195`	`195`	`} catch (InvalidItemException $e) {`
`196`		`- $this->handleStepExecutionWarning($stepExecution, get_class($this->processor), $e);`
	`196`	`+ $this->handleStepExecutionWarning($stepExecution, $this->processor, $e);`
`197`	`197`
`198`	`198`	`continue;`
`199`	`199`	`}`
`@@ -205,7 +205,7 @@ public function doExecute(StepExecution $stepExecution)`
`205`	`205`	`$this->writer->write($itemsToWrite);`
`206`	`206`	`$itemsToWrite = array();`
`207`	`207`	`} catch (InvalidItemException $e) {`
`208`		`- $this->handleStepExecutionWarning($stepExecution, get_class($this->writer), $e);`
	`208`	`+ $this->handleStepExecutionWarning($stepExecution, $this->writer, $e);`
`209`	`209`
`210`	`210`	`continue;`
`211`	`211`	`}`
`@@ -217,7 +217,7 @@ public function doExecute(StepExecution $stepExecution)`
`217`	`217`	`$this->writer->write($itemsToWrite);`
`218`	`218`	`$itemsToWrite = array();`
`219`	`219`	`} catch (InvalidItemException $e) {`
`220`		`- $this->handleStepExecutionWarning($stepExecution, get_class($this->writer), $e);`
	`220`	`+ $this->handleStepExecutionWarning($stepExecution, $this->writer, $e);`
`221`	`221`	`}`
`222`	`222`	`}`
`223`	`223`	`}`
`@@ -247,9 +247,12 @@ protected function initializeStepComponents(StepExecution $stepExecution)`
`247`	`247`	`* @param string $class`
`248`	`248`	`* @param InvalidItemException $e`
`249`	`249`	`*/`
`250`		`- private function handleStepExecutionWarning(StepExecution $stepExecution, $class, InvalidItemException $e)`
`251`		`- {`
`252`		`- $stepExecution->addWarning($class, $e->getMessage(), $e->getItem());`
`253`		`- $this->dispatchInvalidItemEvent($class, $e->getMessage(), $e->getItem());`
	`250`	`+ private function handleStepExecutionWarning(`
	`251`	`+ StepExecution $stepExecution,`
	`252`	`+ AbstractConfigurableStepElement $element,`
	`253`	`+ InvalidItemException $e`
	`254`	`+ ) {`
	`255`	`+ $stepExecution->addWarning($element->getName(), $e->getMessage(), $e->getItem());`
	`256`	`+ $this->dispatchInvalidItemEvent(get_class($element), $e->getMessage(), $e->getItem());`
`254`	`257`	`}`
`255`	`258`	`}`