class SchemaCompatibilityCheckerTest

Same name in this branch
  1. 10 core/modules/sdc/tests/src/Unit/SchemaCompatibilityCheckerTest.php \Drupal\Tests\sdc\Unit\SchemaCompatibilityCheckerTest
Same name and namespace in other branches
  1. 11.x core/modules/sdc/tests/src/Unit/SchemaCompatibilityCheckerTest.php \Drupal\Tests\sdc\Unit\SchemaCompatibilityCheckerTest
  2. 11.x core/tests/Drupal/Tests/Core/Theme/Component/SchemaCompatibilityCheckerTest.php \Drupal\Tests\Core\Theme\Component\SchemaCompatibilityCheckerTest

@coversDefaultClass \Drupal\Core\Theme\Component\SchemaCompatibilityChecker
@group sdc

Hierarchy

Expanded class hierarchy of SchemaCompatibilityCheckerTest

File

core/tests/Drupal/Tests/Core/Theme/Component/SchemaCompatibilityCheckerTest.php, line 15

Namespace

Drupal\Tests\Core\Theme\Component
View on git.drupalcode.org
View source 
class SchemaCompatibilityCheckerTest extends UnitTestCase {
  
  /**
   * The system under test.
   */
  protected SchemaCompatibilityChecker $checker;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->checker = new SchemaCompatibilityChecker();
  }
  
  /**
   * @covers ::isCompatible
   * @dataProvider dataProviderIsCompatible
   */
  public function testIsCompatible(array $first_schema, array $second_schema, bool $expected) : void {
    try {
      $this->checker
        ->isCompatible($first_schema, $second_schema);
      $is_compatible = TRUE;
    } catch (IncompatibleComponentSchema $e) {
      $is_compatible = FALSE;
    }
    $this->assertSame($expected, $is_compatible);
  }
  
  /**
   * Data provider for the test testIsCompatible.
   *
   * @return array[]
   *   The batches of data.
   */
  public static function dataProviderIsCompatible() : array {
    $schema = [
      'type' => 'object',
      'required' => [
        'text',
      ],
      'properties' => [
        'text' => [
          'type' => 'string',
          'title' => 'Title',
          'description' => 'The title for the button',
          'minLength' => 2,
          'examples' => [
            'Press',
            'Submit now',
          ],
        ],
        'iconType' => [
          'type' => 'string',
          'title' => 'Icon Type',
          'enum' => [
            'power',
            'like',
            'external',
          ],
        ],
      ],
    ];
    $schema_different_required = [
      $schema,
      'required' => [
        'foo',
      ],
    ];
    $schema_missing_icon_type = $schema;
    unset($schema_missing_icon_type['properties']['iconType']);
    $schema_missing_text = $schema;
    unset($schema_missing_text['properties']['text']);
    $schema_icon_with_number = $schema;
    $schema_icon_with_number['properties']['iconType']['type'] = [
      'string',
      'number',
    ];
    $schema_additional_enum = $schema;
    $schema_additional_enum['properties']['iconType']['enum'][] = 'wow';
    $schema_with_sub_schema = $schema;
    $schema_with_sub_schema['properties']['parent'] = $schema;
    $schema_with_sub_schema_enum = $schema;
    $schema_with_sub_schema_enum['properties']['parent'] = $schema_additional_enum;
    return [
      [
        $schema,
        $schema,
        TRUE,
      ],
      [
        $schema,
        $schema_different_required,
        FALSE,
      ],
      [
        $schema_different_required,
        $schema,
        FALSE,
      ],
      [
        $schema_missing_icon_type,
        $schema,
        TRUE,
      ],
      [
        $schema,
        $schema_missing_icon_type,
        TRUE,
      ],
      [
        $schema_missing_text,
        $schema,
        TRUE,
      ],
      [
        $schema,
        $schema_missing_text,
        TRUE,
      ],
      [
        $schema_icon_with_number,
        $schema,
        FALSE,
      ],
      [
        $schema,
        $schema_icon_with_number,
        TRUE,
      ],
      [
        $schema,
        $schema_additional_enum,
        TRUE,
      ],
      [
        $schema_additional_enum,
        $schema,
        FALSE,
      ],
      [
        $schema_with_sub_schema,
        $schema_with_sub_schema,
        TRUE,
      ],
      [
        $schema_with_sub_schema,
        $schema_with_sub_schema_enum,
        TRUE,
      ],
      [
        $schema_with_sub_schema_enum,
        $schema_with_sub_schema,
        FALSE,
      ],
    ];
  }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
SchemaCompatibilityCheckerTest::$checker protected property The system under test.
SchemaCompatibilityCheckerTest::dataProviderIsCompatible public static function Data provider for the test testIsCompatible.
SchemaCompatibilityCheckerTest::setUp protected function Overrides UnitTestCase::setUp
SchemaCompatibilityCheckerTest::testIsCompatible public function @covers ::isCompatible[[api-linebreak]]
@dataProvider dataProviderIsCompatible
UnitTestCase::$root protected property The app root. 1
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.