class PotxTestCase in Translation template extractor 7.3

@file Tests to ensure that the template extractor works as intended.

Hierarchy

• class \DrupalTestCase
  • class \DrupalWebTestCase
    • class \PotxTestCase

File

tests/potx.test, line 8

Tests to ensure that the template extractor works as intended.

class PotxTestCase extends DrupalWebTestCase {
  public static function getInfo() {
    return array(
      'name' => t('Translation template extractor'),
      'description' => t('Ensure that the translation template extractor functions properly.'),
      'group' => t('Translation template extractor'),
    );
  }
  public function setUp() {

    // Set up required modules for potx.
    parent::setUp('locale', 'potx');

    // Add potx.inc which we test for its functionality.
    include_once __DIR__ . '/../potx.inc';
    include_once __DIR__ . '/../potx.local.inc';
    potx_local_init();

    // Store empty error message for reuse in multiple cases.
    $this->empty_error = t('Empty string attempted to be localized. Please do not leave test code for localization in your source.');
  }

  /**
   * Test parsing of Drupal 5 module.
   */
  public function testDrupal5() {

    // Parse and build the Drupal 5 module file.
    $filename = __DIR__ . '/potx_test_5.module';
    $this
      ->parseFile($filename, POTX_API_5);

    // Assert strings found in module source code.
    $this
      ->assertMsgID('Test menu item in 5');
    $this
      ->assertMsgID('This is a test menu item in 5');
    $this
      ->assertMsgID('This is a test string.');
    $this
      ->assertMsgID('test watchdog type');

    // No support for instant t() in watchdog.
    $this
      ->assertNoMsgID('My watchdog message');
    $this
      ->assertMsgID('test potx permission');
    $this
      ->assertMsgID('one more test potx permission');
    $this
      ->assertPluralID('1 test string', '@count test strings');

    // Installer string should not appear in runtime output.
    $this
      ->assertNoMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgID('Installer string in context');

    // No context support yet.
    $this
      ->assertNoMsgIDContext('Test string in context', 'Test context');
    $this
      ->assertMsgID('Test string in context');
    $this
      ->assertNoMsgIDContext('Dynamic string in context', 'Dynamic context');
    $this
      ->assertMsgID('Dynamic string in context');

    // The singular/plural will not even be found without context, because
    // Drupal 5 does not have support for args on format_plural.
    $this
      ->assertNoMsgID('1 test string in context');
    $this
      ->assertNoPluralIDContext('1 test string in context', '@count test strings in context', 'Test context');

    // Look at installer strings.
    $this
      ->parseFile($filename, POTX_API_5, POTX_STRING_INSTALLER);
    $this
      ->assertMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgID('1 test string');
    $this
      ->assertNoMsgID('This is a test string.');
    $this
      ->assertNoMsgIDContext('Installer string in context', 'Installer context');
    $this
      ->assertMsgID('Installer string in context');
    $this
      ->assertNoMsgIDContext('Dynamic string in context', 'Dynamic context');
    $this
      ->assertMsgID('Dynamic string in context');
    $this
      ->assert(count($this->potx_status) == 4, t('4 error messages found'));
    $this
      ->assert($this->potx_status[0][0] == $this->empty_error, t('First empty error found.'));
    $this
      ->assert($this->potx_status[1][0] == $this->empty_error, t('Second empty error found.'));
    $this
      ->assert($this->potx_status[2][0] == 'In format_plural(), the singular and plural strings should be literal strings. There should be no variables, concatenation, constants or even a t() call there.', t('Fourth error found.'));
    $this
      ->assert($this->potx_status[3][0] == $this->empty_error, t('Third empty error found.'));
  }

  /**
   * Test parsing of Drupal 6 module.
   */
  public function testDrupal6() {

    // Parse and build the Drupal 6 module file.
    $filename = __DIR__ . '/potx_test_6.module';
    $this
      ->parseFile($filename, POTX_API_6);

    // Assert strings found in module source code.
    $this
      ->assertMsgID('Test menu item');
    $this
      ->assertMsgID('This is a test menu item');
    $this
      ->assertMsgID('This is a test string.');
    $this
      ->assertMsgID('test watchdog type');
    $this
      ->assertMsgID('My watchdog message');
    $this
      ->assertMsgID('test potx permission');
    $this
      ->assertMsgID('one more test potx permission');
    $this
      ->assertPluralID('1 test string', '@count test strings');
    $this
      ->assertMsgID('Test menu item description');
    $this
      ->assertMsgID('Test menu item description altered (1)');
    $this
      ->assertMsgID('Test menu item description altered (2)');
    $this
      ->assertMsgID('Test menu item title altered');

    // Installer string should not appear in runtime output.
    $this
      ->assertNoMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgID('Installer string in context');

    // No context support yet.
    $this
      ->assertNoMsgIDContext('Test string in context', 'Test context');
    $this
      ->assertMsgID('Test string in context');
    $this
      ->assertNoMsgIDContext('Dynamic string in context', 'Dynamic context');
    $this
      ->assertMsgID('Dynamic string in context');
    $this
      ->assertPluralID('1 test string in context', '@count test strings in context');
    $this
      ->assertNoPluralIDContext('1 test string in context', '@count test strings in context', 'Test context');

    // Look at installer strings.
    $this
      ->parseFile($filename, POTX_API_6, POTX_STRING_INSTALLER);
    $this
      ->assertMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgID('1 test string');
    $this
      ->assertNoMsgID('This is a test string.');
    $this
      ->assertNoMsgIDContext('Installer string in context', 'Installer context');
    $this
      ->assertMsgID('Installer string in context');
    $this
      ->assertNoMsgIDContext('Dynamic string in context', 'Dynamic context');
    $this
      ->assertMsgID('Dynamic string in context');
    $this
      ->assert(count($this->potx_status) == 3, t('3 error messages found'));
    $this
      ->assert($this->potx_status[0][0] == $this->empty_error, t('First empty error found.'));
    $this
      ->assert($this->potx_status[1][0] == $this->empty_error, t('Second empty error found.'));
    $this
      ->assert($this->potx_status[2][0] == $this->empty_error, t('Third empty error found.'));
  }

  /**
   * Test parsing of Drupal 7 module.
   */
  public function testDrupal7() {

    // Parse and build the Drupal 7 module file.
    $filename = __DIR__ . '/potx_test_7.module';
    $this
      ->parseFile($filename, POTX_API_7);

    // Assert strings found in module source code.
    $this
      ->assertMsgID('Test menu item');
    $this
      ->assertMsgID('This is a test menu item');
    $this
      ->assertMsgID('This is a test string.');
    $this
      ->assertMsgID('test watchdog type');
    $this
      ->assertMsgID('My watchdog message');
    $this
      ->assertMsgID('PHP Syntax error gracefully handled');

    // No support for hook_perm() anymore. t() in hook_permissions().
    $this
      ->assertNoMsgID('test potx permission');
    $this
      ->assertNoMsgID('one more test potx permission');
    $this
      ->assertMsgID('Test potx permission');
    $this
      ->assertMsgID('Test potx permission description');
    $this
      ->assertMsgID('One more test potx permission');
    $this
      ->assertMsgID('One more test potx permission description');
    $this
      ->assertPluralID('1 test string', '@count test strings');
    $this
      ->assertPluralIDContext('1 test string in context', '@count test strings in context', 'Test context');
    $this
      ->assertMsgID('Test menu item description');
    $this
      ->assertMsgID('Test menu item description altered (1)');
    $this
      ->assertMsgID('Test menu item description altered (2)');
    $this
      ->assertMsgID('Test menu item title altered');
    $this
      ->assertNoMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgIDContext('Installer string in context', 'Installer context');
    $this
      ->assertMsgIDContext('Dynamic string in context', 'Dynamic context');

    // Context support added.
    $this
      ->assertMsgIDContext('Test string in context', 'Test context');

    // Drush support.
    $this
      ->assertMsgID('This could have been in a drush file');

    // Look at installer strings.
    $this
      ->parseFile($filename, POTX_API_7, POTX_STRING_INSTALLER);
    $this
      ->assertMsgID('Installer only test string');
    $this
      ->assertMsgID('Dynamic callback test string');
    $this
      ->assertNoMsgID('1 test string');
    $this
      ->assertNoMsgID('This is a test string.');
    $this
      ->assertMsgIDContext('Installer string in context', 'Installer context');
    $this
      ->assertMsgIDContext('Dynamic string in context', 'Dynamic context');
    $this
      ->assert(count($this->potx_status) == 3, t('3 error messages found'));
    $this
      ->assert($this->potx_status[0][0] == $this->empty_error, t('First empty error found.'));
    $this
      ->assert($this->potx_status[1][0] == 'Unexpected ;', t('Unexpected semicolon found.'));
    $this
      ->assert($this->potx_status[2][0] == $this->empty_error, t('Second empty error found.'));
  }
  public function testDrupal8LanguageManager() {
    $filename = __DIR__ . '/LanguageManager.php';
    $this
      ->parseFile($filename, POTX_API_8);
    $this
      ->assertMsgID('Test English language');
  }

  /**
   * Test parsing of Drupal 8 Twig templates.
   */
  public function testDrupal8Twig() {
    $filename = __DIR__ . '/potx_test_8.html.twig';
    $this
      ->parseFile($filename, POTX_API_8);
    $this
      ->assertMsgID('This is a translated string.');
    $this
      ->assertMsgID('A double-quoted string');
    $this
      ->assertMsgID('Here\'s a double-quoted "and escaped" string.');
    $this
      ->assertMsgID("Here's a string with an escaped quote.");
    $this
      ->assertNoMsgID('This is a concatenated string that should not be picked up.');
    $this
      ->assertNoMsgID('This is a concatenated string ');
    $this
      ->assertNoMsgID('that should not be picked up.');
    $this
      ->assertNoMsgID('This is an untranslated string.');
    $this
      ->assert(count($this->potx_status) == 1, t('1 error message found'));
    $this
      ->assert($this->potx_status[0][0] == t('Uses of the t filter in Twig templates should start with a single literal string, and should not be chained.'), t('Concatenation error found.'));
    $this
      ->assertMsgID('Hello sun.');
    $this
      ->assertMsgIDContext('Hello sun, with context.', 'Lolspeak');
    $this
      ->assertMsgID('Hello Earth.');
    $this
      ->assertMsgID('Hello moon.');
    $this
      ->assertPluralID('Hello star.', 'Hello @count stars.');
    $this
      ->assertMsgID('Escaped: @string');
    $this
      ->assertMsgID('Placeholder: %string');
    $this
      ->assertMsgID('This @node.type is submitted by @author.name, and has a length of: @count. It contains: %node.numbers and @node.bad_text.');
    $this
      ->assertMsgIDContext('I have context.', 'Lolspeak');
    $this
      ->assertNoMsgIDContext('I have no context.', 'zz');
    $this
      ->assertMsgIDContext('I have context and another parameter.', 'Lolspeak');
    $this
      ->assertMsgID('A multiline\\n    trans block.');
    $this
      ->assertMsgID('Test string with @extra_filter');
    $this
      ->assertMsgID('Test string with @multiple_filters');
    $this
      ->assertMsgID('Test string with %multiple_filters');
    $this
      ->assertMsgID('Meta-data for a help topic title');
    $this
      ->assertNoMsgID('Meta-data that should not be translated');
  }

  /**
   * Test parsing of Drupal 8 module.
   */
  public function testDrupal8() {

    // Parse and build the Drupal 8 module file.
    $filename = __DIR__ . '/potx_test_8.module.txt';
    $this
      ->parseFile($filename, POTX_API_8);

    // Test parsing $this->t calls in D8 code
    $this
      ->assertMsgID('Using t inside D8 classes ($this->t)');

    // Assert strings found in module source code.
    $this
      ->assertMsgID('Good translation annotation');
    $this
      ->assertMsgID('Another good translation annotation');
    $this
      ->assertMsgID('Final good translation annotation');
    $this
      ->assertNoMsgIDContext('Good translation annotation', 'Translation test');
    $this
      ->assertMsgID('Translation in good context');
    $this
      ->assertMsgIDContext('Translation in good context', 'Translation test');
    $this
      ->assert(count($this->potx_status) == 2, t('2 error messages found'));
    $this
      ->assert($this->potx_status[0][0] == 'In @Translation, only one, non-empty static string is allowed in double quotes.', t('Incorrect @Translation found.'));
    $this
      ->assert($this->potx_status[1][0] == $this->empty_error, t('Second empty error found.'));
    $this
      ->assertPluralID('1 formatPlural test string', '@count formatPlural test strings');
    $this
      ->assertPluralIDContext('1 formatPlural test string in context', '@count formatPlural test strings in context', 'Test context');
    $this
      ->assertPluralID('1 translation->formatPlural test string', '@count translation->formatPlural test strings');
    $this
      ->assertPluralIDContext('1 translation->formatPlural test string in context', '@count translation->formatPlural test strings in context', 'Test context');
    $this
      ->assertPluralID('1 PluralTranslatableMarkup test string', '@count PluralTranslatableMarkup test strings');
    $this
      ->assertPluralIDContext('1 PluralTranslatableMarkup test string with context', '@count PluralTranslatableMarkup test strings with context', 'Test context');
    $this
      ->assertMsgID('TranslationWrapper string');
    $this
      ->assertMsgIDContext('TranslationWrapper string with context', 'With context');
    $this
      ->assertMsgID('TranslatableMarkup string');
    $this
      ->assertMsgID('TranslatableMarkup string without context');
    $this
      ->assertMsgIDContext('TranslatableMarkup string with long array context', 'With context');
    $this
      ->assertMsgIDContext('TranslatableMarkup string with short array context', 'With context');
    $this
      ->assertMsgIDContext('TranslatableMarkup string with long array followed by short array context', 'With context');
    $this
      ->assertMsgIDContext('TranslatableMarkup string with complicated tokens', 'With context');
    $this
      ->assertMsgIDContext('TranslatableMarkup string with complicated option tokens', 'With context');
    $this
      ->assertMsgID('Test translatable string inside an inline template');
    $this
      ->assertMsgID('Another test translatable string inside an inline template');
    $this
      ->assertMsgID('A translatable string inside an inline template, with double-quoted "#template" key');
    $this
      ->assertMsgID('Debug message');
    $this
      ->assertMsgID('Info message');
    $this
      ->assertMsgID('Notice message');
    $this
      ->assertMsgID('Warning message');
    $this
      ->assertMsgID('Error message');
    $this
      ->assertMsgID('Critical message');
    $this
      ->assertMsgID('Alert message');
    $this
      ->assertMsgID('Emergency message');
    $this
      ->assertMsgID('Log message');
    $this
      ->assertMsgID('Log message 2');
    $this
      ->assertMsgID('Log message 3');
  }

  /**
   * Test parsing of Drupal 8 .info.yml files.
   */
  public function testDrupal8InfoYml() {
    $filename = __DIR__ . '/potx_test_8.info.yml';
    $this
      ->parseFile($filename, POTX_API_8);

    // Look for name, description and package name extracted.
    $this
      ->assertMsgID('Translation template extractor tester');
    $this
      ->assertMsgID('Test description');
    $this
      ->assertMsgID('Test package');
    $this
      ->assertMsgID('Test region');
    $this
      ->assertMsgID('Another region');
  }

  /**
   * Test parsing of Drupal 8 .routing.yml files.
   */
  public function testDrupal8RoutingYml() {
    $filename = __DIR__ . '/potx_test_8.routing.yml';
    $this
      ->parseFile($filename, POTX_API_8);

    // Look for all title can be extracted
    $this
      ->assertMsgID('Build translation test');
    $this
      ->assertMsgID('Build alternative translation');
    $this
      ->assertMsgIDContext('Translation title in context', 'Title context');
  }

  /**
   * Test parsing of Drupal 8 local tasks, contextual link and action files.
   */
  public function testDrupal8LocalContextualYml() {
    $filenames = array(
      __DIR__ . '/potx_test_8.links.task.yml',
      __DIR__ . '/potx_test_8.links.action.yml',
      __DIR__ . '/potx_test_8.links.contextual.yml',
    );
    $this
      ->parseFile($filenames[0], POTX_API_8);
    $this
      ->assertMsgID('Local task translation test');
    $this
      ->assertMsgIDContext('Local task translation with context test', 'Local task context');
    $this
      ->parseFile($filenames[1], POTX_API_8);
    $this
      ->assertMsgID('Local action translation test');
    $this
      ->assertMsgIDContext('Local action translation with context test', 'Local action context');
    $this
      ->parseFile($filenames[2], POTX_API_8);
    $this
      ->assertMsgID('Test Contextual link');
    $this
      ->assertMsgIDContext('Test Contextual link with context', 'Contextual Context');
  }

  /**
   * Test parsing of Drupal 8 menu link files.
   */
  public function testDrupal8MenuLinksYml() {
    $this
      ->parseFile(__DIR__ . '/potx_test_8.links.menu.yml', POTX_API_8);
    $this
      ->assertMsgID('Test menu link title');
    $this
      ->assertMsgID('Test menu link description.');
    $this
      ->assertMsgIDContext('Test menu link title with context', 'Menu item context');
  }

  /**
   * Test parsing of custom yaml files.
   */
  public function testDrupal8CustomYml() {
    $files = _potx_explore_dir(__DIR__ . '/potx_test_8/', '*', POTX_API_8);
    _potx_init_yaml_translation_patterns();
    $this
      ->parseFile($files[0], POTX_API_8);
    $this
      ->assertMsgID('Test custom yaml translatable');
    $this
      ->assertMsgIDContext('Test custom yaml translatable with context', 'Yaml translatable context');

    // Test that translation patterns for a module won't be used for extracting
    // translatable strings for another module.
    potx_finish_processing('_potx_save_string', POTX_API_8);
    $files = _potx_explore_dir(__DIR__ . '/potx_test_yml/', '*', POTX_API_8);
    $this
      ->parseFile(__DIR__ . '/potx_test_yml/potx_test_8.test2.yml', POTX_API_8);
    $this
      ->assertNoMsgID('Not translatable string');
    $this
      ->assertMsgID('Translatable string');
    $this
      ->assertMsgIDContext('Test custom yaml translatable field with context', 'Yaml translatable context');

    // Test that custom translation patterns are extracted from subfolders.
    $this
      ->parseFile(__DIR__ . '/potx_test_yml/test_folder/potx_test_8.test3.yml', POTX_API_8);
    $this
      ->assertMsgID('Translatable string inside directory');
  }

  /**
   * Test parsing of Drupal 8 .breakpoints.yml files.
   */
  public function testDrupal8BreakpointsYml() {
    $filename = __DIR__ . '/potx_test_8.breakpoints.yml';
    $this
      ->parseFile($filename, POTX_API_8);
    $this
      ->assertMsgID('Mobile');
    $this
      ->assertMsgID('Standard');
    $this
      ->assertMsgID('Some breakpoint group');
  }

  /**
   * Test parsing of Drupal 8 permissions files.
   */
  public function testDrupal8PermissionsYml() {
    $this
      ->parseFile(__DIR__ . '/potx_test_8.permissions.yml', POTX_API_8);
    $this
      ->assertMsgID('Title potx_test_8_a');
    $this
      ->assertMsgID('Description: potx_test_8_a');
    $this
      ->assertMsgID('Title potx_test_8_b');
    $this
      ->assertNoMsgID('some_callback');
  }

  /**
   * Test parsing of Drupal 8 shipped configuration files.
   */
  public function testDrupal8ShippedConfiguration() {
    global $_potx_store, $_potx_strings, $_potx_install;
    $_potx_store = $_potx_strings = $_potx_install = array();
    $test_d8_path = __DIR__ . '/drupal8';
    $files = _potx_explore_dir($test_d8_path, '*', POTX_API_8, TRUE);
    foreach ($files as $file) {
      _potx_process_file($file, 0, '_potx_save_string', '_potx_save_version', POTX_API_8);
    }
    _potx_parse_shipped_configuration('_potx_save_string', POTX_API_8);
    $this
      ->buildOutput(POTX_API_8);
    for ($i = 1; $i < 8; $i++) {
      $this
        ->assertNoMsgID($i . '');
    }

    // Test extraction of config schema labels.
    // Make sure all the 'label' strings are extracted.
    $this
      ->assertMsgID('Test integer');
    $this
      ->assertMsgID('Test string with "quotes"');
    $this
      ->assertMsgID('Mapping integer');
    $this
      ->assertMsgID('Test string in sequence');

    // Make sure other strings are not extracted.
    $this
      ->assertNoMsgID('mapping');
    $this
      ->assertNoMsgID('sequence');

    // Test extraction of shipped config translatables.
    $this
      ->assertMsgID('A string with "translatable: true" property');
    $this
      ->assertMsgIDContext('Y-m-d', 'PHP date format');
    $this
      ->assertMsgIDContext('Test string with context', 'Test context');
    $this
      ->assertMsgIDContext('Test label with context', 'Test label with context');
    $this
      ->assertMsgIDContext('Test overriding context', 'Test context override');
    $this
      ->assertMsgID('Simple mapping name');
    $this
      ->assertMsgID('Simple mapping code');
    $this
      ->assertMsgID('Mapping with type - name');
    $this
      ->assertMsgID('Mapping with type - code');
    $this
      ->assertMsgID('Mapping with type - extra label');
    $this
      ->assertMsgID('Simple sequence - Item 1');
    $this
      ->assertMsgID('Simple sequence - Item 2');
    $this
      ->assertMsgID('Typed sequence - Item 1 name');
    $this
      ->assertMsgID('Typed sequence - Item 1 code');
    $this
      ->assertMsgID('Typed sequence - Item 2 name');
    $this
      ->assertMsgID('Typed sequence - Item 2 code');
    $this
      ->assertMsgID('Sequence of sequence - Description 1');
    $this
      ->assertMsgID('Sequence of sequence - Description 2');
    $this
      ->assertMsgID('BC sequence item 1');
    $this
      ->assertMsgID('BC sequence item 2');
    $this
      ->assertMsgID('Basic variable (text)');
    $this
      ->assertMsgID('Parent variable (text)');
    $this
      ->assertMsgID('Key variable (text)');
    $this
      ->assertMsgID('Complex variable test');
    $this
      ->assertMsgID('Optional config translatable string');
    $this
      ->assertMsgIDContext('Optional config test string with context', 'Test context');
    $this
      ->assertNoMsgID('A simple string');
    $this
      ->assertNoMsgID('A text with "translatable: false" property');
    $this
      ->assertNoMsgID('text');
    $this
      ->assertNoMsgID('custom');
    $this
      ->assertNoMsgID('Basic variable (custom)');
    $this
      ->assertNoMsgID('Parent variable (custom)');
    $this
      ->assertNoMsgID('Key variable (custom)');
    $this
      ->assertPluralID('1 place', '@count places');
    $this
      ->assertPluralID('1 comment', '@count comments', 'Test context');
    $this
      ->assertMsgID('Test boolean based variable');
  }

  /**
   * Test parsing Drupal 8 validation constraint messages.
   */
  public function testDrupal8ConstraintMessages() {
    $filename = __DIR__ . '/TestConstraint.php';
    $this
      ->parseFile($filename, POTX_API_8);
    $this
      ->assertMsgID('Test message');
    $this
      ->assertMsgID('Test message 2');
    $this
      ->assertPluralID('1 test message', '@count test message');
    $this
      ->assertNoMsgID('Not a message for translation');
  }

  /**
   * Test parsing of Drupal 6 info file. Drupal 5 and 7 have no other rules.
   */
  public function testDrupalInfo() {

    // Parse and build the Drupal 6 module file.
    $filename = __DIR__ . '/potx_test_6.info';
    $this
      ->parseFile($filename, POTX_API_6);

    // Look for name, description and package name extracted.
    $this
      ->assertMsgID('Translation template extractor tester');
    $this
      ->assertMsgID('Test description');
    $this
      ->assertMsgID('Test package');
  }

  /**
   * Test parsing of a Drupal JS file.
   */
  public function testDrupalJS() {

    // Parse and build the Drupal JS file (from above Drupal 5).
    $filename = __DIR__ . '/potx_test.js';
    $this
      ->parseFile($filename, POTX_API_6);

    // Assert strings found in JS source code.
    $this
      ->assertMsgID('Test string in JS');
    $this
      ->assertPluralID('1 test string in JS', '@count test strings in JS');
    $this
      ->assertMsgID('String with @placeholder value');
    $this
      ->assertMsgIDContext('Test string in JS in test context', 'Test context');
    $this
      ->assertMsgIDContext('Test string in JS in context and with @placeholder', 'Test context');
    $this
      ->assertMsgIDContext('Multiline string for the test with @placeholder', 'Test context');
    $this
      ->assertPluralIDContext('1 test string in JS in test context', '@count test strings in JS in test context', 'Test context');
    $this
      ->assertPluralIDContext('1 test string in JS with context and @placeholder', '@count test strings in JS with context and @placeholder', 'Test context');
    $this
      ->assert(count($this->potx_status) == 1, t('1 error message found'));
    $this
      ->assert($this->potx_status[0][0] == $this->empty_error, t('Empty error found.'));
  }

  /**
   * Parse the given file with the given API version.
   */
  private function parseFile($filename, $api_version, $string_mode = POTX_STRING_RUNTIME) {
    global $_potx_store, $_potx_strings, $_potx_install;
    $_potx_store = $_potx_strings = $_potx_install = array();
    potx_status('set', POTX_STATUS_STRUCTURED);
    _potx_process_file($filename, 0, '_potx_save_string', '_potx_save_version', $api_version);
    _potx_build_files($string_mode, POTX_BUILD_SINGLE, 'general', '_potx_save_string', '_potx_save_version', '_potx_get_header', NULL, NULL, $api_version);

    // Grab .po representation of parsed content.
    ob_start();
    _potx_write_files('potx-test.po');
    $this->potx_output = ob_get_clean();

    //debug(var_export($this->potx_output, TRUE));
    $this->potx_status = potx_status('get', TRUE);

    //debug(var_export($this->potx_status, TRUE));
  }

  /**
   * Build the output from parsed files.
   */
  private function buildOutput($api_version, $string_mode = POTX_STRING_RUNTIME) {
    potx_status('set', POTX_STATUS_STRUCTURED);
    _potx_build_files($string_mode, POTX_BUILD_SINGLE, 'general', '_potx_save_string', '_potx_save_version', '_potx_get_header', NULL, NULL, $api_version);

    // Grab .po representation of parsed content.
    ob_start();
    _potx_write_files('potx-test.po');
    $this->potx_output = ob_get_clean();
    $this->potx_status = potx_status('get', TRUE);
  }

  /**
   * Helper function to assert an msgid construct in the .po file.
   */
  private function assertMsgID($string, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('MsgID "@raw" found', array(
        '@raw' => check_plain($string),
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgid "' . _potx_format_quoted_string('"' . $string . '"') . '"') !== FALSE, $message, $group);
  }

  /**
   * Helper function to assert a missing msgid construct in the .po file.
   */
  private function assertNoMsgID($string, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('MsgID "@raw" not found', array(
        '@raw' => check_plain($string),
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgid "' . _potx_format_quoted_string('"' . $string . '"') . '"') === FALSE, $message, $group);
  }

  /**
   * Helper function to assert an msgid with context in the .po file.
   */
  private function assertMsgIDContext($string, $context, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('MsgID "@raw" in context "@context" found', array(
        '@raw' => check_plain($string),
        '@context' => check_plain($context),
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgctxt "' . _potx_format_quoted_string('"' . $context . '"') . "\"\nmsgid \"" . _potx_format_quoted_string('"' . $string . '"') . '"') !== FALSE, $message, $group);
  }

  /**
   * Helper function to assert an msgid with context in the .po file.
   */
  private function assertNoMsgIDContext($string, $context, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('No MsgID "@raw" in context "@context" found', array(
        '@raw' => check_plain($string),
        '@context' => check_plain($context),
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgid "' . _potx_format_quoted_string('"' . $string . '"') . '"' . "\nmsgctxt \"" . _potx_format_quoted_string('"' . $context . '"') . '"') === FALSE, $message, $group);
  }

  /**
   * Helper function to assert an msgid_plural construct in the .po file.
   */
  private function assertPluralID($string, $plural, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('Plural ID "@raw" found', array(
        '@raw' => check_plain($string),
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgid "' . _potx_format_quoted_string('"' . $string . '"') . "\"\nmsgid_plural \"" . _potx_format_quoted_string('"' . $plural . '"') . '"') !== FALSE, $message, $group);
  }

  /**
   * Helper function to assert an msgid_plural with context in the .po file.
   */
  private function assertPluralIDContext($string, $plural, $context, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('Plural ID "@raw" found with context "@context"', array(
        '@raw' => check_plain($string),
        '@context' => $context,
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgctxt "' . _potx_format_quoted_string('"' . $context . '"') . "\"\nmsgid \"" . _potx_format_quoted_string('"' . $string . '"') . "\"\nmsgid_plural \"" . _potx_format_quoted_string('"' . $plural . '"') . '"') !== FALSE, $message, $group);
  }

  /**
   * Helper function to assert lack of msgid_plural with context in the .po file.
   */
  private function assertNoPluralIDContext($string, $plural, $context, $message = '', $group = 'Other') {
    if (!$message) {
      $message = t('No plural ID "@raw" found with context "@context"', array(
        '@raw' => check_plain($string),
        '@context' => $context,
      ));
    }
    $this
      ->assert(strpos($this->potx_output, 'msgctxt "' . _potx_format_quoted_string('"' . $context . '"') . "\"\nmsgid \"" . _potx_format_quoted_string('"' . $string . '"') . "\"\nmsgid_plural \"" . _potx_format_quoted_string('"' . $plural . '"') . '"') === FALSE, $message, $group);
  }

  /**
   * Debug functionality until simpletest built-in debugging is backported.
   */
  private function outputScreenContents($description = 'output', $basename = 'output') {

    // This is a hack to get a directory that won't be cleaned up by simpletest
    $file_dir = file_directory_path() . '/../simpletest_output_pages';
    if (!is_dir($file_dir)) {
      mkdir($file_dir, 0777, TRUE);
    }
    $output_path = "{$file_dir}/{$basename}." . $this
      ->randomName(10) . '.html';
    $rv = file_put_contents($output_path, $this
      ->drupalGetContent());
    $this
      ->pass("{$description}: " . l('Contents of result page', $output_path));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DrupalTestCase::$assertions	protected	property	Assertions thrown in that test case.
DrupalTestCase::$databasePrefix	protected	property	The database prefix of this test run.
DrupalTestCase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
DrupalTestCase::$results	public	property	Current results of this test case.
DrupalTestCase::$setup	protected	property	Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix	protected	property
DrupalTestCase::$setupEnvironment	protected	property
DrupalTestCase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId	protected	property	The test run ID.
DrupalTestCase::$timeLimit	protected	property	Time limit for the test.
DrupalTestCase::$useSetupInstallationCache	public	property	Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache	public	property	Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
DrupalTestCase::assert	protected	function	Internal helper: stores the assert.
DrupalTestCase::assertEqual	protected	function	Check to see if two values are equal.
DrupalTestCase::assertFalse	protected	function	Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical	protected	function	Check to see if two values are identical.
DrupalTestCase::assertNotEqual	protected	function	Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical	protected	function	Check to see if two values are not identical.
DrupalTestCase::assertNotNull	protected	function	Check to see if a value is not NULL.
DrupalTestCase::assertNull	protected	function	Check to see if a value is NULL.
DrupalTestCase::assertTrue	protected	function	Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert	public static	function	Delete an assertion record by message ID.
DrupalTestCase::error	protected	function	Fire an error assertion.	1
DrupalTestCase::errorHandler	public	function	Handle errors during test runs.	1
DrupalTestCase::exceptionHandler	protected	function	Handle exceptions.
DrupalTestCase::fail	protected	function	Fire an assertion that is always negative.
DrupalTestCase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert	public static	function	Store an assertion from outside the testing context.
DrupalTestCase::pass	protected	function	Fire an assertion that is always positive.
DrupalTestCase::randomName	public static	function	Generates a random string containing letters and numbers.
DrupalTestCase::randomString	public static	function	Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run	public	function	Run all tests in this class.
DrupalTestCase::verbose	protected	function	Logs a verbose message in a text file.
DrupalWebTestCase::$additionalCurlOptions	protected	property	Additional cURL options.
DrupalWebTestCase::$content	protected	property	The content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFile	protected	property	The current cookie file used by cURL.
DrupalWebTestCase::$cookies	protected	property	The cookies of the page currently loaded in the internal browser.
DrupalWebTestCase::$curlHandle	protected	property	The handle of the current cURL connection.
DrupalWebTestCase::$drupalSettings	protected	property	The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elements	protected	property	The parsed version of the page.
DrupalWebTestCase::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
DrupalWebTestCase::$headers	protected	property	The headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentials	protected	property	HTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_method	protected	property	HTTP authentication method
DrupalWebTestCase::$loggedInUser	protected	property	The current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacks	protected	property	The original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUser	protected	property	The original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContent	protected	property	The content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profile	protected	property	The profile to install as a basis for testing.	20
DrupalWebTestCase::$redirect_count	protected	property	The number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_id	protected	property	The current session ID, if available.
DrupalWebTestCase::$session_name	protected	property	The current session name, if available.
DrupalWebTestCase::$url	protected	property	The URL currently loaded in the internal browser.
DrupalWebTestCase::assertField	protected	function	Asserts that a field exists with the given name or ID.
DrupalWebTestCase::assertFieldById	protected	function	Asserts that a field exists in the current page with the given ID and value.
DrupalWebTestCase::assertFieldByName	protected	function	Asserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLink	protected	function	Pass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHref	protected	function	Pass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMail	protected	function	Asserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPattern	protected	function	Asserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailString	protected	function	Asserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
DrupalWebTestCase::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
DrupalWebTestCase::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath	protected	function	Asserts that a field doesn't exist or its value doesn't match, by XPath.
DrupalWebTestCase::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLink	protected	function	Pass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHref	protected	function	Pass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPattern	protected	function	Will trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRaw	protected	function	Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponse	protected	function	Asserts the page did not return the specified response code.
DrupalWebTestCase::assertNoText	protected	function	Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitle	protected	function	Pass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueText	protected	function	Pass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
DrupalWebTestCase::assertPattern	protected	function	Will trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRaw	protected	function	Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponse	protected	function	Asserts the page responds with the specified response code.
DrupalWebTestCase::assertText	protected	function	Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelper	protected	function	Helper for assertText and assertNoText.
DrupalWebTestCase::assertThemeOutput	protected	function	Asserts themed output.
DrupalWebTestCase::assertTitle	protected	function	Pass if the page title is the given string.
DrupalWebTestCase::assertUniqueText	protected	function	Pass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrl	protected	function	Pass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQuery	protected	function	Builds an XPath query.
DrupalWebTestCase::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
DrupalWebTestCase::checkForMetaRefresh	protected	function	Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissions	protected	function	Check to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLink	protected	function	Follows a link by name.
DrupalWebTestCase::constructFieldXpath	protected	function	Helper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::copySetupCache	protected	function	Copy the setup cache from/to another table and files directory.
DrupalWebTestCase::cronRun	protected	function	Runs cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlClose	protected	function	Close the cURL handler and unset the handler.
DrupalWebTestCase::curlExec	protected	function	Initializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallback	protected	function	Reads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitialize	protected	function	Initializes the cURL connection.
DrupalWebTestCase::drupalCompareFiles	protected	function	Compare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentType	protected	function	Creates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNode	protected	function	Creates a node based on default settings.
DrupalWebTestCase::drupalCreateRole	protected	function	Creates a role with specified permissions.
DrupalWebTestCase::drupalCreateUser	protected	function	Create a user with a given set of permissions.
DrupalWebTestCase::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAX	protected	function	Retrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContent	protected	function	Gets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeader	protected	function	Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
DrupalWebTestCase::drupalGetHeaders	protected	function	Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
DrupalWebTestCase::drupalGetMails	protected	function	Gets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitle		function	Get a node from the database based on its title.
DrupalWebTestCase::drupalGetSettings	protected	function	Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFiles	protected	function	Get a list files that can be used in tests.
DrupalWebTestCase::drupalGetToken	protected	function	Generate a token for the currently logged in user.
DrupalWebTestCase::drupalHead	protected	function	Retrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLogin	protected	function	Log in a user with the internal browser.
DrupalWebTestCase::drupalLogout	protected	function
DrupalWebTestCase::drupalPost	protected	function	Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAX	protected	function	Execute an Ajax submission.
DrupalWebTestCase::drupalSetContent	protected	function	Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
DrupalWebTestCase::drupalSetSettings	protected	function	Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
DrupalWebTestCase::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItem	protected	function	Get the selected value from a select field.
DrupalWebTestCase::getSetupCacheKey	protected	function	Returns the cache key used for the setup caching.
DrupalWebTestCase::getUrl	protected	function	Get the current URL from the cURL handler.
DrupalWebTestCase::handleForm	protected	function	Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
DrupalWebTestCase::loadSetupCache	protected	function	Copies the cached tables and files for a cached installation setup.
DrupalWebTestCase::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry	protected	function	Preload the registry from the testing site.
DrupalWebTestCase::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.
DrupalWebTestCase::prepareEnvironment	protected	function	Prepares the current environment for running the test.
DrupalWebTestCase::recursiveDirectoryCopy	protected	function	Recursively copy one directory to another.
DrupalWebTestCase::refreshVariables	protected	function	Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread.	1
DrupalWebTestCase::resetAll	protected	function	Reset all data structures after having enabled new modules.
DrupalWebTestCase::storeSetupCache	protected	function	Store the installation setup to a cache.
DrupalWebTestCase::tearDown	protected	function	Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.	6
DrupalWebTestCase::verboseEmail	protected	function	Outputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpath	protected	function	Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__construct		function	Constructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct	1
PotxTestCase::assertMsgID	private	function	Helper function to assert an msgid construct in the .po file.
PotxTestCase::assertMsgIDContext	private	function	Helper function to assert an msgid with context in the .po file.
PotxTestCase::assertNoMsgID	private	function	Helper function to assert a missing msgid construct in the .po file.
PotxTestCase::assertNoMsgIDContext	private	function	Helper function to assert an msgid with context in the .po file.
PotxTestCase::assertNoPluralIDContext	private	function	Helper function to assert lack of msgid_plural with context in the .po file.
PotxTestCase::assertPluralID	private	function	Helper function to assert an msgid_plural construct in the .po file.
PotxTestCase::assertPluralIDContext	private	function	Helper function to assert an msgid_plural with context in the .po file.
PotxTestCase::buildOutput	private	function	Build the output from parsed files.
PotxTestCase::getInfo	public static	function
PotxTestCase::outputScreenContents	private	function	Debug functionality until simpletest built-in debugging is backported.
PotxTestCase::parseFile	private	function	Parse the given file with the given API version.
PotxTestCase::setUp	public	function	Sets up a Drupal site for running functional and integration tests. Overrides DrupalWebTestCase::setUp
PotxTestCase::testDrupal5	public	function	Test parsing of Drupal 5 module.
PotxTestCase::testDrupal6	public	function	Test parsing of Drupal 6 module.
PotxTestCase::testDrupal7	public	function	Test parsing of Drupal 7 module.
PotxTestCase::testDrupal8	public	function	Test parsing of Drupal 8 module.
PotxTestCase::testDrupal8BreakpointsYml	public	function	Test parsing of Drupal 8 .breakpoints.yml files.
PotxTestCase::testDrupal8ConstraintMessages	public	function	Test parsing Drupal 8 validation constraint messages.
PotxTestCase::testDrupal8CustomYml	public	function	Test parsing of custom yaml files.
PotxTestCase::testDrupal8InfoYml	public	function	Test parsing of Drupal 8 .info.yml files.
PotxTestCase::testDrupal8LanguageManager	public	function
PotxTestCase::testDrupal8LocalContextualYml	public	function	Test parsing of Drupal 8 local tasks, contextual link and action files.
PotxTestCase::testDrupal8MenuLinksYml	public	function	Test parsing of Drupal 8 menu link files.
PotxTestCase::testDrupal8PermissionsYml	public	function	Test parsing of Drupal 8 permissions files.
PotxTestCase::testDrupal8RoutingYml	public	function	Test parsing of Drupal 8 .routing.yml files.
PotxTestCase::testDrupal8ShippedConfiguration	public	function	Test parsing of Drupal 8 shipped configuration files.
PotxTestCase::testDrupal8Twig	public	function	Test parsing of Drupal 8 Twig templates.
PotxTestCase::testDrupalInfo	public	function	Test parsing of Drupal 6 info file. Drupal 5 and 7 have no other rules.
PotxTestCase::testDrupalJS	public	function	Test parsing of a Drupal JS file.