');
$this->assertEqual($library, $expected, 'Library information is correctly gathered.');
// Test a library specified with an .info file gets detected.
$expected = array(
'name' => 'Example info file',
'info file' => drupal_get_path('module', 'libraries') . '/tests/example/example_info_file.libraries.info.yml',
);
libraries_info_defaults($expected, 'example_info_file');
$library = libraries_info('example_info_file');
// If this module was downloaded from Drupal.org, the Drupal.org packaging
// system has corrupted the test info file.
// @see http://drupal.org/node/1606606
unset($library['core'], $library['datestamp'], $library['project'], $library['version']);
$this->verbose('Expected:
' . var_export($expected, TRUE) . '
');
$this->verbose('Actual:
' . var_export($library, TRUE) . '
');
$this->assertEqual($library, $expected, 'Library specified with an .info file found');
}
/**
* Tests libraries_detect().
*/
function testLibrariesDetect() {
// Test missing library.
$library = libraries_detect('example_missing');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['error'], 'not found', 'Missing library not found.');
$error_message = t('The %library library could not be found.', array(
'%library' => $library['name'],
));
$this->assertEqual($library['error message'], $error_message, 'Correct error message for a missing library.');
// Test unknown library version.
$library = libraries_detect('example_undetected_version');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['error'], 'not detected', 'Undetected version detected as such.');
$error_message = t('The version of the %library library could not be detected.', array(
'%library' => $library['name'],
));
$this->assertEqual($library['error message'], $error_message, 'Correct error message for a library with an undetected version.');
// Test unsupported library version.
$library = libraries_detect('example_unsupported_version');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['error'], 'not supported', 'Unsupported version detected as such.');
$error_message = t('The installed version %version of the %library library is not supported.', array(
'%version' => $library['version'],
'%library' => $library['name'],
));
$this->assertEqual($library['error message'], $error_message, 'Correct error message for a library with an unsupported version.');
// Test supported library version.
$library = libraries_detect('example_supported_version');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['installed'], TRUE, 'Supported library version found.');
// Test libraries_get_version().
$library = libraries_detect('example_default_version_callback');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['version'], '1', 'Expected version returned by default version callback.');
// Test a multiple-parameter version callback.
$library = libraries_detect('example_multiple_parameter_version_callback');
$this->verbose('
' . var_export($library, TRUE) . '
');
$this->assertEqual($library['version'], '1', 'Expected version returned by multiple parameter version callback.');
// Test a top-level files property.
$library = libraries_detect('example_files');
$files = array(
'js' => array('example_1.js' => array()),
'css' => array('example_1.css' => array()),
'php' => array('example_1.php' => array()),
);
$this->verbose('
');
$this->assertEqual($library, $expected, 'Prepare callback was applied correctly.');
// Test a callback in the 'pre-detect' and 'post-detect' phases.
// Successfully detected libraries should only contain version information
// for the detected version and thus, be marked as installed.
unset($expected['versions']);
$expected['installed'] = TRUE;
// Additionally, version-specific properties of the detected version are
// supposed to override the corresponding top-level properties.
$expected['info callback'] = 'applied (version 1)';
$expected['variants']['example_variant']['installed'] = TRUE;
$expected['variants']['example_variant']['info callback'] = 'applied (version 1, variant example_variant)';
// Version-overloading takes place after the 'pre-detect' callbacks have
// been applied.
$expected['pre-detect callback'] = 'applied (version 1)';
$expected['post-detect callback'] = 'applied (top-level)';
$expected['variants']['example_variant']['pre-detect callback'] = 'applied (version 1, variant example_variant)';
$expected['variants']['example_variant']['post-detect callback'] = 'applied (variant example_variant)';
$library = libraries_detect('example_callback');
$this->verbose('Expected:
' . var_export($expected, TRUE) . '
');
$this->verbose('Actual:
' . var_export($library, TRUE) . '
');
$this->assertEqual($library, $expected, 'Detect callback was applied correctly.');
// Test a callback in the 'pre-load' and 'post-load' phases.
// Successfully loaded libraries should only contain information about the
// already loaded variant.
unset($expected['variants']);
$expected['loaded'] = 0;
$expected['pre-load callback'] = 'applied (top-level)';
$expected['post-load callback'] = 'applied (top-level)';
$library = libraries_load('example_callback');
$this->verbose('Expected:
' . var_export($expected, TRUE) . '
');
$this->verbose('Actual:
' . var_export($library, TRUE) . '
');
$this->assertEqual($library, $expected, 'Pre-load and post-load callbacks were applied correctly.');
// This is not recommended usually and is only used for testing purposes.
drupal_static_reset('libraries_load');
// Successfully loaded library variants are supposed to contain the specific
// variant information only.
$expected['info callback'] = 'applied (version 1, variant example_variant)';
$expected['pre-detect callback'] = 'applied (version 1, variant example_variant)';
$expected['post-detect callback'] = 'applied (variant example_variant)';
$library = libraries_load('example_callback', 'example_variant');
$this->verbose('Expected:
' . var_export($expected, TRUE) . '
');
$this->verbose('Actual:
' . var_export($library, TRUE) . '
');
$this->assertEqual($library, $expected, 'Pre-detect and post-detect callbacks were applied correctly to a variant.');
}
/**
* Tests that library files are properly added to the page output.
*
* We check for JavaScript and CSS files directly in the DOM and add a list of
* included PHP files manually to the page output.
*
* @todo Remove or rewrite to accomodate integration with core Libraries.
* @see _libraries_test_load()
*/
function _testLibrariesOutput() {
// Test loading of a simple library with a top-level files property.
$this->drupalGet('libraries_test/files');
$this->assertLibraryFiles('example_1', 'File loading');
// Test loading of integration files.
$this->drupalGet('libraries_test/integration_files');
$this->assertRaw('libraries_test.js', 'Integration file loading: libraries_test.js found');
$this->assertRaw('libraries_test.css', 'Integration file loading: libraries_test.css found');
$this->assertRaw('libraries_test.inc', 'Integration file loading: libraries_test.inc found');
// Test version overloading.
$this->drupalGet('libraries_test/versions');
$this->assertLibraryFiles('example_2', 'Version overloading');
// Test variant loading.
$this->drupalGet('libraries_test/variant');
$this->assertLibraryFiles('example_3', 'Variant loading');
// Test version overloading and variant loading.
$this->drupalGet('libraries_test/versions_and_variants');
$this->assertLibraryFiles('example_4', 'Concurrent version and variant overloading');
// Test caching.
\Drupal::state()->set('libraries_test.cache', TRUE);
\Drupal::cache('libraries')->delete('example_callback');
// When the library information is not cached, all callback groups should be
// invoked.
$this->drupalGet('libraries_test/cache');
$this->assertRaw('The info callback group was invoked.', 'Info callback invoked for uncached libraries.');
$this->assertRaw('The pre-detect callback group was invoked.', 'Pre-detect callback invoked for uncached libraries.');
$this->assertRaw('The post-detect callback group was invoked.', 'Post-detect callback invoked for uncached libraries.');
$this->assertRaw('The pre-load callback group was invoked.', 'Pre-load callback invoked for uncached libraries.');
$this->assertRaw('The post-load callback group was invoked.', 'Post-load callback invoked for uncached libraries.');
// When the library information is cached only the 'pre-load' and
// 'post-load' callback groups should be invoked.
$this->drupalGet('libraries_test/cache');
$this->assertNoRaw('The info callback group was not invoked.', 'Info callback not invoked for cached libraries.');
$this->assertNoRaw('The pre-detect callback group was not invoked.', 'Pre-detect callback not invoked for cached libraries.');
$this->assertNoRaw('The post-detect callback group was not invoked.', 'Post-detect callback not invoked for cached libraries.');
$this->assertRaw('The pre-load callback group was invoked.', 'Pre-load callback invoked for cached libraries.');
$this->assertRaw('The post-load callback group was invoked.', 'Post-load callback invoked for cached libraries.');
\Drupal::state()->set('libraries_test.cache', FALSE);
}
/**
* Helper function to assert that a library was correctly loaded.
*
* Asserts that all the correct files were loaded and all the incorrect ones
* were not.
*
* @param $name
* The name of the files that should be loaded. The current testing system
* knows of 'example_1', 'example_2', 'example_3' and 'example_4'. Each name
* has an associated JavaScript, CSS and PHP file that will be asserted. All
* other files will be asserted to not be loaded. See
* tests/example/README.txt for more information on how the loading of the
* files is tested.
* @param $label
* (optional) A label to prepend to the assertion messages, to make them
* less ambiguous.
* @param $extensions
* (optional) The expected file extensions of $name. Defaults to
* array('js', 'css', 'php').
*/
function assertLibraryFiles($name, $label = '', $extensions = array('js', 'css', 'php')) {
$label = ($label !== '' ? "$label: " : '');
// Test that the wrong files are not loaded...
$names = array(
'example_1' => FALSE,
'example_2' => FALSE,
'example_3' => FALSE,
'example_4' => FALSE,
);
// ...and the correct ones are.
$names[$name] = TRUE;
// Test for the specific HTML that the different file types appear as in the
// DOM.
$html = array(
'js' => array(''),
'css' => array(''),
// PHP files do not get added to the DOM directly.
// @see _libraries_test_load()
'php' => array('
', '
'),
);
$html_expected = array();
$html_not_expected = array();
foreach ($names as $name => $expected) {
foreach ($extensions as $extension) {
$filepath = drupal_get_path('module', 'libraries') . "/tests/example/$name.$extension";
// JavaScript and CSS files appear as full URLs and with an appended
// query string.
if (in_array($extension, array('js', 'css'))) {
$filepath = $this->urlAssembler->assemble("base://$filepath", [
'query' => [
$this->state->get('system.css_js_query_string') ?: '0' => NULL,
],
'absolute' => TRUE,
]);
// If index.php is part of the generated URLs, we need to strip it.
//$filepath = str_replace('index.php/', '', $filepath);
}
list($prefix, $suffix) = $html[$extension];
$raw = $prefix . $filepath . $suffix;
if ($expected) {
$html_expected[] = Html::escape($raw);
$this->assertRaw($raw, "$label$name.$extension found.");
}
else {
$html_not_expected[] = Html::escape($raw);
$this->assertNoRaw($raw, "$label$name.$extension not found.");
}
}
}
$html_expected = '
' . implode('
', $html_expected) . '
';
$html_not_expected = '
' . implode('
', $html_not_expected) . '
';
$this->verbose("Strings of HTML that are expected to be present:{$html_expected}Strings of HTML that are expected to not be present:{$html_not_expected}");
}
}