class ImageAdminStylesUnitTest

class ImageAdminStylesUnitTest extends ImageFieldTestCase {
    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',
        );
    }
    function setUp() {
        parent::setUp('image_module_test', 'image_module_styles_test');
    }
    
    /**
     * 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['name'], $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['name'], '/.*/'));
    }
    
    /**
     * Test creating an image style with a numeric name and ensuring it can be
     * applied to an image.
     */
    function testNumericStyleName() {
        $style_name = rand();
        $style_label = $this->randomString();
        $edit = array(
            'name' => $style_name,
            'label' => $style_label,
        );
        $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
        $this->assertRaw(t('Style %name was created.', array(
            '%name' => $style_label,
        )), 'Image style successfully created.');
        $options = image_style_options();
        $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));
        $style_label = $this->randomString();
        $style_path = 'admin/config/media/image-styles/edit/' . $style_name;
        $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(),
            'image_rotate' => array(
                'data[degrees]' => 5,
                'data[random]' => 1,
                'data[bgcolor]' => '#FFFF00',
            ),
        );
        // Add style form.
        $edit = array(
            'name' => $style_name,
            'label' => $style_label,
        );
        $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
        $this->assertRaw(t('Style %name was created.', array(
            '%name' => $style_label,
        )), 'Image style successfully created.');
        // 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'));
            }
        }
        // Edit effect form.
        // Revisit each form to make sure the effect was saved.
        drupal_static_reset('image_styles');
        $style = image_style_load($style_name);
        foreach ($style['effects'] as $ieid => $effect) {
            $this->drupalGet($style_path . '/effects/' . $ieid);
            foreach ($effect_edits[$effect['name']] as $field => $value) {
                $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,
                )));
            }
        }
        // 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;
            }
        }
        $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));
        $style_label = $this->randomString();
        $weight = count($effect_edits);
        $edit = array(
            'name' => $style_name,
            '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.
        $style_path = 'admin/config/media/image-styles/edit/' . $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_label,
        )));
        // 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.
        drupal_static_reset('image_styles');
        $style = image_style_load($style_name, NULL);
        // 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;
            }
        }
        $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,
        )));
        // Test effect deletion form.
        $effect = array_pop($style['effects']);
        $this->drupalPost($style_path . '/effects/' . $effect['ieid'] . '/delete', array(), t('Delete'));
        $this->assertRaw(t('The image effect %name has been deleted.', array(
            '%name' => $effect['label'],
        )), 'Image effect deleted.');
        // Style deletion form.
        // Delete the style.
        $this->drupalPost('admin/config/media/image-styles/delete/' . $style_name, 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'],
        )));
        drupal_static_reset('image_styles');
        $this->assertFalse(image_style_load($style_name), format_string('Image style %style successfully deleted.', array(
            '%style' => $style['label'],
        )));
    }
    
    /**
     * Test to override, edit, then revert a style.
     */
    function testDefaultStyle() {
        // Setup a style to be created and effects to add to it.
        $style_name = 'thumbnail';
        $style_label = 'Thumbnail (100x100)';
        $edit_path = 'admin/config/media/image-styles/edit/' . $style_name;
        $delete_path = 'admin/config/media/image-styles/delete/' . $style_name;
        $revert_path = 'admin/config/media/image-styles/revert/' . $style_name;
        // Ensure deleting a default is not possible.
        $this->drupalGet($delete_path);
        $this->assertText(t('Page not found'), 'Default styles may not be deleted.');
        // Ensure that editing a default is not possible (without overriding).
        $this->drupalGet($edit_path);
        $disabled_field = $this->xpath('//input[@id=:id and @disabled="disabled"]', array(
            ':id' => 'edit-name',
        ));
        $this->assertTrue($disabled_field, 'Default styles may not be renamed.');
        $this->assertNoField('edit-submit', 'Default styles may not be edited.');
        $this->assertNoField('edit-add', 'Default styles may not have new effects added.');
        // Create an image to make sure the default works before overriding.
        drupal_static_reset('image_styles');
        $style = image_style_load($style_name);
        $image_path = $this->createSampleImage($style);
        $this->assertEqual($this->getImageCount($style), 1, format_string('Image style %style image %file successfully generated.', array(
            '%style' => $style['name'],
            '%file' => $image_path,
        )));
        // Verify that effects attached to a default style do not have an ieid key.
        foreach ($style['effects'] as $effect) {
            $this->assertFalse(isset($effect['ieid']), format_string('The %effect effect does not have an ieid.', array(
                '%effect' => $effect['name'],
            )));
        }
        // Override the default.
        $this->drupalPost($edit_path, array(), t('Override defaults'));
        $this->assertRaw(t('The %style style has been overridden, allowing you to change its settings.', array(
            '%style' => $style_label,
        )), 'Default image style may be overridden.');
        // Add sample effect to the overridden style.
        $this->drupalPost($edit_path, array(
            'new' => 'image_desaturate',
        ), t('Add'));
        drupal_static_reset('image_styles');
        $style = image_style_load($style_name);
        // Verify that effects attached to the style have an ieid now.
        foreach ($style['effects'] as $effect) {
            $this->assertTrue(isset($effect['ieid']), format_string('The %effect effect has an ieid.', array(
                '%effect' => $effect['name'],
            )));
        }
        // The style should now have 2 effect, the original scale provided by core
        // and the desaturate effect we added in the override.
        $effects = array_values($style['effects']);
        $this->assertEqual($effects[0]['name'], 'image_scale', 'The default effect still exists in the overridden style.');
        $this->assertEqual($effects[1]['name'], 'image_desaturate', 'The added effect exists in the overridden style.');
        // Check that we are able to rename an overridden style.
        $this->drupalGet($edit_path);
        $disabled_field = $this->xpath('//input[@id=:id and @disabled="disabled"]', array(
            ':id' => 'edit-name',
        ));
        $this->assertFalse($disabled_field, 'Overridden styles may be renamed.');
        // Create an image to ensure the override works properly.
        $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,
        )));
        // Revert the image style.
        $this->drupalPost($revert_path, array(), t('Revert'));
        drupal_static_reset('image_styles');
        $style = image_style_load($style_name);
        // The style should now have the single effect for scale.
        $effects = array_values($style['effects']);
        $this->assertEqual($effects[0]['name'], 'image_scale', 'The default effect still exists in the reverted style.');
        $this->assertFalse(array_key_exists(1, $effects), 'The added effect has been removed in the reverted style.');
        // Verify that a new style with the same name as the default one could not
        // be created.
        $edit = array(
            'name' => $style_name,
            'label' => $style_label,
        );
        // The default style is not overriden.
        $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
        $this->assertNoRaw(t('Style %name was created.', array(
            '%name' => $style_label,
        )), 'Image style successfully created.');
        // Override the default.
        $this->drupalPost($edit_path, array(), t('Override defaults'));
        $this->assertRaw(t('The %style style has been overridden, allowing you to change its settings.', array(
            '%style' => $style_label,
        )), 'Default image style may be overridden.');
        // The default style is overriden.
        $this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
        $this->assertNoRaw(t('Style %name was created.', array(
            '%name' => $style_label,
        )), 'Image style successfully created.');
        // Revert the image style.
        $this->drupalPost($revert_path, array(), t('Revert'));
        drupal_static_reset('image_styles');
    }
    
    /**
     * Test deleting a style and choosing a replacement style.
     */
    function testStyleReplacement() {
        // Create a new style.
        $style_name = strtolower($this->randomName(10));
        $style_label = $this->randomString();
        image_style_save(array(
            'name' => $style_name,
            'label' => $style_label,
        ));
        $style_path = 'admin/config/media/image-styles/edit/' . $style_name;
        // Create an image field that uses the new style.
        $field_name = strtolower($this->randomName(10));
        $this->createImageField($field_name, 'article');
        $instance = field_info_instance('node', $field_name, 'article');
        $instance['display']['default']['type'] = 'image';
        $instance['display']['default']['settings']['image_style'] = $style_name;
        field_update_instance($instance);
        // 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(check_plain(image_style_url($style_name, $node->{$field_name}[LANGUAGE_NONE][0]['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));
        $new_style_label = $this->randomString();
        $edit = array(
            'name' => $new_style_name,
            'label' => $new_style_label,
        );
        $this->drupalPost('admin/config/media/image-styles/edit/' . $style_name, $edit, t('Update style'));
        $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(check_plain(image_style_url($new_style_name, $node->{$field_name}[LANGUAGE_NONE][0]['uri'])), format_string('Image displayed using style replacement style.'));
        // Delete the style and choose a replacement style.
        $edit = array(
            'replacement' => 'thumbnail',
        );
        $this->drupalPost('admin/config/media/image-styles/delete/' . $new_style_name, $edit, t('Delete'));
        $message = t('Style %name was deleted.', array(
            '%name' => $new_style_label,
        ));
        $this->assertRaw($message, $message);
        $this->drupalGet('node/' . $nid);
        $this->assertRaw(check_plain(image_style_url('thumbnail', $node->{$field_name}[LANGUAGE_NONE][0]['uri'])), format_string('Image displayed using style replacement style.'));
    }
    
    /**
     * Test disabling a module providing an effect in use by an image style.
     */
    function testOrphanedEffect() {
        // This will not check whether anything depends on the module.
        module_disable(array(
            'image_module_test',
        ), FALSE);
        $this->drupalGet('admin/config/media/image-styles');
        $this->assertText('Test Image Style', 'Image style with an orphaned effect displayed in the list of styles.');
        $image_log = db_query_range('SELECT message FROM {watchdog} WHERE type = :type ORDER BY wid DESC', 0, 1, array(
            ':type' => 'image',
        ))->fetchField();
        $this->assertEqual('Image style %style_name has an effect %effect_name with no definition.', $image_log, 'A watchdog message was logged for the broken image style effect');
    }

}