Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use jsonReport method in backstopjs

Best JavaScript code snippet using backstopjs

shexValidator.js

Source:shexValidator.js

1/**2 * Copyright 2020 Google LLC3 *4 * Licensed under the Apache License, Version 2.0 (the "License");5 * you may not use this file except in compliance with the License.6 * You may obtain a copy of the License at7 *8 *      https://www.apache.org/licenses/LICENSE-2.09 *10 * Unless required by applicable law or agreed to in writing, software11 * distributed under the License is distributed on an "AS IS" BASIS,12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16const shexParser = require('@shexjs/parser');17const shex = require('@shexjs/core');18const utils = require('./util');19const parser = require('./parser');20const errors = require('./errors');21const TYPE = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type';22class ValidationReport {23    /**24     * @param {object} jsonReport - report from shex.js, which needs to be simplified25     * @param {object} schema - parsed shapes in ShExJ format26     * @param {object} annotations27     */28    constructor(jsonReport, schema, annotations) {29        this.failures = [];30        this.shapes = new Map();31        schema.shapes.forEach(shape => {32            this.shapes.set(shape.id, this.getShapeCore(shape));33        });34        this.simplify(jsonReport, undefined, undefined);35        this.removeMissingIfTypeMismatch();36        this.annotations = annotations;37    }38    /**39     * Simplifies shex.js nested report into a linear structure40     * @param {object} jsonReport41     * @param {string|undefined} parentNode42     * @param {string|undefined} parentShape43     */44    simplify(jsonReport, parentNode, parentShape) {45        if (Array.isArray(jsonReport)) {46            jsonReport.forEach(err => this.simplify(err, parentNode, parentShape));47            return;48        }49        // STEP 1: if report doesn't contain errors, MissingProperty @type or failures50        // that doesn't need to be added, return51        if (!jsonReport.type ||52            jsonReport.type === 'ShapeAndResults' ||53            jsonReport.type === 'ShapeOrResults' ||54            jsonReport.property === TYPE ||55            jsonReport.constraint && jsonReport.constraint.predicate === TYPE ||56            jsonReport.type === 'NodeConstraintViolation' ||57            jsonReport.type === 'ShapeOrFailure' ||58            jsonReport.type === 'ShapeTest') {59            return;60        }61        // STEP 2: if array or intermediate nested structure, simplify nested values62        if (jsonReport.type === 'ShapeAndFailure' ||63            jsonReport.type === 'Failure' ||64            jsonReport.type === 'SemActFailure' ||65            jsonReport.type === 'FailureList' ||66            jsonReport.type === 'ExtendedResults' ||67            jsonReport.type === 'ExtensionFailure' ||68            (!jsonReport.type) && jsonReport.errors) {69            const node = jsonReport.node;70            this.simplify(jsonReport.errors, node || parentNode, jsonReport.shape || parentShape);71            return;72        }73        // STEP 3: handle closed shape errors74        if (jsonReport.type === 'ClosedShapeViolation') {75            jsonReport.unexpectedTriples.forEach(trpl => {76                const failure = {77                    type: jsonReport.type,78                    property: trpl.predicate,79                    message: `Unexpected property ${trpl.predicate}`,80                    node: parentNode,81                    shape: parentShape82                }83                this.failures.push(failure);84            });85            return;86        }87        // STEP 4: fill out the failure88        const failure = {89            type: jsonReport.type,90            property: jsonReport.property || (jsonReport.constraint && jsonReport.constraint.predicate),91            message: '',92            node: (jsonReport.triple && jsonReport.triple.subject) || parentNode,93            shape: parentShape,94        };95        switch (jsonReport.type) {96            case 'TypeMismatch':97                failure.message = `Value provided for property ${failure.property} has an unexpected type`;98                this.simplify(jsonReport.errors, undefined, undefined);99                break;100            case 'MissingProperty':101                failure.message = `Property ${failure.property} not found`;102                break;103            case 'ExcessTripleViolation':104                failure.message = `Property ${failure.property} has a cardinality issue`;105                break;106            case 'BooleanSemActFailure':107                if (!jsonReport.ctx.predicate) return;108                failure.message = `Property ${failure.property} failed semantic action with code js:'${jsonReport.code}'`;109                break;110            case 'NegatedProperty':111                failure.message = `Negated property ${failure.property}`;112                break;113            default:114                throw new errors.ShexValidationError(`Unknown failure type ${jsonReport.type}`);115        }116        this.failures.push(failure);117    }118    /**119     * Recursively parses ShExJ Shape structure to get the core Shape with properties120     * @param {object} node121     * @returns {object}122     */123    getShapeCore(node) {124        if (node.type === 'Shape') {125            return node;126        }127        if (node.shapeExprs) {128            const nodes = node.shapeExprs129                .map(/** @param {*} nestedStruct */nestedStruct => this.getShapeCore(nestedStruct))130                .filter(/** @param {*} nestedStruct */nestedStruct => nestedStruct !== undefined);131            if (nodes.length > 0) return nodes[0];132        }133    }134    /**135     * Gets annotations for specific property in shape from the ShExJ shape136     * @param {string} shape137     * @param {string} property138     * @returns {Map<string, string>}139     */140    getAnnotations(shape, property) {141        const mapper = new Map();142        let shapeObj = this.shapes.get(shape);143        if (!shapeObj || !shapeObj.expression) return mapper;144        let propStructure;145        if (shapeObj.expression.expressions !== undefined) {146            propStructure = shapeObj.expression.expressions147                .filter(x => x.predicate === property)[0];148        } else if (shapeObj.expression.predicate === property){149            propStructure = shapeObj.expression;150        }151        if (!propStructure || !propStructure.annotations) return mapper;152        propStructure.annotations.forEach(x => {153            mapper.set(x.predicate, x.object.value);154        });155        return mapper;156    }157    /**158     * Hack for removing MissingProperty violations if the same property has TypeMismatch violation159     */160    removeMissingIfTypeMismatch() {161        const typeMismatches = this.failures.filter(x => x.type === 'TypeMismatch');162        const missings = [];163        for (const typeMismatch of typeMismatches) {164            missings.push(this.failures.filter(x => x.property === typeMismatch.property && x.type === 'MissingProperty')[0]);165            this.failures = this.failures.filter(x => !missings.includes(x));166        }167    }168    /**169     * Transforms a temporary report failures to structured data report failures170     * @returns {[StructuredDataFailure]}171     */172    toStructuredDataReport() {173        return this.failures.map(err => {174            /** @type StructuredDataFailure */175            const failure = {176                property: err.property,177                message: err.message,178                shape: err.shape,179                severity: 'error'180            }181            if (err.shape && err.property && this.annotations) {182                const shapeAnnotations = this.getAnnotations(err.shape, err.property);183                for (const [key, value] of Object.entries(this.annotations)) {184                    const annotation = shapeAnnotations.get(value) || failure[key];185                    if (annotation) failure[key] = annotation;186                }187            }188            return failure;189        });190    }191}192class ShexValidator {193    /**194     * @param {object|string} shapes - ShExJ shapes195     * @param {{annotations:object|undefined}} options196     */197    constructor(shapes, options={}) {198        if (typeof shapes === 'string') {199            this.shapes = shexParser.construct('', {}, {}).parse(shapes);200        } else {201            this.shapes = shapes;202        }203        this.annotations = options.annotations;204    }205    /**206     * Validates data against ShEx shapes207     * @param {string|Store} data208     * @param {string} shape -  identifier of the target shape209     * @param {{ baseUrl: string|undefined }} options210     * @returns {Promise<{baseUrl: string, store: Store, failures: [StructuredDataFailure]}>}211     */212    async validate(data, shape, options = {}) {213        const baseUrl = options.baseUrl || utils.randomUrl();214        if (typeof data === 'string') {215            data = await parser.stringToQuads(data, baseUrl);216        }217        const db = shex.Util.makeN3DB(data);218        const validator = shex.Validator.construct(this.shapes);219        const errors = new ValidationReport(validator.validate(db, [{220            node: baseUrl,221            shape: shape,222        }]), this.shapes, this.annotations);223        return {224            baseUrl: baseUrl,225            store: data,226            failures: errors.toStructuredDataReport()227        };228    }229}230/**231 * @typedef {{232 *     property: string,233 *     message: string,234 *     severity: 'error'|'warning'|'info',235 *     shape: string236 * }} StructuredDataFailure237 */...

JsCoverageStore.js

Source:JsCoverageStore.js

1/*2 * Aria Templates3 * Copyright Amadeus s.a.s.4 */5/**6 * Store for coverage reports7 */8Aria.classDefinition({9    $classpath : "aria.jsunit.JsCoverageStore",10    $dependencies : ["aria.utils.Date", "aria.core.Browser"],11    $statics : {12        baseReportsURL : "http://aria/jscoverage-reports/",13        baseStoreURL : "http://aria/jscoverage-store/"14    },15    $constructor : function () {16        /**17         * The timestamp for the current test, which will be used to store the results18         * @type String19         */20        this.reportDate = aria.utils.Date.format(new Date(), "yyyy'_'MM'_'dd'_'hh'_'mm'_'ss");21        /**22         * URL "suffix" describing the current report23         * @type String24         */25        this._urlSuffix = aria.core.Browser.name.toLowerCase() + "/" + this.reportDate + "/";26    },27    $prototype : {28        /**29         * Send all the JsCoverage reports to the jscoverage server30         * @param {Object} options31         */32        store : function (options) {33            this.storeReport();34            if (options.callback) {35                options.callback.fn.call(options.callback.scope);36            }37        },38        /**39         * Store the Js Coverage report on the server. They are stored in browser specific folders. The latest coverage40         * is always accessible at http://aria/jscoverage-reports/${browsername}/latest41         */42        storeReport : function () {43            var url = this.getBaseStoreURL();44            var jsonReport = this.getJSONReport();45            this.sendJSONReport(jsonReport, url);46        },47        /**48         * @return {String}49         */50        getBaseStoreURL : function () {51            return this.baseStoreURL + this._getURLSuffix();52        },53        /**54         * @return {String}55         */56        getBaseReportsURL : function () {57            return this.baseReportsURL + this._getURLSuffix();58        },59        /**60         * Retrieve a URL "suffix" describing the current report, based on the browser name, and the test date This61         * suffix should then be used both to store and retrieve the JSCoverage report62         * @return {String}63         * @protected64         */65        _getURLSuffix : function () {66            return this._urlSuffix;67        },68        /**69         * Send a Js Coverage report as JSON70         * @param {String} The report as a javascript object71         * @param {String} URL of the jscoverage-store service. Defaults to http://aria/jscoverage-store/72         */73        sendJSONReport : function (jsonReport, url) {74            var createRequest = function () {75                if (Aria.$global.XMLHttpRequest) {76                    return new Aria.$global.XMLHttpRequest();77                } else if (Aria.$global.ActiveXObject) {78                    return new Aria.$global.ActiveXObject("Microsoft.XMLHTTP");79                }80            };81            var request = createRequest();82            request.open("POST", url, false);83            request.setRequestHeader("Content-Type", "application/json");84            request.setRequestHeader("Content-Length", jsonReport.length.toString());85            request.send(jsonReport);86            if (request.status === 200 || request.status === 201 || request.status === 204) {87                return request.responseText;88            } else {89                throw request.status;90            }91        },92        /**93         * Return JSON representation of a report94         * @return String95         */96        getJSONReport : function () {97            var pad = function (s) {98                return "0000".substr(s.length) + s;99            };100            var quote = function (s) {101                return "\"" + s.replace(/[\u0000-\u001f"\\\u007f-\uffff]/g, function (c) {102                    switch (c) {103                        case "\b" :104                            return "\\b";105                        case "\f" :106                            return "\\f";107                        case "\n" :108                            return "\\n";109                        case "\r" :110                            return "\\r";111                        case "\t" :112                            return "\\t";113                        case "\"" :114                            return "\\\"";115                        case "\\" :116                            return "\\\\";117                        default :118                            return "\\u" + pad(c.charCodeAt(0).toString(16));119                    }120                }) + "\"";121            };122            var json = [];123            var jscov = Aria.$global._$jscoverage;124            if (jscov) {125                for (var file in jscov) {126                    if (!jscov.hasOwnProperty(file)) {127                        continue;128                    }129                    var coverage = jscov[file];130                    var array = [];131                    var length = coverage.length;132                    for (var line = 0; line < length; line++) {133                        var value = coverage[line];134                        if (value === undefined || value === null) {135                            value = "null";136                        }137                        array.push(value);138                    }139                    var source = coverage.source;140                    var lines = [];141                    length = source.length;142                    for (var line = 0; line < length; line++) {143                        lines.push(quote(source[line]));144                    }145                    json.push(quote(file)146                            + (":{\"coverage\":[" + array.join(",") + "],\"source\":[" + lines.join(",") + "]}"));147                }148            }149            json = "{" + json.join(",") + "}";150            return json;151        }152    }...

Using AI Code Generation

1var backstopjs = require('backstopjs');2var config = require('./backstop.json');3backstopjs('reference', {config: config})4  .then(function () {5    return backstopjs('test', {config: config});6  })7  .then(function () {8    return backstopjs('openReport', {config: config});9  })10  .then(function () {11    return backstopjs('jsonReport', {config: config});12  })13  .then(function (data) {14    console.log(data);15  })16  .catch(function (error) {17    console.error(error);18  });19{20        {21            "pair": {22            },23        },24        {25            "pair": {

Using AI Code Generation

1var backstopjs = require('backstopjs');2var config = require('./backstop.json');3backstopjs('jsonReport', { config: config })4.then(function (data) {5    console.log(data);6})7.catch(function (err) {8    console.log(err);9});10{11    {12    },13    {14    }15    {16    }17  "paths": {18  },19  "engineOptions": {20  },21}

Using AI Code Generation

1var backstopjs = require('backstopjs');2backstopjs('jsonReport', { config: './backstop.json' });3var backstopjs = require('backstopjs');4backstopjs('test', { config: './backstop.json' });5var backstopjs = require('backstopjs');6backstopjs('approve', { config: './backstop.json' });7var backstopjs = require('backstopjs');8backstopjs('reference', { config: './backstop.json' });9var backstopjs = require('backstopjs');10backstopjs('openReport', { config: './backstop.json' });11var backstopjs = require('backstopjs');12backstopjs('approve', { config: './backstop.json' });13var backstopjs = require('backstopjs');14backstopjs('openReport', { config: './backstop.json' });15var backstopjs = require('backstopjs');16backstopjs('approve', { config: './backstop.json' });17var backstopjs = require('backstopjs');18backstopjs('openReport', { config: './backstop.json' });19var backstopjs = require('backstopjs');20backstopjs('approve', { config: './backstop.json' });21var backstopjs = require('backstopjs');22backstopjs('openReport', { config: './backstop.json' });23var backstopjs = require('backstopjs');24backstopjs('approve

Using AI Code Generation

1var jsonReport = require('backstopjs').jsonReport;2jsonReport('test_report');3var jsonReport = require('backstopjs').jsonReport;4gulp.task('backstopJsonReport', function () {5    jsonReport('test_report');6});7var jsonReport = require('backstopjs').jsonReport;8grunt.registerTask('backstopJsonReport', function () {9    jsonReport('test_report');10});11"scripts": {12}

Using AI Code Generation

1var backstopjs = require('backstopjs');2var config = require('./backstop.json');3backstopjs('reference', {config: config})4.then(function(){5    return backstopjs('test', {config: config});6})7.then(function(){8    return backstopjs('openReport', {config: config});9})10.catch(function (error) {11    console.error(error);12});

Using AI Code Generation

1var backstopjs = require('backstopjs');2var scenario = require('./scenario.js');3var backstopConfig = require('./backstop.json');4backstopConfig.scenarios = [scenario];5backstopjs('jsonReport', { config: backstopConfig })6    .then(function (data) {7        var fs = require('fs');8        var jsonReport = JSON.stringify(data);9        fs.writeFileSync('report.json', jsonReport);10    })11    .catch(function (error) {12        console.error(error);13    });14var scenario = {15}16module.exports = scenario;17var backstopConfig = {18        {19        },20        {21        },22        {23        }24    "paths": {25    },

Using AI Code Generation

1var jsonReport = require('backstopjs').jsonReport;2jsonReport('test_report');3var jsonReport = require('backstopjs').jsonReport;4jsonReport('test_report');5var jsonReport = require('backstopjs').jsonReport;6jsonReport('test_report');7var jsonReport = require('backstopjs').jsonReport;8jsonReport('test_report');

Using AI Code Generation

1var backstopjs = require('backstopjs');2backstopjs('test', {3}).then(function (childResult) {4  console.log(childResult);5});6{7    {8    },9    {10    },11    {12    },13    {14    },15    {16    }17    {18    }19  "paths": {20  },21  "engineOptions": {22  },

Using AI Code Generation

1const jsonReport = require('backstopjs/core/util/jsonReport');2const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');3const jsonReport = require('backstopjs/core/util/jsonReport');4const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');5const jsonReport = require('backstopjs/core/util/jsonReport');6const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');7const jsonReport = require('backstopjs/core/util/jsonReport');8const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');9const jsonReport = require('backstopjs/core/util/jsonReport');10const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');11const jsonReport = require('backstopjs/core/util/jsonReport');12const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');13const jsonReport = require('backstopjs/core/util/jsonReport');14const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');15const jsonReport = require('backstopjs/core/util/jsonReport');16const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');17const jsonReport = require('backstopjs/core/util/jsonReport');18const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');19const jsonReport = require('backstopjs/core/util/jsonReport');20const report = jsonReport('backstop_data/bitmaps_test/20170603-114320/');21const jsonReport = require('backstopjs/core/util/jsonReport');22const report = jsonReport('backstop_data/bitmaps_test/201

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.