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
|
<?php
declare(strict_types=1);
namespace Dotenv\Tests;
use Dotenv\Dotenv;
use Dotenv\Exception\InvalidEncodingException;
use Dotenv\Exception\InvalidPathException;
use Dotenv\Loader\Loader;
use Dotenv\Parser\Parser;
use Dotenv\Repository\RepositoryBuilder;
use Dotenv\Store\StoreBuilder;
use PHPUnit\Framework\Attributes\BeforeClass;
use PHPUnit\Framework\TestCase;
final class DotenvTest extends TestCase
{
/**
* @var string
*/
private static $folder;
/**
* @return void
*/
#[BeforeClass]
public static function setFolder()
{
self::$folder = \dirname(__DIR__).'/fixtures/env';
}
public function testDotenvThrowsExceptionIfUnableToLoadFile()
{
$dotenv = Dotenv::createMutable(__DIR__);
$this->expectException(InvalidPathException::class);
$this->expectExceptionMessage('Unable to read any of the environment file(s) at');
$dotenv->load();
}
public function testDotenvThrowsExceptionIfUnableToLoadFiles()
{
$dotenv = Dotenv::createMutable([__DIR__, __DIR__.'/foo/bar']);
$this->expectException(InvalidPathException::class);
$this->expectExceptionMessage('Unable to read any of the environment file(s) at');
$dotenv->load();
}
public function testDotenvThrowsExceptionWhenNoFiles()
{
$dotenv = Dotenv::createMutable([]);
$this->expectException(InvalidPathException::class);
$this->expectExceptionMessage('At least one environment file path must be provided.');
$dotenv->load();
}
public function testDotenvTriesPathsToLoad()
{
$dotenv = Dotenv::createMutable([__DIR__, self::$folder]);
self::assertCount(4, $dotenv->load());
}
public function testDotenvTriesPathsToLoadTwice()
{
$dotenv = Dotenv::createMutable([__DIR__, self::$folder]);
self::assertCount(4, $dotenv->load());
$dotenv = Dotenv::createImmutable([__DIR__, self::$folder]);
self::assertCount(0, $dotenv->load());
}
public function testDotenvTriesPathsToSafeLoad()
{
$dotenv = Dotenv::createMutable([__DIR__, self::$folder]);
self::assertCount(4, $dotenv->safeLoad());
}
public function testDotenvSkipsLoadingIfFileIsMissing()
{
$dotenv = Dotenv::createMutable(__DIR__);
self::assertSame([], $dotenv->safeLoad());
}
public function testDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder);
self::assertSame(
['FOO' => 'bar', 'BAR' => 'baz', 'SPACED' => 'with spaces', 'NULL' => ''],
$dotenv->load()
);
self::assertSame('bar', $_SERVER['FOO']);
self::assertSame('baz', $_SERVER['BAR']);
self::assertSame('with spaces', $_SERVER['SPACED']);
self::assertEmpty($_SERVER['NULL']);
}
public function testDotenvLoadsEnvironmentVarsMultipleWithShortCircuitMode()
{
$dotenv = Dotenv::createMutable(self::$folder, ['.env', 'example.env']);
self::assertSame(
['FOO' => 'bar', 'BAR' => 'baz', 'SPACED' => 'with spaces', 'NULL' => ''],
$dotenv->load()
);
}
public function testDotenvLoadsEnvironmentVarsMultipleWithoutShortCircuitMode()
{
$dotenv = Dotenv::createMutable(self::$folder, ['.env', 'example.env'], false);
self::assertSame(
['FOO' => 'bar', 'BAR' => 'baz', 'SPACED' => 'with spaces', 'NULL' => '', 'EG' => 'example'],
$dotenv->load()
);
}
public function testCommentedDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'commented.env');
$dotenv->load();
self::assertSame('bar', $_SERVER['CFOO']);
self::assertFalse(isset($_SERVER['CBAR']));
self::assertFalse(isset($_SERVER['CZOO']));
self::assertSame('with spaces', $_SERVER['CSPACED']);
self::assertSame('a value with a # character', $_SERVER['CQUOTES']);
self::assertSame('a value with a # character & a quote " character inside quotes', $_SERVER['CQUOTESWITHQUOTE']);
self::assertEmpty($_SERVER['CNULL']);
self::assertEmpty($_SERVER['EMPTY']);
self::assertEmpty($_SERVER['EMPTY2']);
self::assertSame('foo', $_SERVER['FOOO']);
}
public function testQuotedDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'quoted.env');
$dotenv->load();
self::assertSame('bar', $_SERVER['QFOO']);
self::assertSame('baz', $_SERVER['QBAR']);
self::assertSame('with spaces', $_SERVER['QSPACED']);
self::assertEmpty(\getenv('QNULL'));
self::assertSame('pgsql:host=localhost;dbname=test', $_SERVER['QEQUALS']);
self::assertSame('test some escaped characters like a quote (") or maybe a backslash (\\)', $_SERVER['QESCAPED']);
self::assertSame('iiiiviiiixiiiiviiii\\n', $_SERVER['QSLASH']);
self::assertSame('iiiiviiiixiiiiviiii\\\\n', $_SERVER['SQSLASH']);
}
public function testLargeDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'large.env');
$dotenv->load();
self::assertSame(2730, \strlen($_SERVER['LARGE']));
self::assertSame(8192, \strlen($_SERVER['HUGE']));
}
public function testDotenvLoadsMultibyteVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'multibyte.env');
$dotenv->load();
self::assertSame('Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č Ď ď Đ đ Ē ē Ĕ ĕ Ė ė Ę ę Ě ě', $_SERVER['MB1']);
self::assertSame('行内支付', $_SERVER['MB2']);
self::assertSame('🚀', $_SERVER['APP_ENV']);
}
public function testDotenvLoadsMultibyteUTF8Vars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'multibyte.env', false, 'UTF-8');
$dotenv->load();
self::assertSame('Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č Ď ď Đ đ Ē ē Ĕ ĕ Ė ė Ę ę Ě ě', $_SERVER['MB1']);
self::assertSame('行内支付', $_SERVER['MB2']);
self::assertSame('🚀', $_SERVER['APP_ENV']);
}
public function testDotenvLoadWithInvalidEncoding()
{
$dotenv = Dotenv::createMutable(self::$folder, 'multibyte.env', false, 'UTF-88');
$this->expectException(InvalidEncodingException::class);
$this->expectExceptionMessage('Illegal character encoding [UTF-88] specified.');
$dotenv->load();
}
public function testDotenvLoadsMultibyteWindowsVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'windows.env', false, 'Windows-1252');
$dotenv->load();
self::assertSame('ñá', $_SERVER['MBW']);
}
public function testMultipleDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'multiple.env');
$dotenv->load();
self::assertSame('bar', $_SERVER['MULTI1']);
self::assertSame('foo', $_SERVER['MULTI2']);
}
public function testExportedDotenvLoadsEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'exported.env');
$dotenv->load();
self::assertSame('bar', $_SERVER['EFOO']);
self::assertSame('baz', $_SERVER['EBAR']);
self::assertSame('with spaces', $_SERVER['ESPACED']);
self::assertSame('123', $_SERVER['EDQUOTED']);
self::assertSame('456', $_SERVER['ESQUOTED']);
self::assertEmpty($_SERVER['ENULL']);
}
public function testDotenvLoadsEnvGlobals()
{
$dotenv = Dotenv::createMutable(self::$folder);
$dotenv->load();
self::assertSame('bar', $_SERVER['FOO']);
self::assertSame('baz', $_SERVER['BAR']);
self::assertSame('with spaces', $_SERVER['SPACED']);
self::assertEmpty($_SERVER['NULL']);
}
public function testDotenvLoadsServerGlobals()
{
$dotenv = Dotenv::createMutable(self::$folder);
$dotenv->load();
self::assertSame('bar', $_ENV['FOO']);
self::assertSame('baz', $_ENV['BAR']);
self::assertSame('with spaces', $_ENV['SPACED']);
self::assertEmpty($_ENV['NULL']);
}
public function testDotenvNestedEnvironmentVars()
{
$dotenv = Dotenv::createMutable(self::$folder, 'nested.env');
$dotenv->load();
self::assertSame('{$NVAR1} {$NVAR2}', $_ENV['NVAR3']); // not resolved
self::assertSame('Hellō World!', $_ENV['NVAR4']);
self::assertSame('$NVAR1 {NVAR2}', $_ENV['NVAR5']); // not resolved
self::assertSame('Special Value', $_ENV['N.VAR6']); // new '.' (dot) in var name
self::assertSame('Special Value', $_ENV['NVAR7']); // nested '.' (dot) variable
self::assertSame('', $_ENV['NVAR8']); // nested variable is empty string
self::assertSame('', $_ENV['NVAR9']); // nested variable is empty string
self::assertSame('${NVAR888}', $_ENV['NVAR10']); // nested variable is not set
self::assertSame('NVAR1', $_ENV['NVAR11']);
self::assertSame('Hellō', $_ENV['NVAR12']);
self::assertSame('${${NVAR11}}', $_ENV['NVAR13']); // single quotes
self::assertSame('${NVAR1} ${NVAR2}', $_ENV['NVAR14']); // single quotes
self::assertSame('${NVAR1} ${NVAR2}', $_ENV['NVAR15']); // escaped
}
public function testDotenvNullFileArgumentUsesDefault()
{
$dotenv = Dotenv::createMutable(self::$folder, null);
$dotenv->load();
self::assertSame('bar', $_SERVER['FOO']);
}
/**
* The fixture data has whitespace between the key and in the value string.
*
* Test that these keys are trimmed down.
*/
public function testDotenvTrimmedKeys()
{
$dotenv = Dotenv::createMutable(self::$folder, 'quoted.env');
$dotenv->load();
self::assertSame('no space', $_SERVER['QWHITESPACE']);
}
public function testDotenvLoadDoesNotOverwriteEnv()
{
\putenv('IMMUTABLE=true');
$dotenv = Dotenv::createImmutable(self::$folder, 'immutable.env');
$dotenv->load();
self::assertSame('true', \getenv('IMMUTABLE'));
}
public function testDotenvLoadAfterOverload()
{
\putenv('IMMUTABLE=true');
$dotenv = Dotenv::createUnsafeMutable(self::$folder, 'immutable.env');
$dotenv->load();
self::assertSame('false', \getenv('IMMUTABLE'));
}
public function testDotenvOverloadAfterLoad()
{
\putenv('IMMUTABLE=true');
$dotenv = Dotenv::createUnsafeImmutable(self::$folder, 'immutable.env');
$dotenv->load();
self::assertSame('true', \getenv('IMMUTABLE'));
}
public function testDotenvOverloadDoesOverwriteEnv()
{
$dotenv = Dotenv::createUnsafeMutable(self::$folder, 'mutable.env');
$dotenv->load();
self::assertSame('true', \getenv('MUTABLE'));
}
public function testDotenvAllowsSpecialCharacters()
{
$dotenv = Dotenv::createUnsafeMutable(self::$folder, 'specialchars.env');
$dotenv->load();
self::assertSame('$a6^C7k%zs+e^.jvjXk', \getenv('SPVAR1'));
self::assertSame('?BUty3koaV3%GA*hMAwH}B', \getenv('SPVAR2'));
self::assertSame('jdgEB4{QgEC]HL))&GcXxokB+wqoN+j>xkV7K?m$r', \getenv('SPVAR3'));
self::assertSame('22222:22#2^{', \getenv('SPVAR4'));
self::assertSame('test some escaped characters like a quote " or maybe a backslash \\', \getenv('SPVAR5'));
self::assertSame('secret!@', \getenv('SPVAR6'));
self::assertSame('secret!@#', \getenv('SPVAR7'));
self::assertSame('secret!@#', \getenv('SPVAR8'));
}
public function testMultilineLoading()
{
$dotenv = Dotenv::createUnsafeMutable(self::$folder, 'multiline.env');
$dotenv->load();
self::assertSame("test\n test\"test\"\n test", \getenv('TEST'));
self::assertSame("test\ntest", \getenv('TEST_ND'));
self::assertSame('test\\ntest', \getenv('TEST_NS'));
self::assertSame('https://vision.googleapis.com/v1/images:annotate?key=', \getenv('TEST_EQD'));
self::assertSame('https://vision.googleapis.com/v1/images:annotate?key=', \getenv('TEST_EQS'));
}
public function testEmptyLoading()
{
$dotenv = Dotenv::createImmutable(self::$folder, 'empty.env');
self::assertSame(['EMPTY_VAR' => null], $dotenv->load());
}
public function testUnicodeVarNames()
{
$dotenv = Dotenv::createImmutable(self::$folder, 'unicodevarnames.env');
$dotenv->load();
self::assertSame('Skybert', $_SERVER['AlbertÅberg']);
self::assertSame('2022-04-01T00:00', $_SERVER['ДатаЗакрытияРасчетногоПериода']);
}
public function testDirectConstructor()
{
$repository = RepositoryBuilder::createWithDefaultAdapters()->make();
$store = StoreBuilder::createWithDefaultName()->addPath(self::$folder)->make();
$dotenv = new Dotenv($store, new Parser(), new Loader(), $repository);
self::assertSame([
'FOO' => 'bar',
'BAR' => 'baz',
'SPACED' => 'with spaces',
'NULL' => '',
], $dotenv->load());
}
public function testDotenvParseExample1()
{
$output = Dotenv::parse(
"BASE_DIR=\"/var/webroot/project-root\"\nCACHE_DIR=\"\${BASE_DIR}/cache\"\nTMP_DIR=\"\${BASE_DIR}/tmp\"\n"
);
self::assertSame($output, [
'BASE_DIR' => '/var/webroot/project-root',
'CACHE_DIR' => '/var/webroot/project-root/cache',
'TMP_DIR' => '/var/webroot/project-root/tmp',
]);
}
public function testDotenvParseExample2()
{
$output = Dotenv::parse("FOO=Bar\nBAZ=\"Hello \${FOO}\"");
self::assertSame($output, ['FOO' => 'Bar', 'BAZ' => 'Hello Bar']);
}
public function testDotenvParseEmptyCase()
{
$output = Dotenv::parse('');
self::assertSame($output, []);
}
}
|