FilesExpand file tree

 master

/

SharedTestHelpers.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

192 lines (171 loc) · 5.33 KB

 master

/

SharedTestHelpers.php

Copy path

Top

File metadata and controls

• Code
• Blame

192 lines (171 loc) · 5.33 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

<?php namespace Tests;

use BookStack\Entities\Book;

use BookStack\Entities\Bookshelf;

use BookStack\Entities\Chapter;

use BookStack\Entities\Entity;

use BookStack\Entities\Page;

use BookStack\Entities\Repos\EntityRepo;

use BookStack\Auth\Permissions\PermissionsRepo;

use BookStack\Auth\Role;

use BookStack\Auth\Permissions\PermissionService;

use BookStack\Entities\Repos\PageRepo;

use BookStack\Settings\SettingService;

trait SharedTestHelpers

{

protected $admin;

protected $editor;

/**

* Set the current user context to be an admin.

* @return $this

*/

public function asAdmin()

{

return $this->actingAs($this->getAdmin());

}

/**

* Get the current admin user.

* @return mixed

*/

public function getAdmin() {

if($this->admin === null) {

$adminRole = Role::getSystemRole('admin');

$this->admin = $adminRole->users->first();

}

return $this->admin;

}

/**

* Set the current user context to be an editor.

* @return $this

*/

public function asEditor()

{

return $this->actingAs($this->getEditor());

}

/**

* Get a editor user.

* @return mixed

*/

protected function getEditor() {

if($this->editor === null) {

$editorRole = Role::getRole('editor');

$this->editor = $editorRole->users->first();

}

return $this->editor;

}

/**

* Get an instance of a user with 'viewer' permissions

* @param $attributes

* @return mixed

*/

protected function getViewer($attributes = [])

{

$user = \BookStack\Auth\Role::getRole('viewer')->users()->first();

if (!empty($attributes)) $user->forceFill($attributes)->save();

return $user;

}

/**

* Regenerate the permission for an entity.

* @param Entity $entity

*/

protected function regenEntityPermissions(Entity $entity)

{

app(PermissionService::class)->buildJointPermissionsForEntity($entity);

$entity->load('jointPermissions');

}

/**

* Create and return a new bookshelf.

* @param array $input

* @return \BookStack\Entities\Bookshelf

*/

public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) {

return app(EntityRepo::class)->createFromInput('bookshelf', $input, false);

}

/**

* Create and return a new book.

* @param array $input

* @return Book

*/

public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {

return app(EntityRepo::class)->createFromInput('book', $input, false);

}

/**

* Create and return a new test chapter

* @param array $input

* @param Book $book

* @return \BookStack\Entities\Chapter

*/

public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {

return app(EntityRepo::class)->createFromInput('chapter', $input, $book);

}

/**

* Create and return a new test page

* @param array $input

* @return Page

*/

public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {

$book = Book::first();

$pageRepo = app(PageRepo::class);

$draftPage = $pageRepo->getDraftPage($book);

return $pageRepo->publishPageDraft($draftPage, $input);

}

/**

* Quickly sets an array of settings.

* @param $settingsArray

*/

protected function setSettings($settingsArray)

{

$settings = app(SettingService::class);

foreach ($settingsArray as $key => $value) {

$settings->put($key, $value);

}

}

/**

* Manually set some permissions on an entity.

* @param Entity $entity

* @param array $actions

* @param array $roles

*/

protected function setEntityRestrictions(Entity $entity, $actions = [], $roles = [])

{

$entity->restricted = true;

$entity->permissions()->delete();

$permissions = [];

foreach ($actions as $action) {

foreach ($roles as $role) {

$permissions[] = [

'role_id' => $role->id,

'action' => strtolower($action)

];

}

}

$entity->permissions()->createMany($permissions);

$entity->save();

$entity->load('permissions');

$this->app[PermissionService::class]->buildJointPermissionsForEntity($entity);

$entity->load('jointPermissions');

}

/**

* Give the given user some permissions.

* @param \BookStack\Auth\User $user

* @param array $permissions

*/

protected function giveUserPermissions(\BookStack\Auth\User $user, $permissions = [])

{

$newRole = $this->createNewRole($permissions);

$user->attachRole($newRole);

$user->load('roles');

$user->permissions(false);

}

/**

* Create a new basic role for testing purposes.

* @param array $permissions

* @return Role

*/

protected function createNewRole($permissions = [])

{

$permissionRepo = app(PermissionsRepo::class);

$roleData = factory(Role::class)->make()->toArray();

$roleData['permissions'] = array_flip($permissions);

return $permissionRepo->saveNewRole($roleData);

}

}