namespace Tests\Exports;
use BookStack\Activity\ActivityType;
+use BookStack\Entities\Models\Book;
use BookStack\Exports\Import;
+use BookStack\Exports\ZipExports\Models\ZipExportBook;
+use BookStack\Exports\ZipExports\Models\ZipExportChapter;
+use BookStack\Exports\ZipExports\Models\ZipExportPage;
use Illuminate\Http\UploadedFile;
use Illuminate\Testing\TestResponse;
use Tests\TestCase;
public function test_error_shown_if_no_importable_key()
{
$this->asAdmin();
- $resp = $this->runImportFromFile($this->zipUploadFromData([
+ $resp = $this->runImportFromFile(ZipTestHelper::zipUploadFromData([
'instance' => []
]));
public function test_zip_data_validation_messages_shown()
{
$this->asAdmin();
- $resp = $this->runImportFromFile($this->zipUploadFromData([
+ $resp = $this->runImportFromFile(ZipTestHelper::zipUploadFromData([
'book' => [
'id' => 4,
'pages' => [
{
$admin = $this->users->admin();
$this->actingAs($admin);
- $resp = $this->runImportFromFile($this->zipUploadFromData([
+ $data = [
'book' => [
'name' => 'My great book name',
'chapters' => [
]
],
],
- ]));
+ ];
+
+ $resp = $this->runImportFromFile(ZipTestHelper::zipUploadFromData($data));
$this->assertDatabaseHas('imports', [
'name' => 'My great book name',
- 'book_count' => 1,
- 'chapter_count' => 1,
- 'page_count' => 2,
+ 'type' => 'book',
'created_by' => $admin->id,
]);
$resp->assertRedirect("/import/{$import->id}");
$this->assertFileExists(storage_path($import->path));
$this->assertActivityExists(ActivityType::IMPORT_CREATE);
+
+ ZipTestHelper::deleteZipForImport($import);
}
public function test_import_show_page()
{
- $import = Import::factory()->create(['name' => 'MySuperAdminImport']);
+ $exportBook = new ZipExportBook();
+ $exportBook->name = 'My exported book';
+ $exportChapter = new ZipExportChapter();
+ $exportChapter->name = 'My exported chapter';
+ $exportPage = new ZipExportPage();
+ $exportPage->name = 'My exported page';
+ $exportBook->chapters = [$exportChapter];
+ $exportChapter->pages = [$exportPage];
+
+ $import = Import::factory()->create([
+ 'name' => 'MySuperAdminImport',
+ 'metadata' => json_encode($exportBook)
+ ]);
$resp = $this->asAdmin()->get("/import/{$import->id}");
$resp->assertOk();
- $resp->assertSee('MySuperAdminImport');
+ $resp->assertSeeText('My exported book');
+ $resp->assertSeeText('My exported chapter');
+ $resp->assertSeeText('My exported page');
}
public function test_import_show_page_access_limited()
public function test_import_delete()
{
$this->asAdmin();
- $this->runImportFromFile($this->zipUploadFromData([
+ $this->runImportFromFile(ZipTestHelper::zipUploadFromData([
'book' => [
'name' => 'My great book name'
],
$this->delete("/import/{$adminImport->id}")->assertRedirect('/import');
}
- protected function runImportFromFile(UploadedFile $file): TestResponse
+ public function test_run_simple_success_scenario()
{
- return $this->call('POST', '/import', [], [], ['file' => $file]);
+ $import = ZipTestHelper::importFromData([], [
+ 'book' => [
+ 'name' => 'My imported book',
+ 'pages' => [
+ [
+ 'name' => 'My imported book page',
+ 'html' => '<p>Hello there from child page!</p>'
+ ]
+ ],
+ ]
+ ]);
+
+ $resp = $this->asAdmin()->post("/import/{$import->id}");
+ $book = Book::query()->where('name', '=', 'My imported book')->latest()->first();
+ $resp->assertRedirect($book->getUrl());
+
+ $resp = $this->followRedirects($resp);
+ $resp->assertSee('My imported book page');
+ $resp->assertSee('Hello there from child page!');
+
+ $this->assertDatabaseMissing('imports', ['id' => $import->id]);
+ $this->assertFileDoesNotExist(storage_path($import->path));
+ $this->assertActivityExists(ActivityType::IMPORT_RUN, null, $import->logDescriptor());
}
- protected function zipUploadFromData(array $data): UploadedFile
+ public function test_import_run_access_limited()
{
- $zipFile = tempnam(sys_get_temp_dir(), 'bstest-');
+ $user = $this->users->editor();
+ $admin = $this->users->admin();
+ $userImport = Import::factory()->create(['name' => 'MySuperUserImport', 'created_by' => $user->id]);
+ $adminImport = Import::factory()->create(['name' => 'MySuperAdminImport', 'created_by' => $admin->id]);
+ $this->actingAs($user);
- $zip = new ZipArchive();
- $zip->open($zipFile, ZipArchive::CREATE);
- $zip->addFromString('data.json', json_encode($data));
- $zip->close();
+ $this->post("/import/{$userImport->id}")->assertRedirect('/');
+ $this->post("/import/{$adminImport->id}")->assertRedirect('/');
+
+ $this->permissions->grantUserRolePermissions($user, ['content-import']);
+
+ $this->post("/import/{$userImport->id}")->assertRedirect($userImport->getUrl()); // Getting validation response instead of access issue response
+ $this->post("/import/{$adminImport->id}")->assertStatus(404);
- return new UploadedFile($zipFile, 'upload.zip', 'application/zip', null, true);
+ $this->permissions->grantUserRolePermissions($user, ['settings-manage']);
+
+ $this->post("/import/{$adminImport->id}")->assertRedirect($adminImport->getUrl()); // Getting validation response instead of access issue response
+ }
+
+ public function test_run_revalidates_content()
+ {
+ $import = ZipTestHelper::importFromData([], [
+ 'book' => [
+ 'id' => 'abc',
+ ]
+ ]);
+
+ $resp = $this->asAdmin()->post("/import/{$import->id}");
+ $resp->assertRedirect($import->getUrl());
+
+ $resp = $this->followRedirects($resp);
+ $resp->assertSeeText('The name field is required.');
+ $resp->assertSeeText('The id must be an integer.');
+
+ ZipTestHelper::deleteZipForImport($import);
+ }
+
+ public function test_run_checks_permissions_on_import()
+ {
+ $viewer = $this->users->viewer();
+ $this->permissions->grantUserRolePermissions($viewer, ['content-import']);
+ $import = ZipTestHelper::importFromData(['created_by' => $viewer->id], [
+ 'book' => ['name' => 'My import book'],
+ ]);
+
+ $resp = $this->asViewer()->post("/import/{$import->id}");
+ $resp->assertRedirect($import->getUrl());
+
+ $resp = $this->followRedirects($resp);
+ $resp->assertSeeText('You are lacking the required permissions to create books.');
+
+ ZipTestHelper::deleteZipForImport($import);
+ }
+
+ public function test_run_requires_parent_for_chapter_and_page_imports()
+ {
+ $book = $this->entities->book();
+ $pageImport = ZipTestHelper::importFromData([], [
+ 'page' => ['name' => 'My page', 'html' => '<p>page test!</p>'],
+ ]);
+ $chapterImport = ZipTestHelper::importFromData([], [
+ 'chapter' => ['name' => 'My chapter'],
+ ]);
+
+ $resp = $this->asAdmin()->post("/import/{$pageImport->id}");
+ $resp->assertRedirect($pageImport->getUrl());
+ $this->followRedirects($resp)->assertSee('The parent field is required.');
+
+ $resp = $this->asAdmin()->post("/import/{$pageImport->id}", ['parent' => "book:{$book->id}"]);
+ $resp->assertRedirectContains($book->getUrl());
+
+ $resp = $this->asAdmin()->post("/import/{$chapterImport->id}");
+ $resp->assertRedirect($chapterImport->getUrl());
+ $this->followRedirects($resp)->assertSee('The parent field is required.');
+
+ $resp = $this->asAdmin()->post("/import/{$chapterImport->id}", ['parent' => "book:{$book->id}"]);
+ $resp->assertRedirectContains($book->getUrl());
+ }
+
+ public function test_run_validates_correct_parent_type()
+ {
+ $chapter = $this->entities->chapter();
+ $import = ZipTestHelper::importFromData([], [
+ 'chapter' => ['name' => 'My chapter'],
+ ]);
+
+ $resp = $this->asAdmin()->post("/import/{$import->id}", ['parent' => "chapter:{$chapter->id}"]);
+ $resp->assertRedirect($import->getUrl());
+
+ $resp = $this->followRedirects($resp);
+ $resp->assertSee('Parent book required for chapter import.');
+
+ ZipTestHelper::deleteZipForImport($import);
+ }
+
+ protected function runImportFromFile(UploadedFile $file): TestResponse
+ {
+ return $this->call('POST', '/import', [], [], ['file' => $file]);
}
}
projects / bookstack / blobdiff