Multi container XML paths

Author: ckuran

README.md

@@ -56,9 +56,9 @@ includes:
 
 # Configuration
 
-You have to provide a path to `srcDevDebugProjectContainer.xml` or similar XML file describing your container.
+You have to provide a path to XML container file generated by Symfony.
 
-```yaml
+```neon
 parameters:
     symfony:
         containerXmlPath: var/cache/dev/srcDevDebugProjectContainer.xml
@@ -71,6 +71,24 @@ parameters:
         - var/cache/dev/Symfony/Config
 ```
 
+There is a multi environment solution. Container locator will check any location provided in `containerXmlPaths` parameter:
+
+```neon
+parameters:
+    symfony:
+        containerXmlPaths:
+            - var/cache/dev/srcDevDebugProjectContainer.xml
+            - var/cache/test/srcTestDebugProjectContainer.xml
+        # or with Symfony 4.2+
+        containerXmlPaths:
+            - var/cache/dev/srcApp_KernelDevDebugContainer.xml
+            - var/cache/test/srcApp_KernelTestDebugContainer.xml
+        # or with Symfony 5+
+        containerXmlPaths:
+            - var/cache/dev/App_KernelDevDebugContainer.xml
+            - var/cache/test/App_KernelTestDebugContainer.xml
+```
+
 ## Constant hassers
 
 Sometimes, when you are dealing with optional dependencies, the `::has()` methods can cause problems. For example, the following construct would complain that the condition is always either on or off, depending on whether you have the dependency for `service` installed:

src/Symfony/Configuration.php

@@ -21,6 +21,14 @@ public function getContainerXmlPath(): ?string
 		return $this->parameters['containerXmlPath'] ?? $this->parameters['container_xml_path'] ?? null;
 	}
 
+	/**
+	 * @return array<int, string>
+	 */
+	public function getContainerXmlPaths(): array
+	{
+		return $this->parameters['containerXmlPaths'] ?? [];
+	}
+
 	public function hasConstantHassers(): bool
 	{
 		return $this->parameters['constantHassers'] ?? $this->parameters['constant_hassers'] ?? true;

src/Symfony/XmlParameterMapFactory.php

@@ -7,28 +7,58 @@
 final class XmlParameterMapFactory implements ParameterMapFactory
 {
 
-	/** @var string|null */
-	private $containerXml;
+	/** @var array<int, string> */
+	private $containerXmls;
 
 	public function __construct(Configuration $configuration)
 	{
-		$this->containerXml = $configuration->getContainerXmlPath();
+		$this->containerXmls = $configuration->getContainerXmlPaths();
+
+		$containerXml = $configuration->getContainerXmlPath();
+		if ($containerXml === null) {
+			return;
+		}
+
+		$this->containerXmls = array_merge(
+			[$containerXml],
+			$this->containerXmls
+		);
 	}
 
 	public function create(): ParameterMap
 	{
-		if ($this->containerXml === null) {
+		if (count($this->containerXmls) === 0) {
 			return new FakeParameterMap();
 		}
 
-		$fileContents = file_get_contents($this->containerXml);
+		foreach ($this->containerXmls as $containerXml) {
+			try {
+				return $this->loadXml($containerXml);
+			} catch (XmlContainerNotExistsException $e) {
+				continue;
+			}
+		}
+
+		throw new XmlContainerNotExistsException(
+			'Container not found. Attempted to load:' . PHP_EOL .
+			implode(PHP_EOL, $this->containerXmls)
+		);
+	}
+
+	private function loadXml(string $containerXml): DefaultParameterMap
+	{
+		if (file_exists($containerXml) === false) {
+			throw new XmlContainerNotExistsException(sprintf('Container %s does not exist', $containerXml));
+		}
+
+		$fileContents = file_get_contents($containerXml);
 		if ($fileContents === false) {
-			throw new XmlContainerNotExistsException(sprintf('Container %s does not exist', $this->containerXml));
+			throw new XmlContainerNotExistsException(sprintf('Container %s could not load the content', $containerXml));
 		}
 
 		$xml = @simplexml_load_string($fileContents);
 		if ($xml === false) {
-			throw new XmlContainerNotExistsException(sprintf('Container %s cannot be parsed', $this->containerXml));
+			throw new XmlContainerNotExistsException(sprintf('Container %s cannot be parsed', $containerXml));
 		}
 
 		/** @var \PHPStan\Symfony\Parameter[] $parameters */

src/Symfony/XmlServiceMapFactory.php

@@ -10,28 +10,58 @@
 final class XmlServiceMapFactory implements ServiceMapFactory
 {
 
-	/** @var string|null */
-	private $containerXml;
+	/** @var array<int, string> */
+	private $containerXmls;
 
 	public function __construct(Configuration $configuration)
 	{
-		$this->containerXml = $configuration->getContainerXmlPath();
+		$this->containerXmls = $configuration->getContainerXmlPaths();
+
+		$containerXml = $configuration->getContainerXmlPath();
+		if ($containerXml === null) {
+			return;
+		}
+
+		$this->containerXmls = array_merge(
+			[$containerXml],
+			$this->containerXmls
+		);
 	}
 
 	public function create(): ServiceMap
 	{
-		if ($this->containerXml === null) {
+		if (count($this->containerXmls) === 0) {
 			return new FakeServiceMap();
 		}
 
-		$fileContents = file_get_contents($this->containerXml);
+		foreach ($this->containerXmls as $containerXml) {
+			try {
+				return $this->loadXml($containerXml);
+			} catch (XmlContainerNotExistsException $e) {
+				continue;
+			}
+		}
+
+		throw new XmlContainerNotExistsException(
+			'Container not found. Attempted to load:' . PHP_EOL .
+			implode(PHP_EOL, $this->containerXmls)
+		);
+	}
+
+	private function loadXml(string $containerXml): DefaultServiceMap
+	{
+		if (file_exists($containerXml) === false) {
+			throw new XmlContainerNotExistsException(sprintf('Container %s does not exist', $containerXml));
+		}
+
+		$fileContents = file_get_contents($containerXml);
 		if ($fileContents === false) {
-			throw new XmlContainerNotExistsException(sprintf('Container %s does not exist', $this->containerXml));
+			throw new XmlContainerNotExistsException(sprintf('Container %s could not load the content', $containerXml));
 		}
 
 		$xml = @simplexml_load_string($fileContents);
 		if ($xml === false) {
-			throw new XmlContainerNotExistsException(sprintf('Container %s cannot be parsed', $this->containerXml));
+			throw new XmlContainerNotExistsException(sprintf('Container %s cannot be parsed', $containerXml));
 		}
 
 		/** @var \PHPStan\Symfony\Service[] $services */