Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEnvironmentVariableTest.php
More file actions
389 lines (331 loc) · 13.7 KB
/
Copy pathEnvironmentVariableTest.php
File metadata and controls
389 lines (331 loc) · 13.7 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<?php
declare(strict_types=1);
namespace Test\TinyBlocks\EnvironmentVariable;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use TinyBlocks\EnvironmentVariable\EnvironmentVariable;
use TinyBlocks\EnvironmentVariable\Internal\Exceptions\EnvironmentValueNotBoolean;
use TinyBlocks\EnvironmentVariable\Internal\Exceptions\EnvironmentValueNotInteger;
use TinyBlocks\EnvironmentVariable\Internal\Exceptions\EnvironmentVariableMissing;
final class EnvironmentVariableTest extends TestCase
{
private const array MANAGED_VARIABLES = [
'MY_VAR',
'VALID_INT',
'INVALID_INT',
'INVALID_BOOL',
'NON_EXISTENT',
'NULL_VALUE',
'EMPTY_STRING',
'VALID_STRING',
'NEGATIVE_INT',
'NUMERIC_TRUE',
'BOOLEAN_TRUE',
'STRING_VALUE',
'INTEGER_ZERO',
'NUMERIC_FALSE',
'BOOLEAN_FALSE',
'NON_SCALAR_ENV',
'NUMERIC_STRING',
'NON_EXISTENT_VAR',
'INTEGER_POSITIVE',
'INTEGER_NEGATIVE',
'NON_SCALAR_SERVER',
'STRING_WITH_SPACES',
'FROM_ENV_SUPERGLOBAL',
'NON_EXISTENT_MY_VAR',
'FROM_SERVER_SUPERGLOBAL'
];
protected function tearDown(): void
{
foreach (self::MANAGED_VARIABLES as $variable) {
putenv($variable);
unset($_ENV[$variable], $_SERVER[$variable]);
}
}
#[DataProvider('stringConversionDataProvider')]
public function testToStringWhenValuePresentThenReturnsExpectedString(
mixed $value,
string $variable,
string $expected
): void {
/** @Given the environment variable is set with the given raw value */
putenv(sprintf('%s=%s', $variable, $value));
/** @When converting the environment variable to string */
$actual = EnvironmentVariable::from(name: $variable)->toString();
/** @Then the returned string matches the expected representation */
self::assertSame($expected, $actual);
}
#[DataProvider('integerConversionDataProvider')]
public function testToIntegerWhenValueIsNumericThenReturnsExpectedInteger(
string $value,
string $variable,
int $expected
): void {
/** @Given the environment variable is set with a numeric string */
putenv(sprintf('%s=%s', $variable, $value));
/** @When converting the environment variable to integer */
$actual = EnvironmentVariable::from(name: $variable)->toInteger();
/** @Then the returned integer matches the expected value */
self::assertSame($expected, $actual);
}
#[DataProvider('booleanConversionDataProvider')]
public function testToBooleanWhenValueIsBooleanLikeThenReturnsExpectedBoolean(
string $value,
string $variable,
bool $expected
): void {
/** @Given the environment variable is set with a boolean-like value */
putenv(sprintf('%s=%s', $variable, $value));
/** @When converting the environment variable to boolean */
$actual = EnvironmentVariable::from(name: $variable)->toBoolean();
/** @Then the returned boolean matches the expected value */
self::assertSame($expected, $actual);
}
public function testFromOrDefaultWhenVariableMissingThenReturnsDefault(): void
{
/** @Given the environment variable does not exist */
$variable = 'NON_EXISTENT_MY_VAR';
/** @When requesting the variable with a default value */
$actual = EnvironmentVariable::fromOrDefault(name: $variable, defaultValueIfNotFound: '0');
/** @Then the returned instance exposes the default value */
self::assertSame(0, $actual->toInteger());
}
public function testFromOrDefaultWhenVariableExistsThenReturnsExistingValue(): void
{
/** @Given the environment variable exists with an existing value */
putenv(sprintf('%s=%s', 'MY_VAR', 'existing_value'));
/** @When requesting the variable with a default value */
$actual = EnvironmentVariable::fromOrDefault(name: 'MY_VAR', defaultValueIfNotFound: 'default_value');
/** @Then the returned instance exposes the existing value */
self::assertSame('existing_value', $actual->toString());
}
public function testFromOrDefaultWhenVariableMissingAndNoDefaultThenToStringIsEmpty(): void
{
/** @Given the environment variable does not exist */
$variable = 'NON_EXISTENT_VAR';
/** @When requesting the variable without a default value */
$actual = EnvironmentVariable::fromOrDefault(name: $variable);
/** @Then the returned instance exposes an empty string */
self::assertSame('', $actual->toString());
}
public function testFromOrDefaultWhenVariableMissingAndNoDefaultThenHasValueIsFalse(): void
{
/** @Given the environment variable does not exist */
$variable = 'NON_EXISTENT_VAR';
/** @When requesting the variable without a default value */
$actual = EnvironmentVariable::fromOrDefault(name: $variable);
/** @Then the returned instance reports no value */
self::assertFalse($actual->hasValue());
}
#[DataProvider('hasValueDataProvider')]
public function testHasValueWhenValueIsMeaningfulThenReturnsTrue(string $value, string $variable): void
{
/** @Given the environment variable is set with a meaningful value */
putenv(sprintf('%s=%s', $variable, $value));
/** @When checking if the environment variable has a value */
$actual = EnvironmentVariable::from(name: $variable)->hasValue();
/** @Then the check reports the presence of a value */
self::assertTrue($actual);
}
#[DataProvider('hasNoValueDataProvider')]
public function testHasValueWhenValueIsAbsentOrNullLikeThenReturnsFalse(?string $value, string $variable): void
{
/** @Given the environment variable is set with a null-like value */
putenv(sprintf('%s=%s', $variable, $value));
/** @When checking if the environment variable has a value */
$actual = EnvironmentVariable::from(name: $variable)->hasValue();
/** @Then the check reports the absence of a value */
self::assertFalse($actual);
}
public function testFromWhenVariableIsMissingThenThrowsEnvironmentVariableMissing(): void
{
/** @Given the environment variable does not exist */
$variable = 'NON_EXISTENT';
/** @Then a missing environment variable exception is expected */
$this->expectException(EnvironmentVariableMissing::class);
$this->expectExceptionMessage('Environment variable <NON_EXISTENT> is missing.');
/** @When requesting the missing environment variable */
EnvironmentVariable::from(name: $variable);
}
public function testFromWhenScalarPresentInEnvSuperglobalThenValueIsCoerced(): void
{
/** @Given a non-string scalar available only in $_ENV */
$_ENV['FROM_ENV_SUPERGLOBAL'] = 42;
/** @When reading the environment variable */
$actual = EnvironmentVariable::from(name: 'FROM_ENV_SUPERGLOBAL')->toString();
/** @Then the value from $_ENV is coerced to string */
self::assertSame('42', $actual);
}
public function testFromWhenScalarPresentInServerSuperglobalThenValueIsCoerced(): void
{
/** @Given a non-string scalar available only in $_SERVER */
$_SERVER['FROM_SERVER_SUPERGLOBAL'] = 7;
/** @When reading the environment variable */
$actual = EnvironmentVariable::from(name: 'FROM_SERVER_SUPERGLOBAL')->toString();
/** @Then the value from $_SERVER is coerced to string */
self::assertSame('7', $actual);
}
public function testFromWhenNonScalarInEnvSuperglobalThenThrowsMissing(): void
{
/** @Given a non-scalar entry in $_ENV */
$_ENV['NON_SCALAR_ENV'] = ['nested' => 'value'];
/** @Then a missing environment variable exception is expected */
$this->expectException(EnvironmentVariableMissing::class);
/** @When reading the environment variable */
EnvironmentVariable::from(name: 'NON_SCALAR_ENV');
}
public function testFromWhenNonScalarInServerSuperglobalThenThrowsMissing(): void
{
/** @Given a non-scalar entry in $_SERVER */
$_SERVER['NON_SCALAR_SERVER'] = ['nested' => 'value'];
/** @Then a missing environment variable exception is expected */
$this->expectException(EnvironmentVariableMissing::class);
/** @When reading the environment variable */
EnvironmentVariable::from(name: 'NON_SCALAR_SERVER');
}
public function testToIntegerWhenValueIsNotNumericThenThrowsEnvironmentValueNotInteger(): void
{
/** @Given the environment variable holds a non-numeric value */
putenv(sprintf('%s=%s', 'INVALID_INT', 'invalid-value'));
/** @Then an invalid integer conversion exception is expected */
$this->expectException(EnvironmentValueNotInteger::class);
$this->expectExceptionMessage(
'The value for environment variable <INVALID_INT> is invalid for conversion to <integer>.'
);
/** @When converting the environment variable to integer */
EnvironmentVariable::from(name: 'INVALID_INT')->toInteger();
}
public function testToBooleanWhenValueIsNotBooleanLikeThenThrowsEnvironmentValueNotBoolean(): void
{
/** @Given the environment variable holds a non-boolean-like value */
putenv(sprintf('%s=%s', 'INVALID_BOOL', 'invalid-value'));
/** @Then an invalid boolean conversion exception is expected */
$this->expectException(EnvironmentValueNotBoolean::class);
$this->expectExceptionMessage(
'The value for environment variable <INVALID_BOOL> is invalid for conversion to <boolean>.'
);
/** @When converting the environment variable to boolean */
EnvironmentVariable::from(name: 'INVALID_BOOL')->toBoolean();
}
public static function stringConversionDataProvider(): array
{
return [
'String value' => [
'value' => 'Hello, world!',
'variable' => 'VALID_STRING',
'expected' => 'Hello, world!'
],
'Numeric string' => [
'value' => '123',
'variable' => 'NUMERIC_STRING',
'expected' => '123'
],
'Boolean true value' => [
'value' => true,
'variable' => 'BOOLEAN_TRUE',
'expected' => '1'
],
'Boolean false value' => [
'value' => false,
'variable' => 'BOOLEAN_FALSE',
'expected' => ''
]
];
}
public static function integerConversionDataProvider(): array
{
return [
'Integer value' => [
'value' => '123',
'variable' => 'VALID_INT',
'expected' => 123
],
'Numeric string' => [
'value' => '42',
'variable' => 'NUMERIC_STRING',
'expected' => 42
],
'Negative integer' => [
'value' => '-7',
'variable' => 'NEGATIVE_INT',
'expected' => -7
]
];
}
public static function booleanConversionDataProvider(): array
{
return [
'Numeric value one as string' => [
'value' => '1',
'variable' => 'NUMERIC_TRUE',
'expected' => true
],
'Numeric value zero as string' => [
'value' => '0',
'variable' => 'NUMERIC_FALSE',
'expected' => false
],
'Boolean true value as string' => [
'value' => 'true',
'variable' => 'BOOLEAN_TRUE',
'expected' => true
],
'Boolean false value as string' => [
'value' => 'false',
'variable' => 'BOOLEAN_FALSE',
'expected' => false
]
];
}
public static function hasValueDataProvider(): array
{
return [
'String value' => [
'value' => 'Hello, World!',
'variable' => 'STRING_VALUE'
],
'Integer value 0' => [
'value' => '0',
'variable' => 'INTEGER_ZERO'
],
'Boolean value true' => [
'value' => 'true',
'variable' => 'BOOLEAN_TRUE'
],
'Boolean value false' => [
'value' => 'false',
'variable' => 'BOOLEAN_FALSE'
],
'Integer value positive' => [
'value' => '123',
'variable' => 'INTEGER_POSITIVE'
],
'Integer value negative' => [
'value' => '-1',
'variable' => 'INTEGER_NEGATIVE'
]
];
}
public static function hasNoValueDataProvider(): array
{
return [
'Null value' => [
'value' => null,
'variable' => 'NULL_VALUE'
],
'Empty string' => [
'value' => '',
'variable' => 'EMPTY_STRING'
],
'String null value' => [
'value' => 'NULL',
'variable' => 'NULL_VALUE'
],
'String with only spaces' => [
'value' => ' ',
'variable' => 'STRING_WITH_SPACES'
]
];
}
}
You can’t perform that action at this time.