project tests

Author: Erwane

README.md

@@ -4,6 +4,12 @@ Fixtures are for databases, resources for the rest.
 
 Help your phpunit tests to load resources from files, like, json content, raw e-mails, logs file, etc.
 
+## Version map
+
+| branch | This package version | PHP min |
+|:------:|----------------------|:-------:|
+|  1.x   | ^1.0                 | PHP 7.2 |
+
 ## Usage
 
 ```shell
@@ -12,14 +18,59 @@ 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: 
+```php
+use ResourceHelper\ResourceHelper;
+
+ResourceHelper::setBaseDir('/project/tests_resources/');
+ResourceHelper::setTmpDir('/project/tmp/');
+```
+
+In your test, you can get your resources path, content or copy with `File` methods:
 ```php
 use ResourceHelper\File;
 
 // Get <project_dir>/tests/resources/webhooks/mailgun.json content
-$content = File::instance()->getContent('webhooks/mailgun.json');
+$content = File::getContent('webhooks/mailgun.json');
 
 // Create a copy you can manipulate without destroy your resource.
-$copy = File::instance()->getCopy('emails/change-my-headers.eml');
+$copy = File::getCopy('accounting/invoices.csv');
+```
+
+## `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'
 ```
 
-## Methods
+### 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
+    'filename' => 'file.csv', // Filename
+    'hash' => 'abcdef0123456789', // File hash
+]
+```
+
+### 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
+    'filename' => 'file.ext', // Filename
+    'hash' => 'abcdef0123456789', // File hash
+]
+```

src/File.php

@@ -0,0 +1,87 @@
+<?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 InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Helper for tests resources files.
+ */
+class File
+{
+    /**
+     * Look in $_paths for file resource and return path.
+     *
+     * @param string $path Resource name or path.
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    public static function getPath(string $path): string
+    {
+        $resourcePath = ResourceHelper::getBaseDir() . $path;
+        if (!is_file($resourcePath)) {
+            throw new InvalidArgumentException(sprintf('Path "%s" not found', $path));
+        }
+
+        return $resourcePath;
+    }
+
+    /**
+     * Get resource file info.
+     *
+     * @param string $path Resource name or path.
+     * @return array
+     */
+    public static function getInfo(string $path): array
+    {
+        $resourcePath = self::getPath($path);
+
+        $fileInfo = pathinfo($resourcePath);
+        $hash = hash_file('sha1', $resourcePath);
+
+        return [
+            'path' => $resourcePath,
+            'filename' => $fileInfo['basename'],
+            'hash' => $hash,
+        ];
+    }
+
+    /**
+     * Get resources file content.
+     *
+     * @param string $path Resource name or path.
+     * @return string
+     */
+    public static function getContent(string $path): string
+    {
+        return file_get_contents(self::getPath($path));
+    }
+
+    /**
+     * Get resources file infos with a copy of file resource.
+     *
+     * @param string $path Resource name or path.
+     * @param \PHPUnit\Framework\TestCase $test Running test
+     * @return array
+     */
+    public static function getCopy(string $path, TestCase $test): array
+    {
+        $infos = self::getInfo($path);
+        $resourcePath = $infos['path'];
+
+        $infos['path'] = ResourceHelper::createTmpTestDir($test) . $infos['filename'];
+
+        copy($resourcePath, $infos['path']);
+
+        return $infos;
+    }
+}

src/ResourceHelper.php

@@ -0,0 +1,139 @@
+<?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 Composer\InstalledVersions;
+use DirectoryIterator;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * ResourceHelper
+ */
+class ResourceHelper
+{
+    /**
+     * @var string
+     */
+    protected static $_baseDir;
+
+    /**
+     * @var string
+     */
+    protected static $_tmpDir;
+
+    /**
+     * Get resource base dir.
+     *
+     * @return string
+     */
+    public static function getBaseDir(): string
+    {
+        if (empty(self::$_baseDir)) {
+            self::$_baseDir = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'resources' . DIRECTORY_SEPARATOR;
+        }
+
+        return self::$_baseDir;
+    }
+
+    /**
+     * Set resources base dir.
+     *
+     * @param string $baseDir New resources base dir
+     * @return void
+     */
+    public static function setBaseDir(string $baseDir): void
+    {
+        self::$_baseDir = $baseDir;
+    }
+
+    /**
+     * Get resources tmp dir.
+     *
+     * @return string
+     */
+    public static function getTmpDir(): string
+    {
+        if (empty(self::$_tmpDir)) {
+            $root = InstalledVersions::getRootPackage();
+            $project = preg_replace('#[._ /-]#', '-', $root['name']);
+
+            self::$_tmpDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . $project . DIRECTORY_SEPARATOR;
+        }
+
+        return self::$_tmpDir;
+    }
+
+    /**
+     * Set resources tmp dir.
+     *
+     * @param string $tmpDir New project resources tmp dir
+     * @return void
+     */
+    public static function setTmpDir(string $tmpDir): void
+    {
+        self::$_tmpDir = $tmpDir;
+    }
+
+    /**
+     * Build the test dir path from TestCase.
+     *
+     * @param \PHPUnit\Framework\TestCase|string $test Running test or test method full name
+     * @return string
+     */
+    public static function getTmpTestPath($test): string
+    {
+        $name = $test;
+        if ($test instanceof TestCase) {
+            $name = $test->toString();
+        }
+        $namespace = explode('\\', $name);
+        $method = str_replace('::', '_', end($namespace));
+
+        return ResourceHelper::getTmpDir() . $method . DIRECTORY_SEPARATOR;
+    }
+
+    /**
+     * Create tmp test directory.
+     *
+     * @param \PHPUnit\Framework\TestCase|string $test Running test or test method full name
+     * @return string
+     */
+    public static function createTmpTestDir($test): string
+    {
+        self::destroyTmpTestDir($test);
+
+        $dir = self::getTmpTestPath($test);
+        mkdir($dir, 0700, true);
+
+        return $dir;
+    }
+
+    /**
+     * Destroy tmp test directory.
+     *
+     * @param \PHPUnit\Framework\TestCase|string $test Running test or test method full name
+     * @return void
+     */
+    public static function destroyTmpTestDir($test): void
+    {
+        $dir = self::getTmpTestPath($test);
+        if (is_dir($dir)) {
+            /** @var \DirectoryIterator $file */
+            foreach (new DirectoryIterator($dir) as $file) {
+                if (is_file($file->getPathname())) {
+                    unlink($file->getPathname());
+                }
+            }
+
+            rmdir($dir);
+        }
+    }
+}

tests/TestCase/FileTest.php

@@ -0,0 +1,75 @@
+<?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\File;
+use ResourceHelper\ResourceHelper;
+
+/**
+ * @uses   \ResourceHelper\File
+ * @covers \ResourceHelper\File
+ */
+class FileTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        ResourceHelper::destroyTmpTestDir($this);
+    }
+
+    public function testGetPathUnknown(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectErrorMessage('Path "unknown.file" not found');
+        File::getPath('unknown.file');
+    }
+
+    public function testGetPath(): void
+    {
+        $path = File::getPath('basic.json');
+        $this->assertEquals(ResourceHelper::getBaseDir() . 'basic.json', $path);
+    }
+
+    public function testGetInfos(): void
+    {
+        $infos = File::getInfo('basic.json');
+
+        $this->assertSame([
+            'path' => ResourceHelper::getBaseDir() . 'basic.json',
+            'filename' => 'basic.json',
+            'hash' => 'ea52ae55e385714418888d9bbd1ab849855eae3e',
+        ], $infos);
+    }
+
+    public function testGetContent(): void
+    {
+        $content = File::getContent('basic.json');
+
+        $expected = <<<JSON
+{
+    "key": "value",
+    "int": 23
+}
+
+JSON;
+        $this->assertEquals($expected, $content);
+    }
+
+    public function testGetCopy(): void
+    {
+        $copy = File::getCopy('basic.json', $this);
+        $expected = ResourceHelper::getTmpDir() . 'FileTest_testGetCopy' . DIRECTORY_SEPARATOR . 'basic.json';
+        $this->assertEquals($expected, $copy['path']);
+        $this->assertFileExists($copy['path']);
+        $this->assertEquals('ea52ae55e385714418888d9bbd1ab849855eae3e', hash_file('sha1', $copy['path']));
+    }
+}