Added step execution warning supports

Dropped support for (reader|filter|writer) specific warning.

Author: gquemener

Entity/StepExecution.php

@@ -126,30 +126,17 @@ class StepExecution
     /**
      * @var array
      *
-     * @ORM\Column(name="errors", type="array", nullable=true)
+     * @ORM\Column(name="errors", type="array")
      */
-    private $errors = null;
+    private $errors = array();
 
     /**
      * @var array
      *
-     * @ORM\Column(name="reader_warnings", type="array", nullable=true)
+     * @ORM\Column(name="warnings", type="array")
      */
-    private $readerWarnings = array();
+    private $warnings = array();
 
-    /**
-     * @var array
-     *
-     * @ORM\Column(name="filter_warnings", type="array", nullable=true)
-     */
-    private $filterWarnings = array();
-
-    /**
-     * @var array
-     *
-     * @ORM\Column(name="writer_warnings", type="array", nullable=true)
-     */
-    private $writerWarnings = array();
 
     /**
      * Constructor with mandatory properties.
@@ -266,32 +253,6 @@ public function incrementReadCount()
         $this->readCount++;
     }
 
-    /**
-     * Add a reader warning
-     *
-     * @param string $reader
-     * @param string $message
-     * @param mixed  $data
-     */
-    public function addReaderWarning($reader, $message, $data)
-    {
-        $this->readerWarnings[] = array(
-            'reader' => $reader,
-            'reason' => $message,
-            'data'   => $data,
-        );
-    }
-
-    /**
-     * Get the reader warnings
-     *
-     * @return array[]
-     */
-    public function getReaderWarnings()
-    {
-        return $this->readerWarnings;
-    }
-
     /**
      * Returns the current number of items written for this execution
      *
@@ -324,32 +285,6 @@ public function incrementWriteCount()
         $this->writeCount++;
     }
 
-    /**
-     * Add a writer warning
-     *
-     * @param string $writer
-     * @param string $message
-     * @param mixed  $data
-     */
-    public function addWriterWarning($writer, $message, $data)
-    {
-        $this->writerWarnings[] = array(
-            'writer' => $writer,
-            'reason' => $message,
-            'data'   => $data,
-        );
-    }
-
-    /**
-     * Get the writer warnings
-     *
-     * @return array[]
-     */
-    public function getWriterWarnings()
-    {
-        return $this->writerWarnings;
-    }
-
     /**
      * Returns the current number of items filtered out of this execution
      *
@@ -376,16 +311,6 @@ public function addFilterWarning($filter, $message, $data)
         );
     }
 
-    /**
-     * Get the filter warnings
-     *
-     * @return array[]
-     */
-    public function getFilterWarnings()
-    {
-        return $this->filterWarnings;
-    }
-
     /**
      * @return flag to indicate that an execution should halt
      */
@@ -566,6 +491,32 @@ public function getErrors()
         return $this->errors;
     }
 
+    /**
+     * Add a warning
+     *
+     * @param string $class
+     * @param string $reason
+     * @param mixed  $item
+     */
+    public function addWarning($class, $reason, $item)
+    {
+        $this->warnings[] = array(
+            'class'  => $class,
+            'reason' => $reason,
+            'item'   => $item,
+        );
+    }
+
+    /**
+     * Get the warnings
+     *
+     * @return array[]
+     */
+    public function getWarnings()
+    {
+        return $this->warnings;
+    }
+
     /**
      * To string
      * @return string

Step/ItemStep.php

@@ -176,6 +176,12 @@ public function doExecute(StepExecution $stepExecution)
                     continue;
                 }
             } catch (InvalidItemException $e) {
+                $stepExecution->addError(
+                    get_class($this->reader),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+
                 $this->dispatchInvalidItemEvent(
                     get_class($this->reader),
                     $e->getMessage(),
@@ -197,6 +203,12 @@ public function doExecute(StepExecution $stepExecution)
                     );
                 }
             } catch (InvalidItemException $e) {
+                $stepExecution->addError(
+                    get_class($this->processor),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+
                 $this->dispatchInvalidItemEvent(
                     get_class($this->processor),
                     $e->getMessage(),
@@ -213,6 +225,12 @@ public function doExecute(StepExecution $stepExecution)
                     $this->writer->write($itemsToWrite);
                     $itemsToWrite = array();
                 } catch (InvalidItemException $e) {
+                    $stepExecution->addError(
+                        get_class($this->writer),
+                        $e->getMessage(),
+                        $e->getItem()
+                    );
+
                     $this->dispatchInvalidItemEvent(
                         get_class($this->processor),
                         $e->getMessage(),
@@ -229,6 +247,12 @@ public function doExecute(StepExecution $stepExecution)
                 $this->writer->write($itemsToWrite);
                 $itemsToWrite = array();
             } catch (InvalidItemException $e) {
+                $stepExecution->addError(
+                    get_class($this->writer),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+
                 $this->dispatchInvalidItemEvent(
                     get_class($this->processor),
                     $e->getMessage(),

Tests/Unit/Entity/StepExecutionTest.php

@@ -168,17 +168,33 @@ public function testToString()
         $this->assertEquals($expectedString, (string) $this->stepExecution);
     }
 
-    public function testAddReaderWarning()
+    public function testAddWarning()
     {
-        $reader = $this->getMock('Oro\Bundle\BatchBundle\Item\ItemReaderInterface');
-        $reason = 'something is wrong';
-        $data = array('foo' => 'bar');
-
-        $this->stepExecution->addReaderWarning($reader, $reason, $data);
+        $this->stepExecution->addWarning(
+            'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+            'something is wrong on line 1',
+            array('foo' => 'bar')
+        );
+        $this->stepExecution->addWarning(
+            'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+            'something is wrong on line 2',
+            array('baz' => false)
+        );
 
         $this->assertEquals(
-            array(array('reader' => $reader, 'reason' => $reason, 'data' => $data)),
-            $this->stepExecution->getReaderWarnings()
+            array(
+                array(
+                    'class'  => 'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+                    'reason' => 'something is wrong on line 1',
+                    'item'   => array('foo' => 'bar')
+                ),
+                array(
+                    'class'  => 'Oro\Bundle\BatchBundle\Item\ItemReaderInterface',
+                    'reason' => 'something is wrong on line 2',
+                    'item'   => array('baz' => false)
+                )
+            ),
+            $this->stepExecution->getWarnings()
         );
     }
 

Tests/Unit/Step/ItemStepTest.php

@@ -192,6 +192,14 @@ public function testDispatchReaderInvalidItemException()
         $this->itemStep->setProcessor($processor);
         $this->itemStep->setWriter($writer);
 
+        $stepExecution->expects($this->once())
+            ->method('addError')
+            ->with(
+                get_class($reader),
+                'The read item is invalid',
+                array('foo' => 'bar')
+            );
+
         $this->itemStep->setBatchSize(5);
         $this->itemStep->execute($stepExecution);
     }
@@ -242,6 +250,14 @@ public function testDispatchProcessInvalidItemException()
         $this->itemStep->setProcessor($processor);
         $this->itemStep->setWriter($writer);
 
+        $stepExecution->expects($this->once())
+            ->method('addError')
+            ->with(
+                get_class($processor),
+                'The processed item is invalid',
+                array('foo' => 'bar')
+            );
+
         $this->itemStep->setBatchSize(5);
         $this->itemStep->execute($stepExecution);
     }
@@ -295,6 +311,14 @@ public function testDispatchWriteInvalidItemException()
         $this->itemStep->setProcessor($processor);
         $this->itemStep->setWriter($writer);
 
+        $stepExecution->expects($this->once())
+            ->method('addError')
+            ->with(
+                get_class($writer),
+                'The written item is invalid',
+                array('foo' => 'bar')
+            );
+
         $this->itemStep->setBatchSize(5);
         $this->itemStep->execute($stepExecution);
     }