Make container xml config option nullable

Author: lookyman

extension.neon

@@ -1,5 +1,6 @@
 parameters:
 symfony:
+container_xml_path: null
 constant_hassers: true
 console_application_loader: null
 

src/Rules/Symfony/ContainerInterfacePrivateServiceRule.php

@@ -62,7 +62,7 @@ public function processNode(Node $node, Scope $scope): array
 return [];
 }
 
-$serviceId = ServiceMap::getServiceIdFromNode($node->args[0]->value, $scope);
+$serviceId = $this->serviceMap::getServiceIdFromNode($node->args[0]->value, $scope);
 if ($serviceId !== null) {
 $service = $this->serviceMap->getService($serviceId);
 if ($service !== null && !$service->isPublic()) {

src/Rules/Symfony/ContainerInterfaceUnknownServiceRule.php

@@ -59,7 +59,7 @@ public function processNode(Node $node, Scope $scope): array
 return [];
 }
 
-$serviceId = ServiceMap::getServiceIdFromNode($node->args[0]->value, $scope);
+$serviceId = $this->serviceMap::getServiceIdFromNode($node->args[0]->value, $scope);
 if ($serviceId !== null) {
 $service = $this->serviceMap->getService($serviceId);
 $serviceIdType = $scope->getType($node->args[0]->value);

src/Symfony/DefaultServiceMap.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+use PhpParser\Node\Expr;
+use PHPStan\Analyser\Scope;
+use PHPStan\Type\TypeUtils;
+use function count;
+
+final class DefaultServiceMap implements ServiceMap
+{
+
+/** @var \PHPStan\Symfony\ServiceDefinition[] */
+private $services;
+
+/**
+ * @param \PHPStan\Symfony\ServiceDefinition[] $services
+ */
+public function __construct(array $services)
+{
+$this->services = $services;
+}
+
+/**
+ * @return \PHPStan\Symfony\ServiceDefinition[]
+ */
+public function getServices(): array
+{
+return $this->services;
+}
+
+public function getService(string $id): ?ServiceDefinition
+{
+return $this->services[$id] ?? null;
+}
+
+public static function getServiceIdFromNode(Expr $node, Scope $scope): ?string
+{
+$strings = TypeUtils::getConstantStrings($scope->getType($node));
+return count($strings) === 1 ? $strings[0]->getValue() : null;
+}
+
+}

src/Symfony/FakeServiceMap.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+use PhpParser\Node\Expr;
+use PHPStan\Analyser\Scope;
+
+final class FakeServiceMap implements ServiceMap
+{
+
+/**
+ * @return \PHPStan\Symfony\ServiceDefinition[]
+ */
+public function getServices(): array
+{
+return [];
+}
+
+public function getService(string $id): ?ServiceDefinition
+{
+return null;
+}
+
+public static function getServiceIdFromNode(Expr $node, Scope $scope): ?string
+{
+return null;
+}
+
+}

src/Symfony/ServiceMap.php

@@ -4,40 +4,17 @@
 
 use PhpParser\Node\Expr;
 use PHPStan\Analyser\Scope;
-use PHPStan\Type\TypeUtils;
-use function count;
 
-final class ServiceMap
+interface ServiceMap
 {
 
-/** @var \PHPStan\Symfony\ServiceDefinition[] */
-private $services;
-
-/**
- * @param \PHPStan\Symfony\ServiceDefinition[] $services
- */
-public function __construct(array $services)
-{
-$this->services = $services;
-}
-
 /**
  * @return \PHPStan\Symfony\ServiceDefinition[]
  */
-public function getServices(): array
-{
-return $this->services;
-}
+public function getServices(): array;
 
-public function getService(string $id): ?ServiceDefinition
-{
-return $this->services[$id] ?? null;
-}
+public function getService(string $id): ?ServiceDefinition;
 
-public static function getServiceIdFromNode(Expr $node, Scope $scope): ?string
-{
-$strings = TypeUtils::getConstantStrings($scope->getType($node));
-return count($strings) === 1 ? $strings[0]->getValue() : null;
-}
+public static function getServiceIdFromNode(Expr $node, Scope $scope): ?string;
 
 }

src/Symfony/XmlServiceMapFactory.php

@@ -10,16 +10,20 @@
 final class XmlServiceMapFactory implements ServiceMapFactory
 {
 
-/** @var string */
+/** @var string|null */
 private $containerXml;
 
-public function __construct(string $containerXml)
+public function __construct(?string $containerXml)
 {
 $this->containerXml = $containerXml;
 }
 
 public function create(): ServiceMap
 {
+if ($this->containerXml === null) {
+return new FakeServiceMap();
+}
+
 $fileContents = file_get_contents($this->containerXml);
 if ($fileContents === false) {
 throw new XmlContainerNotExistsException(sprintf('Container %s does not exist or cannot be parsed', $this->containerXml));
@@ -70,7 +74,7 @@ public function create(): ServiceMap
 );
 }
 
-return new ServiceMap($services);
+return new DefaultServiceMap($services);
 }
 
 }

src/Type/Symfony/ServiceDynamicReturnTypeExtension.php

@@ -24,13 +24,13 @@ final class ServiceDynamicReturnTypeExtension implements DynamicMethodReturnType
 private $constantHassers;
 
 /** @var \PHPStan\Symfony\ServiceMap */
-private $symfonyServiceMap;
+private $serviceMap;
 
 public function __construct(string $className, bool $constantHassers, ServiceMap $symfonyServiceMap)
 {
 $this->className = $className;
 $this->constantHassers = $constantHassers;
-$this->symfonyServiceMap = $symfonyServiceMap;
+$this->serviceMap = $symfonyServiceMap;
 }
 
 public function getClass(): string
@@ -65,9 +65,9 @@ private function getGetTypeFromMethodCall(
 return $returnType;
 }
 
-$serviceId = ServiceMap::getServiceIdFromNode($methodCall->args[0]->value, $scope);
+$serviceId = $this->serviceMap::getServiceIdFromNode($methodCall->args[0]->value, $scope);
 if ($serviceId !== null) {
-$service = $this->symfonyServiceMap->getService($serviceId);
+$service = $this->serviceMap->getService($serviceId);
 if ($service !== null && !$service->isSynthetic()) {
 return new ObjectType($service->getClass() ?? $serviceId);
 }
@@ -87,9 +87,9 @@ private function getHasTypeFromMethodCall(
 return $returnType;
 }
 
-$serviceId = ServiceMap::getServiceIdFromNode($methodCall->args[0]->value, $scope);
+$serviceId = $this->serviceMap::getServiceIdFromNode($methodCall->args[0]->value, $scope);
 if ($serviceId !== null) {
-$service = $this->symfonyServiceMap->getService($serviceId);
+$service = $this->serviceMap->getService($serviceId);
 return new ConstantBooleanType($service !== null && $service->isPublic());
 }
 

tests/Rules/Symfony/ContainerInterfacePrivateServiceRuleFakeTest.php

@@ -0,0 +1,59 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Symfony;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Symfony\XmlServiceMapFactory;
+use PHPStan\Testing\RuleTestCase;
+
+final class ContainerInterfacePrivateServiceRuleFakeTest extends RuleTestCase
+{
+
+protected function getRule(): Rule
+{
+return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(null))->create());
+}
+
+public function testGetPrivateService(): void
+{
+$this->analyse(
+[
+__DIR__ . '/ExampleController.php',
+],
+[]
+);
+}
+
+public function testGetPrivateServiceInLegacyServiceSubscriber(): void
+{
+if (!interface_exists('Symfony\\Component\\DependencyInjection\\ServiceSubscriberInterface')) {
+self::markTestSkipped('The test needs Symfony\Component\DependencyInjection\ServiceSubscriberInterface class.');
+}
+
+$this->analyse(
+[
+__DIR__ . '/ExampleLegacyServiceSubscriber.php',
+__DIR__ . '/ExampleLegacyServiceSubscriberFromAbstractController.php',
+__DIR__ . '/ExampleLegacyServiceSubscriberFromLegacyController.php',
+],
+[]
+);
+}
+
+public function testGetPrivateServiceInServiceSubscriber(): void
+{
+if (!interface_exists('Symfony\Contracts\Service\ServiceSubscriberInterface')) {
+self::markTestSkipped('The test needs Symfony\Contracts\Service\ServiceSubscriberInterface class.');
+}
+
+$this->analyse(
+[
+__DIR__ . '/ExampleServiceSubscriber.php',
+__DIR__ . '/ExampleServiceSubscriberFromAbstractController.php',
+__DIR__ . '/ExampleServiceSubscriberFromLegacyController.php',
+],
+[]
+);
+}
+
+}

tests/Rules/Symfony/ContainerInterfaceUnknownServiceRuleFakeTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Symfony;
+
+use PhpParser\PrettyPrinter\Standard;
+use PHPStan\Rules\Rule;
+use PHPStan\Symfony\XmlServiceMapFactory;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\Symfony\ServiceTypeSpecifyingExtension;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class ContainerInterfaceUnknownServiceRuleFakeTest extends RuleTestCase
+{
+
+protected function getRule(): Rule
+{
+return new ContainerInterfaceUnknownServiceRule((new XmlServiceMapFactory(null))->create(), new Standard());
+}
+
+/**
+ * @return \PHPStan\Type\MethodTypeSpecifyingExtension[]
+ */
+protected function getMethodTypeSpecifyingExtensions(): array
+{
+return [
+new ServiceTypeSpecifyingExtension(Controller::class, new Standard()),
+];
+}
+
+public function testGetPrivateService(): void
+{
+$this->analyse(
+[
+__DIR__ . '/ExampleController.php',
+],
+[]
+);
+}
+
+}