FilesExpand file tree

 development

/

TestResponse.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

196 lines (171 loc) · 5.75 KB

 development

/

TestResponse.php

Copy path

Top

File metadata and controls

• Code
• Blame

196 lines (171 loc) · 5.75 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

193

194

195

196

<?php

namespace Tests;

use Illuminate\Testing\TestResponse as BaseTestResponse;

use PHPUnit\Framework\Assert as PHPUnit;

use Symfony\Component\DomCrawler\Crawler;

/**

* Class TestResponse

* Custom extension of the default Laravel TestResponse class.

*/

class TestResponse extends BaseTestResponse

{

protected $crawlerInstance;

/**

* Get the DOM Crawler for the response content.

*/

protected function crawler(): Crawler

{

if (!is_object($this->crawlerInstance)) {

$this->crawlerInstance = new Crawler($this->getContent());

}

return $this->crawlerInstance;

}

/**

* Get the HTML of the first element at the given selector.

*/

public function getElementHtml(string $selector): string

{

return $this->crawler()->filter($selector)->first()->outerHtml();

}

/**

* Assert the response contains the specified element.

*

* @return $this

*/

public function assertElementExists(string $selector)

{

$elements = $this->crawler()->filter($selector);

PHPUnit::assertTrue(

$elements->count() > 0,

'Unable to find element matching the selector: ' . PHP_EOL . PHP_EOL .

"[{$selector}]" . PHP_EOL . PHP_EOL .

'within' . PHP_EOL . PHP_EOL .

"[{$this->getContent()}]."

);

return $this;

}

/**

* Assert the response contains the given count of elements

* that match the given css selector.

*

* @return $this

*/

public function assertElementCount(string $selector, int $count)

{

$elements = $this->crawler()->filter($selector);

PHPUnit::assertTrue(

$elements->count() === $count,

'Unable to ' . $count . ' element(s) matching the selector: ' . PHP_EOL . PHP_EOL .

"[{$selector}]" . PHP_EOL . PHP_EOL .

'found ' . $elements->count() . ' within' . PHP_EOL . PHP_EOL .

"[{$this->getContent()}]."

);

return $this;

}

/**

* Assert the response does not contain the specified element.

*

* @return $this

*/

public function assertElementNotExists(string $selector)

{

$elements = $this->crawler()->filter($selector);

PHPUnit::assertTrue(

$elements->count() === 0,

'Found elements matching the selector: ' . PHP_EOL . PHP_EOL .

"[{$selector}]" . PHP_EOL . PHP_EOL .

'within' . PHP_EOL . PHP_EOL .

"[{$this->getContent()}]."

);

return $this;

}

/**

* Assert the response includes a specific element containing the given text.

* If an nth match is provided, only that will be checked otherwise all matching

* elements will be checked for the given text.

*

* @return $this

*/

public function assertElementContains(string $selector, string $text, ?int $nthMatch = null)

{

$elements = $this->crawler()->filter($selector);

$matched = false;

$pattern = $this->getEscapedPattern($text);

if (!is_null($nthMatch)) {

$elements = $elements->eq($nthMatch - 1);

}

foreach ($elements as $element) {

$element = new Crawler($element);

if (preg_match("/$pattern/i", $element->text())) {

$matched = true;

break;

}

}

PHPUnit::assertTrue(

$matched,

'Unable to find element of selector: ' . PHP_EOL . PHP_EOL .

($nthMatch ? ("at position {$nthMatch}" . PHP_EOL . PHP_EOL) : '') .

"[{$selector}]" . PHP_EOL . PHP_EOL .

'containing text' . PHP_EOL . PHP_EOL .

"[{$text}]" . PHP_EOL . PHP_EOL .

'within' . PHP_EOL . PHP_EOL .

"[{$this->getContent()}]."

);

return $this;

}

/**

* Assert the response does not include a specific element containing the given text.

* If an nth match is provided, only that will be checked otherwise all matching

* elements will be checked for the given text.

*

* @return $this

*/

public function assertElementNotContains(string $selector, string $text, ?int $nthMatch = null)

{

$elements = $this->crawler()->filter($selector);

$matched = false;

$pattern = $this->getEscapedPattern($text);

if (!is_null($nthMatch)) {

$elements = $elements->eq($nthMatch - 1);

}

foreach ($elements as $element) {

$element = new Crawler($element);

if (preg_match("/$pattern/i", $element->html())) {

$matched = true;

break;

}

}

PHPUnit::assertTrue(

!$matched,

'Found element of selector: ' . PHP_EOL . PHP_EOL .

($nthMatch ? ("at position {$nthMatch}" . PHP_EOL . PHP_EOL) : '') .

"[{$selector}]" . PHP_EOL . PHP_EOL .

'containing text' . PHP_EOL . PHP_EOL .

"[{$text}]" . PHP_EOL . PHP_EOL .

'within' . PHP_EOL . PHP_EOL .

"[{$this->getContent()}]."

);

return $this;

}

/**

* Assert there's a notification within the view containing the given text.

*

* @return $this

*/

public function assertNotificationContains(string $text)

{

return $this->assertElementContains('[notification]', $text);

}

/**

* Get the escaped text pattern for the constraint.

*

* @return string

*/

protected function getEscapedPattern(string $text)

{

$rawPattern = preg_quote($text, '/');

$escapedPattern = preg_quote(e($text), '/');

return $rawPattern == $escapedPattern

? $rawPattern : "({$rawPattern}|{$escapedPattern})";

}

}