class MachineNameTest

Same name in this branch
  1. 11.x core/tests/Drupal/KernelTests/Core/Render/Element/MachineNameTest.php \Drupal\KernelTests\Core\Render\Element\MachineNameTest
  2. 11.x core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php \Drupal\FunctionalJavascriptTests\Core\MachineNameTest
  3. 11.x core/tests/Drupal/Tests/Core/Render/Element/MachineNameTest.php \Drupal\Tests\Core\Render\Element\MachineNameTest
Same name in other branches
  1. 9 core/modules/migrate/tests/src/Unit/process/MachineNameTest.php \Drupal\Tests\migrate\Unit\process\MachineNameTest
  2. 9 core/tests/Drupal/KernelTests/Core/Render/Element/MachineNameTest.php \Drupal\KernelTests\Core\Render\Element\MachineNameTest
  3. 9 core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php \Drupal\FunctionalJavascriptTests\Core\MachineNameTest
  4. 9 core/tests/Drupal/Tests/Core/Render/Element/MachineNameTest.php \Drupal\Tests\Core\Render\Element\MachineNameTest
  5. 8.9.x core/modules/migrate/tests/src/Unit/process/MachineNameTest.php \Drupal\Tests\migrate\Unit\process\MachineNameTest
  6. 8.9.x core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php \Drupal\FunctionalJavascriptTests\Core\MachineNameTest
  7. 8.9.x core/tests/Drupal/Tests/Core/Render/Element/MachineNameTest.php \Drupal\Tests\Core\Render\Element\MachineNameTest
  8. 10 core/modules/migrate/tests/src/Unit/process/MachineNameTest.php \Drupal\Tests\migrate\Unit\process\MachineNameTest
  9. 10 core/tests/Drupal/KernelTests/Core/Render/Element/MachineNameTest.php \Drupal\KernelTests\Core\Render\Element\MachineNameTest
  10. 10 core/tests/Drupal/FunctionalJavascriptTests/Core/MachineNameTest.php \Drupal\FunctionalJavascriptTests\Core\MachineNameTest
  11. 10 core/tests/Drupal/Tests/Core/Render/Element/MachineNameTest.php \Drupal\Tests\Core\Render\Element\MachineNameTest

Tests the machine name process plugin.

@group migrate

Hierarchy

Expanded class hierarchy of MachineNameTest

File

core/modules/migrate/tests/src/Unit/process/MachineNameTest.php, line 15

Namespace

Drupal\Tests\migrate\Unit\process
View source
class MachineNameTest extends MigrateProcessTestCase {
    
    /**
     * The mock transliteration.
     *
     * @var \Drupal\Component\Transliteration\TransliterationInterface
     */
    protected $transliteration;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        $this->transliteration = $this->getMockBuilder('Drupal\\Component\\Transliteration\\TransliterationInterface')
            ->disableOriginalConstructor()
            ->getMock();
        $this->row = $this->getMockBuilder('Drupal\\migrate\\Row')
            ->disableOriginalConstructor()
            ->getMock();
        $this->migrateExecutable = $this->getMockBuilder('Drupal\\migrate\\MigrateExecutable')
            ->disableOriginalConstructor()
            ->getMock();
        parent::setUp();
    }
    
    /**
     * Tests machine name transformation of non-alphanumeric characters.
     *
     * @param string $human_name
     *   The human-readable name that will be converted in the test.
     * @param array $configuration
     *   The plugin configuration.
     * @param string $expected_result
     *   The expected result of the transformation.
     *
     * @dataProvider providerTestMachineNames
     */
    public function testMachineNames(string $human_name, array $configuration, string $expected_result) : void {
        // Test for calling transliterate on mock object.
        $this->transliteration
            ->expects($this->once())
            ->method('transliterate')
            ->with($human_name)
            ->willReturnCallback(function (string $string) : string {
            return str_replace([
                'á',
                'é',
                'ő',
            ], [
                'a',
                'e',
                'o',
            ], $string);
        });
        $plugin = new MachineName($configuration, 'machine_name', [], $this->transliteration);
        $value = $plugin->transform($human_name, $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertEquals($expected_result, $value);
    }
    
    /**
     * Provides test cases for MachineNameTest::testMachineNames().
     *
     * @return array
     *   An array of test cases.
     */
    public static function providerTestMachineNames() : array {
        return [
            // Tests the following transformations:
            // - non-alphanumeric character (including spaces) -> underscore,
            // - Uppercase -> lowercase,
            // - Multiple consecutive underscore -> single underscore.
'default' => [
                'human_name' => 'foo2, the.bar;2*&the%baz!YEE____HaW áéő',
                'configuration' => [],
                'expected_result' => 'foo2_the_bar_2_the_baz_yee_haw_aeo',
            ],
            // Tests with a different pattern that allows periods.
'period_allowed' => [
                'human_name' => '2*&the%baz!YEE____HaW áéő.jpg',
                'configuration' => [
                    'replace_pattern' => '/[^a-z0-9_.]+/',
                ],
                'expected_result' => '2_the_baz_yee_haw_aeo.jpg',
            ],
        ];
    }
    
    /**
     * Tests that the replacement regular expression is a string.
     */
    public function testInvalidConfiguration() : void {
        $configuration['replace_pattern'] = 1;
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage('The replace pattern should be a string');
        new MachineName($configuration, 'machine_name', [], $this->transliteration);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
MachineNameTest::$transliteration protected property The mock transliteration.
MachineNameTest::providerTestMachineNames public static function Provides test cases for MachineNameTest::testMachineNames().
MachineNameTest::setUp protected function Overrides MigrateProcessTestCase::setUp
MachineNameTest::testInvalidConfiguration public function Tests that the replacement regular expression is a string.
MachineNameTest::testMachineNames public function Tests machine name transformation of non-alphanumeric characters.
MigrateProcessTestCase::$migrateExecutable protected property
MigrateProcessTestCase::$plugin protected property 1
MigrateProcessTestCase::$row protected property
MigrateTestCase::$idMap protected property The migration ID map.
MigrateTestCase::$migrationConfiguration protected property An array of migration configuration values. 10
MigrateTestCase::$migrationStatus protected property Local store for mocking setStatus()/getStatus().
MigrateTestCase::createSchemaFromRow protected function Generates a table schema from a row.
MigrateTestCase::getDatabase protected function Gets an SQLite database connection object for use in tests.
MigrateTestCase::getMigration protected function Retrieves a mocked migration.
MigrateTestCase::getValue protected function Gets the value on a row for a given key.
MigrateTestCase::queryResultTest public function Tests a query.
MigrateTestCase::retrievalAssertHelper protected function Asserts tested values during test retrieval.
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.
UnitTestCase::$root protected property The app root.
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

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