Windshaft-cartodb/test/acceptance/named-layers-visibility-test.js

'use strict';

var step = require('step');
var testHelper = require('../support/test-helper');

var assert = require('../support/assert');
var CartodbWindshaft = require('../../lib/server');
var serverOptions = require('../../lib/server-options');

var RedisPool = require('redis-mpool');
var TemplateMaps = require('../../lib/backends/template-maps');
const mapnik = require('@carto/mapnik');

var IMAGE_TOLERANCE = 20;

describe('layers visibility for previews', function () {
    var server;

    before(function () {
        server = new CartodbWindshaft(serverOptions);
    });

    // configure redis pool instance to use in tests
    var redisPool = new RedisPool(global.environment.redis);
    var templateMaps = new TemplateMaps(redisPool, {
        max_user_templates: global.environment.maxUserTemplates
    });

    var username = 'localhost';

    function createLayer (color, layerId) {
        var mod;

        if (color === 'red') {
            mod = 0;
        } else if (color === 'orange') {
            mod = 1;
        } else if (color === 'blue') {
            mod = 2;
        } else {
            mod = 0;
        }

        return {
            type: 'mapnik',
            id: layerId,
            options: {
                sql: 'select * from populated_places_simple_reduced where cartodb_id % 3 = ' + mod,
                cartocss: '#layer { marker-fill: ' + color + '; }',
                cartocss_version: '2.3.0'
            }
        };
    }

    function createTemplate (scenario) {
        return {
            version: '0.0.1',
            name: scenario.name,
            auth: {
                method: 'open'
            },
            view: {
                bounds: {
                    west: 0,
                    south: 0,
                    east: 45,
                    north: 45
                },
                zoom: 4,
                center: {
                    lng: 40,
                    lat: 20
                },
                preview_layers: scenario.layerPerview
            },
            layergroup: {
                layers: scenario.layers
            }
        };
    }

    afterEach(function (done) {
        testHelper.deleteRedisKeys({
            'user:localhost:mapviews:global': 5
        }, done);
    });

    function previewFixture (version) {
        return './test/fixtures/previews/populated_places_simple_reduced-' + version + '.png';
    }

    var threeLayerPointDistintColor = [
        createLayer('red'),
        createLayer('orange'),
        createLayer('blue', 'layer2')
    ];

    var scenarios = [{
        name: 'preview_layers_red',
        layerPerview: {
            0: true,
            1: false,
            layer2: false
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_orange',
        layerPerview: {
            0: false,
            1: true,
            layer2: false
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_blue',
        layerPerview: {
            0: false,
            1: false,
            layer2: true
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_red_orange',
        layerPerview: {
            0: true,
            1: true,
            layer2: false
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_red_blue',
        layerPerview: {
            0: true,
            1: false,
            layer2: true
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_orange_blue',
        layerPerview: {
            0: false,
            1: true,
            layer2: true
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_red_orange_blue',
        layerPerview: {
            0: true,
            1: true,
            layer2: true
        },
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_all',
        layerPerview: {},
        layers: threeLayerPointDistintColor
    }, {
        name: 'preview_layers_undefined',
        layerPerview: undefined,
        layers: threeLayerPointDistintColor
    }];

    scenarios.forEach(function (scenario) {
        it('should filter layers for template: ' + scenario.name, function (done) {
            step(
                function addTemplate () {
                    var next = this;
                    var template = createTemplate(scenario);

                    templateMaps.addTemplate(username, template, next);
                },
                function requestPreview (err) {
                    assert.ifError(err);

                    var next = this;

                    assert.response(server, {
                        url: '/api/v1/map/static/named/' + scenario.name + '/640/480.png',
                        method: 'GET',
                        headers: {
                            host: 'localhost'
                        },
                        encoding: 'binary'
                    }, {
                        status: 200,
                        headers: {
                            'content-type': 'image/png'
                        }
                    }, function (res, err) {
                        next(err, res);
                    });
                },
                function checkPreview (err, res) {
                    assert.ifError(err);

                    var next = this;
                    var img = mapnik.Image.fromBytes(Buffer.from(res.body, 'binary'));
                    var previewFixturePath = previewFixture(scenario.name);

                    assert.imageIsSimilarToFile(img, previewFixturePath, IMAGE_TOLERANCE, next);
                },
                function deleteTemplate (err) {
                    assert.ifError(err);

                    var next = this;

                    templateMaps.delTemplate(username, scenario.name, next);
                },
                function finish (err) {
                    done(err);
                }
            );
        });
    });
});