You are here

ContainerBuilderTest.php in Drupal 9

File

core/tests/Drupal/Tests/Core/DependencyInjection/ContainerBuilderTest.php
View source
<?php

namespace Drupal\Tests\Core\DependencyInjection;

use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\UnitTestCase;
use Drupal\Tests\Core\DependencyInjection\Fixture\BarClass;
use Symfony\Component\DependencyInjection\Definition;

/**
 * @coversDefaultClass \Drupal\Core\DependencyInjection\ContainerBuilder
 * @group DependencyInjection
 */
class ContainerBuilderTest extends UnitTestCase {

  /**
   * @covers ::get
   */
  public function testGet() {
    $container = new ContainerBuilder();
    $container
      ->register('bar', 'Drupal\\Tests\\Core\\DependencyInjection\\Fixture\\BarClass');
    $result = $container
      ->get('bar');
    $this
      ->assertInstanceOf(BarClass::class, $result);
  }

  /**
   * @covers ::set
   */
  public function testSet() {
    $container = new ContainerBuilder();
    $class = new BarClass();
    $container
      ->set('bar', $class);
    $this
      ->assertEquals('bar', $class->_serviceId);
  }

  /**
   * @covers ::set
   */
  public function testSetException() {
    $container = new ContainerBuilder();
    $class = new BarClass();
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Service ID names must be lowercase: Bar');
    $container
      ->set('Bar', $class);
  }

  /**
   * @covers ::setParameter
   */
  public function testSetParameterException() {
    $container = new ContainerBuilder();
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Parameter names must be lowercase: Buzz');
    $container
      ->setParameter('Buzz', 'buzz');
  }

  /**
   * @covers ::register
   */
  public function testRegisterException() {
    $container = new ContainerBuilder();
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Service ID names must be lowercase: Bar');
    $container
      ->register('Bar');
  }

  /**
   * @covers ::register
   */
  public function testRegister() {
    $container = new ContainerBuilder();
    $service = $container
      ->register('bar');
    $this
      ->assertTrue($service
      ->isPublic());
  }

  /**
   * @covers ::setDefinition
   */
  public function testSetDefinition() {

    // Test a service with public set to true.
    $container = new ContainerBuilder();
    $definition = new Definition();
    $definition
      ->setPublic(TRUE);
    $service = $container
      ->setDefinition('foo', $definition);
    $this
      ->assertTrue($service
      ->isPublic());

    // Test a service with public set to false.
    $definition = new Definition();
    $definition
      ->setPublic(FALSE);
    $service = $container
      ->setDefinition('foo', $definition);
    $this
      ->assertFalse($service
      ->isPublic());
  }

  /**
   * @covers ::setDefinition
   *
   * @group legacy
   */
  public function testLegacySetDefinition() {

    // Test a service with public set to default.
    $container = new ContainerBuilder();
    $definition = new Definition();
    $this
      ->expectDeprecation('Not marking service definitions as public is deprecated in drupal:9.2.0 and is required in drupal:10.0.0. Call $definition->setPublic(TRUE) before calling ::setDefinition(). See https://www.drupal.org/node/3194517');
    $service = $container
      ->setDefinition('foo', $definition);
    $this
      ->assertTrue($service
      ->isPublic());
  }

  /**
   * @covers ::setAlias
   */
  public function testSetAlias() {
    $container = new ContainerBuilder();
    $container
      ->register('bar');
    $alias = $container
      ->setAlias('foo', 'bar');
    $this
      ->assertTrue($alias
      ->isPublic());
  }

  /**
   * Tests serialization.
   */
  public function testSerialize() {
    $container = new ContainerBuilder();
    $this
      ->expectException(\AssertionError::class);
    serialize($container);
  }

  /**
   * Tests constructor and resource tracking disabling.
   *
   * This test runs in a separate process to ensure the aliased class does not
   * affect any other tests.
   *
   * @runInSeparateProcess
   * @preserveGlobalState disabled
   */
  public function testConstructor() {
    class_alias(TestInterface::class, 'Symfony\\Component\\Config\\Resource\\ResourceInterface');
    $container = new ContainerBuilder();
    $this
      ->assertFalse($container
      ->isTrackingResources());
  }

}

/**
 * A test interface for testing ContainerBuilder::__construct().
 *
 * @see \Drupal\Tests\Core\DependencyInjection\ContainerBuilderTest::testConstructor()
 */
interface TestInterface {

}

Classes

Namesort descending Description
ContainerBuilderTest @coversDefaultClass \Drupal\Core\DependencyInjection\ContainerBuilder @group DependencyInjection

Interfaces

Namesort descending Description
TestInterface A test interface for testing ContainerBuilder::__construct().