* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Flex\Tests\Configurator; use Composer\Composer; use Composer\IO\IOInterface; use PHPUnit\Framework\TestCase; use Symfony\Flex\Configurator\EnvConfigurator; use Symfony\Flex\Lock; use Symfony\Flex\Options; use Symfony\Flex\Recipe; use Symfony\Flex\Update\RecipeUpdate; class EnvConfiguratorTest extends TestCase { public function testConfigure() { @mkdir(FLEX_TEST_DIR); $configurator = new EnvConfigurator( $this->getMockBuilder(Composer::class)->getMock(), $this->getMockBuilder(IOInterface::class)->getMock(), new Options(['root-dir' => FLEX_TEST_DIR]) ); $lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock(); $recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock(); $recipe->expects($this->any())->method('getName')->willReturn('FooBundle'); $env = FLEX_TEST_DIR.'/.env.dist'; @unlink($env); touch($env); $phpunit = FLEX_TEST_DIR.'/phpunit.xml'; $phpunitDist = $phpunit.'.dist'; @unlink($phpunit); @unlink($phpunitDist); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunitDist); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunit); $configurator->configure($recipe, [ 'APP_ENV' => 'test bar', 'APP_DEBUG' => '0', 'APP_PARAGRAPH' => "foo\n\"bar\"\\t", 'DATABASE_URL' => 'mysql://root@127.0.0.1:3306/symfony?charset=utf8mb4&serverVersion=5.7', 'MAILER_URL' => 'null://localhost', 'MAILER_USER' => 'fabien', '#1' => 'Comment 1', '#2' => 'Comment 3', '#TRUSTED_SECRET' => 's3cretf0rt3st"<>', 'APP_SECRET' => 's3cretf0rt3st"<>', ], $lock); $envContents = << FooBundle ### APP_ENV="test bar" APP_DEBUG=0 APP_PARAGRAPH="foo\\n\\"bar\\"\\\\t" DATABASE_URL="mysql://root@127.0.0.1:3306/symfony?charset=utf8mb4&serverVersion=5.7" MAILER_URL=null://localhost MAILER_USER=fabien # Comment 1 # Comment 3 #TRUSTED_SECRET="s3cretf0rt3st\"<>" APP_SECRET="s3cretf0rt3st\"<>" ###< FooBundle ### EOF; $xmlContents = << tests/ EOF; $this->assertStringEqualsFile($env, $envContents); $this->assertStringEqualsFile($phpunitDist, $xmlContents); $this->assertStringEqualsFile($phpunit, $xmlContents); $configurator->configure($recipe, [ 'APP_ENV' => 'test', 'APP_DEBUG' => '0', '#1' => 'Comment 1', '#2' => 'Comment 3', '#TRUSTED_SECRET' => 's3cretf0rt3st', 'APP_SECRET' => 's3cretf0rt3st', ], $lock); $this->assertStringEqualsFile($env, $envContents); $this->assertStringEqualsFile($phpunitDist, $xmlContents); $this->assertStringEqualsFile($phpunit, $xmlContents); $configurator->unconfigure($recipe, [ 'APP_ENV' => 'test', 'APP_DEBUG' => '0', '#1' => 'Comment 1', '#2' => 'Comment 3', '#TRUSTED_SECRET' => 's3cretf0rt3st', 'APP_SECRET' => 's3cretf0rt3st', ], $lock); $this->assertStringEqualsFile( $env, <<assertFileEquals(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunitDist); $this->assertFileEquals(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunit); @unlink($env); @unlink($phpunit); } public function testConfigureGeneratedSecret() { @mkdir(FLEX_TEST_DIR); $configurator = new EnvConfigurator( $this->getMockBuilder(Composer::class)->getMock(), $this->getMockBuilder(IOInterface::class)->getMock(), new Options(['root-dir' => FLEX_TEST_DIR]) ); $lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock(); $recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock(); $recipe->expects($this->any())->method('getName')->willReturn('FooBundle'); $env = FLEX_TEST_DIR.'/.env.dist'; @unlink($env); touch($env); $phpunit = FLEX_TEST_DIR.'/phpunit.xml'; $phpunitDist = $phpunit.'.dist'; @unlink($phpunit); @unlink($phpunitDist); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunitDist); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunit); $configurator->configure($recipe, [ '#TRUSTED_SECRET_1' => '%generate(secret,32)%', '#TRUSTED_SECRET_2' => '%generate(secret, 32)%', '#TRUSTED_SECRET_3' => '%generate(secret, 32)%', 'APP_SECRET' => '%generate(secret)%', ], $lock); $envContents = file_get_contents($env); $this->assertMatchesRegularExpression('/#TRUSTED_SECRET_1=[a-z0-9]{64}/', $envContents); $this->assertMatchesRegularExpression('/#TRUSTED_SECRET_2=[a-z0-9]{64}/', $envContents); $this->assertMatchesRegularExpression('/#TRUSTED_SECRET_3=[a-z0-9]{64}/', $envContents); $this->assertMatchesRegularExpression('/APP_SECRET=[a-z0-9]{32}/', $envContents); @unlink($env); foreach ([$phpunitDist, $phpunit] as $file) { $fileContents = file_get_contents($file); $this->assertMatchesRegularExpression('//', $fileContents); $this->assertMatchesRegularExpression('//', $fileContents); $this->assertMatchesRegularExpression('//', $fileContents); $this->assertMatchesRegularExpression('//', $fileContents); } } public function testConfigureForce() { @mkdir(FLEX_TEST_DIR); $configurator = new EnvConfigurator( $this->getMockBuilder(Composer::class)->getMock(), $this->getMockBuilder(IOInterface::class)->getMock(), new Options(['root-dir' => FLEX_TEST_DIR]) ); $recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock(); $recipe->expects($this->any())->method('getName')->willReturn('FooBundle'); $env = FLEX_TEST_DIR.'/.env.dist'; $phpunit = FLEX_TEST_DIR.'/phpunit.xml'; $phpunitDist = $phpunit.'.dist'; @unlink($env); @unlink($phpunit); @unlink($phpunitDist); touch($env); file_put_contents($env, "# preexisting content\n"); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunitDist); copy(__DIR__.'/../Fixtures/phpunit.xml.dist', $phpunit); $envContentsConfigure = << FooBundle ### FOO=bar ###< FooBundle ### # new content EOT; $envContentsForce = << FooBundle ### FOO=bar OOF=rab ###< FooBundle ### # new content EOT; $xmlContentsConfigure = << tests/ EOT; $xmlContentsForce = << tests/ EOT; $lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock(); $configurator->configure($recipe, [ 'FOO' => 'bar', ], $lock); file_put_contents($env, "\n# new content\n", \FILE_APPEND); file_put_contents($phpunit, str_replace( ' ', "\n \n ", file_get_contents($phpunit) )); file_put_contents($phpunitDist, str_replace( ' ', "\n \n ", file_get_contents($phpunitDist) )); $this->assertStringEqualsFile($env, $envContentsConfigure); $this->assertStringEqualsFile($phpunit, $xmlContentsConfigure); $this->assertStringEqualsFile($phpunitDist, $xmlContentsConfigure); $configurator->configure($recipe, [ 'FOO' => 'bar', 'OOF' => 'rab', ], $lock, [ 'force' => true, ]); $this->assertStringEqualsFile($env, $envContentsForce); $this->assertStringEqualsFile($phpunit, $xmlContentsForce); $this->assertStringEqualsFile($phpunitDist, $xmlContentsForce); @unlink($env); @unlink($phpunit); @unlink($phpunitDist); } public function testUpdate() { $configurator = new EnvConfigurator( $this->createMock(Composer::class), $this->createMock(IOInterface::class), new Options(['root-dir' => FLEX_TEST_DIR]) ); $recipe = $this->createMock(Recipe::class); $recipe->method('getName') ->willReturn('symfony/foo-bundle'); $recipeUpdate = new RecipeUpdate( $recipe, $recipe, $this->createMock(Lock::class), FLEX_TEST_DIR ); @mkdir(FLEX_TEST_DIR); file_put_contents( FLEX_TEST_DIR.'/.env', << symfony/foo-bundle ### APP_ENV="test bar" APP_SECRET=EXISTING_SECRET_VALUE APP_DEBUG=0 ###< symfony/foo-bundle ### ###> symfony/baz-bundle ### OTHER_VAR=1 ###< symfony/baz-bundle ### EOF ); $configurator->update( $recipeUpdate, // %generate(secret)% should not regenerate a new value ['APP_ENV' => 'original', 'APP_SECRET' => '%generate(secret)%', 'APP_DEBUG' => 0, 'EXTRA_VAR' => 'apple'], ['APP_ENV' => 'updated', 'APP_SECRET' => '%generate(secret)%', 'APP_DEBUG' => 0, 'NEW_VAR' => 'orange'] ); $this->assertSame(['.env' => << symfony/foo-bundle ### APP_ENV=original APP_SECRET=EXISTING_SECRET_VALUE APP_DEBUG=0 EXTRA_VAR=apple ###< symfony/foo-bundle ### ###> symfony/baz-bundle ### OTHER_VAR=1 ###< symfony/baz-bundle ### EOF ], $recipeUpdate->getOriginalFiles()); $this->assertSame(['.env' => << symfony/foo-bundle ### APP_ENV=updated APP_SECRET=EXISTING_SECRET_VALUE APP_DEBUG=0 NEW_VAR=orange ###< symfony/foo-bundle ### ###> symfony/baz-bundle ### OTHER_VAR=1 ###< symfony/baz-bundle ### EOF ], $recipeUpdate->getNewFiles()); } }