Extracted test file handling to its own class

[bookstack] / tests / Uploads / ImageTest.php

diff --git a/tests/Uploads/ImageTest.php b/tests/Uploads/ImageTest.php
index c6e678ff2f73ecbf94141958dc7a015ea3ac4cac..fb98565fc3d8a0774167703b097b5f26d2973f67 100644 (file)
--- a/tests/Uploads/ImageTest.php
+++ b/tests/Uploads/ImageTest.php
@@ -2,7 +2,6 @@
 
 namespace Tests\Uploads;
 
-use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Uploads\Image;
 use BookStack\Uploads\ImageService;
@@ -11,20 +10,18 @@ use Tests\TestCase;
 
 class ImageTest extends TestCase
 {
-    use UsesImages;
-
     public function test_image_upload()
     {
         $page = $this->entities->page();
         $admin = $this->users->admin();
         $this->actingAs($admin);
 
-        $imgDetails = $this->uploadGalleryImage($page);
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $page);
         $relPath = $imgDetails['path'];
 
         $this->assertTrue(file_exists(public_path($relPath)), 'Uploaded image found at path: ' . public_path($relPath));
 
-        $this->deleteImage($relPath);
+        $this->files->deleteAtRelativePath($relPath);
 
         $this->assertDatabaseHas('images', [
             'url'         => $this->baseUrl . $relPath,
@@ -43,9 +40,9 @@ class ImageTest extends TestCase
         $admin = $this->users->admin();
         $this->actingAs($admin);
 
-        $originalFile = $this->getTestImageFilePath('compressed.png');
+        $originalFile = $this->files->testFilePath('compressed.png');
         $originalFileSize = filesize($originalFile);
-        $imgDetails = $this->uploadGalleryImage($page, 'compressed.png');
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $page, 'compressed.png');
         $relPath = $imgDetails['path'];
 
         $this->assertTrue(file_exists(public_path($relPath)), 'Uploaded image found at path: ' . public_path($relPath));
@@ -55,8 +52,8 @@ class ImageTest extends TestCase
         $displayImagePath = public_path($displayImageRelPath);
         $displayFileSize = filesize($displayImagePath);
 
-        $this->deleteImage($relPath);
-        $this->deleteImage($displayImageRelPath);
+        $this->files->deleteAtRelativePath($relPath);
+        $this->files->deleteAtRelativePath($displayImageRelPath);
 
         $this->assertEquals($originalFileSize, $displayFileSize, 'Display thumbnail generation should not increase image size');
     }
@@ -67,8 +64,8 @@ class ImageTest extends TestCase
         $admin = $this->users->admin();
         $this->actingAs($admin);
 
-        $imgDetails = $this->uploadGalleryImage($page, 'animated.png');
-        $this->deleteImage($imgDetails['path']);
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $page, 'animated.png');
+        $this->files->deleteAtRelativePath($imgDetails['path']);
 
         $this->assertStringContainsString('thumbs-', $imgDetails['response']->thumbs->gallery);
         $this->assertStringNotContainsString('thumbs-', $imgDetails['response']->thumbs->display);
@@ -79,7 +76,7 @@ class ImageTest extends TestCase
         $editor = $this->users->editor();
         $this->actingAs($editor);
 
-        $imgDetails = $this->uploadGalleryImage();
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $this->entities->page());
         $image = Image::query()->first();
 
         $newName = Str::random();
@@ -87,7 +84,7 @@ class ImageTest extends TestCase
         $update->assertSuccessful();
         $update->assertSee($newName);
 
-        $this->deleteImage($imgDetails['path']);
+        $this->files->deleteAtRelativePath($imgDetails['path']);
 
         $this->assertDatabaseHas('images', [
             'type' => 'gallery',
@@ -99,7 +96,7 @@ class ImageTest extends TestCase
     {
         $this->asEditor();
 
-        $imgDetails = $this->uploadGalleryImage();
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $this->entities->page());
         $image = Image::query()->first();
 
         $pageId = $imgDetails['page']->id;
@@ -129,7 +126,7 @@ class ImageTest extends TestCase
         $editor = $this->users->editor();
         $this->actingAs($editor);
 
-        $imgDetails = $this->uploadGalleryImage($page);
+        $imgDetails = $this->files->uploadGalleryImageToPage($this, $page);
 
         $image = Image::query()->first();
         $page->html = '<img src="' . $image->url . '">';
@@ -140,7 +137,7 @@ class ImageTest extends TestCase
         $usage->assertSeeText($page->name);
         $usage->assertSee($page->getUrl());
 
-        $this->deleteImage($imgDetails['path']);
+        $this->files->deleteAtRelativePath($imgDetails['path']);
     }
 
     public function test_php_files_cannot_be_uploaded()
@@ -150,10 +147,10 @@ class ImageTest extends TestCase
         $this->actingAs($admin);
 
         $fileName = 'bad.php';
-        $relPath = $this->getTestImagePath('gallery', $fileName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $fileName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        $file = $this->newTestImageFromBase64('bad-php.base64', $fileName);
+        $file = $this->files->imageFromBase64File('bad-php.base64', $fileName);
         $upload = $this->withHeader('Content-Type', 'image/jpeg')->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $file], []);
         $upload->assertStatus(302);
 
@@ -172,10 +169,10 @@ class ImageTest extends TestCase
         $this->actingAs($admin);
 
         $fileName = 'bad.phtml';
-        $relPath = $this->getTestImagePath('gallery', $fileName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $fileName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        $file = $this->newTestImageFromBase64('bad-phtml.base64', $fileName);
+        $file = $this->files->imageFromBase64File('bad-phtml.base64', $fileName);
         $upload = $this->withHeader('Content-Type', 'image/jpeg')->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $file], []);
         $upload->assertStatus(302);
 
@@ -189,11 +186,11 @@ class ImageTest extends TestCase
         $this->actingAs($admin);
 
         $fileName = 'bad.phtml.png';
-        $relPath = $this->getTestImagePath('gallery', $fileName);
+        $relPath = $this->files->expectedImagePath('gallery', $fileName);
         $expectedRelPath = dirname($relPath) . '/bad-phtml.png';
-        $this->deleteImage($expectedRelPath);
+        $this->files->deleteAtRelativePath($expectedRelPath);
 
-        $file = $this->newTestImageFromBase64('bad-phtml-png.base64', $fileName);
+        $file = $this->files->imageFromBase64File('bad-phtml-png.base64', $fileName);
         $upload = $this->withHeader('Content-Type', 'image/png')->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $file], []);
         $upload->assertStatus(200);
 
@@ -204,7 +201,7 @@ class ImageTest extends TestCase
         $this->assertFileDoesNotExist(public_path($relPath), 'Uploaded image file name was not stripped of dots');
         $this->assertFileExists(public_path($expectedRelPath));
 
-        $this->deleteImage($lastImage->path);
+        $this->files->deleteAtRelativePath($lastImage->path);
     }
 
     public function test_url_entities_removed_from_filenames()
@@ -218,10 +215,10 @@ class ImageTest extends TestCase
             '#.png',
         ];
         foreach ($badNames as $name) {
-            $galleryFile = $this->getTestImage($name);
+            $galleryFile = $this->files->uploadedImage($name);
             $page = $this->entities->page();
-            $badPath = $this->getTestImagePath('gallery', $name);
-            $this->deleteImage($badPath);
+            $badPath = $this->files->expectedImagePath('gallery', $name);
+            $this->files->deleteAtRelativePath($badPath);
 
             $upload = $this->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
             $upload->assertStatus(200);
@@ -235,7 +232,7 @@ class ImageTest extends TestCase
 
             $this->assertTrue(strlen($newFileName) > 0, 'File name was reduced to nothing');
 
-            $this->deleteImage($lastImage->path);
+            $this->files->deleteAtRelativePath($lastImage->path);
         }
     }
 
@@ -243,7 +240,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure');
         $this->asEditor();
-        $galleryFile = $this->getTestImage('my-secure-test-upload.png');
+        $galleryFile = $this->files->uploadedImage('my-secure-test-upload.png');
         $page = $this->entities->page();
         $expectedPath = storage_path('uploads/images/gallery/' . date('Y-m') . '/my-secure-test-upload.png');
 
@@ -291,7 +288,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure');
         $this->asEditor();
-        $galleryFile = $this->getTestImage('my-secure-test-upload.png');
+        $galleryFile = $this->files->uploadedImage('my-secure-test-upload.png');
         $page = $this->entities->page();
         $expectedPath = storage_path('uploads/images/gallery/' . date('Y-m') . '/my-secure-test-upload.png');
 
@@ -314,7 +311,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure');
         $this->asAdmin();
-        $galleryFile = $this->getTestImage('my-system-test-upload.png');
+        $galleryFile = $this->files->uploadedImage('my-system-test-upload.png');
         $expectedPath = public_path('uploads/images/system/' . date('Y-m') . '/my-system-test-upload.png');
 
         $upload = $this->call('POST', '/settings/customization', [], [], ['app_logo' => $galleryFile], []);
@@ -331,7 +328,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure_restricted');
         $this->asAdmin();
-        $galleryFile = $this->getTestImage('my-system-test-restricted-upload.png');
+        $galleryFile = $this->files->uploadedImage('my-system-test-restricted-upload.png');
         $expectedPath = public_path('uploads/images/system/' . date('Y-m') . '/my-system-test-restricted-upload.png');
 
         $upload = $this->call('POST', '/settings/customization', [], [], ['app_logo' => $galleryFile], []);
@@ -348,7 +345,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure_restricted');
         $this->asEditor();
-        $galleryFile = $this->getTestImage('my-secure-restricted-test-upload.png');
+        $galleryFile = $this->files->uploadedImage('my-secure-restricted-test-upload.png');
         $page = $this->entities->page();
 
         $upload = $this->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
@@ -372,7 +369,7 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure_restricted');
         $this->asEditor();
-        $galleryFile = $this->getTestImage('my-secure-restricted-thumb-test-test.png');
+        $galleryFile = $this->files->uploadedImage('my-secure-restricted-thumb-test-test.png');
         $page = $this->entities->page();
 
         $upload = $this->call('POST', '/images/gallery', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
@@ -396,12 +393,10 @@ class ImageTest extends TestCase
     {
         config()->set('filesystems.images', 'local_secure_restricted');
         $this->asEditor();
-        $galleryFile = $this->getTestImage('my-secure-restricted-export-test.png');
+        $galleryFile = $this->files->uploadedImage('my-secure-restricted-export-test.png');
 
-        /** @var Page $pageA */
-        /** @var Page $pageB */
-        $pageA = Page::query()->first();
-        $pageB = Page::query()->where('id', '!=', $pageA->id)->first();
+        $pageA = $this->entities->page();
+        $pageB = $this->entities->page();
         $expectedPath = storage_path('uploads/images/gallery/' . date('Y-m') . '/my-secure-restricted-export-test.png');
 
         $upload = $this->asEditor()->call('POST', '/images/gallery', ['uploaded_to' => $pageA->id], [], ['file' => $galleryFile], []);
@@ -430,10 +425,10 @@ class ImageTest extends TestCase
         $page = $this->entities->page();
         $this->asAdmin();
         $imageName = 'first-image.png';
-        $relPath = $this->getTestImagePath('gallery', $imageName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $imageName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        $this->uploadImage($imageName, $page->id);
+        $this->files->uploadGalleryImage($this, $imageName, $page->id);
         $image = Image::first();
 
         $delete = $this->delete('/images/' . $image->id);
@@ -453,12 +448,12 @@ class ImageTest extends TestCase
         $this->asAdmin();
         $imageName = 'first-image.png';
 
-        $relPath = $this->getTestImagePath('gallery', $imageName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $imageName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        $this->uploadImage($imageName, $page->id);
-        $this->uploadImage($imageName, $page->id);
-        $this->uploadImage($imageName, $page->id);
+        $this->files->uploadGalleryImage($this, $imageName, $page->id);
+        $this->files->uploadGalleryImage($this, $imageName, $page->id);
+        $this->files->uploadGalleryImage($this, $imageName, $page->id);
 
         $image = Image::first();
         $folder = public_path(dirname($relPath));
@@ -477,11 +472,11 @@ class ImageTest extends TestCase
         $page = $this->entities->page();
         $this->asAdmin();
         $imageName = 'first-image.png';
-        $relPath = $this->getTestImagePath('gallery', $imageName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $imageName);
+        $this->files->deleteAtRelativePath($relPath);
         $viewer = $this->users->viewer();
 
-        $this->uploadImage($imageName, $page->id);
+        $this->files->uploadGalleryImage($this, $imageName, $page->id);
         $image = Image::first();
 
         $resp = $this->get("/images/edit/{$image->id}");
@@ -495,16 +490,16 @@ class ImageTest extends TestCase
         $resp = $this->actingAs($viewer)->get("/images/edit/{$image->id}");
         $this->withHtml($resp)->assertElementExists('button#image-manager-delete[title="Delete"]');
 
-        $this->deleteImage($relPath);
+        $this->files->deleteAtRelativePath($relPath);
     }
 
     protected function getTestProfileImage()
     {
         $imageName = 'profile.png';
-        $relPath = $this->getTestImagePath('user', $imageName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('user', $imageName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        return $this->getTestImage($imageName);
+        return $this->files->uploadedImage($imageName);
     }
 
     public function test_user_image_upload()
@@ -559,10 +554,10 @@ class ImageTest extends TestCase
         $this->actingAs($admin);
 
         $imageName = 'unused-image.png';
-        $relPath = $this->getTestImagePath('gallery', $imageName);
-        $this->deleteImage($relPath);
+        $relPath = $this->files->expectedImagePath('gallery', $imageName);
+        $this->files->deleteAtRelativePath($relPath);
 
-        $upload = $this->uploadImage($imageName, $page->id);
+        $upload = $this->files->uploadGalleryImage($this, $imageName, $page->id);
         $upload->assertStatus(200);
         $image = Image::where('type', '=', 'gallery')->first();
 
@@ -604,6 +599,6 @@ class ImageTest extends TestCase
         $this->assertCount(1, $toDelete);
         $this->assertFalse(file_exists($absPath));
 
-        $this->deleteImage($relPath);
+        $this->files->deleteAtRelativePath($relPath);
     }
 }