Refactor and optimize tests

Author: MGatner

.gitignore

@@ -1,4 +1,4 @@
-vendor/
+/vendor/
 build/
 phpunit*.xml
 phpunit

UPGRADING.md

@@ -5,6 +5,7 @@
 
 * Switches to `Tatter\Preferences` for managing persistent settings; read more below
 * Drops `Tatter\Audits` as a dependency and adds it as a suggestion; read more below
+* Access rights are now handled via Config file; see [Tatter\Permits](https://github.com/tattersoftware/codeigniter4-permits) for more information
 
 ### `Settings` Migration
 
@@ -29,7 +30,7 @@ php spark migrate --all
 ```
 
 Example model file in **app/Models/FileModel.php**:
-```
+```php
 <?php
 
 namespace App\Models;

composer.json

@@ -26,12 +26,11 @@
         "tatter/alerts": "^2.0",
         "tatter/exports": "^2.0",
         "tatter/frontend": "^1.0",
-        "tatter/permits": "^2.0",
+        "tatter/permits": "^3.0",
         "tatter/preferences": "^1.0",
         "tatter/thumbnails": "^1.2"
     },
     "require-dev": {
-        "antecedent/patchwork": "^2.1",
         "codeigniter4/codeigniter4": "dev-develop",
         "tatter/imposter": "^1.0",
         "tatter/tools": "^1.15"

src/Config/Registrar.php

@@ -17,4 +17,21 @@ public static function Pager()
             ],
         ];
     }
+
+    /**
+     * Adds necessary configuration values for Permits
+     * to identify the owner(s) of files.
+     *
+     * @return array<string,mixed>
+     */
+    public static function Permits()
+    {
+        return [
+            'files' => [
+                'userKey'    => 'user_id',
+                'pivotKey'   => 'file_id',
+                'pivotTable' => 'files_users',
+            ],
+        ];
+    }
 }

src/Controllers/Files.php

@@ -25,7 +25,7 @@ class Files extends Controller
     protected $config;
 
     /**
-     * The model to use, may be a child of this library's.
+     * The model to use.
      *
      * @var FileModel
      */
@@ -162,7 +162,6 @@ public function user($userId = null)
             }
 
             $this->setData([
-                'access'   => $this->model->mayAdmin() ? 'manage' : 'display',
                 'title'    => 'User Files',
                 'userName' => 'User',
             ]);

src/Models/FileModel.php

@@ -33,12 +33,6 @@ class FileModel extends Model
         'size' => 'permit_empty|is_natural',
     ];
 
-    // Permits
-    protected $mode       = 04660;
-    protected $userKey    = 'user_id';
-    protected $pivotKey   = 'file_id';
-    protected $usersPivot = 'files_users';
-
     //--------------------------------------------------------------------
 
     /**

tests/_support/FeatureTestCase.php

@@ -2,9 +2,7 @@
 
 namespace Tests\Support;
 
-use CodeIgniter\Config\Factories;
 use CodeIgniter\Test\FeatureTestTrait;
-use Tests\Support\Models\UserModel;
 
 /**
  * @internal
@@ -13,36 +11,19 @@ abstract class FeatureTestCase extends TestCase
 {
     use FeatureTestTrait;
 
-    /**
-     * If present, will override application
-     * routes when using call().
-     *
-     * @var \CodeIgniter\Router\RouteCollection
-     */
-    protected $routes;
-
-    /**
-     * Values to be set in the SESSION global
-     * before running the test.
-     *
-     * @var array
-     */
-    protected $session = [];
-
     /**
      * Enabled auto clean op buffer after request call
      *
      * @var bool
      */
     protected $clean = true;
 
+    protected $refreshVfs = false;
+
     protected function setUp(): void
     {
         parent::setUp();
 
-        // Make sure we use the correct UserModel for permissions
-        Factories::injectMock('models', UserModel::class, new UserModel());
-
         // Make sure everything is published once
         $this->publishAll();
     }

tests/_support/Models/UserModel.php

@@ -8,6 +8,10 @@
 use org\bovigo\vfs\vfsStream;
 use Tatter\Assets\Test\AssetsTestTrait;
 use Tatter\Files\Config\Files;
+use Tatter\Files\Models\FileModel;
+use Tatter\Imposter\Entities\User;
+use Tatter\Imposter\Factories\ImposterFactory;
+use Tatter\Users\UserProvider;
 
 /**
  * @internal
@@ -17,21 +21,36 @@ abstract class TestCase extends CIUnitTestCase
     use AssetsTestTrait;
     use DatabaseTestTrait;
 
-    protected $refresh = false;
+    /**
+     * Whether the files have been copied to
+     * the virtual workspave yet.
+     *
+     * @var bool
+     */
+    private static $copiedVfs = false;
+
+    protected $refreshVfs = true;
+    protected $refresh    = false;
     protected $namespace;
 
     /**
      * Path to a test file to work with
      *
-     * @var string
+     * @var string|null
      */
     protected $testPath;
 
+    /**
+     * @var FileModel
+     */
+    protected $model;
+
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
         helper(['auth', 'files', 'preferences']);
+        UserProvider::addFactory(ImposterFactory::class, ImposterFactory::class);
     }
 
     protected function setUp(): void
@@ -40,22 +59,55 @@ protected function setUp(): void
 
         parent::setUp();
 
-        $_REQUEST = [];
         $_POST    = [];
         $_GET     = [];
         $_FILES   = [];
+        $_REQUEST = [];
 
-        // Copy the files to VFS
-        vfsStream::copyFromFileSystem(SUPPORTPATH . 'VFS', $this->root);
+        // Make sure all files are on a single page
+        $_REQUEST['perPage'] = 200;
 
-        // "vendor" gets ignored by .gitignore so rename it after copying to VFS
-        $path = $this->root->url() . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR;
-        rename($this->root->url() . '/storage', $path);
-        $this->testPath = $path . 'image.jpg';
+        // Copy the files to VFS (if necessary)
+        if (! self::$copiedVfs) {
+            vfsStream::copyFromFileSystem(SUPPORTPATH . 'VFS', self::$root);
+        }
 
         // Force Files config to the virtual path
+        $path   = self::$root->url() . DIRECTORY_SEPARATOR;
         $config = config('Files');
         $config->setPath($path);
         Factories::injectMock('config', 'Files', $config);
+
+        $this->testPath = $config->getPath() . 'image.jpg';
+
+        // Set up the model
+        $this->model = model(FileModel::class); // @phpstan-ignore-line
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        if (! empty($this->refreshVfs)) {
+            self::$copiedVfs = false;
+        }
+
+        ImposterFactory::reset();
+    }
+
+    /**
+     * Creates a test User with some files.
+     *
+     * @return array Tuple of [User, File]
+     */
+    protected function createUserWithFile(): array
+    {
+        $user     = ImposterFactory::fake();
+        $user->id = ImposterFactory::add($user);
+
+        $file = fake(FileModel::class);
+        $this->model->addToUser($file->id, $user->id);
+
+        return [$user, $file];
     }
 }