bug #22976 [DependencyInjection] Use more clear message when unused environment variables detected (voronkovich)

fabpot · fabpot · commit 12f5636eaee8 · 2017-06-03T08:50:21.000-07:00
This PR was squashed before being merged into the 3.2 branch (closes #22976). Discussion ---------- [DependencyInjection] Use more clear message when unused environment variables detected | Q | A | ------------- | --- | Branch? |3.2 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22955 | License | MIT Old error message: ``` Incompatible use of dynamic environment variables "DATABASE_URL", "MAILER_URL" found in parameters. ``` New error message: ``` Environment variables "DATABASE_URL", "MAILER_URL" are never used. Please, check your container's configuration. ``` Commits ------- 6dbdb1b [DependencyInjection] Use more clear message when unused environment variables detected
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -166,7 +166,7 @@ public function dump(array $options = array())
             }
         }
         if ($unusedEnvs) {
-            throw new EnvParameterException($unusedEnvs);
+            throw new EnvParameterException($unusedEnvs, null, 'Environment variables "%s" are never used. Please, check your container\'s configuration.');
         }
 
         return $code;
diff --git a/src/Symfony/Component/DependencyInjection/Exception/EnvParameterException.php b/src/Symfony/Component/DependencyInjection/Exception/EnvParameterException.php
@@ -18,8 +18,8 @@
  */
 class EnvParameterException extends InvalidArgumentException
 {
-    public function __construct(array $usedEnvs, \Exception $previous = null)
+    public function __construct(array $envs, \Exception $previous = null, $message = 'Incompatible use of dynamic environment variables "%s" found in parameters.')
     {
-        parent::__construct(sprintf('Incompatible use of dynamic environment variables "%s" found in parameters.', implode('", "', $usedEnvs)), 0, $previous);
+        parent::__construct(sprintf($message, implode('", "', $envs)), 0, $previous);
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php b/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php
@@ -302,7 +302,7 @@ public function testEnvParameter()
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\EnvParameterException
-     * @expectedExceptionMessage Incompatible use of dynamic environment variables "FOO" found in parameters.
+     * @expectedExceptionMessage Environment variables "FOO" are never used. Please, check your container's configuration.
      */
     public function testUnusedEnvParameter()
     {

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ public function dump(array $options = array())`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`	`if ($unusedEnvs) {`
`169`		`- throw new EnvParameterException($unusedEnvs);`
	`169`	`+ throw new EnvParameterException($unusedEnvs, null, 'Environment variables "%s" are never used. Please, check your container\'s configuration.');`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`return $code;`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@`
`18`	`18`	`*/`
`19`	`19`	`class EnvParameterException extends InvalidArgumentException`
`20`	`20`	`{`
`21`		`- public function __construct(array $usedEnvs, \Exception $previous = null)`
	`21`	`+ public function __construct(array $envs, \Exception $previous = null, $message = 'Incompatible use of dynamic environment variables "%s" found in parameters.')`
`22`	`22`	`{`
`23`		`- parent::__construct(sprintf('Incompatible use of dynamic environment variables "%s" found in parameters.', implode('", "', $usedEnvs)), 0, $previous);`
	`23`	`+ parent::__construct(sprintf($message, implode('", "', $envs)), 0, $previous);`
`24`	`24`	`}`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -302,7 +302,7 @@ public function testEnvParameter()`
`302`	`302`
`303`	`303`	`/**`
`304`	`304`	`* @expectedException \Symfony\Component\DependencyInjection\Exception\EnvParameterException`
`305`		`- * @expectedExceptionMessage Incompatible use of dynamic environment variables "FOO" found in parameters.`
	`305`	`+ * @expectedExceptionMessage Environment variables "FOO" are never used. Please, check your container's configuration.`
`306`	`306`	`*/`
`307`	`307`	`public function testUnusedEnvParameter()`
`308`	`308`	`{`