assert.js

import { RuntimeError } from "error";
import ExpressionParser from "service/ExpressionParser";
import { migrateAssertVisible } from "service/suite";

export function buildAssertionTpl( assertionCall, command, preCode ) {
  try {
    const cbBody = createCbBody( command );
    if ( command.method === "assertConsoleMessage" ) {
      return templateConsoleMessageAssertion( cbBody, command.assert, preCode );
    }
    if ( command.method === "assertDialog" ) {
      return templateDialogAssertion( cbBody, command.assert, command.params, preCode );
    }
    return justify( `${ preCode }\nresult = ${ assertionCall };` ) + ` ${ cbBody }`;
  } catch ( err ) {
    console.warn( "Renderer process: buildAssertionTpl error:", err, { assertionCall, command, preCode });
    throw err;
  }
}

export function stringifyTypes( types, unit = "", op = "<" ) {
  return Object.keys( types._enabled )
    .filter( ( key ) => types._enabled[ key ])
    .map( ( el ) => `\`${ el }\` ${ op } \`${ types[ el ] }${ unit }\`` ).join( ", " );
}

function templateConsoleMessageAssertion( cbBody, assert, comment ) {
  return justify( `
${ comment }
result = consoleLog
  .filter( message => ( "${ assert.type }" === "any" || message.type() === "${ assert.type }" ) )
  .map( message => message.text() );
${ cbBody.replace( /^ /g, "" ) }
${ assert.reset !== false ? `consoleLog = [];` : `` }
  ` );
}

function templateDialogAssertion( cbBody, assert, params, comment ) {
  return justify( `
${ comment }
result = dialogLog
  .filter( dialog => ( "${ assert.type }" === "any" || dialog.type() === "${ assert.type }" ) )
  .map( dialog => dialog.message() );
${ cbBody.replace( /^ /g, "" ) }
${ assert.reset !== false ? `dialogLog = [];` : `` }
` );
}

/**
 * Some assertions allow you to enable/disable params
 * In such case options._enabled map has information about what of params are enabled
 * { key1: boolean }
 *
 * @param {Object} options
 * @returns {Object}
 */
function getEnabledOptions( options ) {
  return Object.entries( options._enabled )
    .filter( pair => Boolean( pair[ 1 ]) )
    .reduce( ( carry, pair ) => {
      const key = pair[ 0 ];
      carry[ key ] = options[ key ];
      return carry;
    }, {});
}

/**
 *
 * @param {String} text
 * @returns {String}
 */
export function justify( text ) {
  return ( "\n" + text ).split( "\n" ).map( line => "      " + line ).join( "\n" );
}

function parseTpl( value, id, type ) {
  // https://github.com/dsheiko/puppetry/pull/91/commits/8c939d2bd822a88eb49511e78ac5055d17828962
  if ( typeof type === "undefined" || !( type == "string" || type == "text" ) ) {
    return JSON.stringify( value );
  }
  // @see ./src/component/Schema/Params/Element/assertText.js
  if ( typeof type !== "undefined" && type === "text" ) {
    value = value.replace( /\n+/gm, "\n" );
  }
  const parser = new ExpressionParser( id );
  return parser.stringify( value );
}

function negate( not ) {
  // can be boolean, but now we have in AssertConsoleMessage "true"/"false"
  return ( not === "false" || !not ) ? `` : `.not`;
}

function getExpectation( method, params, assert ) {
  switch ( method ) {
  case "assertConsoleMessage":
    return JSON.stringify( `to find console messages `
      + `of type "${ assert.type }" with text ${ assert.assertion !== "haveString" ? "~ " : "" }`
      + `"${ assert.value }"` );
  case "assertDialog":
    return JSON.stringify( `to find dialogs `
      + `of type "${ assert.type }" with message ${ assert.assertion !== "haveString" ? "~ " : "" }`
      + `"${ assert.value }"` );
  case "assertTextCount":
  case "assertNodeCount":
    return JSON.stringify( `number of the matching elements` );
  case "assertScroll":
    return typeof params.direction !== "undefined"
      ? JSON.stringify( `scroll offset ${ params.direction }` ) : `null`;
  default:
    return "null";
  }
}

function createCbBody({ assert, target, method, id, params }) {
  const { assertion, value, operator, position, not, ...options } = assert,
        source = `${ target }.${ method }`;

  switch ( assertion ) {
  case "visible":
    return justify( `expect( result ).toBeVisible( ${ JSON.stringify( assert ) }, "${ source }" );` );
  case "screenshot":
    return justify( `expect( result ).toMatchScreenshot( ${ options.mismatchTolerance }, "${ source }" );` );
  case "selector":
    return justify( `expect( result ).toMatchSelector( "${ value }", "${ source }" );` );
  case "boolean":
    // support Puppetry < 3.0.0
    if ( method === "assertVisible" ) {
      return justify( `expect( result ).toBeVisible( ${ JSON.stringify(
        migrateAssertVisible({ method, assert }) ) }, "${ source }" );` );
    }
    return justify( `expect( result )${ value ? "" : ".not" }.toBeOk( "${ source }" );` );

  case "number":
    return justify( `expect( result ).toPassCondition( "${ operator }", ${ value },`
      + ` ${ getExpectation( method, params, assert ) }, "${ source }" );` );

  case "contains":
    return justify( `expect( result ).toIncludeSubstring( ${ parseTpl( value, id, options.assertionType ) }`
        + `, "${ source }" );` );
  case "!contains":
    return justify( `expect( result ).not.toIncludeSubstring( ${ parseTpl( value, id, options.assertionType ) }`
        + `, "${ source }" );` );
  case "equals":
    return justify( `expect( result ).toBeEqual( ${ parseTpl( value, id, options.assertionType ) }, "${ source }" );` );
  case "!equals":
    return justify( `expect( result )`
    + `.not.toBeEqual( ${ parseTpl( value, id, options.assertionType ) }, "${ source }" );` );
  case "empty":
    return justify( `expect( result ).toBeEmpty( "${ source }" );` );
  case "!empty":
    return justify( `expect( result ).not.toBeEmpty( "${ source }" );` );


  case "hasClass":
    return justify( `expect( result ).toHaveClass( "${ params.name }", "${ source }" );` );
  case "!hasClass":
    return justify( `expect( result ).not.toHaveClass( "${ params.name }", "${ source }" );` );

  case "hasAttribute":
    return justify( `expect( result ).toHaveAttribute( "${ params.name }", "${ source }" );` );
  case "!hasAttribute":
    return justify( `expect( result ).not.toHaveAttribute( "${ params.name }", "${ source }" );` );

  case "hasProperty":
    return justify( `expect( result ).toHavePropertyTrue( "${ params.name }", "${ source }" );` );
  case "!hasProperty":
    return justify( `expect( result ).not.toHavePropertyTrue( "${ params.name }", "${ source }" );` );

  case "haveString":
    return justify( `expect( result )${ negate( not ) }`
        + `.toHaveString( ${ parseTpl( value, id, options.assertionType ) }`
        + `, ${ getExpectation( method, params, assert ) }, "${ source }" );` );
  case "haveSubstring":
    return justify( `expect( result )${ negate( not ) }`
        + `.toHaveSubstring( ${ parseTpl( value, id, options.assertionType ) }`
        + `, ${ getExpectation( method, params, assert ) }, "${ source }" );` );

  case "position":
    return justify( `expect( result ).toMatchPosition`
          + `( "${ position }", "${ target }", "${ options.target }", "${ source }" );` );
  case "boundingBox":
    return justify( `expect( result )`
          + `.toMatchBoundingBoxSnapshot( ${ JSON.stringify( options, null, "  " ) }, "${ source }" );` );

  case "response":
    return justify( `expect( result )`
          + `.toMatchResponse( ${ JSON.stringify({ ...options, not }, null, "  " ) }, "${ source }" );` );

  case "rest":
    return justify( `
result.data = await result.text();
ENV[ "PUPPETRY_LAST_RESPONSE_TEXT" ] = result.data;
expect( result )`
          + `.toMatchRest( ${ JSON.stringify( params.url ) }, `
          + `${ JSON.stringify( options, null, "  " ) }, "${ source }" );` );
  case "assertPerformanceTiming":
    return resolveTimingAssertion( options, source );
  case "assertAssetWeight":
    return resolveAssetAssertion( "toMatchAssetWeight", options, source );
  case "assertAssetCount":
    return resolveAssetAssertion( "toMatchAssetCount", options, source );
  case "assertGaTracking":
    return justify( `expect( result )`
          + `.toMatchGaTracking( ${ JSON.stringify( options, null, "  " ) }, "${ source }" );` );
  default:
    throw RuntimeError( `Invalid assertion '${ assertion }'` );
  }

}

function resolveTimingAssertion( options, source ) {
  const data = getEnabledOptions( options );
  return Object.entries( data ).reduce( ( carry, pair ) => {
    const type = JSON.stringify( pair[ 0 ]),
          rawVal = parseInt( pair[ 1 ], 10 ),
          val = ( isNaN( rawVal ) ? 0 : rawVal );
    carry += justify( `expect( result ).toMatchTiming( `
      + `${ type }, ${ val }, "${ source }" ); ` );
    return carry;
  }, "" );
}

function resolveAssetAssertion( assertionMethod, options, source ) {
  const data = getEnabledOptions( options );
  return Object.entries( data ).reduce( ( carry, pair ) => {
    const type = JSON.stringify( pair[ 0 ]),
          rawVal = parseInt( pair[ 1 ], 10 ),
          val = ( isNaN( rawVal ) ? 0 : rawVal ) * ( assertionMethod === "toMatchAssetCount" ? 1 : 1000 );
    carry += justify( `expect( result ).${ assertionMethod }( `
      + `${ type }, ${ val }, "${ source }" ); ` );
    return carry;
  }, "" );
}