KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use executeFunction method of com.intuit.karate.core.ScenarioEngine class

Best Karate code snippet using com.intuit.karate.core.ScenarioEngine.executeFunction

Source:ScenarioEngine.java

...286      if (afterFeature) {287        ScenarioEngine.set(this); // for any bridge / js to work288      }289      try {290        executeFunction(v);291      } catch (Exception e) {292        String prefix = afterFeature ? "afterFeature" : "afterScenario";293        logger.warn("{} hook failed: {}", prefix, e + "");294      }295    }296  }297  // gatling =================================================================298  //299  private PerfEvent prevPerfEvent;300  public void logLastPerfEvent(String failureMessage) {301    if (prevPerfEvent != null && runtime.perfMode) {302      if (failureMessage != null) {303        prevPerfEvent.setFailed(true);304        prevPerfEvent.setMessage(failureMessage);305      }306      runtime.featureRuntime.perfHook.reportPerfEvent(prevPerfEvent);307    }308    prevPerfEvent = null;309  }310  public void capturePerfEvent(PerfEvent event) {311    logLastPerfEvent(null);312    prevPerfEvent = event;313  }314  // http ====================================================================315  //316  private HttpRequestBuilder requestBuilder; // see init() method317  private HttpRequest request;318  private Response response;319  private Config config;320  public Config getConfig() {321    return config;322  }323  // important: use this to trigger client re-config324  // callonce routine is one example325  public void setConfig(Config config) {326    this.config = config;327    config.attach(JS);328    if (requestBuilder != null) {329      requestBuilder.client.setConfig(config);330    }331  }332  public HttpRequest getRequest() {333    return request;334  }335  public Response getResponse() {336    return response;337  }338  public HttpRequestBuilder getRequestBuilder() {339    return requestBuilder;340  }341  public void configure(String key, String exp) {342    Variable v = evalKarateExpression(exp);343    configure(key, v);344  }345  public Driver getDriver() {346    return this.driver;347  }348  public NewDriver getCurrentChrome() {349    if (driver != null && driver instanceof Chrome) {350      Optional<NewDriver> newDriver = newDrivers.values().stream().filter(item -> item.driver == driver).findFirst();351      if (newDriver.isPresent()) {352        return newDriver.get();353      } else {354        return new NewDriver(null, null, driver);355      }356    } else {357      return null;358    }359  }360  public void configure(String key, Variable v) {361    key = StringUtils.trimToEmpty(key);362    if (key.equals("newDriver")) {363      // @FIXME override start364      Map<String, Object> map = v.getValue();365      if (map.containsKey("name")) {366        String name = (String) map.get("name");367        validateVariableName(name);368        if (newDrivers.containsKey(name) || vars.containsKey(name)) {369          throw new RuntimeException("name: " + name + " already exists.");370        } else {371          Boolean isDefault = (boolean) map.getOrDefault("default", false);372          Driver newDriver = DriverOptions.start(map, runtime);373          newDrivers.put(name, new NewDriver(name, map, newDriver));374          if (isDefault) {375            config.configure("driver", v);376            setDriver(newDriver);377          }378          setVariable(name, newDriver);379        }380      } else {381        throw new RuntimeException("there must be a name when configure a new driver.");382      }383      // override end384    } else {385      // if next line returns true, config is http-client related386      if (config.configure(key, v)) {387        if (requestBuilder != null) {388          requestBuilder.client.setConfig(config);389        }390      }391    }392  }393  private void evalAsMap(String exp, BiConsumer<String, List<String>> fun) {394    Variable var = evalKarateExpression(exp);395    if (!var.isMap()) {396      logger.warn("did not evaluate to map {}: {}", exp, var);397      return;398    }399    Map<String, Object> map = var.getValue();400    map.forEach((k, v) -> {401      if (v instanceof List) {402        List list = (List) v;403        List<String> values = new ArrayList(list.size());404        for (Object o : list) { // support non-string values, e.g. numbers405          if (o != null) {406            values.add(o.toString());407          }408        }409        fun.accept(k, values);410      } else if (v != null) {411        fun.accept(k, Collections.singletonList(v.toString()));412      }413    });414  }415  public void url(String exp) {416    Variable var = evalKarateExpression(exp);417    requestBuilder.url(var.getAsString());418  }419  public void path(String exp) {420    List list = evalJs("[" + exp + "]").getValue();421    for (Object o : list) {422      if (o != null) {423        requestBuilder.path(o.toString());424      }425    }426  }427  // TODO document that for params and headers, lists are supported but428  // enclosed in square brackets429  public void param(String name, String exp) {430    Variable var = evalJs(exp);431    if (var.isList()) {432      requestBuilder.param(name, var.<List> getValue());433    } else {434      requestBuilder.param(name, var.getAsString());435    }436  }437  public void params(String expr) {438    evalAsMap(expr, (k, v) -> requestBuilder.param(k, v));439  }440  public void header(String name, String exp) {441    Variable var = evalKarateExpression(exp);442    if (var.isList()) {443      requestBuilder.header(name, var.<List> getValue());444    } else {445      requestBuilder.header(name, var.getAsString());446    }447  }448  public void headers(String expr) {449    evalAsMap(expr, (k, v) -> requestBuilder.header(k, v));450  }451  public void cookie(String name, String exp) {452    Variable var = evalKarateExpression(exp);453    if (var.isString()) {454      requestBuilder.cookie(name, var.getAsString());455    } else if (var.isMap()) {456      Map<String, Object> map = var.getValue();457      map.put("name", name);458      requestBuilder.cookie(map);459    }460  }461  // TODO document new options, [name = map | cookies listOfMaps]462  public void cookies(String exp) {463    Variable var = evalKarateExpression(exp);464    Map<String, Map> cookies = Cookies.normalize(var.getValue());465    requestBuilder.cookies(cookies.values());466  }467  private void updateConfigCookies(Map<String, Map> cookies) {468    if (cookies == null) {469      return;470    }471    if (config.getCookies().isNull()) {472      config.setCookies(new Variable(cookies));473    } else {474      Map<String, Map> map = getOrEvalAsMap(config.getCookies());475      map.putAll(cookies);476      config.setCookies(new Variable(map));477    }478  }479  public void formField(String name, String exp) {480    Variable var = evalKarateExpression(exp);481    if (var.isList()) {482      requestBuilder.formField(name, var.<List> getValue());483    } else {484      requestBuilder.formField(name, var.getAsString());485    }486  }487  public void formFields(String exp) {488    Variable var = evalKarateExpression(exp);489    if (var.isMap()) {490      Map<String, Object> map = var.getValue();491      map.forEach((k, v) -> {492        requestBuilder.formField(k, v);493      });494    } else {495      logger.warn("did not evaluate to map {}: {}", exp, var);496    }497  }498  public void multipartField(String name, String value) {499    multipartFile(name, value);500  }501  public void multipartFields(String exp) {502    multipartFiles(exp);503  }504  private void multiPartInternal(String name, Object value) {505    Map<String, Object> map = new HashMap();506    if (name != null) {507      map.put("name", name);508    }509    if (value instanceof Map) {510      map.putAll((Map) value);511      String toRead = (String) map.get("read");512      if (toRead != null) {513        File file = fileReader.relativePathToFile(toRead);514        map.put("value", file);515      }516      requestBuilder.multiPart(map);517    } else if (value instanceof String) {518      map.put("value", (String) value);519      multiPartInternal(name, map);520    } else if (value instanceof List) {521      List list = (List) value;522      for (Object o : list) {523        multiPartInternal(null, o);524      }525    } else if (logger.isTraceEnabled()) {526      logger.trace("did not evaluate to string, map or list {}: {}", name, value);527    }528  }529  public void multipartFile(String name, String exp) {530    Variable var = evalKarateExpression(exp);531    multiPartInternal(name, var.getValue());532  }533  public void multipartFiles(String exp) {534    Variable var = evalKarateExpression(exp);535    if (var.isMap()) {536      Map<String, Object> map = var.getValue();537      map.forEach((k, v) -> multiPartInternal(k, v));538    } else if (var.isList()) {539      List<Map> list = var.getValue();540      for (Map map : list) {541        multiPartInternal(null, map);542      }543    } else {544      logger.warn("did not evaluate to map or list {}: {}", exp, var);545    }546  }547  public void request(String body) {548    Variable v = evalKarateExpression(body);549    requestBuilder.body(v.getValue());550  }551  public void soapAction(String exp) {552    String action = evalKarateExpression(exp).getAsString();553    if (action == null) {554      action = "";555    }556    requestBuilder.header("SOAPAction", action);557    requestBuilder.contentType("text/xml");558    method("POST");559  }560  public void retry(String condition) {561    requestBuilder.setRetryUntil(condition);562  }563  public void method(String method) {564    if (!HttpConstants.HTTP_METHODS.contains(method.toUpperCase())) { // support expressions also565      method = evalKarateExpression(method).getAsString();566    }567    requestBuilder.method(method);568    httpInvoke();569  }570  // extracted for mock proceed()571  public Response httpInvoke() {572    if (requestBuilder.isRetry()) {573      httpInvokeWithRetries();574    } else {575      httpInvokeOnce();576    }577    requestBuilder.reset();578    return response;579  }580  private void httpInvokeOnce() {581    Map<String, Map> cookies = getOrEvalAsMap(config.getCookies());582    if (cookies != null) {583      requestBuilder.cookies(cookies.values());584    }585    Map<String, Object> headers;586    if (config.getHeaders().isJsOrJavaFunction()) {587      headers = getOrEvalAsMap(config.getHeaders(), requestBuilder.build());588    } else {589      headers = getOrEvalAsMap(config.getHeaders()); // avoid an extra http request build590    }591    if (headers != null) {592      requestBuilder.headers(headers);593    }594    request = requestBuilder.build();595    String perfEventName = null; // acts as a flag to report perf if not null596    if (runtime.perfMode) {597      perfEventName = runtime.featureRuntime.perfHook.getPerfEventName(request, runtime);598    }599    long startTime = System.currentTimeMillis();600    request.setStartTimeMillis(startTime); // this may be fine-adjusted by actual http client601    if (hooks != null) {602      hooks.forEach(h -> h.beforeHttpCall(request, runtime));603    }604    try {605      response = requestBuilder.client.invoke(request);606    } catch (Exception e) {607      long endTime = System.currentTimeMillis();608      long responseTime = endTime - startTime;609      String message = "http call failed after " + responseTime + " milliseconds for url: " + request.getUrl();610      logger.error(e.getMessage() + ", " + message);611      if (perfEventName != null) {612        PerfEvent pe = new PerfEvent(startTime, endTime, perfEventName, 0);613        capturePerfEvent(pe); // failure flag and message should be set by logLastPerfEvent()614      }615      throw new KarateException(message, e);616    }617    if (hooks != null) {618      hooks.forEach(h -> h.afterHttpCall(request, response, runtime));619    }620    byte[] bytes = response.getBody();621    Object body;622    String responseType;623    ResourceType resourceType = response.getResourceType();624    if (resourceType != null && resourceType.isBinary()) {625      responseType = "binary";626      body = bytes;627    } else {628      try {629        body = JsValue.fromBytes(bytes, true, resourceType);630      } catch (Exception e) {631        body = FileUtils.toString(bytes);632        logger.warn("auto-conversion of response failed: {}", e.getMessage());633      }634      if (body instanceof Map || body instanceof List) {635        responseType = "json";636      } else if (body instanceof Node) {637        responseType = "xml";638      } else {639        responseType = "string";640      }641    }642    setVariable(RESPONSE_STATUS, response.getStatus());643    setVariable(RESPONSE, body);644    if (config.isLowerCaseResponseHeaders()) {645      setVariable(RESPONSE_HEADERS, response.getHeadersWithLowerCaseNames());646    } else {647      setVariable(RESPONSE_HEADERS, response.getHeaders());648    }649    setHiddenVariable(RESPONSE_BYTES, bytes);650    setHiddenVariable(RESPONSE_TYPE, responseType);651    cookies = response.getCookies();652    updateConfigCookies(cookies);653    setHiddenVariable(RESPONSE_COOKIES, cookies);654    startTime = request.getStartTimeMillis(); // in case it was re-adjusted by http client655    long endTime = request.getEndTimeMillis();656    setHiddenVariable(REQUEST_TIME_STAMP, startTime);657    setHiddenVariable(RESPONSE_TIME, endTime - startTime);658    if (perfEventName != null) {659      PerfEvent pe = new PerfEvent(startTime, endTime, perfEventName, response.getStatus());660      capturePerfEvent(pe);661    }662  }663  private void httpInvokeWithRetries() {664    int maxRetries = config.getRetryCount();665    int sleep = config.getRetryInterval();666    int retryCount = 0;667    while (true) {668      if (retryCount == maxRetries) {669        throw new KarateException("too many retry attempts: " + maxRetries);670      }671      if (retryCount > 0) {672        try {673          logger.debug("sleeping before retry #{}", retryCount);674          Thread.sleep(sleep);675        } catch (Exception e) {676          throw new RuntimeException(e);677        }678      }679      httpInvokeOnce();680      Variable v;681      try {682        v = evalKarateExpression(requestBuilder.getRetryUntil());683      } catch (Exception e) {684        logger.warn("retry condition evaluation failed: {}", e.getMessage());685        v = Variable.NULL;686      }687      if (v.isTrue()) {688        if (retryCount > 0) {689          logger.debug("retry condition satisfied");690        }691        break;692      } else {693        logger.debug("retry condition not satisfied: {}", requestBuilder.getRetryUntil());694      }695      retryCount++;696    }697  }698  public void status(int status) {699    if (status != response.getStatus()) {700      // make sure log masking is applied701      String message = HttpLogger.getStatusFailureMessage(status, config, request, response);702      setFailedReason(new KarateException(message));703    }704  }705  public KeyStore getKeyStore(String trustStoreFile, String password, String type) {706    if (trustStoreFile == null) {707      return null;708    }709    char[] passwordChars = password == null ? null : password.toCharArray();710    if (type == null) {711      type = KeyStore.getDefaultType();712    }713    try {714      KeyStore keyStore = KeyStore.getInstance(type);715      InputStream is = fileReader.readFileAsStream(trustStoreFile);716      keyStore.load(is, passwordChars);717      logger.debug("key store key count for {}: {}", trustStoreFile, keyStore.size());718      return keyStore;719    } catch (Exception e) {720      logger.error("key store init failed: {}", e.getMessage());721      throw new RuntimeException(e);722    }723  }724  // http mock ===============================================================725  //726  public void mockProceed(String requestUrlBase) {727    String urlBase = requestUrlBase == null ? vars.get(REQUEST_URL_BASE).getValue() : requestUrlBase;728    String uri = vars.get(REQUEST_URI).getValue();729    String url = uri == null ? urlBase : urlBase + "/" + uri;730    requestBuilder.url(url);731    requestBuilder.params(vars.get(REQUEST_PARAMS).getValue());732    requestBuilder.method(vars.get(REQUEST_METHOD).getValue());733    requestBuilder.headers(vars.get(REQUEST_HEADERS).<Map> getValue());734    requestBuilder.removeHeader(HttpConstants.HDR_CONTENT_LENGTH);735    requestBuilder.body(vars.get(REQUEST).getValue());736    if (requestBuilder.client instanceof ArmeriaHttpClient) {737      Request mockRequest = MockHandler.LOCAL_REQUEST.get();738      if (mockRequest != null) {739        ArmeriaHttpClient client = (ArmeriaHttpClient) requestBuilder.client;740        client.setRequestContext(mockRequest.getRequestContext());741      }742    }743    httpInvoke();744  }745  public Map<String, Object> mockConfigureHeaders() {746    return getOrEvalAsMap(config.getResponseHeaders());747  }748  public void mockAfterScenario() {749    if (config.getAfterScenario().isJsOrJavaFunction()) {750      executeFunction(config.getAfterScenario());751    }752  }753  // websocket / async =======================================================754  //755  private List<WebSocketClient> webSocketClients;756  CompletableFuture SIGNAL = new CompletableFuture();757  public WebSocketClient webSocket(WebSocketOptions options) {758    WebSocketClient webSocketClient = new WebSocketClient(options, logger);759    if (webSocketClients == null) {760      webSocketClients = new ArrayList();761    }762    webSocketClients.add(webSocketClient);763    return webSocketClient;764  }765  public void signal(Object result) {766    logger.debug("signal called: {}", result);767    if (parent != null) {768      parent.signal(result);769    } else {770      synchronized (JS.context) {771        SIGNAL.complete(result);772      }773    }774  }775  public Object listen(String exp) {776    Variable v = evalKarateExpression(exp);777    int timeout = v.getAsInt();778    logger.debug("entered listen state with timeout: {}", timeout);779    Object listenResult = null;780    try {781      listenResult = SIGNAL.get(timeout, TimeUnit.MILLISECONDS);782    } catch (Exception e) {783      logger.error("listen timed out: {}", e + "");784    }785    synchronized (JS.context) {786      setHiddenVariable(LISTEN_RESULT, listenResult);787      logger.debug("exit listen state with result: {}", listenResult);788      SIGNAL = new CompletableFuture();789      return listenResult;790    }791  }792  public Command fork(boolean useLineFeed, List<String> args) {793    return fork(useLineFeed, Collections.singletonMap("args", args));794  }795  public Command fork(boolean useLineFeed, String line) {796    return fork(useLineFeed, Collections.singletonMap("line", line));797  }798  public Command fork(boolean useLineFeed, Map<String, Object> options) {799    Boolean useShell = (Boolean) options.get("useShell");800    if (useShell == null) {801      useShell = false;802    }803    List<String> list = (List) options.get("args");804    String[] args;805    if (list == null) {806      String line = (String) options.get("line");807      if (line == null) {808        throw new RuntimeException("'line' or 'args' is required");809      }810      args = Command.tokenize(line);811    } else {812      args = list.toArray(new String[list.size()]);813    }814    if (useShell) {815      args = Command.prefixShellArgs(args);816    }817    String workingDir = (String) options.get("workingDir");818    File workingFile = workingDir == null ? null : new File(workingDir);819    Command command = new Command(useLineFeed, logger, null, null, workingFile, args);820    Map env = (Map) options.get("env");821    if (env != null) {822      command.setEnvironment(env);823    }824    Boolean redirectErrorStream = (Boolean) options.get("redirectErrorStream");825    if (redirectErrorStream != null) {826      command.setRedirectErrorStream(redirectErrorStream);827    }828    Value funOut = (Value) options.get("listener");829    if (funOut != null && funOut.canExecute()) {830      ScenarioListener sl = new ScenarioListener(this, funOut);831      command.setListener(sl);832    }833    Value funErr = (Value) options.get("errorListener");834    if (funErr != null && funErr.canExecute()) {835      ScenarioListener sl = new ScenarioListener(this, funErr);836      command.setErrorListener(sl);837    }838    Boolean start = (Boolean) options.get("start");839    if (start == null) {840      start = true;841    }842    if (start) {843      command.start();844    }845    return command;846  }847  // ui driver / robot =======================================================848  //849  protected Driver driver;850  protected Plugin robot;851  private void autoDef(Plugin plugin, String instanceName) {852    for (String methodName : plugin.methodNames()) {853      String invoke = instanceName + "." + methodName;854      StringBuilder sb = new StringBuilder();855      sb.append("(function(){ if (arguments.length == 0) return ").append(invoke).append("();")856        .append(" if (arguments.length == 1) return ").append(invoke).append("(arguments[0]);")857        .append(" if (arguments.length == 2) return ").append(invoke).append("(arguments[0], arguments[1]);")858        .append(" if (arguments.length == 3) return ")859        .append(invoke).append("(arguments[0], arguments[1], arguments[2]);")860        .append(" if (arguments.length == 4) return ")861        .append(invoke).append("(arguments[0], arguments[1], arguments[2], arguments[3]);")862        .append(" if (arguments.length == 5) return ")863        .append(invoke).append("(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]);")864        .append(" if (arguments.length == 6) return ")865        .append(invoke).append("(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5]);")866        .append(" if (arguments.length == 7) return ")867        .append(invoke)868        .append("(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6]);")869        .append(" return ").append(invoke).append(870        "(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6], "871          + "arguments[7]) })");872      setHiddenVariable(methodName, evalJs(sb.toString()));873    }874  }875  public void driver(String exp) {876    Variable v = evalKarateExpression(exp);877    // re-create driver within a test if needed878    // but user is expected to call quit() OR use the driver keyword with a JSON argument879    if (driver == null || driver.isTerminated() || v.isMap()) {880      Map<String, Object> options = config.getDriverOptions();881      if (options == null) {882        options = new HashMap();883      }884      options.put("target", config.getDriverTarget());885      if (v.isMap()) {886        options.putAll(v.getValue());887      }888      setDriver(DriverOptions.start(options, runtime));889    }890    if (v.isString()) {891      driver.setUrl(v.getAsString());892    }893  }894  public void robot(String exp) {895    Variable v = evalKarateExpression(exp);896    if (robot == null) {897      Map<String, Object> options = config.getRobotOptions();898      if (options == null) {899        options = new HashMap();900      }901      if (v.isMap()) {902        options.putAll(v.getValue());903      } else if (v.isString()) {904        options.put("window", v.getAsString());905      }906      try {907        Class clazz = Class.forName("com.intuit.karate.robot.RobotFactory");908        PluginFactory factory = (PluginFactory) clazz.newInstance();909        robot = factory.create(runtime, options);910      } catch (KarateException ke) {911        throw ke;912      } catch (Exception e) {913        String message =914          "cannot instantiate robot, is 'karate-robot' included as a maven / gradle dependency ? " + e.getMessage();915        logger.error(message);916        throw new RuntimeException(message, e);917      }918      setRobot(robot);919    }920  }921  public void setDriver(Driver driver) {922    this.driver = driver;923    setHiddenVariable(DRIVER, driver);924    if (robot != null) {925      logger.warn("'robot' is active, use 'driver.' prefix for driver methods");926      return;927    }928    autoDef(driver, DRIVER);929    setHiddenVariable(KEY, Key.INSTANCE);930    Ocr ocr = new Ocr(driver);931    setHiddenVariable(Ocr.ENGINE_KEY(), ocr);932    Img img = new Img(driver, ocr);933    setHiddenVariable(Img.ENGINE_KEY(), img);934    asura.ui.karate.plugins.System sys = new asura.ui.karate.plugins.System(driver, ocr, img, true);935    setHiddenVariable(sys.ENGINE_KEY(), sys);936  }937  public void setRobot(Plugin robot) { // TODO unify938    this.robot = robot;939    // robot.setContext(this);940    setHiddenVariable(ROBOT, robot);941    if (driver != null) {942      logger.warn("'driver' is active, use 'robot.' prefix for robot methods");943      return;944    }945    autoDef(robot, ROBOT);946    setHiddenVariable(KEY, Key.INSTANCE);947  }948  public void stop(StepResult lastStepResult) {949    if (runtime.caller.isSharedScope()) {950      // TODO life-cycle this hand off951      ScenarioEngine caller = runtime.caller.parentRuntime.engine;952      if (driver != null) { // a called feature inited the driver953        caller.setDriver(driver);954      }955      if (robot != null) {956        caller.setRobot(robot);957      }958      caller.webSocketClients = webSocketClients;959      // return, don't kill driver just yet960    } else if (runtime.caller.depth == 0) { // end of top-level scenario (no caller)961      if (webSocketClients != null) {962        webSocketClients.forEach(WebSocketClient::close);963      }964      if (driver != null) { // TODO move this to Plugin.afterScenario()965        DriverOptions options = driver.getOptions();966        if (options.stop) {967          driver.quit();968        }969        if (options.target != null) {970          logger.debug("custom target configured, attempting stop()");971          Map<String, Object> map = options.target.stop(runtime);972          String video = (String) map.get("video");973          embedVideo(video);974        } else {975          if (options.afterStop != null) {976            Command.execLine(null, options.afterStop);977          }978          embedVideo(options.videoFile);979        }980      }981      // @FIXME override start982      if (!newDrivers.isEmpty()) {983        newDrivers.values().forEach(newDriver -> {984          if (newDriver.isStop()) {985            newDriver.stopDriver();986          }987        });988      }989      // override end990      if (robot != null) {991        robot.afterScenario();992      }993    }994  }995  private void embedVideo(String path) {996    if (path != null) {997      File videoFile = new File(path);998      if (videoFile.exists()) {999        Embed embed = runtime.embedVideo(videoFile);1000        logger.debug("appended video to report: {}", embed);1001      }1002    }1003  }1004  // doc =====================================================================1005  //1006  private KarateTemplateEngine templateEngine;1007  public void doc(String exp) {1008    if (runtime.reportDisabled) {1009      return;1010    }1011    String path;1012    Variable v = evalKarateExpression(exp);1013    if (v.isString()) {1014      path = v.getAsString();1015    } else if (v.isMap()) {1016      Map<String, Object> map = v.getValue();1017      path = (String) map.get("read");1018      if (path == null) {1019        logger.warn("doc json missing 'read' property: {}", v);1020        return;1021      }1022    } else {1023      logger.warn("doc is not string or json: {}", v);1024      return;1025    }1026    if (templateEngine == null) {1027      String prefixedPath = runtime.featureRuntime.rootFeature.feature.getResource().getPrefixedParentPath();1028      templateEngine = TemplateUtils.forResourcePath(JS, prefixedPath);1029    }1030    String html = templateEngine.process(path);1031    runtime.embed(FileUtils.toBytes(html), ResourceType.HTML);1032  }1033  //==========================================================================1034  //1035  public void init() { // not in constructor because it has to be on Runnable.run() thread1036    JS = JsEngine.local();1037    logger.trace("js context: {}", JS);1038    runtime.magicVariables.forEach((k, v) -> setHiddenVariable(k, v));1039    attachVariables(); // re-hydrate any functions from caller or background1040    setHiddenVariable(KARATE, bridge);1041    setHiddenVariable(READ, readFunction);1042    HttpClient client = runtime.featureRuntime.suite.clientFactory.create(this);1043    requestBuilder = new HttpRequestBuilder(client);1044    // TODO improve life cycle and concept of shared objects1045    if (!runtime.caller.isNone()) {1046      ScenarioEngine caller = runtime.caller.parentRuntime.engine;1047      if (caller.driver != null) {1048        setDriver(caller.driver);1049      }1050      if (caller.robot != null) {1051        setRobot(caller.robot);1052      }1053    }1054  }1055  private void attachVariables() {1056    vars.forEach((k, v) -> {1057      switch (v.type) {1058        case JS_FUNCTION:1059          Value value = attach(v.getValue());1060          v = new Variable(value);1061          vars.put(k, v);1062          break;1063        case MAP:1064        case LIST:1065          recurseAndAttach(v.getValue());1066          break;1067        case OTHER:1068          if (v.isJsFunctionWrapper()) {1069            JsFunction jf = v.getValue();1070            Value attached = attachSource(jf.source);1071            v = new Variable(attached);1072            vars.put(k, v);1073          }1074          break;1075        default:1076          // do nothing1077      }1078      JS.put(k, v.getValue());1079    });1080  }1081  public Map<String, Variable> detachVariables() {1082    Map<String, Variable> detached = new HashMap(vars.size());1083    vars.forEach((k, v) -> {1084      switch (v.type) {1085        case JS_FUNCTION:1086          JsFunction jf = new JsFunction(v.getValue());1087          v = new Variable(jf);1088          break;1089        case MAP:1090        case LIST:1091          recurseAndDetach(v.getValue());1092          break;1093        default:1094          // do nothing1095      }1096      detached.put(k, v);1097    });1098    return detached;1099  }1100  protected Object recurseAndAttach(Object o) {1101    if (o instanceof Value) {1102      Value value = (Value) o;1103      return value.canExecute() ? attach(value) : null;1104    } else if (o instanceof JsFunction) {1105      JsFunction jf = (JsFunction) o;1106      return attachSource(jf.source);1107    } else if (o instanceof List) {1108      List list = (List) o;1109      int count = list.size();1110      for (int i = 0; i < count; i++) {1111        Object child = list.get(i);1112        Object result = recurseAndAttach(child);1113        if (result != null) {1114          list.set(i, result);1115        }1116      }1117      return null;1118    } else if (o instanceof Map) {1119      Map<String, Object> map = (Map) o;1120      map.forEach((k, v) -> {1121        Object result = recurseAndAttach(v);1122        if (result != null) {1123          map.put(k, result);1124        }1125      });1126      return null;1127    } else {1128      return null;1129    }1130  }1131  protected Object recurseAndDetach(Object o) {1132    if (o instanceof Value) {1133      Value value = (Value) o;1134      return value.canExecute() ? new JsFunction(value) : null;1135    } else if (o instanceof List) {1136      List list = (List) o;1137      int count = list.size();1138      for (int i = 0; i < count; i++) {1139        Object child = list.get(i);1140        Object result = recurseAndDetach(child);1141        if (result != null) {1142          list.set(i, result);1143        }1144      }1145      return null;1146    } else if (o instanceof Map) {1147      Map<String, Object> map = (Map) o;1148      map.forEach((k, v) -> {1149        Object result = recurseAndDetach(v);1150        if (result != null) {1151          map.put(k, result);1152        }1153      });1154      return null;1155    } else {1156      return null;1157    }1158  }1159  public Value attachSource(CharSequence source) {1160    return JS.attachSource(source);1161  }1162  public Value attach(Value before) {1163    return JS.attach(before);1164  }1165  protected <T> Map<String, T> getOrEvalAsMap(Variable var, Object... args) {1166    if (var.isJsOrJavaFunction()) {1167      Variable res = executeFunction(var, args);1168      return res.isMap() ? res.getValue() : null;1169    } else {1170      return var.isMap() ? var.getValue() : null;1171    }1172  }1173  public Variable executeFunction(Variable var, Object... args) {1174    switch (var.type) {1175      case JS_FUNCTION:1176        Value jsFunction = var.getValue();1177        JsValue jsResult = executeJsValue(jsFunction, args);1178        return new Variable(jsResult);1179      case JAVA_FUNCTION:  // definitely a "call" with a single argument1180        Function javaFunction = var.getValue();1181        Object arg = args.length == 0 ? null : args[0];1182        Object javaResult = javaFunction.apply(arg);1183        return new Variable(JsValue.unWrap(javaResult));1184      default:1185        throw new RuntimeException("expected function, but was: " + var);1186    }1187  }1188  private JsValue executeJsValue(Value function, Object... args) {1189    try {1190      return JS.execute(function, args);1191    } catch (Exception e) {1192      String jsSource = function.getSourceLocation().getCharacters().toString();1193      KarateException ke = fromJsEvalException(jsSource, e);1194      setFailedReason(ke);1195      throw ke;1196    }1197  }1198  public Variable evalJs(String js) {1199    try {1200      return new Variable(JS.eval(js));1201    } catch (Exception e) {1202      KarateException ke = fromJsEvalException(js, e);1203      setFailedReason(ke);1204      throw ke;1205    }1206  }1207  protected static KarateException fromJsEvalException(String js, Exception e) {1208    // do our best to make js error traces informative, else thrown exception seems to1209    // get swallowed by the java reflection based method invoke flow1210    StackTraceElement[] stack = e.getStackTrace();1211    StringBuilder sb = new StringBuilder();1212    sb.append(">>>> js failed:\n");1213    List<String> lines = StringUtils.toStringLines(js);1214    int index = 0;1215    for (String line : lines) {1216      sb.append(String.format("%02d", ++index)).append(": ").append(line).append('\n');1217    }1218    sb.append("<<<<\n");1219    sb.append(e.toString()).append('\n');1220    for (int i = 0; i < stack.length; i++) {1221      String line = stack[i].toString();1222      sb.append("- ").append(line).append('\n');1223      if (line.startsWith("<js>") || i > 5) {1224        break;1225      }1226    }1227    return new KarateException(sb.toString());1228  }1229  public void setHiddenVariable(String key, Object value) {1230    if (value instanceof Variable) {1231      value = ((Variable) value).getValue();1232    }1233    JS.put(key, value);1234  }1235  public void setVariable(String key, Object value) {1236    Variable v;1237    if (value instanceof Variable) {1238      v = (Variable) value;1239    } else {1240      v = new Variable(value);1241    }1242    vars.put(key, v);1243    if (JS != null) {1244      JS.put(key, v.getValue());1245    }1246    if (children != null) {1247      children.forEach(c -> c.setVariable(key, value));1248    }1249  }1250  public void setVariables(Map<String, Object> map) {1251    if (map == null) {1252      return;1253    }1254    map.forEach((k, v) -> setVariable(k, v));1255  }1256  private static Map<String, Variable> copy(Map<String, Variable> source, boolean deep) {1257    Map<String, Variable> map = new HashMap(source.size());1258    source.forEach((k, v) -> map.put(k, v.copy(deep)));1259    return map;1260  }1261  public Map<String, Variable> copyVariables(boolean deep) {1262    return copy(vars, deep);1263  }1264  public Map<String, Object> getAllVariablesAsMap() {1265    Map<String, Object> map = new HashMap(vars.size());1266    vars.forEach((k, v) -> map.put(k, v == null ? null : v.getValue()));1267    return map;1268  }1269  private static void validateVariableName(String name) {1270    if (!isValidVariableName(name)) {1271      throw new RuntimeException("invalid variable name: " + name);1272    }1273    if (KARATE.equals(name)) {1274      throw new RuntimeException("'karate' is a reserved name");1275    }1276    if (REQUEST.equals(name) || "url".equals(name)) {1277      throw new RuntimeException(1278        "'" + name + "' is a reserved name, also use the form '* " + name + " <expression>' instead");1279    }1280  }1281  private Variable evalAndCastTo(AssignType assignType, String exp) {1282    Variable v = evalKarateExpression(exp);1283    switch (assignType) {1284      case BYTE_ARRAY:1285        return new Variable(v.getAsByteArray());1286      case STRING:1287        return new Variable(v.getAsString());1288      case XML:1289        return new Variable(v.getAsXml());1290      case XML_STRING:1291        String xml = XmlUtils.toString(v.getAsXml());1292        return new Variable(xml);1293      case JSON:1294        return new Variable(v.getValueAndForceParsingAsJson());1295      case YAML:1296        return new Variable(JsonUtils.fromYaml(v.getAsString()));1297      case CSV:1298        return new Variable(JsonUtils.fromCsv(v.getAsString()));1299      case COPY:1300        return v.copy(true);1301      default: // AUTO (TEXT is pre-handled, see below)1302        return v; // as is1303    }1304  }1305  public void assign(AssignType assignType, String name, String exp) {1306    name = StringUtils.trimToEmpty(name);1307    validateVariableName(name); // always validate when gherkin1308    if (vars.containsKey(name)) {1309      logger.warn("over-writing existing variable '{}' with new value: {}", name, exp);1310    }1311    if (assignType == AssignType.TEXT) {1312      setVariable(name, exp);1313    } else {1314      setVariable(name, evalAndCastTo(assignType, exp));1315    }1316  }1317  private static boolean isEmbeddedExpression(String text) {1318    return text != null && (text.startsWith("#(") || text.startsWith("##(")) && text.endsWith(")");1319  }1320  private static class EmbedAction {1321    final boolean remove;1322    final Object value;1323    private EmbedAction(boolean remove, Object value) {1324      this.remove = remove;1325      this.value = value;1326    }1327    static EmbedAction remove() {1328      return new EmbedAction(true, null);1329    }1330    static EmbedAction update(Object value) {1331      return new EmbedAction(false, value);1332    }1333  }1334  public Variable evalEmbeddedExpressions(Variable value) {1335    switch (value.type) {1336      case STRING:1337      case MAP:1338      case LIST:1339        EmbedAction ea = recurseEmbeddedExpressions(value);1340        if (ea != null) {1341          return ea.remove ? Variable.NULL : new Variable(ea.value);1342        } else {1343          return value;1344        }1345      case XML:1346        recurseXmlEmbeddedExpressions(value.getValue());1347      default:1348        return value;1349    }1350  }1351  private EmbedAction recurseEmbeddedExpressions(Variable node) {1352    switch (node.type) {1353      case LIST:1354        List list = node.getValue();1355        Set<Integer> indexesToRemove = new HashSet();1356        int count = list.size();1357        for (int i = 0; i < count; i++) {1358          EmbedAction ea = recurseEmbeddedExpressions(new Variable(list.get(i)));1359          if (ea != null) {1360            if (ea.remove) {1361              indexesToRemove.add(i);1362            } else {1363              list.set(i, ea.value);1364            }1365          }1366        }1367        if (!indexesToRemove.isEmpty()) {1368          List copy = new ArrayList(count - indexesToRemove.size());1369          for (int i = 0; i < count; i++) {1370            if (!indexesToRemove.contains(i)) {1371              copy.add(list.get(i));1372            }1373          }1374          return EmbedAction.update(copy);1375        } else {1376          return null;1377        }1378      case MAP:1379        Map<String, Object> map = node.getValue();1380        List<String> keysToRemove = new ArrayList();1381        map.forEach((k, v) -> {1382          EmbedAction ea = recurseEmbeddedExpressions(new Variable(v));1383          if (ea != null) {1384            if (ea.remove) {1385              keysToRemove.add(k);1386            } else {1387              map.put(k, ea.value);1388            }1389          }1390        });1391        for (String key : keysToRemove) {1392          map.remove(key);1393        }1394        return null;1395      case XML:1396        return null;1397      case STRING:1398        String value = StringUtils.trimToNull(node.getValue());1399        if (!isEmbeddedExpression(value)) {1400          return null;1401        }1402        boolean optional = value.charAt(1) == '#';1403        value = value.substring(optional ? 2 : 1);1404        try {1405          JsValue result = JS.eval(value);1406          if (optional) {1407            if (result.isNull()) {1408              return EmbedAction.remove();1409            } else if (result.isObject() || result.isArray()) {1410              // preserve optional JSON chunk schema-like references as-is, they are needed for future match attempts1411              return null;1412            }1413            // and only substitute primitives !1414          }1415          return EmbedAction.update(result.getValue());1416        } catch (Exception e) {1417          logger.trace("embedded expression failed {}: {}", value, e.getMessage());1418          return null;1419        }1420      default:1421        // do nothing1422        return null;1423    }1424  }1425  private void recurseXmlEmbeddedExpressions(Node node) {1426    if (node.getNodeType() == Node.DOCUMENT_NODE) {1427      node = node.getFirstChild();1428    }1429    NamedNodeMap attribs = node.getAttributes();1430    int attribCount = attribs == null ? 0 : attribs.getLength();1431    Set<Attr> attributesToRemove = new HashSet(attribCount);1432    for (int i = 0; i < attribCount; i++) {1433      Attr attrib = (Attr) attribs.item(i);1434      String value = attrib.getValue();1435      value = StringUtils.trimToNull(value);1436      if (isEmbeddedExpression(value)) {1437        boolean optional = value.charAt(1) == '#';1438        value = value.substring(optional ? 2 : 1);1439        try {1440          JsValue jv = JS.eval(value);1441          if (optional && jv.isNull()) {1442            attributesToRemove.add(attrib);1443          } else {1444            attrib.setValue(jv.getAsString());1445          }1446        } catch (Exception e) {1447          logger.trace("xml-attribute embedded expression failed, {}: {}", attrib.getName(), e.getMessage());1448        }1449      }1450    }1451    for (Attr toRemove : attributesToRemove) {1452      attribs.removeNamedItem(toRemove.getName());1453    }1454    NodeList nodeList = node.getChildNodes();1455    int childCount = nodeList.getLength();1456    List<Node> nodes = new ArrayList(childCount);1457    for (int i = 0; i < childCount; i++) {1458      nodes.add(nodeList.item(i));1459    }1460    Set<Node> elementsToRemove = new HashSet(childCount);1461    for (Node child : nodes) {1462      String value = child.getNodeValue();1463      if (value != null) {1464        value = StringUtils.trimToEmpty(value);1465        if (isEmbeddedExpression(value)) {1466          boolean optional = value.charAt(1) == '#';1467          value = value.substring(optional ? 2 : 1);1468          try {1469            JsValue jv = JS.eval(value);1470            if (optional) {1471              if (jv.isNull()) {1472                elementsToRemove.add(child);1473              } else if (jv.isXml() || jv.isObject()) {1474                // preserve optional XML chunk schema-like references as-is, they are needed for future match attempts1475              } else {1476                child.setNodeValue(jv.getAsString());1477              }1478            } else {1479              if (jv.isXml() || jv.isObject()) {1480                Node evalNode = jv.isXml() ? jv.getValue() : XmlUtils.fromMap(jv.getValue());1481                if (evalNode.getNodeType() == Node.DOCUMENT_NODE) {1482                  evalNode = evalNode.getFirstChild();1483                }1484                if (child.getNodeType() == Node.CDATA_SECTION_NODE) {1485                  child.setNodeValue(XmlUtils.toString(evalNode));1486                } else {1487                  evalNode = node.getOwnerDocument().importNode(evalNode, true);1488                  child.getParentNode().replaceChild(evalNode, child);1489                }1490              } else {1491                child.setNodeValue(jv.getAsString());1492              }1493            }1494          } catch (Exception e) {1495            logger.trace("xml embedded expression failed, {}: {}", child.getNodeName(), e.getMessage());1496          }1497        }1498      } else if (child.hasChildNodes() || child.hasAttributes()) {1499        recurseXmlEmbeddedExpressions(child);1500      }1501    }1502    for (Node toRemove : elementsToRemove) { // because of how the above routine works, these are always of type1503      // TEXT_NODE1504      Node parent = toRemove.getParentNode(); // element containing the text-node1505      Node grandParent = parent.getParentNode(); // parent element1506      grandParent.removeChild(parent);1507    }1508  }1509  public String replacePlaceholderText(String text, String token, String replaceWith) {1510    if (text == null) {1511      return null;1512    }1513    replaceWith = StringUtils.trimToNull(replaceWith);1514    if (replaceWith == null) {1515      return text;1516    }1517    try {1518      Variable v = evalKarateExpression(replaceWith);1519      replaceWith = v.getAsString();1520    } catch (Exception e) {1521      throw new RuntimeException(1522        "expression error (replace string values need to be within quotes): " + e.getMessage());1523    }1524    if (replaceWith == null) { // ignore if eval result is null1525      return text;1526    }1527    token = StringUtils.trimToNull(token);1528    if (token == null) {1529      return text;1530    }1531    char firstChar = token.charAt(0);1532    if (Character.isLetterOrDigit(firstChar)) {1533      token = '<' + token + '>';1534    }1535    return text.replace(token, replaceWith);1536  }1537  private static final String TOKEN = "token";1538  public void replaceTable(String text, List<Map<String, String>> list) {1539    if (text == null) {1540      return;1541    }1542    if (list == null) {1543      return;1544    }1545    for (Map<String, String> map : list) {1546      String token = map.get(TOKEN);1547      if (token == null) {1548        continue;1549      }1550      // the verbosity below is to be lenient with table second column name1551      List<String> keys = new ArrayList(map.keySet());1552      keys.remove(TOKEN);1553      Iterator<String> iterator = keys.iterator();1554      if (iterator.hasNext()) {1555        String key = keys.iterator().next();1556        String value = map.get(key);1557        replace(text, token, value);1558      }1559    }1560  }1561  public void set(String name, String path, Variable value) {1562    set(name, path, false, value, false, false);1563  }1564  private void set(String name, String path, String exp, boolean delete, boolean viaTable) {1565    set(name, path, isWithinParentheses(exp), evalKarateExpression(exp), delete, viaTable);1566  }1567  private void set(String name, String path, boolean isWithinParentheses, Variable value, boolean delete,1568    boolean viaTable) {1569    name = StringUtils.trimToEmpty(name);1570    path = StringUtils.trimToNull(path);1571    if (viaTable && value.isNull() && !isWithinParentheses) {1572      // by default, skip any expression that evaluates to null unless the user expressed1573      // intent to over-ride by enclosing the expression in parentheses1574      return;1575    }1576    if (path == null) {1577      StringUtils.Pair nameAndPath = parseVariableAndPath(name);1578      name = nameAndPath.left;1579      path = nameAndPath.right;1580    }1581    Variable target = vars.get(name);1582    if (isXmlPath(path)) {1583      if (target == null || target.isNull()) {1584        if (viaTable) { // auto create if using set via cucumber table as a convenience1585          Document empty = XmlUtils.newDocument();1586          target = new Variable(empty);1587          setVariable(name, target);1588        } else {1589          throw new RuntimeException("variable is null or not set '" + name + "'");1590        }1591      }1592      Document doc = target.getValue();1593      if (delete) {1594        XmlUtils.removeByPath(doc, path);1595      } else if (value.isXml()) {1596        Node node = value.getValue();1597        XmlUtils.setByPath(doc, path, node);1598      } else if (value.isMap()) { // cast to xml1599        Node node = XmlUtils.fromMap(value.getValue());1600        XmlUtils.setByPath(doc, path, node);1601      } else {1602        XmlUtils.setByPath(doc, path, value.getAsString());1603      }1604    } else { // assume json-path1605      if (target == null || target.isNull()) {1606        if (viaTable) { // auto create if using set via cucumber table as a convenience1607          Json json;1608          if (path.startsWith("$[") && !path.startsWith("$['")) {1609            json = Json.of("[]");1610          } else {1611            json = Json.of("{}");1612          }1613          target = new Variable(json.value());1614          setVariable(name, target);1615        } else {1616          throw new RuntimeException("variable is null or not set '" + name + "'");1617        }1618      }1619      Json json;1620      if (target.isMapOrList()) {1621        json = Json.of(target.<Object> getValue());1622      } else {1623        throw new RuntimeException("cannot set json path on type: " + target);1624      }1625      if (delete) {1626        json.remove(path);1627      } else {1628        json.set(path, value.<Object> getValue());1629      }1630    }1631  }1632  private static final String PATH = "path";1633  public void setViaTable(String name, String path, List<Map<String, String>> list) {1634    name = StringUtils.trimToEmpty(name);1635    path = StringUtils.trimToNull(path);1636    if (path == null) {1637      StringUtils.Pair nameAndPath = parseVariableAndPath(name);1638      name = nameAndPath.left;1639      path = nameAndPath.right;1640    }1641    for (Map<String, String> map : list) {1642      String append = (String) map.get(PATH);1643      if (append == null) {1644        continue;1645      }1646      List<String> keys = new ArrayList(map.keySet());1647      keys.remove(PATH);1648      int columnCount = keys.size();1649      for (int i = 0; i < columnCount; i++) {1650        String key = keys.get(i);1651        String expression = StringUtils.trimToNull(map.get(key));1652        if (expression == null) { // cucumber cell was left blank1653          continue; // skip1654          // default behavior is to skip nulls when the expression evaluates1655          // this is driven by the routine in setValueByPath1656          // and users can over-ride this by simply enclosing the expression in parentheses1657        }1658        String suffix;1659        try {1660          int arrayIndex = Integer.valueOf(key);1661          suffix = "[" + arrayIndex + "]";1662        } catch (NumberFormatException e) { // default to the column position as the index1663          suffix = columnCount > 1 ? "[" + i + "]" : "";1664        }1665        String finalPath;1666        if (append.startsWith("/") || (path != null && path.startsWith("/"))) { // XML1667          if (path == null) {1668            finalPath = append + suffix;1669          } else {1670            finalPath = path + suffix + '/' + append;1671          }1672        } else {1673          if (path == null) {1674            path = "$";1675          }1676          finalPath = path + suffix + '.' + append;1677        }1678        set(name, finalPath, expression, false, true);1679      }1680    }1681  }1682  public static StringUtils.Pair parseVariableAndPath(String text) {1683    Matcher matcher = VAR_AND_PATH_PATTERN.matcher(text);1684    matcher.find();1685    String name = text.substring(0, matcher.end());1686    String path;1687    if (matcher.end() == text.length()) {1688      path = "";1689    } else {1690      path = text.substring(matcher.end()).trim();1691    }1692    if (isXmlPath(path) || isXmlPathFunction(path)) {1693      // xml, don't prefix for json1694    } else {1695      path = "$" + path;1696    }1697    return StringUtils.pair(name, path);1698  }1699  public Match.Result match(Match.Type matchType, String expression, String path, String rhs) {1700    String name = StringUtils.trimToEmpty(expression);1701    if (isDollarPrefixedJsonPath(name) || isXmlPath(name)) { //1702      path = name;1703      name = RESPONSE;1704    }1705    if (name.startsWith("$")) { // in case someone used the dollar prefix by mistake on the LHS1706      name = name.substring(1);1707    }1708    path = StringUtils.trimToNull(path);1709    if (path == null) {1710      StringUtils.Pair pair = parseVariableAndPath(name);1711      name = pair.left;1712      path = pair.right;1713    }1714    if ("header".equals(name)) { // convenience shortcut for asserting against response header1715      return matchHeader(matchType, path, rhs);1716    }1717    Variable actual;1718    // karate started out by "defaulting" to JsonPath on the LHS of a match so we have this kludge1719    // but we now handle JS expressions of almost any shape on the LHS, if in doubt, wrap in parentheses1720    // actually it is not too bad - the XPath function check is the only odd one out1721    // rules:1722    // if not XPath function, wrapped in parentheses, involves function call1723    //      [then] JS eval1724    // else if XPath, JsonPath, JsonPath wildcard ".." or "*" or "[?"1725    //      [then] eval name, and do a JsonPath or XPath using the parsed path1726    if (isXmlPathFunction(path)1727      || (!name.startsWith("(") && !path.endsWith(")") && !path.contains(")."))1728      && (isDollarPrefixed(path) || isJsonPath(path) || isXmlPath(path))) {1729      actual = evalKarateExpression(name);1730      // edge case: java property getter, e.g. "driver.cookies"1731      if (!actual.isMap() && !actual.isList() && !isXmlPath(path) && !isXmlPathFunction(path)) {1732        actual = evalKarateExpression(expression); // fall back to JS eval of entire LHS1733        path = "$";1734      }1735    } else {1736      actual = evalKarateExpression(expression); // JS eval of entire LHS1737      path = "$";1738    }1739    if ("$".equals(path) || "/".equals(path)) {1740      // we have eval-ed the entire LHS, so proceed to match RHS to "$"1741    } else {1742      if (isDollarPrefixed(path)) { // json-path1743        actual = evalJsonPath(actual, path);1744      } else { // xpath1745        actual = evalXmlPath(actual, path);1746      }1747    }1748    Variable expected = evalKarateExpression(rhs);1749    return match(matchType, actual.getValue(), expected.getValue());1750  }1751  // TODO document that match header is case-insensitive at last1752  private Match.Result matchHeader(Match.Type matchType, String name, String exp) {1753    Variable expected = evalKarateExpression(exp);1754    String actual = response.getHeader(name);1755    return match(matchType, actual, expected.getValue());1756  }1757  public Match.Result match(Match.Type matchType, Object actual, Object expected) {1758    return Match.execute(JS, matchType, actual, expected);1759  }1760  private static final Pattern VAR_AND_PATH_PATTERN = Pattern.compile("\\w+");1761  private static final String VARIABLE_PATTERN_STRING = "[a-zA-Z][\\w]*";1762  private static final Pattern VARIABLE_PATTERN = Pattern.compile(VARIABLE_PATTERN_STRING);1763  private static final Pattern FUNCTION_PATTERN = Pattern.compile("^function[^(]*\\(");1764  private static final Pattern JS_PLACEHODER = Pattern.compile("\\$\\{.*?\\}");1765  public static boolean isJavaScriptFunction(String text) {1766    return FUNCTION_PATTERN.matcher(text).find();1767  }1768  public static boolean isValidVariableName(String name) {1769    return VARIABLE_PATTERN.matcher(name).matches();1770  }1771  public static boolean hasJavaScriptPlacehoder(String exp) {1772    return JS_PLACEHODER.matcher(exp).find();1773  }1774  public static final boolean isVariableAndSpaceAndPath(String text) {1775    return text.matches("^" + VARIABLE_PATTERN_STRING + "\\s+.+");1776  }1777  public static final boolean isVariable(String text) {1778    return VARIABLE_PATTERN.matcher(text).matches();1779  }1780  public static final boolean isWithinParentheses(String text) {1781    return text != null && text.startsWith("(") && text.endsWith(")");1782  }1783  public static final boolean isCallSyntax(String text) {1784    return text.startsWith("call ");1785  }1786  public static final boolean isCallOnceSyntax(String text) {1787    return text.startsWith("callonce ");1788  }1789  public static final boolean isGetSyntax(String text) {1790    return text.startsWith("get ") || text.startsWith("get[");1791  }1792  public static final boolean isJson(String text) {1793    return text.startsWith("{") || text.startsWith("[");1794  }1795  public static final boolean isXml(String text) {1796    return text.startsWith("<");1797  }1798  public static boolean isXmlPath(String text) {1799    return text.startsWith("/");1800  }1801  public static boolean isXmlPathFunction(String text) {1802    return text.matches("^[a-z-]+\\(.+");1803  }1804  public static final boolean isJsonPath(String text) {1805    return text.indexOf('*') != -1 || text.contains("..") || text.contains("[?");1806  }1807  public static final boolean isDollarPrefixed(String text) {1808    return text.startsWith("$");1809  }1810  public static final boolean isDollarPrefixedJsonPath(String text) {1811    return text.startsWith("$.") || text.startsWith("$[") || text.equals("$");1812  }1813  public static StringUtils.Pair parseCallArgs(String line) {1814    int pos = line.indexOf("read(");1815    if (pos != -1) {1816      pos = line.indexOf(')');1817      if (pos == -1) {1818        throw new RuntimeException("failed to parse call arguments: " + line);1819      }1820      return new StringUtils.Pair(line.substring(0, pos + 1), StringUtils.trimToNull(line.substring(pos + 1)));1821    }1822    pos = line.indexOf(' ');1823    if (pos == -1) {1824      return new StringUtils.Pair(line, null);1825    }1826    return new StringUtils.Pair(line.substring(0, pos), StringUtils.trimToNull(line.substring(pos)));1827  }1828  public Variable call(Variable called, Variable arg, boolean sharedScope) {1829    switch (called.type) {1830      case JS_FUNCTION:1831      case JAVA_FUNCTION:1832        return arg == null ? executeFunction(called) : executeFunction(called, new Object[] {arg.getValue()});1833      case FEATURE:1834        Variable res = callFeature(called.getValue(), arg, -1, sharedScope);1835        recurseAndAttach(res.getValue()); // will always be a map, we update entries within1836        return res;1837      default:1838        throw new RuntimeException("not a callable feature or js function: " + called);1839    }1840  }1841  public Variable call(boolean callOnce, String exp, boolean sharedScope) {1842    StringUtils.Pair pair = parseCallArgs(exp);1843    Variable called = evalKarateExpression(pair.left);1844    Variable arg = pair.right == null ? null : evalKarateExpression(pair.right);1845    Variable result;1846    if (callOnce) {1847      result = callOnce(exp, called, arg, sharedScope);1848    } else {1849      result = call(called, arg, sharedScope);1850    }1851    if (sharedScope && result.isMap()) {1852      setVariables(result.getValue());1853    }1854    return result;1855  }1856  private Variable result(ScenarioCall.Result result, boolean sharedScope) {1857    if (sharedScope) { // if shared scope1858      vars.clear(); // clean slate1859      vars.putAll(copy(result.vars, false)); // clone for safety1860      init(); // this will also insert magic variables1861      setConfig(new Config(result.config)); // re-apply config from time of snapshot1862      return Variable.NULL; // since we already reset the vars above we return null1863      // else the call() routine would try to do it again1864      // note that shared scope means a return value is meaningless1865    } else {1866      return result.value.copy(false); // clone result for safety1867    }1868  }1869  private Variable callOnce(String cacheKey, Variable called, Variable arg, boolean sharedScope) {1870    // IMPORTANT: the call result is always shallow-cloned before returning1871    // so that call result (especially if a java Map) is not mutated by other scenarios1872    final Map<String, ScenarioCall.Result> CACHE = runtime.featureRuntime.FEATURE_CACHE;1873    ScenarioCall.Result result = CACHE.get(cacheKey);1874    if (result != null) {1875      logger.trace("callonce cache hit for: {}", cacheKey);1876      return result(result, sharedScope);1877    }1878    long startTime = System.currentTimeMillis();1879    logger.trace("callonce waiting for lock: {}", cacheKey);1880    synchronized (CACHE) {1881      result = CACHE.get(cacheKey); // retry1882      if (result != null) {1883        long endTime = System.currentTimeMillis() - startTime;1884        logger.warn("this thread waited {} milliseconds for callonce lock: {}", endTime, cacheKey);1885        return result(result, sharedScope);1886      }1887      // this thread is the 'winner'1888      logger.info(">> lock acquired, begin callonce: {}", cacheKey);1889      Variable resultValue = call(called, arg, sharedScope);1890      // we clone result (and config) here, to snapshot state at the point the callonce was invoked1891      // this prevents the state from being clobbered by the subsequent steps of this1892      // first scenario that is about to use the result1893      Map<String, Variable> clonedVars = called.isFeature() && sharedScope ? detachVariables() : null;1894      Config clonedConfig = new Config(config);1895      clonedConfig.detach();1896      result = new ScenarioCall.Result(resultValue.copy(false), clonedConfig, clonedVars);1897      CACHE.put(cacheKey, result);1898      logger.info("<< lock released, cached callonce: {}", cacheKey);1899      return resultValue; // another routine will apply globally if needed1900    }1901  }1902  public Variable callFeature(Feature feature, Variable arg, int index, boolean sharedScope) {1903    if (arg == null || arg.isMap()) {1904      ScenarioCall call = new ScenarioCall(runtime, feature, arg);1905      call.setLoopIndex(index);1906      call.setSharedScope(sharedScope);1907      FeatureRuntime fr = new FeatureRuntime(call);1908      fr.run();1909      // VERY IMPORTANT ! switch back from called feature js context1910      THREAD_LOCAL.set(this);1911      FeatureResult result = fr.result;1912      runtime.addCallResult(result);1913      if (result.isFailed()) {1914        KarateException ke = result.getErrorMessagesCombined();1915        throw ke;1916      } else {1917        return new Variable(result.getVariables());1918      }1919    } else if (arg.isList() || arg.isJsOrJavaFunction()) {1920      List result = new ArrayList();1921      List<String> errors = new ArrayList();1922      int loopIndex = 0;1923      boolean isList = arg.isList();1924      Iterator iterator = isList ? arg.<List> getValue().iterator() : null;1925      while (true) {1926        Variable loopArg;1927        if (isList) {1928          loopArg = iterator.hasNext() ? new Variable(iterator.next()) : Variable.NULL;1929        } else { // function1930          loopArg = executeFunction(arg, new Object[] {loopIndex});1931        }1932        if (!loopArg.isMap()) {1933          if (!isList) {1934            logger.info("feature call loop function ended at index {}, returned: {}", loopIndex, loopArg);1935          }1936          break;1937        }1938        try {1939          Variable loopResult = callFeature(feature, loopArg, loopIndex, sharedScope);1940          result.add(loopResult.getValue());1941        } catch (Exception e) {1942          String message = "feature call loop failed at index: " + loopIndex + ", " + e.getMessage();1943          errors.add(message);1944          runtime.logError(message);...

executeFunction

Using AI Code Generation

1import com.intuit.karate.core.ScenarioEngine2import com.intuit.karate.core.Feature3import com.intuit.karate.core.FeatureRuntime4import com.intuit.karate.core.FeatureRuntimeOptions5import com.intuit.karate.core.FeatureRuntimeOptionsBuilder6import com.intuit.karate.core.FeatureRuntimeOptionsBuilder.Options7import com.intuit.karate.core.FeatureRuntimeOptionsBuilder.OptionsBuilder8import com.intuit.karate.core.Scenario9import com.intuit.karate.core.ScenarioContext10import com.intuit.karate.core.ScenarioException11import com.intuit.karate.core.ScenarioRuntime12import com.intuit.karate.core.ScenarioRuntimeOptions13import com.intuit.karate.core.ScenarioRuntimeOptionsBuilder14import com.intuit.karate.core.ScenarioRuntimeOptionsBuilder.Options15import com.intuit.karate.core.ScenarioRuntimeOptionsBuilder.OptionsBuilder16import com.intuit.karate.core.ScenarioState17import com.intuit.karate.core.ScenarioStateBuilder18import com.intuit.karate.core.ScenarioStateBuilder.State19import com.intuit.karate.core.ScenarioStateBuilder.StateBuilder20import com.intuit.karate.core.ScenarioUtils21import com.intuit.karate.core.ScenarioUtils.*22import com.intuit.karate.core.ScenarioUtils.isScenario23import com.intuit.karate.core.ScenarioUtils.isScenarioOutline24import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExample25import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamples26import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTable27import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableRow28import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableRowCell29import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableRowCells30import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableRowEnd31import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableRowStart32import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableStart33import com.intuit.karate.core.ScenarioUtils.isScenarioOutlineExamplesTableEnd34import com.intuit.karate.core.ScenarioUtils.isScenarioOutline

executeFunction

Using AI Code Generation

1import com.intuit.karate.core.ScenarioEngine2import com.intuit.karate.core.Feature3import com.intuit.karate.core.FeatureRuntime4def feature = new Feature(null, '''5def engine = new ScenarioEngine(feature)6def runtime = new FeatureRuntime(feature, engine, null)7def result = runtime.executeFunction('a')

executeFunction

Using AI Code Generation

1import com.intuit.karate.core.ScenarioEngine2import com.intuit.karate.core.ScenarioContext3import com.intuit.karate.core.ScenarioResult4import com.intuit.karate.core.Feature5import com.intuit.karate.core.FeatureRuntime6import com.intuit.karate.core.FeatureContext7import com.intuit.karate.core.FeatureResult8import com.intuit.karate.core.FeatureInfo9import com.intuit.karate.core.FeatureRuntimeOptions10import com.intuit.karate.core.FeatureRuntimeOptionsBuilder11import com.intuit.karate.core.FeatureRuntimeOptionsBuilder.*12import com.intuit.karate.core.FeatureRuntimeOptionsBuilder.FeatureRuntimeOpt

executeFunction

Using AI Code Generation

1    * def myFunction = function() { return 'my value' }2    * myFunction() == 'my value'3    * def myValue = engine.executeFunction('classpath:my.feature', 'myFunction')4    * def myFunction = function(arg1, arg2) { return arg1 + arg2 }5    * myFunction(1, 2) == 36    * def myValue = engine.executeFunction('classpath:my.feature', 'myFunction', [ 1, 2 ])7    * def myFunction = function(arg) { return arg }8    * myFunction({ 'key1' : 'value1', 'key2' : 'value2' }) == { 'key1' : 'value1', 'key2' : 'value2' }9    * def myValue = engine.executeFunction('classpath:my.feature', 'myFunction', [ { 'key1' : 'value1', 'key2' : 'value2' } ])10    * myValue == { 'key1' : '

executeFunction

Using AI Code Generation

1* def feature = read('classpath:com/intuit/karate/core/execute-function.feature')2* def scenario = feature.getFeatureElements().get(0)3* def context = engine.createContext(feature, scenario, new java.util.HashMap())4* def result = engine.executeFunction(context, 'add', [1, 2])5* def result2 = engine.executeFunction(context, 'add', [1, 2, 3])6* def options = { foo: 'bar' }7* def result3 = engine.executeFunction(context, 'add', [1, 2, 3], options)8* def options = { foo: 'bar' }9* def callback = { a, b -> a + b }10* def result4 = engine.executeFunction(context, 'add', [1, 2, 3], options, callback)11* def options = { foo: 'bar' }12* def callback = { a, b -> a + b }13function add(a, b) {14  return a + b;15}16* def result5 = engine.executeFunction(context, 'add', [1, 2, 3], options, callback, js)17* def options = { foo: 'bar' }18* def callback = { a, b -> a + b }19function add(a, b) {20  return a + b;21}22* def config = { foo: 'bar' }23* def result6 = engine.executeFunction(context, 'add', [1, 2, 3], options, callback, js, config)

executeFunction

Using AI Code Generation

1import com.intuit.karate.core.ScenarioEngine2import com.intuit.karate.core.FeatureRuntime3import com.intuit.karate.core.FeatureRuntimeOptions4import com.intuit.karate.core.FeatureRuntimeOptionsBuilder5    * def options = new FeatureRuntimeOptionsBuilder().build()6    * def featureRuntime = new FeatureRuntime('classpath:myFunction.feature', options)7    * def myFunction = engine.executeFunction(featureRuntime, 'myFunction')8    * def result = myFunction()9    * myFunction = engine.executeFunction(featureRuntime, 'myFunction')10    * result = myFunction()11    * myFunction = engine.executeFunction(featureRuntime, 'myFunction')12    * result = myFunction()

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.