Merge pull request #19 from jdecool/unit-tests

Add complete bundle unit testing

Author: skwi

.atoum.php

@@ -0,0 +1,3 @@
+<?php
+
+$script->addTestsFromDirectory(__DIR__ . '/Tests/Units');

.bootstrap.atoum.php

@@ -0,0 +1,3 @@
+<?php
+
+require_once __DIR__ . '/vendor/autoload.php';

.travis.yml

@@ -7,8 +7,7 @@ php:
   - 5.3
 
 before_script:
-  - wget http://getcomposer.org/composer.phar
-  - php composer.phar install --dev
+  - composer install --dev
 
 script:
-  vendor/bin/atoum -bf Tests/bootstrap.atoum.php -d Tests
+  vendor/bin/atoum

Manager/BaseEntityWithFileManager.php

@@ -52,6 +52,10 @@ class BaseEntityWithFileManager
      */
     public function __construct($arrayFilepath, $entityManager)
     {
+        if (!isset($arrayFilepath['bundle.web'])) {
+            throw new \InvalidArgumentException('$arrayFilepath must have a bundle.web key (even empty).');
+        }
+
         $this->entityManager = $entityManager;
         $this->webPath = $arrayFilepath['bundle.web'];
 
@@ -106,9 +110,12 @@ protected function setter($propertyName, $filenameOnly = false)
     public function getFileAbsolutePath(BaseEntityWithFile $entity, $propertyName)
     {
         $getter = $this->getter($propertyName, true);
-        $entity->$getter();
-        $path = sprintf('%s%s', $this->rootPath,
-            $entity->$getter());
+
+        try {
+            $path = sprintf('%s%s', $this->rootPath, $entity->$getter());
+        } catch (\Exception $e) {
+            throw new \UnexpectedValueException();
+        }
 
         return $path;
     }
@@ -125,7 +132,13 @@ public function getFileWebPath(BaseEntityWithFile $entity, $propertyName)
     {
         $getter = $this->getter($propertyName, true);
 
-        return sprintf('%s%s', $this->webPath, $entity->$getter());
+        try {
+            $path = sprintf('%s%s', $this->webPath, $entity->$getter());
+        } catch (\Exception $e) {
+            throw new \UnexpectedValueException();
+        }
+
+        return $path;
     }
 
     /**
@@ -253,14 +266,22 @@ protected function buildDestination(BaseEntityWithFile $entity, $propertyName, $
             $this->arrayFilepath[$propertyName]);
 
         //Replace slugged placeholder
-        $fileDestinationName = preg_replace(
-            '#{slug::([^}-]+)}#ie', '$this->slug($entity->get("$1"))', $fileDestinationName);
+        $fileDestinationName = preg_replace_callback(
+            '#{slug::([^}-]+)}#i',
+            create_function('$matches', 'return $this->slug($entity->get("$1"));'),
+            $fileDestinationName);
+
         //Replace date format placeholder
-        $fileDestinationName = preg_replace(
-            '#{date::([^}-]+)::([^}-]+)}#ie', '$entity->get("$2")->format("$1")', $fileDestinationName);
+        $fileDestinationName = preg_replace_callback(
+            '#{date::([^}-]+)::([^}-]+)}#i',
+            create_function('$matches', 'return $entity->get("$2")->format("$1");'),
+            $fileDestinationName);
+
         //Replace classic placeholder
-        $fileDestinationName = preg_replace(
-            '#{([^}-]+)}#ie', '$entity->get("$1")', $fileDestinationName);
+        $fileDestinationName = preg_replace_callback(
+            '#{([^}-]+)}#i',
+            create_function('$matches', 'return $entity->get("$1");'),
+            $fileDestinationName);
 
         return $fileDestinationName;
     }
@@ -409,6 +430,10 @@ public function removeFiles(BaseEntityWithFile $entity, $properties = array(), $
      */
     public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFilepath, $destFilepath = null, $operation = 'copy')
     {
+        if (!in_array($operation, array('copy', 'rename'))) {
+            throw new \InvalidArgumentException('$operation only accept "copy" or "rename" value');
+        }
+
         $propertyGetter = $this->getter($propertyName);
         $propertyFileNameGetter = $this->getter($propertyName, true);
         $propertyFileNameSetter = $this->setter($propertyName, true);

Manager/BaseEntityWithImageManager.php

@@ -271,10 +271,11 @@ public function removeFiles(BaseEntityWithFile $entity, $properties = array(), $
      * @param string             $propertyName   The property linked to the file
      * @param string             $sourceFilepath The image source folder
      * @param string|null        $destFilepath   The image destination folder
+     * @param string             $operation      'copy' or 'rename'
      *
      * @return array|null An array containing informations about the copied file
      */
-    public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFilepath, $destFilepath = null)
+    public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFilepath, $destFilepath = null, $operation = 'copy')
     {
         $propertyGetter = $this->getter($propertyName);
         $propertyFileNameGetter = $this->getter($propertyName, true);

README.md

@@ -18,10 +18,10 @@ Unit tests are written using [atoum](https://github.com/atoum/atoum). You will g
 running `composer install`. To run tests, you will need to run the following command :
 
 ``` sh
-$ vendor/bin/atoum -bf Tests/bootstrap.atoum.php -d Tests
+$ vendor/bin/atoum
 
 # To run tests in a loop, ideal to do TDD
-$ vendor/bin/atoum -bf Tests/bootstrap.atoum.php -d Tests --loop
+$ vendor/bin/atoum --loop
 ```
 
 ### Contributors:

Resources/doc/reference-BaseEntityWithImageManager.md

@@ -102,6 +102,7 @@ Replace a property file by another, giver it's path
     - `$propertyName` (`string`) — The property linked to the file
     - `$sourceFilepath` (`string`) — The image source folder
     - `$destFilepath` (`string`|`null`) — The image destination folder
+    - `$operation` (`string`) — 'copy' or 'rename'
 - _Returns:_ An array containing informations about the copied file
     - `array`
     - `null`

Tests/Helper/BaseManagerTestCase.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Novaway\Bundle\FileManagementBundle\Tests\Helper;
+
+class BaseManagerTestCase extends FileTestCase
+{
+    protected function createMockEntityManager()
+    {
+        return new \mock\EntityManager();
+    }
+
+    protected function createMockFileType($originalFilename = null)
+    {
+        $controller = null;
+        if (null === $originalFilename) {
+            $controller = new \atoum\mock\controller();
+            $controller->__construct = function() { };
+        }
+
+        $filetype = new \mock\Symfony\Component\HttpFoundation\File\UploadedFile(
+            $originalFilename,
+            basename($originalFilename),
+            null,
+            null,
+            null,
+            true,
+            $controller
+        );
+
+        if (null !== $originalFilename) {
+            $filetype->getMockController()->getClientOriginalName = function() use ($originalFilename) {
+                return $originalFilename;
+            };
+        }
+
+        $filetype->getMockController()->getError = function() {
+            return UPLOAD_ERR_OK;
+        };
+
+        return $filetype;
+    }
+
+    protected function createMockEntity(array $fields = array())
+    {
+        $entity = new \mock\Novaway\Bundle\FileManagementBundle\Entity\BaseEntityWithFile();
+        foreach ($fields as $name => $value) {
+            $entity->$name = $value;
+
+            // mock accessors
+            $accessor = sprintf('get%s', ucfirst($name));
+            $entity->getMockController()->$accessor = function() use ($entity, $name) {
+                return $entity->$name;
+            };
+
+            // mock setters
+            $setter = sprintf('set%s', ucfirst($name));
+            $entity->getMockController()->$setter = function($param) use ($entity, $name) {
+                $entity->$name = $param;
+                return $entity;
+            };
+        }
+
+        return $entity;
+    }
+} 

Tests/Helper/FileTestCase.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Novaway\Bundle\FileManagementBundle\Tests\Helper;
+
+use mageekguy\atoum;
+
+class FileTestCase extends atoum\test
+{
+    protected $workspace = null;
+    protected static $symlinkOnWindows = null;
+
+    public function beforeTestMethod($testMethod)
+    {
+        if (defined('PHP_WINDOWS_VERSION_MAJOR')) {
+            static::$symlinkOnWindows = true;
+            $originDir = tempnam(sys_get_temp_dir(), 'sl');
+            $targetDir = tempnam(sys_get_temp_dir(), 'sl');
+            if (true !== @symlink($originDir, $targetDir)) {
+                $report = error_get_last();
+                if (is_array($report) && false !== strpos($report['message'], 'error code(1314)')) {
+                    static::$symlinkOnWindows = false;
+                }
+            }
+        }
+
+        $this->workspace = rtrim(sys_get_temp_dir(), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.time().rand(0, 1000).uniqid();
+        mkdir($this->workspace, 0777, true);
+        $this->workspace = realpath($this->workspace);
+    }
+
+    public function afterTestMethod($testMethod)
+    {
+        $this->clean($this->workspace);
+    }
+
+    protected function clean($file)
+    {
+        if (is_dir($file) && !is_link($file)) {
+            $dir = new \FilesystemIterator($file);
+            foreach ($dir as $childFile) {
+                $this->clean($childFile);
+            }
+
+            rmdir($file);
+        } else {
+            unlink($file);
+        }
+    }
+}