Newer
Older
<?php
/**
* @file
* Definition of Drupal\image\Tests\ImageAdminStylesTest.
*/
namespace Drupal\image\Tests;
use Drupal\Core\Language\Language;
/**
* Tests creation, deletion, and editing of image styles and effects.
*/
class ImageAdminStylesTest extends ImageFieldTestBase {
public static function getInfo() {
return array(
'name' => 'Image styles and effects UI configuration',
'description' => 'Tests creation, deletion, and editing of image styles and effects at the UI level.',
'group' => 'Image',
);
}
/**
* Given an image style, generate an image.
*/
function createSampleImage($style) {
static $file_path;
// First, we need to make sure we have an image in our testing
// file directory. Copy over an image on the first run.
if (!isset($file_path)) {
$files = $this->drupalGetTestFiles('image');
$file = reset($files);
$file_path = file_unmanaged_copy($file->uri);
}
return image_style_url($style->id(), $file_path) ? $file_path : FALSE;
}
/**
* Count the number of images currently create for a style.
*/
function getImageCount($style) {
return count(file_scan_directory('public://styles/' . $style->id(), '/.*/'));
}
/**
* Test creating an image style with a numeric name and ensuring it can be
* applied to an image.
*/
function testNumericStyleName() {
$style_name = rand();
Angie Byron
committed
$style_label = $this->randomString();
$edit = array(
'name' => $style_name,
Angie Byron
committed
'label' => $style_label,
);
$this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
Angie Byron
committed
$this->assertRaw(t('Style %name was created.', array('%name' => $style_label)));
$options = image_style_options();
Angie Byron
committed
$this->assertTrue(array_key_exists($style_name, $options), format_string('Array key %key exists.', array('%key' => $style_name)));
}
/**
* General test to add a style, add/remove/edit effects to it, then delete it.
*/
function testStyle() {
// Setup a style to be created and effects to add to it.
$style_name = strtolower($this->randomName(10));
Angie Byron
committed
$style_label = $this->randomString();
Angie Byron
committed
$style_path = 'admin/config/media/image-styles/manage/' . $style_name;
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
$effect_edits = array(
'image_resize' => array(
'data[width]' => 100,
'data[height]' => 101,
),
'image_scale' => array(
'data[width]' => 110,
'data[height]' => 111,
'data[upscale]' => 1,
),
'image_scale_and_crop' => array(
'data[width]' => 120,
'data[height]' => 121,
),
'image_crop' => array(
'data[width]' => 130,
'data[height]' => 131,
'data[anchor]' => 'center-center',
),
'image_desaturate' => array(
// No options for desaturate.
),
'image_rotate' => array(
'data[degrees]' => 5,
'data[random]' => 1,
'data[bgcolor]' => '#FFFF00',
),
);
// Add style form.
$edit = array(
'name' => $style_name,
Angie Byron
committed
'label' => $style_label,
);
$this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
Angie Byron
committed
$this->assertRaw(t('Style %name was created.', array('%name' => $style_label)));
// Add effect form.
// Add each sample effect to the style.
foreach ($effect_edits as $effect => $edit) {
// Add the effect.
$this->drupalPost($style_path, array('new' => $effect), t('Add'));
if (!empty($edit)) {
$this->drupalPost(NULL, $edit, t('Add effect'));
}
}
Angie Byron
committed
// Load the saved image style.
$style = entity_load('image_style', $style_name);
Angie Byron
committed
// Ensure that the image style URI matches our expected path.
$style_uri = $style->uri();
$style_uri_path = url($style_uri['path'], $style_uri['options']);
$this->assertTrue(strpos($style_uri_path, $style_path) !== FALSE, 'The image style URI is correct.');
Angie Byron
committed
// Confirm that all effects on the image style have settings on the effect
// edit form that match what was saved.
$ieids = array();
foreach ($style->effects as $ieid => $effect) {
Angie Byron
committed
// Store the ieid for later use.
$ieids[$effect['name']] = $ieid;
$this->drupalGet($style_path . '/effects/' . $ieid);
foreach ($effect_edits[$effect['name']] as $field => $value) {
Angie Byron
committed
$this->assertFieldByName($field, $value, format_string('The %field field in the %effect effect has the correct value of %value.', array('%field' => $field, '%effect' => $effect['name'], '%value' => $value)));
Angie Byron
committed
// Assert that every effect was saved.
foreach (array_keys($effect_edits) as $effect_name) {
$this->assertTrue(isset($ieids[$effect_name]), format_string(
'A %effect_name effect was saved with ID %ieid',
array(
'%effect_name' => $effect_name,
'%ieid' => $ieids[$effect_name],
)));
}
// Image style overview form (ordering and renaming).
// Confirm the order of effects is maintained according to the order we
// added the fields.
$effect_edits_order = array_keys($effect_edits);
$effects_order = array_values($style->effects);
$order_correct = TRUE;
foreach ($effects_order as $index => $effect) {
if ($effect_edits_order[$index] != $effect['name']) {
$order_correct = FALSE;
}
}
Angie Byron
committed
$this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
// Test the style overview form.
// Change the name of the style and adjust the weights of effects.
$style_name = strtolower($this->randomName(10));
Angie Byron
committed
$style_label = $this->randomString();
$weight = count($effect_edits);
$edit = array(
'name' => $style_name,
Angie Byron
committed
'label' => $style_label,
foreach ($style->effects as $ieid => $effect) {
$edit['effects[' . $ieid . '][weight]'] = $weight;
$weight--;
}
// Create an image to make sure it gets flushed after saving.
$image_path = $this->createSampleImage($style);
$this->assertEqual($this->getImageCount($style), 1, format_string('Image style %style image %file successfully generated.', array('%style' => $style->label(), '%file' => $image_path)));
$this->drupalPost($style_path, $edit, t('Update style'));
// Note that after changing the style name, the style path is changed.
Angie Byron
committed
$style_path = 'admin/config/media/image-styles/manage/' . $style_name;
// Check that the URL was updated.
$this->drupalGet($style_path);
$this->assertResponse(200, format_string('Image style %original renamed to %new', array('%original' => $style->label(), '%new' => $style_name)));
// Check that the image was flushed after updating the style.
// This is especially important when renaming the style. Make sure that
// the old image directory has been deleted.
$this->assertEqual($this->getImageCount($style), 0, format_string('Image style %style was flushed after renaming the style and updating the order of effects.', array('%style' => $style->label())));
// Load the style by the new name with the new weights.
$style = entity_load('image_style', $style_name);
// Confirm the new style order was saved.
$effect_edits_order = array_reverse($effect_edits_order);
$effects_order = array_values($style->effects);
$order_correct = TRUE;
foreach ($effects_order as $index => $effect) {
if ($effect_edits_order[$index] != $effect['name']) {
$order_correct = FALSE;
}
}
Dries Buytaert
committed
$this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
// Image effect deletion form.
// Create an image to make sure it gets flushed after deleting an effect.
$image_path = $this->createSampleImage($style);
$this->assertEqual($this->getImageCount($style), 1, format_string('Image style %style image %file successfully generated.', array('%style' => $style->label(), '%file' => $image_path)));
Angie Byron
committed
// Delete the 'image_crop' effect from the style.
$this->drupalPost($style_path . '/effects/' . $ieids['image_crop'] . '/delete', array(), t('Delete'));
// Confirm that the form submission was successful.
$this->assertResponse(200);
$this->assertRaw(t('The image effect %name has been deleted.', array('%name' => $style->effects[$ieids['image_crop']]['label'])));
// Confirm that there is no longer a link to the effect.
$this->assertNoLinkByHref($style_path . '/effects/' . $ieids['image_crop'] . '/delete');
// Refresh the image style information and verify that the effect was
// actually deleted.
$style = entity_load_unchanged('image_style', $style->id());
$this->assertFalse(isset($style->effects[$ieids['image_crop']]), format_string(
'Effect with ID %ieid no longer found on image style %style',
array(
'%ieid' => $ieids['image_crop'],
'%style' => $style->label,
)));
// Style deletion form.
// Delete the style.
Angie Byron
committed
$this->drupalPost($style_path . '/delete', array(), t('Delete'));
// Confirm the style directory has been removed.
$directory = file_default_scheme() . '://styles/' . $style_name;
$this->assertFalse(is_dir($directory), format_string('Image style %style directory removed on style deletion.', array('%style' => $style->label())));
$this->assertFalse(entity_load('image_style', $style_name), format_string('Image style %style successfully deleted.', array('%style' => $style->label())));
}
/**
* Test deleting a style and choosing a replacement style.
*/
function testStyleReplacement() {
// Create a new style.
$style_name = strtolower($this->randomName(10));
Angie Byron
committed
$style_label = $this->randomString();
$style = entity_create('image_style', array('name' => $style_name, 'label' => $style_label));
$style->save();
Angie Byron
committed
$style_path = 'admin/config/media/image-styles/manage/';
// Create an image field that uses the new style.
$field_name = strtolower($this->randomName(10));
$this->createImageField($field_name, 'article');
entity_get_display('node', 'article', 'default')
->setComponent($field_name, array(
'type' => 'image',
'settings' => array('image_style' => $style_name),
))
->save();
// Create a new node with an image attached.
$test_image = current($this->drupalGetTestFiles('image'));
$nid = $this->uploadNodeImage($test_image, $field_name, 'article');
$node = node_load($nid);
// Test that image is displayed using newly created style.
$this->drupalGet('node/' . $nid);
$this->assertRaw(image_style_url($style_name, file_load($node->{$field_name}[Language::LANGCODE_NOT_SPECIFIED][0]['fid'])->uri), format_string('Image displayed using style @style.', array('@style' => $style_name)));
// Rename the style and make sure the image field is updated.
$new_style_name = strtolower($this->randomName(10));
Angie Byron
committed
$new_style_label = $this->randomString();
$edit = array(
'name' => $new_style_name,
Angie Byron
committed
'label' => $new_style_label,
Angie Byron
committed
$this->drupalPost($style_path . $style_name, $edit, t('Update style'));
Dries Buytaert
committed
$this->assertText(t('Changes to the style have been saved.'), format_string('Style %name was renamed to %new_name.', array('%name' => $style_name, '%new_name' => $new_style_name)));
$this->drupalGet('node/' . $nid);
$this->assertRaw(image_style_url($new_style_name, file_load($node->{$field_name}[Language::LANGCODE_NOT_SPECIFIED][0]['fid'])->uri), 'Image displayed using style replacement style.');
// Delete the style and choose a replacement style.
$edit = array(
'replacement' => 'thumbnail',
);
Angie Byron
committed
$this->drupalPost($style_path . $new_style_name . '/delete', $edit, t('Delete'));
Angie Byron
committed
$message = t('Style %name was deleted.', array('%name' => $new_style_label));
$this->assertRaw($message);
$this->drupalGet('node/' . $nid);
$this->assertRaw(image_style_url('thumbnail', file_load($node->{$field_name}[Language::LANGCODE_NOT_SPECIFIED][0]['fid'])->uri), 'Image displayed using style replacement style.');
Angie Byron
committed
/**
* Verifies that editing an image effect does not cause it to be duplicated.
*/
function testEditEffect() {
// Add a scale effect.
$this->drupalGet('admin/config/media/image-styles/add');
Angie Byron
committed
$this->drupalPost(NULL, array('label' => 'Test style effect edit', 'name' => 'test_style_effect_edit'), t('Create new style'));
Angie Byron
committed
$this->drupalPost(NULL, array('new' => 'image_scale_and_crop'), t('Add'));
$this->drupalPost(NULL, array('data[width]' => '300', 'data[height]' => '200'), t('Add effect'));
$this->assertText(t('Scale and crop 300x200'));
// There should normally be only one edit link on this page initially.
$this->clickLink(t('edit'));
$this->drupalPost(NULL, array('data[width]' => '360', 'data[height]' => '240'), t('Update effect'));
$this->assertText(t('Scale and crop 360x240'));
// Check that the previous effect is replaced.
$this->assertNoText(t('Scale and crop 300x200'));
// Add another scale effect.
$this->drupalGet('admin/config/media/image-styles/add');
Angie Byron
committed
$this->drupalPost(NULL, array('label' => 'Test style scale edit scale', 'name' => 'test_style_scale_edit_scale'), t('Create new style'));
Angie Byron
committed
$this->drupalPost(NULL, array('new' => 'image_scale'), t('Add'));
$this->drupalPost(NULL, array('data[width]' => '12', 'data[height]' => '19'), t('Add effect'));
// Edit the scale effect that was just added.
$this->clickLink(t('edit'));
$this->drupalPost(NULL, array('data[width]' => '24', 'data[height]' => '19'), t('Update effect'));
$this->drupalPost(NULL, array('new' => 'image_scale'), t('Add'));
// Add another scale effect and make sure both exist.
$this->drupalPost(NULL, array('data[width]' => '12', 'data[height]' => '19'), t('Add effect'));
$this->assertText(t('Scale 24x19'));
$this->assertText(t('Scale 12x19'));
}
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/**
* Tests image style configuration import that does a delete.
*/
function testConfigImport() {
// Create a new style.
$style_name = strtolower($this->randomName(10));
$style_label = $this->randomString();
$style = entity_create('image_style', array('name' => $style_name, 'label' => $style_label));
$style->save();
// Create an image field that uses the new style.
$field_name = strtolower($this->randomName(10));
$this->createImageField($field_name, 'article');
entity_get_display('node', 'article', 'default')
->setComponent($field_name, array(
'type' => 'image',
'settings' => array('image_style' => $style_name),
))
->save();
// Create a new node with an image attached.
$test_image = current($this->drupalGetTestFiles('image'));
$nid = $this->uploadNodeImage($test_image, $field_name, 'article');
$node = node_load($nid);
// Test that image is displayed using newly created style.
$this->drupalGet('node/' . $nid);
$this->assertRaw(image_style_url($style_name, file_load($node->{$field_name}[Language::LANGCODE_NOT_SPECIFIED][0]['fid'])->uri), format_string('Image displayed using style @style.', array('@style' => $style_name)));
// Write empty manifest to staging.
$manifest_data = config('manifest.image.style')->get();
unset($manifest_data[$style_name]);
$staging = $this->container->get('config.storage.staging');
$staging->write('manifest.image.style', $manifest_data);
$this->configImporter()->import();
$this->assertFalse(entity_load('image_style', $style_name), 'Style deleted after config import.');
$this->assertEqual($this->getImageCount($style), 0, 'Image style was flushed after being deleted by config import.');
}