Skip to content

Commit

Permalink
ZIP Imports: Started testing core import logic
Browse files Browse the repository at this point in the history 
Fixed image size handling, and lack of attachment reference replacements
during testing.
  • Loading branch information
@ssddanbrown
ssddanbrown committed Nov 16, 2024
1 parent 7681e32 commit 8645aea
Show file tree
Hide file tree
Showing 5 changed files with 170 additions and 6 deletions.
4 changes: 3 additions & 1 deletion app/Exports/ZipExports/ZipImportReferences.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,12 @@ protected function handleReference(string $type, int $id): ?string
} else if ($model instanceof Image) {
if ($model->type === 'gallery') {
$this->imageResizer->loadGalleryThumbnailsForImage($model, false);
return $model->thumbs['gallery'] ?? $model->url;
return $model->thumbs['display'] ?? $model->url;
}

return $model->url;
} else if ($model instanceof Attachment) {
return $model->getUrl(false);
}

return null;
Expand Down
4 changes: 4 additions & 0 deletions app/Exports/ZipExports/ZipImportRunner.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,10 @@ protected function importImage(ZipExportImage $exportImage, Page $page, ZipExpor
$file,
$exportImage->type,
$page->id,
null,
null,
true,
$exportImage->name,
);

$this->references->addImage($image, $exportImage->id);
Expand Down
5 changes: 3 additions & 2 deletions app/Uploads/ImageService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ public function saveNewFromUpload(
int $uploadedTo = 0,
int $resizeWidth = null,
int $resizeHeight = null,
bool $keepRatio = true
bool $keepRatio = true,
string $imageName = '',
): Image {
$imageName = $uploadedFile->getClientOriginalName();
$imageName = $imageName ?: $uploadedFile->getClientOriginalName();
$imageData = file_get_contents($uploadedFile->getRealPath());

if ($resizeWidth !== null || $resizeHeight !== null) {
Expand Down
152 changes: 152 additions & 0 deletions tests/Exports/ZipImportRunnerTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

namespace Tests\Exports;

use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Page;
use BookStack\Exports\ZipExports\ZipImportRunner;
use BookStack\Uploads\Image;
use Tests\TestCase;

class ZipImportRunnerTest extends TestCase
Expand All @@ -15,6 +18,155 @@ protected function setUp(): void
$this->runner = app()->make(ZipImportRunner::class);
}

public function test_book_import()
{
$testImagePath = $this->files->testFilePath('test-image.png');
$testFilePath = $this->files->testFilePath('test-file.txt');
$import = ZipTestHelper::importFromData([], [
'book' => [
'id' => 5,
'name' => 'Import test',
'cover' => 'book_cover_image',
'description_html' => '<p><a href="[[bsexport:page:3]]">Link to chapter page</a></p>',
'tags' => [
['name' => 'Animal', 'value' => 'Cat'],
['name' => 'Category', 'value' => 'Test'],
],
'chapters' => [
[
'id' => 6,
'name' => 'Chapter A',
'description_html' => '<p><a href="[[bsexport:book:5]]">Link to book</a></p>',
'priority' => 1,
'tags' => [
['name' => 'Reviewed'],
['name' => 'Category', 'value' => 'Test Chapter'],
],
'pages' => [
[
'id' => 3,
'name' => 'Page A',
'priority' => 6,
'html' => '
<p><a href="[[bsexport:page:3]]">Link to self</a></p>
<p><a href="[[bsexport:image:1]]">Link to cat image</a></p>
<p><a href="[[bsexport:attachment:4]]">Link to text attachment</a></p>',
'tags' => [
['name' => 'Unreviewed'],
],
'attachments' => [
[
'id' => 4,
'name' => 'Text attachment',
'file' => 'file_attachment'
],
[
'name' => 'Cats',
'link' => 'https://example.com/cats',
]
],
'images' => [
[
'id' => 1,
'name' => 'Cat',
'type' => 'gallery',
'file' => 'cat_image'
],
[
'id' => 2,
'name' => 'Dog Drawing',
'type' => 'drawio',
'file' => 'dog_image'
]
],
],
],
],
[
'name' => 'Chapter child B',
'priority' => 5,
]
],
'pages' => [
[
'name' => 'Page C',
'markdown' => '[Link to text]([[bsexport:attachment:4]]?scale=big)',
'priority' => 3,
]
],
],
], [
'book_cover_image' => $testImagePath,
'file_attachment' => $testFilePath,
'cat_image' => $testImagePath,
'dog_image' => $testImagePath,
]);

$this->asAdmin();
/** @var Book $book */
$book = $this->runner->run($import);

// Book checks
$this->assertEquals('Import test', $book->name);
$this->assertFileExists(public_path($book->cover->path));
$this->assertCount(2, $book->tags);
$this->assertEquals('Cat', $book->tags()->first()->value);
$this->assertCount(2, $book->chapters);
$this->assertEquals(1, $book->directPages()->count());

// Chapter checks
$chapterA = $book->chapters()->where('name', 'Chapter A')->first();
$this->assertCount(2, $chapterA->tags);
$firstChapterTag = $chapterA->tags()->first();
$this->assertEquals('Reviewed', $firstChapterTag->name);
$this->assertEquals('', $firstChapterTag->value);
$this->assertCount(1, $chapterA->pages);

// Page checks
/** @var Page $pageA */
$pageA = $chapterA->pages->first();
$this->assertEquals('Page A', $pageA->name);
$this->assertCount(1, $pageA->tags);
$firstPageTag = $pageA->tags()->first();
$this->assertEquals('Unreviewed', $firstPageTag->name);
$this->assertCount(2, $pageA->attachments);
$firstAttachment = $pageA->attachments->first();
$this->assertEquals('Text attachment', $firstAttachment->name);
$this->assertFileEquals($testFilePath, storage_path($firstAttachment->path));
$this->assertFalse($firstAttachment->external);
$secondAttachment = $pageA->attachments->last();
$this->assertEquals('Cats', $secondAttachment->name);
$this->assertEquals('https://example.com/cats', $secondAttachment->path);
$this->assertTrue($secondAttachment->external);
$pageAImages = Image::where('uploaded_to', '=', $pageA->id)->whereIn('type', ['gallery', 'drawio'])->get();
$this->assertCount(2, $pageAImages);
$this->assertEquals('Cat', $pageAImages[0]->name);
$this->assertEquals('gallery', $pageAImages[0]->type);
$this->assertFileEquals($testImagePath, public_path($pageAImages[0]->path));
$this->assertEquals('Dog Drawing', $pageAImages[1]->name);
$this->assertEquals('drawio', $pageAImages[1]->type);

// Book order check
$children = $book->getDirectVisibleChildren()->values()->all();
$this->assertEquals($children[0]->name, 'Chapter A');
$this->assertEquals($children[1]->name, 'Page C');
$this->assertEquals($children[2]->name, 'Chapter child B');

// Reference checks
$textAttachmentUrl = $firstAttachment->getUrl();
$this->assertStringContainsString($pageA->getUrl(), $book->description_html);
$this->assertStringContainsString($book->getUrl(), $chapterA->description_html);
$this->assertStringContainsString($pageA->getUrl(), $pageA->html);
$this->assertStringContainsString($pageAImages[0]->getThumb(1680, null, true), $pageA->html);
$this->assertStringContainsString($firstAttachment->getUrl(), $pageA->html);

// Reference in converted markdown
$pageC = $children[1];
$this->assertStringContainsString("href=\"{$textAttachmentUrl}?scale=big\"", $pageC->html);

ZipTestHelper::deleteZipForImport($import);
}

// TODO - Test full book import
// TODO - Test full chapter import
// TODO - Test full page import
Expand Down
11 changes: 8 additions & 3 deletions tests/Exports/ZipTestHelper.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

class ZipTestHelper
{
public static function importFromData(array $importData, array $zipData): Import
public static function importFromData(array $importData, array $zipData, array $files = []): Import
{
if (isset($zipData['book'])) {
$importData['type'] = 'book';
Expand All @@ -19,7 +19,7 @@ public static function importFromData(array $importData, array $zipData): Import
}

$import = Import::factory()->create($importData);
$zip = static::zipUploadFromData($zipData);
$zip = static::zipUploadFromData($zipData, $files);
rename($zip->getRealPath(), storage_path($import->path));

return $import;
Expand All @@ -33,13 +33,18 @@ public static function deleteZipForImport(Import $import): void
}
}

public static function zipUploadFromData(array $data): UploadedFile
public static function zipUploadFromData(array $data, array $files = []): UploadedFile
{
$zipFile = tempnam(sys_get_temp_dir(), 'bstest-');

$zip = new ZipArchive();
$zip->open($zipFile, ZipArchive::CREATE);
$zip->addFromString('data.json', json_encode($data));

foreach ($files as $name => $file) {
$zip->addFile($file, "files/$name");
}

$zip->close();

return new UploadedFile($zipFile, 'upload.zip', 'application/zip', null, true);
Expand Down

0 comments on commit 8645aea

Please sign in to comment.