try: from distutils.spawn import find_executable except: find_executable = lambda f: None from datetime import datetime import inspect import logging import os import shutil import subprocess import sys import tempfile import time from unittest import SkipTest import django from django.conf import settings from django.contrib.admin.sites import site as admin_site from django.test import override_settings from django.utils.six.moves.urllib.parse import urlparse, urlunparse, ParseResult from selenium.webdriver.common.action_chains import ActionChains from storages.backends.s3boto3 import S3Boto3Storage from nested_admin.tests.base import ( BaseNestedAdminTestCase, get_model_name, expected_failure_if_suit) from .models import ( PlainStackedRoot, PlainTabularRoot, NestedStackedRoot, NestedTabularRoot) logger = logging.getLogger(__name__) def strip_query_from_url(url): parts = list(urlparse(url)) parts[ParseResult._fields.index('query')] = '' return urlunparse(parts) class disable_string_if_invalid_for_grappelli(override_settings): def __init__(self): self.options = {"TEMPLATES": [settings.TEMPLATES[0].copy()]} if 'grappelli' in settings.INSTALLED_APPS: self.options['TEMPLATES'][0]['OPTIONS'].pop('string_if_invalid') @disable_string_if_invalid_for_grappelli() class VisualComparisonTestCase(BaseNestedAdminTestCase): root_model = None root_models = [PlainStackedRoot, PlainTabularRoot, NestedStackedRoot, NestedTabularRoot] storage = None @classmethod def setUpClass(cls): cls.blinkdiff_bin = os.environ.get('BLINKDIFF_BIN') if not cls.blinkdiff_bin: cls.blinkdiff_bin = find_executable('blink-diff') if not cls.blinkdiff_bin or not os.path.exists(cls.blinkdiff_bin): raise SkipTest("blink-diff not installed") cls.screenshot_output_dir = os.environ.get('SCREENSHOT_OUTPUT_DIR') super(BaseNestedAdminTestCase, cls).setUpClass() cls.root_temp_dir = tempfile.mkdtemp() if os.environ.get('TRAVIS_BUILD_NUMBER'): # For some reason these tests fail on travis when Django > 1.11 if django.VERSION > (1, 11): raise SkipTest("Issue with travis and Django >= 1.11") cls.path_prefix = "travis_%s" % os.environ['TRAVIS_BUILD_NUMBER'] else: cls.path_prefix = "local_%s" % datetime.now().strftime('%Y%m%dT%H%M%S') if all(k in os.environ for k in ['AWS_ACCESS_KEY_ID', 'AWS_SECRET_ACCESS_KEY']): try: storage = S3Boto3Storage() bucket = storage.bucket # noqa except: pass else: cls.storage = storage cls.all_models = {} cls.all_model_names = {} for root_model in cls.root_models: root_admin = admin_site._registry[root_model] def descend_admin_inlines(admin): data = [admin.model, []] for inline in (getattr(admin, 'inlines', None) or []): data[1].append(descend_admin_inlines(inline)) return data cls.all_models[root_model] = models = descend_admin_inlines(root_admin) def recursive_map_model_names(data): if isinstance(data, list): return [m for m in map(recursive_map_model_names, data)] else: return get_model_name(data) cls.all_model_names[root_model] = recursive_map_model_names(models) @classmethod def tearDownClass(cls): super(VisualComparisonTestCase, cls).tearDownClass() shutil.rmtree(cls.root_temp_dir) def setUp(self): super(VisualComparisonTestCase, self).setUp() self.temp_dir = tempfile.mkdtemp(dir=self.root_temp_dir) os.makedirs(os.path.join(self.temp_dir, self.path_prefix)) self.selenium.set_window_size(780, 600) @property def models(self): return self.all_models[self.root_model] @property def model_names(self): return self.all_model_names[self.root_model] def assertSameScreenshot(self, a, b, extra_args=None): diff_output_path = a.replace('_a.png', '_diff.png') args = [ self.blinkdiff_bin, "--verbose", "--threshold", "1", "--delta", "0", "--output", diff_output_path] if self.has_suit: to_block = ['#suit-left', '#header'] for selector in to_block: el = self.selenium.find_element_by_css_selector(selector) args += ['--block-out', "%(x)s,%(y)s,%(w)s,%(h)s" % { 'x': el.location['x'], 'y': el.location['y'], 'w': el.size['width'], 'h': el.size['height'], }] if extra_args: args += extra_args args += [a, b] p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, _ = p.communicate() if p.returncode == 0: # No differences found if self.screenshot_output_dir: os.unlink(a) os.unlink(b) os.unlink(diff_output_path) return else: logger.info(stdout) msg = "Screenshots do not match" if self.storage: s3_name = "%s/%s" % (self.path_prefix, os.path.basename(diff_output_path)) with open(diff_output_path, 'rb') as f: s3_name = self.storage.save(s3_name, f) s3_url = strip_query_from_url(self.storage.url(s3_name)) msg = "%s (See <%s>)" % (msg, s3_url) elif self.screenshot_output_dir: msg = "%s (See %s)" % (msg, diff_output_path) raise AssertionError(msg) def get_admin_screenshot(self): name = inspect.stack()[1][3] prefix = "%s/py%s%s_dj%s%s" % ( (self.path_prefix,) + sys.version_info[:2] + django.VERSION[:2]) if self.has_grappelli: prefix += "_grp" elif self.has_suit: prefix += "_suit" output_dir = self.screenshot_output_dir or self.temp_dir suffix = ('a' if self.root_model.__name__.startswith('Plain') else 'b') image_path = os.path.join(output_dir, "%s_%s_%s.png" % (prefix, name, suffix)) # Move mouse to a consistent place, to avoid hover styles confusing things body_element = self.selenium.execute_script('return document.body') (ActionChains(self.selenium) .move_to_element_with_offset(body_element, 0, 0) .perform()) time.sleep(0.2) self.selenium.save_screenshot(image_path) return image_path def add_inline(self): child_model = self.models[1][0][0] verbose_name = child_model._meta.verbose_name.title() with self.clickable_xpath('//a[contains(string(.), "Add another %s")]' % verbose_name) as el: el.click() def test_stacked_empty(self): screenshots = [] for model in [PlainStackedRoot, NestedStackedRoot]: self.root_model = model self.load_admin() screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) @expected_failure_if_suit def test_tabular_empty(self): screenshots = [] for model in [PlainTabularRoot, NestedTabularRoot]: self.root_model = model self.load_admin() screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) @expected_failure_if_suit def test_tabular_one_item(self): screenshots = [] for model in [PlainTabularRoot, NestedTabularRoot]: self.root_model = model child_model = self.models[1][0][0] root = model.objects.create(slug='a') child_model.objects.create(slug='b', root=root, position=0) self.load_admin(obj=root) screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) def test_stacked_one_item(self): screenshots = [] for model in [PlainStackedRoot, NestedStackedRoot]: self.root_model = model child_model = self.models[1][0][0] root = model.objects.create(slug='a') child_model.objects.create(slug='b', root=root, position=0) self.load_admin(obj=root) screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) @expected_failure_if_suit def test_tabular_added_item(self): screenshots = [] for model in [PlainTabularRoot, NestedTabularRoot]: self.root_model = model self.load_admin() self.add_inline() screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) def test_stacked_added_item(self): screenshots = [] for model in [PlainStackedRoot, NestedStackedRoot]: self.root_model = model self.load_admin() self.add_inline() screenshots.append(self.get_admin_screenshot()) self.assertSameScreenshot(*screenshots) @expected_failure_if_suit def test_tabular_validation_error(self): screenshots = [] for model in [PlainTabularRoot, NestedTabularRoot]: self.root_model = model self.load_admin() if self.has_suit: self.selenium.set_window_size(1400, 800) self.add_inline() with self.clickable_selector('#id_slug') as el: el.send_keys('a') with self.clickable_selector('#id_children-0-slug') as el: el.send_keys('b') self.save_form() screenshots.append(self.get_admin_screenshot()) extra_args = [] if not self.has_grappelli: # django has a bug where it doesn't show the 'Remove' link # if there is a validationerror on a newly added inline # see delete_col = self.selenium.find_element_by_css_selector('#children-0 .delete') extra_args += ['--block-out', "%(x)s,%(y)s,%(w)s,%(h)s" % { 'x': delete_col.location['x'], 'y': delete_col.location['y'], 'w': delete_col.size['width'], 'h': delete_col.size['height'], }] self.assertSameScreenshot(*screenshots, extra_args=extra_args) @expected_failure_if_suit def test_stacked_validation_error(self): screenshots = [] for model in [PlainStackedRoot, NestedStackedRoot]: self.root_model = model self.load_admin() self.add_inline() with self.clickable_selector('#id_slug') as el: el.send_keys('a') with self.clickable_selector('#id_children-0-slug') as el: el.send_keys('b') self.save_form() screenshots.append(self.get_admin_screenshot()) extra_args = [] if not self.has_grappelli: # django has a bug where it doesn't show the 'Remove' link # if there is a validationerror on a newly added inline # see delete_col = self.selenium.find_element_by_css_selector('#children-0 .inline-deletelink') extra_args += ['--block-out', "%(x)s,%(y)s,%(w)s,%(h)s" % { 'x': delete_col.location['x'], 'y': delete_col.location['y'], 'w': delete_col.size['width'], 'h': delete_col.size['height'], }] self.assertSameScreenshot(*screenshots, extra_args=extra_args)