BookStack Code Mirror - bookstack/blob - tests/Entity/PageRevisionTest.php

1 <?php

2

3 namespace Tests\Entity;

4

5 use BookStack\Actions\ActivityType;

6 use BookStack\Entities\Models\Page;

7 use BookStack\Entities\Repos\PageRepo;

8 use Tests\TestCase;

9

10 class PageRevisionTest extends TestCase

11 {

12 public function test_revision_links_visible_to_viewer()

13 {

14 /** @var Page $page */

15 $page = Page::query()->first();

16

17 $html = $this->withHtml($this->asViewer()->get($page->getUrl()));

18 $html->assertLinkExists($page->getUrl('/revisions'));

19 $html->assertElementContains('a', 'Revisions');

20 $html->assertElementContains('a', 'Revision #1');

21 }

22

23 public function test_page_revision_views_viewable()

24 {

25 $this->asEditor();

26

27 $pageRepo = app(PageRepo::class);

28 $page = Page::first();

29 $pageRepo->update($page, ['name' => 'updated page', 'html' => 'new content', 'summary' => 'page revision testing']);

30 $pageRevision = $page->revisions->last();

31

32 $revisionView = $this->get($page->getUrl() . '/revisions/' . $pageRevision->id);

33 $revisionView->assertStatus(200);

34 $revisionView->assertSee('new content');

35

36 $revisionView = $this->get($page->getUrl() . '/revisions/' . $pageRevision->id . '/changes');

37 $revisionView->assertStatus(200);

38 $revisionView->assertSee('new content');

39 }

40

41 public function test_page_revision_preview_shows_content_of_revision()

42 {

43 $this->asEditor();

44

45 $pageRepo = app(PageRepo::class);

46 $page = Page::first();

47 $pageRepo->update($page, ['name' => 'updated page', 'html' => 'new revision content', 'summary' => 'page revision testing']);

48 $pageRevision = $page->revisions->last();

49 $pageRepo->update($page, ['name' => 'updated page', 'html' => 'Updated content', 'summary' => 'page revision testing 2']);

50

51 $revisionView = $this->get($page->getUrl() . '/revisions/' . $pageRevision->id);

52 $revisionView->assertStatus(200);

53 $revisionView->assertSee('new revision content');

54 }

55

56 public function test_page_revision_restore_updates_content()

57 {

58 $this->asEditor();

59

60 $pageRepo = app(PageRepo::class);

61 $page = Page::first();

62 $pageRepo->update($page, ['name' => 'updated page abc123', 'html' => 'new contente def456', 'summary' => 'initial page revision testing']);

63 $pageRepo->update($page, ['name' => 'updated page again', 'html' => 'new content', 'summary' => 'page revision testing']);

64 $page = Page::find($page->id);

65

66 $pageView = $this->get($page->getUrl());

67 $pageView->assertDontSee('abc123');

68 $pageView->assertDontSee('def456');

69

70 $revToRestore = $page->revisions()->where('name', 'like', '%abc123')->first();

71 $restoreReq = $this->put($page->getUrl() . '/revisions/' . $revToRestore->id . '/restore');

72 $page = Page::find($page->id);

73

74 $restoreReq->assertStatus(302);

75 $restoreReq->assertRedirect($page->getUrl());

76

77 $pageView = $this->get($page->getUrl());

78 $pageView->assertSee('abc123');

79 $pageView->assertSee('def456');

80 }

81

82 public function test_page_revision_restore_with_markdown_retains_markdown_content()

83 {

84 $this->asEditor();

85

86 $pageRepo = app(PageRepo::class);

87 $page = Page::first();

88 $pageRepo->update($page, ['name' => 'updated page abc123', 'markdown' => '## New Content def456', 'summary' => 'initial page revision testing']);

89 $pageRepo->update($page, ['name' => 'updated page again', 'markdown' => '## New Content Updated', 'summary' => 'page revision testing']);

90 $page = Page::find($page->id);

91

92 $pageView = $this->get($page->getUrl());

93 $pageView->assertDontSee('abc123');

94 $pageView->assertDontSee('def456');

95

96 $revToRestore = $page->revisions()->where('name', 'like', '%abc123')->first();

97 $restoreReq = $this->put($page->getUrl() . '/revisions/' . $revToRestore->id . '/restore');

98 $page = Page::find($page->id);

99

100 $restoreReq->assertStatus(302);

101 $restoreReq->assertRedirect($page->getUrl());

102

103 $pageView = $this->get($page->getUrl());

104 $this->assertDatabaseHas('pages', [

105 'id' => $page->id,

106 'markdown' => '## New Content def456',

107 ]);

108 $pageView->assertSee('abc123');

109 $pageView->assertSee('def456');

110 }

111

112 public function test_page_revision_restore_sets_new_revision_with_summary()

113 {

114 $this->asEditor();

115

116 $pageRepo = app(PageRepo::class);

117 $page = Page::first();

118 $pageRepo->update($page, ['name' => 'updated page abc123', 'html' => 'new contente def456', 'summary' => 'My first update']);

119 $pageRepo->update($page, ['name' => 'updated page again', 'html' => 'new content', 'summary' => '']);

120 $page->refresh();

121

122 $revToRestore = $page->revisions()->where('name', 'like', '%abc123')->first();

123 $this->put($page->getUrl() . '/revisions/' . $revToRestore->id . '/restore');

124 $page->refresh();

125

126 $this->assertDatabaseHas('page_revisions', [

127 'page_id' => $page->id,

128 'text' => 'new contente def456',

129 'type' => 'version',

130 'summary' => "Restored from #{$revToRestore->id}; My first update",

131 ]);

132

133 $detail = "Revision #{$revToRestore->revision_number} (ID: {$revToRestore->id}) for page ID {$revToRestore->page_id}";

134 $this->assertActivityExists(ActivityType::REVISION_RESTORE, null, $detail);

135 }

136

137 public function test_page_revision_count_increments_on_update()

138 {

139 $page = Page::first();

140 $startCount = $page->revision_count;

141 $resp = $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

142 $resp->assertStatus(302);

143

144 $this->assertTrue(Page::find($page->id)->revision_count === $startCount + 1);

145 }

146

147 public function test_revision_count_shown_in_page_meta()

148 {

149 $page = Page::first();

150 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

151

152 $page = Page::find($page->id);

153 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

154

155 $page = Page::find($page->id);

156 $pageView = $this->get($page->getUrl());

157 $pageView->assertSee('Revision #' . $page->revision_count);

158 }

159

160 public function test_revision_deletion()

161 {

162 /** @var Page $page */

163 $page = Page::query()->first();

164 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

165

166 $page->refresh();

167 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

168

169 $page->refresh();

170 $beforeRevisionCount = $page->revisions->count();

171

172 // Delete the first revision

173 $revision = $page->revisions->get(1);

174 $resp = $this->asEditor()->delete($revision->getUrl('/delete/'));

175 $resp->assertRedirect($page->getUrl('/revisions'));

176

177 $page->refresh();

178 $afterRevisionCount = $page->revisions->count();

179

180 $this->assertTrue($beforeRevisionCount === ($afterRevisionCount + 1));

181

182 $detail = "Revision #{$revision->revision_number} (ID: {$revision->id}) for page ID {$revision->page_id}";

183 $this->assertActivityExists(ActivityType::REVISION_DELETE, null, $detail);

184

185 // Try to delete the latest revision

186 $beforeRevisionCount = $page->revisions->count();

187 $resp = $this->asEditor()->delete($page->currentRevision->getUrl('/delete/'));

188 $resp->assertRedirect($page->getUrl('/revisions'));

189

190 $page->refresh();

191 $afterRevisionCount = $page->revisions->count();

192 $this->assertTrue($beforeRevisionCount === $afterRevisionCount);

193 }

194

195 public function test_revision_limit_enforced()

196 {

197 config()->set('app.revision_limit', 2);

198 $page = Page::first();

199 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

200 $page = Page::find($page->id);

201 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

202 for ($i = 0; $i < 10; $i++) {

203 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

204 }

205

206 $revisionCount = $page->revisions()->count();

207 $this->assertEquals(2, $revisionCount);

208 }

209

210 public function test_false_revision_limit_allows_many_revisions()

211 {

212 config()->set('app.revision_limit', false);

213 $page = Page::first();

214 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

215 $page = Page::find($page->id);

216 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

217 for ($i = 0; $i < 10; $i++) {

218 $this->asEditor()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html', 'summary' => 'Update a']);

219 }

220

221 $revisionCount = $page->revisions()->count();

222 $this->assertEquals(12, $revisionCount);

223 }

224

225 public function test_revision_list_shows_editor_type()

226 {

227 /** @var Page $page */

228 $page = Page::first();

229 $this->asAdmin()->put($page->getUrl(), ['name' => 'Updated page', 'html' => 'new page html']);

230

231 $resp = $this->get($page->refresh()->getUrl('/revisions'));

232 $this->withHtml($resp)->assertElementContains('td', '(WYSIWYG)');

233 $this->withHtml($resp)->assertElementNotContains('td', '(Markdown)');

234

235 $this->asAdmin()->put($page->getUrl(), ['name' => 'Updated page', 'markdown' => '# Some markdown content']);

236 $resp = $this->get($page->refresh()->getUrl('/revisions'));

237 $this->withHtml($resp)->assertElementContains('td', '(Markdown)');

238 }

239 }