ImageAdminStylesTest.php 15.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<?php

/**
 * @file
 * Definition of Drupal\image\Tests\ImageAdminStylesTest.
 */

namespace Drupal\image\Tests;

/**
 * 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);
    }

37
    return image_style_url($style->id(), $file_path) ? $file_path : FALSE;
38 39 40 41 42 43
  }

  /**
   * Count the number of images currently create for a style.
   */
  function getImageCount($style) {
44
    return count(file_scan_directory('public://styles/' . $style->id(), '/.*/'));
45 46 47 48 49 50 51 52
  }

  /**
   * Test creating an image style with a numeric name and ensuring it can be
   * applied to an image.
   */
  function testNumericStyleName() {
    $style_name = rand();
53
    $style_label = $this->randomString();
54 55
    $edit = array(
      'name' => $style_name,
56
      'label' => $style_label,
57 58
    );
    $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
59
    $this->assertRaw(t('Style %name was created.', array('%name' => $style_label)));
60
    $options = image_style_options();
61
    $this->assertTrue(array_key_exists($style_name, $options), format_string('Array key %key exists.', array('%key' => $style_name)));
62 63 64 65 66 67 68 69
  }

  /**
   * 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));
70
    $style_label = $this->randomString();
71
    $style_path = 'admin/config/media/image-styles/manage/' . $style_name;
72 73 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
    $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,
105
      'label' => $style_label,
106 107
    );
    $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
108
    $this->assertRaw(t('Style %name was created.', array('%name' => $style_label)));
109 110 111 112 113 114 115 116 117 118 119 120

    // 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'));
      }
    }

121
    // Load the saved image style.
122
    $style = entity_load('image_style', $style_name);
123 124 125 126
    // 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.');
127

128 129 130
    // Confirm that all effects on the image style have settings on the effect
    // edit form that match what was saved.
    $ieids = array();
131
    foreach ($style->effects as $ieid => $effect) {
132 133
      // Store the ieid for later use.
      $ieids[$effect['name']] = $ieid;
134 135
      $this->drupalGet($style_path . '/effects/' . $ieid);
      foreach ($effect_edits[$effect['name']] as $field => $value) {
136
        $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)));
137 138 139
      }
    }

140 141 142 143 144 145 146 147 148 149
    // 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],
        )));
    }

150 151 152 153 154
    // 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);
155
    $effects_order = array_values($style->effects);
156 157 158 159 160 161
    $order_correct = TRUE;
    foreach ($effects_order as $index => $effect) {
      if ($effect_edits_order[$index] != $effect['name']) {
        $order_correct = FALSE;
      }
    }
162
    $this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
163 164 165 166

    // Test the style overview form.
    // Change the name of the style and adjust the weights of effects.
    $style_name = strtolower($this->randomName(10));
167
    $style_label = $this->randomString();
168 169 170
    $weight = count($effect_edits);
    $edit = array(
      'name' => $style_name,
171
      'label' => $style_label,
172
    );
173
    foreach ($style->effects as $ieid => $effect) {
174 175 176 177 178 179
      $edit['effects[' . $ieid . '][weight]'] = $weight;
      $weight--;
    }

    // Create an image to make sure it gets flushed after saving.
    $image_path = $this->createSampleImage($style);
180
    $this->assertEqual($this->getImageCount($style), 1, format_string('Image style %style image %file successfully generated.', array('%style' => $style->label(), '%file' => $image_path)));
181 182 183 184

    $this->drupalPost($style_path, $edit, t('Update style'));

    // Note that after changing the style name, the style path is changed.
185
    $style_path = 'admin/config/media/image-styles/manage/' . $style_name;
186 187 188

    // Check that the URL was updated.
    $this->drupalGet($style_path);
189
    $this->assertResponse(200, format_string('Image style %original renamed to %new', array('%original' => $style->label(), '%new' => $style_name)));
190 191 192 193

    // 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.
194
    $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())));
195 196

    // Load the style by the new name with the new weights.
197
    $style = entity_load('image_style', $style_name);
198 199 200

    // Confirm the new style order was saved.
    $effect_edits_order = array_reverse($effect_edits_order);
201
    $effects_order = array_values($style->effects);
202 203 204 205 206 207
    $order_correct = TRUE;
    foreach ($effects_order as $index => $effect) {
      if ($effect_edits_order[$index] != $effect['name']) {
        $order_correct = FALSE;
      }
    }
208
    $this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
209 210 211 212 213

    // Image effect deletion form.

    // Create an image to make sure it gets flushed after deleting an effect.
    $image_path = $this->createSampleImage($style);
214
    $this->assertEqual($this->getImageCount($style), 1, format_string('Image style %style image %file successfully generated.', array('%style' => $style->label(), '%file' => $image_path)));
215

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
    // 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,
      )));
232 233 234 235

    // Style deletion form.

    // Delete the style.
236
    $this->drupalPost($style_path . '/delete', array(), t('Delete'));
237 238 239

    // Confirm the style directory has been removed.
    $directory = file_default_scheme() . '://styles/' . $style_name;
240
    $this->assertFalse(is_dir($directory), format_string('Image style %style directory removed on style deletion.', array('%style' => $style->label())));
241

242
    $this->assertFalse(entity_load('image_style', $style_name), format_string('Image style %style successfully deleted.', array('%style' => $style->label())));
243 244 245 246 247 248 249 250 251

  }

  /**
   * Test deleting a style and choosing a replacement style.
   */
  function testStyleReplacement() {
    // Create a new style.
    $style_name = strtolower($this->randomName(10));
252
    $style_label = $this->randomString();
253 254
    $style = entity_create('image_style', array('name' => $style_name, 'label' => $style_label));
    $style->save();
255
    $style_path = 'admin/config/media/image-styles/manage/';
256 257 258 259

    // Create an image field that uses the new style.
    $field_name = strtolower($this->randomName(10));
    $this->createImageField($field_name, 'article');
260 261 262 263 264 265
    entity_get_display('node', 'article', 'default')
      ->setComponent($field_name, array(
        'type' => 'image',
        'settings' => array('image_style' => $style_name),
      ))
      ->save();
266 267 268 269 270 271 272 273

    // 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);
274
    $this->assertRaw(image_style_url($style_name, file_load($node->{$field_name}[LANGUAGE_NOT_SPECIFIED][0]['fid'])->uri), format_string('Image displayed using style @style.', array('@style' => $style_name)));
275 276 277

    // Rename the style and make sure the image field is updated.
    $new_style_name = strtolower($this->randomName(10));
278
    $new_style_label = $this->randomString();
279 280
    $edit = array(
      'name' => $new_style_name,
281
      'label' => $new_style_label,
282
    );
283
    $this->drupalPost($style_path . $style_name, $edit, t('Update style'));
284
    $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)));
285
    $this->drupalGet('node/' . $nid);
286
    $this->assertRaw(image_style_url($new_style_name, file_load($node->{$field_name}[LANGUAGE_NOT_SPECIFIED][0]['fid'])->uri), 'Image displayed using style replacement style.');
287 288 289 290 291

    // Delete the style and choose a replacement style.
    $edit = array(
      'replacement' => 'thumbnail',
    );
292
    $this->drupalPost($style_path . $new_style_name . '/delete', $edit, t('Delete'));
293 294
    $message = t('Style %name was deleted.', array('%name' => $new_style_label));
    $this->assertRaw($message);
295 296

    $this->drupalGet('node/' . $nid);
297
    $this->assertRaw(image_style_url('thumbnail', file_load($node->{$field_name}[LANGUAGE_NOT_SPECIFIED][0]['fid'])->uri), 'Image displayed using style replacement style.');
298
  }
299 300 301 302 303 304 305

  /**
   * 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');
306
    $this->drupalPost(NULL, array('label' => 'Test style effect edit', 'name' => 'test_style_effect_edit'), t('Create new style'));
307 308 309 310 311 312 313 314 315 316 317 318 319 320
    $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');
321
    $this->drupalPost(NULL, array('label' => 'Test style scale edit scale', 'name' => 'test_style_scale_edit_scale'), t('Create new style'));
322 323 324 325 326 327 328 329 330 331 332 333 334 335
    $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'));
  }

336 337 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 365 366 367 368 369 370 371 372 373 374
  /**
   * 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_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);
    config_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.');
  }
375
}