"""
Utilities for view tests.
"""

import json

from contentstore.tests.utils import CourseTestCase
from contentstore.views.helpers import xblock_studio_url
from xmodule.modulestore.tests.factories import ItemFactory


class StudioPageTestCase(CourseTestCase):
    """
    Base class for all tests of Studio pages.
    """

    def setUp(self):
        super(StudioPageTestCase, self).setUp()
        self.chapter = ItemFactory.create(parent_location=self.course.location,
                                          category='chapter', display_name="Week 1")
        self.sequential = ItemFactory.create(parent_location=self.chapter.location,
                                             category='sequential', display_name="Lesson 1")

    def get_page_html(self, xblock):
        """
        Returns the HTML for the page representing the xblock.
        """
        url = xblock_studio_url(xblock)
        self.assertIsNotNone(url)
        resp = self.client.get_html(url)
        self.assertEqual(resp.status_code, 200)
        return resp.content

    def get_preview_html(self, xblock, view_name):
        """
        Returns the HTML for the xblock when shown within a unit or container page.
        """
        preview_url = '/xblock/{usage_key}/{view_name}'.format(usage_key=xblock.location, view_name=view_name)
        resp = self.client.get_json(preview_url)
        self.assertEqual(resp.status_code, 200)
        resp_content = json.loads(resp.content)
        return resp_content['html']

    def validate_preview_html(self, xblock, view_name, can_add=True):
        """
        Verify that the specified xblock's preview has the expected HTML elements.
        """
        html = self.get_preview_html(xblock, view_name)
        self.validate_html_for_add_buttons(html, can_add)

        # Verify drag handles always appear.
        drag_handle_html = '<span data-tooltip="Drag to reorder" class="drag-handle action"></span>'
        self.assertIn(drag_handle_html, html)

        # Verify that there are no action buttons for public blocks
        expected_button_html = [
            '<a href="#" class="edit-button action-button">',
            '<a href="#" data-tooltip="Delete" class="delete-button action-button">',
            '<a href="#" data-tooltip="Duplicate" class="duplicate-button action-button">'
        ]
        for button_html in expected_button_html:
            self.assertIn(button_html, html)

    def validate_html_for_add_buttons(self, html, can_add=True):
        """
        Validate that the specified HTML has the appropriate add actions for the current publish state.
        """
        # Verify that there are no add buttons for public blocks
        add_button_html = '<div class="add-xblock-component new-component-item adding"></div>'
        if can_add:
            self.assertIn(add_button_html, html)
        else:
            self.assertNotIn(add_button_html, html)