mapnik/tests/visual_tests/test.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import mapnik
mapnik.logger.set_severity(mapnik.severity_type.None)

import sys
import os.path
from compare import compare, compare_grids, summary, fail

try:
    import json
except ImportError:
    import simplejson as json

visual_output_dir = "/tmp/mapnik-visual-images"

defaults = {
    'sizes': [(500, 100)],
    'scales':[1.0,2.0],
    'agg': True,
    'cairo': True,
    'grid': True,
}

sizes_many_in_big_range = [(800, 100), (600, 100), (400, 100),
    (300, 100), (250, 100), (150, 100), (100, 100)]

sizes_few_square = [(800, 800), (600, 600), (400, 400), (200, 200)]
sizes_many_in_small_range = [(490, 100), (495, 100), (497, 100), (498, 100),
    (499, 100), (500, 100), (501, 100), (502, 100), (505, 100), (510, 100)]

default_text_box = mapnik.Box2d(-0.05, -0.01, 0.95, 0.01)

dirname = os.path.dirname(__file__)

text_tests = [
    {'name': "list", 'sizes': sizes_many_in_big_range,'bbox':default_text_box},
    {'name': "simple", 'sizes': sizes_many_in_big_range,'bbox':default_text_box},
    {'name': "lines-1", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "lines-2", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "lines-3", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "lines-4", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "lines-5", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "lines-6", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "formatting", 'bbox':default_text_box},
    # https://github.com/mapnik/mapnik/issues/1696
    # https://github.com/mapnik/mapnik/issues/1521
    # fails with clang++ on os x
    #{'name': "lines-shield", 'sizes': sizes_few_square,'bbox':default_text_box},
    {'name': "collision", 'sizes':[(600,400)]},
    {'name': "text-halo-rasterizer", 'sizes':[(600,400)]},
    {'name': "simple-E", 'bbox':default_text_box},
    {'name': "simple-NE",'bbox':default_text_box},
    {'name': "simple-NW",'bbox':default_text_box},
    {'name': "simple-N",'bbox':default_text_box},
    {'name': "simple-SE",'bbox':default_text_box},
    {'name': "simple-SW",'bbox':default_text_box},
    {'name': "simple-S",'bbox':default_text_box},
    {'name': "simple-W",'bbox':default_text_box},
    {'name': "formatting-1",'bbox':default_text_box},
    {'name': "formatting-2",'bbox':default_text_box},
    {'name': "formatting-3",'bbox':default_text_box},
    {'name': "formatting-4",'bbox':default_text_box},
    {'name': "expressionformat",'bbox':default_text_box},
    {'name': "shieldsymbolizer-1", 'sizes': sizes_many_in_small_range,'bbox':default_text_box},
    {'name': "shieldsymbolizer-2", 'bbox':default_text_box},
    {'name': "shieldsymbolizer-3", 'bbox':default_text_box},
    {'name': "shieldsymbolizer-4", 'bbox':default_text_box},
    {'name': "orientation", 'sizes': [(800, 200)], 'bbox':default_text_box},
    {'name': "hb-fontsets", 'sizes': [(800, 200)], 'bbox':default_text_box},
    {'name': "charspacing", 'sizes': [(200, 400)], 'bbox':default_text_box},
    {'name': "line_break", 'sizes': [(800, 800)], 'bbox':default_text_box},
    {'name': "rtl-point", 'sizes': [(200, 200)],'bbox':default_text_box},
    {'name': "jalign-auto", 'sizes': [(200, 200)],'bbox':default_text_box},
    {'name': "line-offset", 'sizes':[(900, 250)],'bbox': mapnik.Box2d(-5.192, 50.189, -5.174, 50.195)},
]

tiff_tests = [
    {'name': "tiff-alpha-gdal", 'sizes':[(600,400)]},
    {'name': "tiff-alpha-broken-assoc-alpha-gdal", 'sizes':[(600,400)]},
    {'name': "tiff-alpha-gradient-gdal", 'sizes':[(600,400)]},
    {'name': "tiff-nodata-edge-gdal", 'sizes':[(600,400),(969,793)]},
    {'name': "tiff-opaque-edge-gdal", 'sizes':[(256,256),(969,793)]},
    {'name': "tiff-opaque-edge-gdal2", 'sizes':[(600,400),(969,793)]},
    {'name': "tiff-opaque-edge-raster2", 'sizes':[(600,400),(969,793)]},
    {'name': "tiff-resampling", 'sizes':[(600,400)]},
    # https://github.com/mapnik/mapnik/issues/1622
    {'name': "tiff-edge-alignment-gdal1", 'sizes':[(256,256),(255,257)],
	'bbox':mapnik.Box2d(-13267022.12540147,4618019.500877209,-13247454.246160466,4637587.380118214)
    },
    {'name': "tiff-edge-alignment-gdal2", 'sizes':[(256,256),(255,257)],
	'bbox':mapnik.Box2d(-13267022.12540147,4598451.621636203,-13247454.246160466,4618019.500877209)
    },
    # https://github.com/mapnik/mapnik/issues/1520
    # commented because these are not critical failures
    #{'name': "tiff-alpha-raster", 'sizes':[(600,400)]},
    #{'name': "tiff-alpha-broken-assoc-alpha-raster", 'sizes':[(600,400)]},
    #{'name': "tiff-nodata-edge-raster", 'sizes':[(600,400)]},
    #{'name': "tiff-opaque-edge-raster", 'sizes':[(256,256)]},
]

other_tests = [
    {'name': "marker-svg-opacity"},
    {'name': "marker-multi-policy", 'sizes':[(600,400)]},
    {'name': "marker-on-line", 'sizes':[(600,400)],
	'bbox': mapnik.Box2d(-10, 0, 15, 20)},
    {'name': "marker-on-line-spacing-eq-width", 'sizes':[(600,400)]},
    {'name': "marker-on-line-spacing-eq-width-overlap", 'sizes':[(600,400)]},
    {'name': "marker_line_placement_on_points"},
    {'name': "marker-with-background-image", 'sizes':[(600,400),(400,600),(257,256)]},
    {'name': "marker-with-background-image-and-hsla-transform", 'sizes':[(600,400),(400,600),(257,256)]},
    {'name': "marker-on-hex-grid", 'sizes':[(600,400),(400,600),(257,256)]},
    {'name': "whole-centroid", 'sizes':[(600,400)],
	'bbox': mapnik.Box2d(736908, 4390316, 2060771, 5942346)},
]

files = text_tests + tiff_tests + other_tests

def report(diff,threshold,quiet=False):
    if diff > threshold:
        if quiet:
            sys.stderr.write('\x1b[31m.\x1b[0m')
        else:
            print '\x1b[31m✘\x1b[0m (\x1b[34m%u different pixels\x1b[0m)' % diff
    else:
        if quiet:
            sys.stderr.write('\x1b[32m.\x1b[0m')
        else:
            print '\x1b[32m✓\x1b[0m'

def report_overwrite(quiet=False):
    if quiet:
	sys.stderr.write('\x1b[33m.\x1b[0m')
    else:
	print '\x1b[33m?\x1b[0m (\x1b[34mReference file replaced with new version\x1b[0m)'

def report_create(quiet=False):
    if quiet:
	sys.stderr.write('\x1b[33m.\x1b[0m')
    else:
	print '\x1b[33m?\x1b[0m (\x1b[34mNew reference file created\x1b[0m)'


def render(config, width, height, bbox, scale_factor, quiet=False, overwrite_failures=False):
    filename = config['name']
    m = mapnik.Map(width, height)
    postfix = "%s-%d-%d-%s" % (filename,width,height,scale_factor)
    
    ## AGG rendering
    if config.get('agg', True):
        expected_agg = os.path.join(dirname, "images", postfix + '-agg-reference.png')
        actual_agg = os.path.join(visual_output_dir, '%s-agg.png' % postfix)
        try:
            mapnik.load_map(m, os.path.join(dirname, "styles", "%s.xml" % filename), False)
            if bbox is not None:
                m.zoom_to_box(bbox)
            else:
                m.zoom_all()
        except Exception, e:
            sys.stderr.write(e.message + '\n')
	    fail(actual_agg, expected_agg, str(e.message))
	    return m
        if not quiet:
            print "\"%s\" with agg..." % (postfix),
        try:
            mapnik.render_to_file(m, actual_agg, 'png8:m=h', scale_factor)
            if not os.path.exists(expected_agg):
                # generate it on the fly
		report_create(quiet)
		fail(actual_agg, expected_agg, None)
            else:
                threshold = 0
                diff = compare(actual_agg, expected_agg, threshold=0, alpha=True)
                if overwrite_failures and diff > threshold:
		    fail(actual_agg, expected_agg, None)
		    report_overwrite(quiet)
                else:
		    report(diff, threshold, quiet)
        except Exception, e:
            sys.stderr.write(e.message + '\n')
	    fail(actual_agg,expected_agg, str(e.message))
    
    ### TODO - set up tests to compare agg and cairo png output
    
    ### Cairo rendering
    if config.get('cairo', True):
        expected_cairo = os.path.join(dirname, "images", postfix + '-cairo-reference.png')
        actual_cairo = os.path.join(visual_output_dir, '%s-cairo.png' % postfix)
        if not quiet:
            print "\"%s\" with cairo..." % (postfix),
        try:
            mapnik.render_to_file(m, actual_cairo,'ARGB32', scale_factor)
            # open and re-save as png8 to save space
            new_im = mapnik.Image.open(actual_cairo)
            new_im.save(actual_cairo,'png8:m=h')
            if not os.path.exists(expected_cairo):
                # generate it on the fly
		report_create(quiet)
                fail(actual_cairo,expected_cairo,None)
            else:
                # cairo and agg differ in alpha for reasons unknown, so don't test it for now
                threshold = 0
                diff = compare(actual_cairo, expected_cairo, threshold=threshold, alpha=False)
                if overwrite_failures and diff > threshold:
		    report_overwrite(quiet)
                    fail(actual_cairo,expected_cairo,None)
                else:
                    report(diff,threshold,quiet)
        except Exception, e:
            sys.stderr.write(e.message + '\n')
            fail(actual_cairo,expected_cairo,str(e.message))
    
    ## Grid rendering
    # TODO - grid renderer does not support scale_factor yet via python
    if scale_factor == 1.0 and config.get('grid', True):
        expected_grid = os.path.join(dirname, "grids", postfix + '-grid-reference.json')
        actual_grid = os.path.join(visual_output_dir, '%s-grid.json' % postfix)
        if not quiet:
            print "\"%s\" with grid..." % (postfix),
        try:
            grid = mapnik.Grid(m.width,m.height)
            mapnik.render_layer(m,grid,layer=0)
            utf1 = grid.encode('utf',resolution=4)
            open(actual_grid,'wb').write(json.dumps(utf1,indent=1))
            if not os.path.exists(expected_grid):
                # generate it on the fly
		report_create(quiet)
                fail(actual_grid,expected_grid,None)
            else:
                threshold = 0
                diff = compare_grids(actual_grid, expected_grid, threshold=threshold, alpha=False)
                if overwrite_failures and diff > threshold:
		    report_overwrite(quiet)
                    fail(actual_grid,expected_grid,None)
                else:
                    report(diff,threshold,quiet)
        except Exception, e:
            sys.stderr.write(e.message + '\n')
            fail(actual_grid,expected_grid,str(e.message))
    return m

if __name__ == "__main__":
    if '-q' in sys.argv:
       quiet = True
       sys.argv.remove('-q')
    else:
       quiet = False

    if '--overwrite' in sys.argv:
       overwrite_failures = True
       sys.argv.remove('--overwrite')
    else:
       overwrite_failures = False

    if len(sys.argv) == 2:
        files = [{"name": sys.argv[1], "sizes": sizes_few_square}]
    elif len(sys.argv) > 2:
        files = []
        for name in sys.argv[1:]:
            files.append({"name": name})

    if not os.path.exists(visual_output_dir):
        os.makedirs(visual_output_dir)

    if 'osm' in mapnik.DatasourceCache.plugin_names():
        for f in files:
            config = dict(defaults)
            config.update(f)
            for size in config['sizes']:
                for scale_factor in config['scales']:
                    m = render(config,
                               size[0],
                               size[1],
                               config.get('bbox'),
                               scale_factor,
                               quiet=quiet,
                               overwrite_failures=overwrite_failures)
            mapnik.save_map(m, os.path.join(dirname, 'xml_output', "%s-out.xml" % config['name']))

        summary(generate=True)