feature#8288 [Process] Added support for stdout and stderr flush (Issue #7884) (imobilis)

fabpot · fabpot · commit eb6da72cf835 · 2013-09-27T15:52:58.000+02:00
This PR was squashed before being merged into the master branch (closes #8288). Discussion ---------- [Process] Added support for stdout and stderr flush (Issue #7884) | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #7884 | License | MIT | Doc PR | symfony/symfony-docs#2728 **To-do** - [x] Submit changes to the documentation. - [x] Fix a test broken on travis. - [x] Fix mistakes on the documentation. - [x] Removed flush + get methods. - [x] Changed tests assert calls. This PR introduces flushing methods for both stdout and stderr on Process class. The new methods are: - flushOutput(): clears the output buffer. - flushErrorOutput(): clears the error output buffer. Tests for new methods are included on the PR. Commits ------- 90daef7 [Process] Added support for stdout and stderr flush (Issue #7884)
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -396,6 +396,19 @@ public function getIncrementalOutput()
         return $latest;
     }
 
+    /**
+     * Clears the process output.
+     *
+     * @return Process
+     */
+    public function flushOutput()
+    {
+        $this->stdout = '';
+        $this->incrementalOutputOffset = 0;
+
+        return $this;
+    }
+
     /**
      * Returns the current error output of the process (STDERR).
      *
@@ -429,6 +442,19 @@ public function getIncrementalErrorOutput()
         return $latest;
     }
 
+    /**
+     * Clears the process output.
+     *
+     * @return Process
+     */
+    public function flushErrorOutput()
+    {
+        $this->stderr = '';
+        $this->incrementalErrorOutputOffset = 0;
+
+        return $this;
+    }
+
     /**
      * Returns the exit code returned by the process.
      *
diff --git a/src/Symfony/Component/Process/Tests/AbstractProcessTest.php b/src/Symfony/Component/Process/Tests/AbstractProcessTest.php
@@ -169,6 +169,15 @@ public function testGetIncrementalErrorOutput()
         }
     }
 
+    public function testFlushErrorOutput()
+    {
+        $p = new Process(sprintf('php -r %s', escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));
+
+        $p->run();
+        $p->flushErrorOutput();
+        $this->assertEmpty($p->getErrorOutput());
+    }
+
     public function testGetOutput()
     {
         $p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++; usleep(500); }')));
@@ -188,6 +197,15 @@ public function testGetIncrementalOutput()
         }
     }
 
+    public function testFlushOutput()
+    {
+        $p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++;}')));
+
+        $p->run();
+        $p->flushOutput();
+        $this->assertEmpty($p->getOutput());
+    }
+
     public function testExitCodeCommandFailed()
     {
         if (defined('PHP_WINDOWS_VERSION_BUILD')) {

Original file line number	Diff line number	Diff line change
`@@ -169,6 +169,15 @@ public function testGetIncrementalErrorOutput()`
`169`	`169`	`}`
`170`	`170`	`}`
`171`	`171`
	`172`	`+ public function testFlushErrorOutput()`
	`173`	`+ {`
	`174`	`+ $p = new Process(sprintf('php -r %s', escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));`
	`175`	`+`
	`176`	`+ $p->run();`
	`177`	`+ $p->flushErrorOutput();`
	`178`	`+ $this->assertEmpty($p->getErrorOutput());`
	`179`	`+ }`
	`180`	`+`
`172`	`181`	`public function testGetOutput()`
`173`	`182`	`{`
`174`	`183`	`$p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++; usleep(500); }')));`
`@@ -188,6 +197,15 @@ public function testGetIncrementalOutput()`
`188`	`197`	`}`
`189`	`198`	`}`
`190`	`199`
	`200`	`+ public function testFlushOutput()`
	`201`	`+ {`
	`202`	`+ $p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++;}')));`
	`203`	`+`
	`204`	`+ $p->run();`
	`205`	`+ $p->flushOutput();`
	`206`	`+ $this->assertEmpty($p->getOutput());`
	`207`	`+ }`
	`208`	`+`
`191`	`209`	`public function testExitCodeCommandFailed()`
`192`	`210`	`{`
`193`	`211`	`if (defined('PHP_WINDOWS_VERSION_BUILD')) {`