PHPUnitExtension tests and doc.

Author: Erwane

README.md

@@ -18,7 +18,8 @@ composer require --dev erwane/phpunit-resource-helper
 
 Create a `resources` directory in your `tests` dir and put your files in. You can add subdirectories.
 
-You can also configure your base directory and tmp directory in your `tests/bootstrap.php` file: 
+You can also configure your base directory and tmp directory in your `tests/bootstrap.php` file:
+
 ```php
 use ResourceHelper\ResourceHelper;
 
@@ -27,6 +28,7 @@ ResourceHelper::setTmpDir('/project/tmp/');
 ```
 
 In your test, you can get your resources path, content or copy with `File` methods:
+
 ```php
 use ResourceHelper\File;
 
@@ -37,21 +39,38 @@ $content = File::getContent('webhooks/mailgun.json');
 $copy = File::getCopy('accounting/invoices.csv');
 ```
 
+You can clean your tmp directory with PHPUnit extension.  
+Only successful tests are cleaned, this allows you to check your resources copy files when test failed.  
+Set up ResourceHelper extension in your `phpunit.dist.xml` configuration file:
+
+```xml
+<!-- phpunit.dist.xml -->
+<extensions>
+    <extension class="ResourceHelper\PHPUnitExtension"></extension>
+</extensions>
+```
+
 ## `File` Methods
 
 ### getPath(string \$path): string
+
 Get resource absolute path from relative `$path`.
+
 ```php
 $path = File::getPath('file.csv');
 // $path = '<project>/tests/resources/my-file.csv'
 ```
 
 ### getInfo(string \$path): array
+
 Get resource information from relative `$path`.
+
 ```php
 $info = File::getInfo('file.csv');
 ```
+
 `$info` will contain:
+
 ```php
 [
     'path' => '/path/file.csv', // Absolute resource path
@@ -61,12 +80,16 @@ $info = File::getInfo('file.csv');
 ```
 
 ### getCopy(string \$path, TestCase \$test): array
+
 Copy the resource to a temporary directory relative to current test.  
 Return the information of this copy.
+
 ```php
 $info = File::getCopy('file.csv');
 ```
+
 `$info` will contain:
+
 ```php
 [
     'path' => '/tmp/project/Test_Method/file.ext', // Absolute resource copy path

phpunit.xml.dist

@@ -14,4 +14,7 @@
             <directory suffix=".php" phpVersion="7.2">src/</directory>
         </whitelist>
     </filter>
+    <extensions>
+        <extension class="ResourceHelper\PHPUnitExtension"></extension>
+    </extensions>
 </phpunit>

src/PHPUnitExtension.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * This file is part of PHPUnit resources helpers library
+ *
+ * @copyright   Copyright (c) Erwane BRETON
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace ResourceHelper;
+
+use PHPUnit\Runner\AfterSuccessfulTestHook;
+
+/**
+ * PHPUnit extension to clean up temp files.
+ */
+class PHPUnitExtension implements AfterSuccessfulTestHook
+{
+    /**
+     * Cleanup test files if case of successful result.
+     *
+     * @param string $test Test name with namespace
+     * @param float $time Test duration time
+     * @return void
+     */
+    public function executeAfterSuccessfulTest(string $test, float $time): void
+    {
+        ResourceHelper::destroyTmpTestDir($test);
+    }
+}

tests/TestCase/PHPUnitExtensionTest.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * This file is part of PHPUnit resources helpers library
+ *
+ * @copyright   Copyright (c) Erwane BRETON
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace ResourceHelper\Test\TestCase;
+
+use PHPUnit\Framework\TestCase;
+use ResourceHelper\PHPUnitExtension;
+use ResourceHelper\ResourceHelper;
+
+/**
+ * @uses   \ResourceHelper\PHPUnitExtension
+ * @covers \ResourceHelper\PHPUnitExtension
+ */
+class PHPUnitExtensionTest extends TestCase
+{
+    public function testAfterSuccessfulTest(): void
+    {
+        $ext = new PHPUnitExtension();
+        $this->assertTrue(method_exists($ext, 'executeAfterSuccessfulTest'));
+
+        // Create tmp test dir
+        ResourceHelper::createTmpTestDir($this);
+
+        $ext->executeAfterSuccessfulTest($this->toString(), 0.3);
+
+        $this->assertDirectoryNotExists(ResourceHelper::getTmpTestPath($this));
+    }
+}