Provide cleanup tools

Author: kylekatarnls

phpunit.xml

@@ -2,7 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/5.6/phpunit.xsd"
          colors="true"
-         bootstrap="./vendor/autoload.php"
+         bootstrap="./tests/bootstrap.php"
          forceCoversAnnotation="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"

src/Phug/DevTool/TestCase.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Phug\DevTool;
+
+use PHPUnit\Framework\TestCase as PHPUnitTestCase;
+
+class TestCase extends PHPUnitTestCase
+{
+    /**
+     * @var string
+     */
+    protected $tempDirectory;
+
+    /**
+     * @var string[]
+     */
+    protected $tempDirectoryFiles;
+
+    /**
+     * @before
+     */
+    public function saveTempDirectoryFilesList()
+    {
+        $this->tempDirectory = $this->tempDirectory ?: sys_get_temp_dir();
+
+        $this->tempDirectoryFiles = scandir($this->tempDirectory);
+    }
+
+    /**
+     * @after
+     */
+    public function cleanupTempDirectory()
+    {
+        $files = scandir($this->tempDirectory);
+
+        foreach (array_diff($files, $this->tempDirectoryFiles) as $file) {
+            $this->removeFile($this->tempDirectory.DIRECTORY_SEPARATOR.$file);
+        }
+    }
+
+    protected function removeFile($file)
+    {
+        if (is_dir($file)) {
+            $this->emptyDirectory($file);
+            rmdir($file);
+
+            return;
+        }
+
+        unlink($file);
+    }
+
+    protected function emptyDirectory($dir)
+    {
+        if (!is_dir($dir)) {
+            return;
+        }
+
+        foreach (scandir($dir) as $file) {
+            if ($file !== '.' && $file !== '..') {
+                $this->removeFile($dir.'/'.$file);
+            }
+        }
+    }
+}

tests/Phug/DevTool/ApplicationTest.php

@@ -2,8 +2,8 @@
 
 namespace Phug\Test\DevTool;
 
-use PHPUnit\Framework\TestCase;
 use Phug\DevTool\Application;
+use Phug\DevTool\TestCase;
 use RuntimeException;
 use Symfony\Component\Console\Application as ConsoleApplication;
 use Symfony\Component\Console\Input\StringInput;
@@ -106,19 +106,20 @@ public function testRunVendorCommand()
     }
 
     /**
-     * @covers                   ::getShellCommandPath
-     * @expectedException        \RuntimeException
-     * @expectedExceptionMessage The given command [vendor/bin/doNotExists] was not found
+     * @covers ::getShellCommandPath
      */
     public function testGetShellCommandPathException()
     {
-        if (method_exists(self::class, 'expectException')) {
-            self::expectException(RuntimeException::class);
-            self::expectExceptionMessage('The given command [vendor/bin/doNotExists] was not found');
+        $message = null;
+
+        try {
+            $app = new Application();
+            $app->runVendorCommand('doNotExists');
+        } catch (RuntimeException $exception) {
+            $message = $exception->getMessage();
         }
 
-        $app = new Application();
-        $app->runVendorCommand('doNotExists');
+        self::assertSame('The given command [vendor/bin/doNotExists] was not found', $message);
     }
 
     /**
@@ -145,7 +146,7 @@ public function testBatPath()
     public function testRunUnitTests()
     {
         $app = new Application();
-        self::expectOutputRegex('/^PHPUnit/');
+        self::expectOutputRegex('/^PHPUnit/m');
         $code = $app->runUnitTests(['--version']);
 
         self::assertSame(0, $code);
@@ -182,8 +183,9 @@ public function testRun()
         $buffer = new BufferedOutput();
         $app = new Application();
         $app->setAutoExit(false);
+        $status = $app->run($input, $buffer);
 
-        self::assertSame(0, $app->run($input, $buffer));
+        self::assertTrue($status === 0 || $status === 255);
         self::assertSame('Code looks great. Go on!', trim($buffer->fetch()));
     }
 }

tests/Phug/DevTool/TestCaseTest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Phug\Test\DevTool;
+
+use Phug\DevTool\TestCase;
+
+/**
+ * Class TestCaseTest.
+ *
+ * @coversDefaultClass \Phug\DevTool\TestCase
+ */
+class TestCaseTest extends TestCase
+{
+    /**
+     * @covers ::<public>
+     */
+    public function testCleanupTempDirectory()
+    {
+        $foo = sys_get_temp_dir().DIRECTORY_SEPARATOR.'foo';
+        $bar = sys_get_temp_dir().DIRECTORY_SEPARATOR.'bar';
+        file_put_contents($foo, 'FOO');
+        $this->saveTempDirectoryFilesList();
+        file_put_contents($bar, 'BAR');
+        $this->cleanupTempDirectory();
+        clearstatcache();
+
+        self::assertFileExists($foo);
+        self::assertFileNotExists($bar);
+
+        unlink($foo);
+    }
+
+    /**
+     * @covers ::removeFile
+     * @covers ::emptyDirectory
+     */
+    public function testEmptyDirectory()
+    {
+        $foo = sys_get_temp_dir().DIRECTORY_SEPARATOR.'foo';
+        $bar = sys_get_temp_dir().DIRECTORY_SEPARATOR.'bar';
+        file_put_contents($foo, 'FOO');
+
+        self::assertNull($this->emptyDirectory($foo));
+
+        mkdir($bar);
+        mkdir("$bar/biz");
+        file_put_contents("$bar/xx", 'xx');
+        file_put_contents("$bar/biz/yy", 'yy');
+
+        self::assertNull($this->emptyDirectory($bar));
+        self::assertSame(['.', '..'], scandir($bar));
+    }
+}

tests/bootstrap.php

@@ -0,0 +1,26 @@
+<?php
+
+include __DIR__.'/../vendor/autoload.php';
+
+set_error_handler(function ($errno, $errstr, $errfile, $errline)
+{
+    switch ($errno) {
+        case E_DEPRECATED:
+        case E_USER_DEPRECATED:
+            if ($errstr === 'The each() function is deprecated. This message will be suppressed on further calls') {
+                return true;
+            }
+
+            break;
+
+        case E_WARNING:
+        case E_USER_WARNING:
+            if ($errstr === 'count(): Parameter must be an array or an object that implements Countable') {
+                return true;
+            }
+
+            break;
+    }
+
+    return false;
+});