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
|
<?php
declare(strict_types=1);
namespace LaminasTest\Stdlib;
use Laminas\Stdlib\ConsoleHelper;
use PHPUnit\Framework\TestCase;
use ReflectionProperty;
use function feof;
use function fopen;
use function fread;
use function rewind;
final class ConsoleHelperTest extends TestCase
{
private ConsoleHelper $helper;
protected function setUp(): void
{
$this->helper = new ConsoleHelper();
}
public function disableColorSupport(): void
{
$r = new ReflectionProperty($this->helper, 'supportsColor');
$r->setValue($this->helper, false);
}
public function enableColorSupport(): void
{
$r = new ReflectionProperty($this->helper, 'supportsColor');
$r->setValue($this->helper, true);
}
public function overrideEolSequence(string $newSequence): void
{
$r = new ReflectionProperty($this->helper, 'eol');
$r->setValue($this->helper, $newSequence);
}
public function overrideStderrResource(mixed $stderr): void
{
$r = new ReflectionProperty($this->helper, 'stderr');
$r->setValue($this->helper, $stderr);
}
/** @param resource $stream */
public function retrieveStreamContents($stream): string
{
rewind($stream);
$contents = '';
while (! feof($stream)) {
$chunk = fread($stream, 4096);
self::assertIsString($chunk);
$contents .= $chunk;
}
return $contents;
}
public function testCanColorizeInfoString(): void
{
$string = ' <info>-h|--help</info> This help message';
$this->enableColorSupport();
$colorized = $this->helper->colorize($string);
self::assertEquals(" \033[32m-h|--help\033[0m This help message", $colorized);
}
public function testCanColorizeErrorString(): void
{
$string = '<error>NOT OK</error> An error occurred';
$this->enableColorSupport();
$colorized = $this->helper->colorize($string);
self::assertEquals("\033[31mNOT OK\033[0m An error occurred", $colorized);
}
public function testCanColorizeMixedStrings(): void
{
$this->enableColorSupport();
$string = "<error>NOT OK</error>\n\n<info>Usage:</info> foo";
$colorized = $this->helper->colorize($string);
self::assertStringContainsString("\033[31mNOT OK\033[0m", $colorized, 'Colorized error string not found');
self::assertStringContainsString("\033[32mUsage:\033[0m", $colorized, 'Colorized info string not found');
}
public function testColorizationWillReplaceTagsWithEmptyStringsWhenColorSupportIsNotDetected(): void
{
$this->disableColorSupport();
$string = "<error>NOT OK</error>\n\n<info>Usage:</info> foo";
$colorized = $this->helper->colorize($string);
self::assertStringNotContainsString("\033[31m", $colorized, 'Colorized error string discovered');
self::assertStringNotContainsString("\033[32m", $colorized, 'Colorized info string discovered');
self::assertStringNotContainsString("\033[0m", $colorized, 'Color reset sequence discovered');
self::assertDoesNotMatchRegularExpression("/<\/?error>/", $colorized, 'Error template string discovered');
self::assertDoesNotMatchRegularExpression("/<\/?info>/", $colorized, 'Info template string discovered');
}
public function testWriteFormatsLinesToPhpEolSequenceAndWritesToProvidedStream(): void
{
$this->overrideEolSequence("\r\n");
$string = "foo bar\nbaz bat";
$stream = fopen('php://temp', 'w+');
self::assertIsResource($stream);
$this->helper->write($string, false, $stream);
$contents = $this->retrieveStreamContents($stream);
self::assertStringContainsString("\r\n", $contents);
}
public function testWriteWillColorizeOutputIfRequested(): void
{
$this->enableColorSupport();
$string = 'foo <info>bar</info>';
$stream = fopen('php://temp', 'w+');
self::assertIsResource($stream);
$this->helper->write($string, true, $stream);
$contents = $this->retrieveStreamContents($stream);
self::assertStringContainsString("\033[32mbar\033[0m", $contents);
}
public function testWriteLineAppendsPhpEolSequenceToString(): void
{
$this->overrideEolSequence("\r\n");
$string = 'foo bar';
$stream = fopen('php://temp', 'w+');
self::assertIsResource($stream);
$this->helper->writeLine($string, false, $stream);
$contents = $this->retrieveStreamContents($stream);
self::assertMatchesRegularExpression("/bar\r\n$/", $contents);
}
public function testWriteErrorMessageWritesColorizedOutputToStderr(): void
{
$stderr = fopen('php://temp', 'w+');
self::assertIsResource($stderr);
$this->overrideStderrResource($stderr);
$this->enableColorSupport();
$this->overrideEolSequence("\r\n");
$this->helper->writeErrorMessage('an error occurred');
$contents = $this->retrieveStreamContents($stderr);
self::assertEquals("\033[31man error occurred\033[0m\r\n\r\n", $contents);
}
}
|
