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

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

Source:ScenarioEngine.java

...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;...

validateVariableName

Using AI Code Generation

1import com.intuit.karate.core.ScenarioEngine2ScenarioEngine.validateVariableName('name')3import com.intuit.karate.core.ScenarioEngine4ScenarioEngine.validateVariableName('name')5import com.intuit.karate.core.ScenarioEngine6ScenarioEngine.validateVariableName('name')7import com.intuit.karate.core.ScenarioEngine8ScenarioEngine.validateVariableName('name')9import com.intuit.karate.core.ScenarioEngine10ScenarioEngine.validateVariableName('name')11import com.intuit.karate.core.ScenarioEngine12ScenarioEngine.validateVariableName('name')13import com.intuit.karate.core.ScenarioEngine14ScenarioEngine.validateVariableName('name')15import com.intuit.karate.core.ScenarioEngine16ScenarioEngine.validateVariableName('name')17import com.intuit.karate.core.ScenarioEngine18ScenarioEngine.validateVariableName('name')19import com.intuit.karate.core.ScenarioEngine20ScenarioEngine.validateVariableName('name')21import com.intuit.karate.core.ScenarioEngine22ScenarioEngine.validateVariableName('name')23import com.intuit.karate.core.ScenarioEngine24ScenarioEngine.validateVariableName('name')25import com.intuit.kar

validateVariableName

Using AI Code Generation

1assert engine.validateVariableName('foo')2assert !engine.validateVariableName('foo-bar')3assert engine.validateVariableName('foo')4assert !engine.validateVariableName('foo-bar')5assert engine.validateVariableName('foo')6assert !engine.validateVariableName('foo-bar')7assert engine.validateVariableName('foo')8assert !engine.validateVariableName('foo-bar')9assert engine.validateVariableName('foo')10assert !engine.validateVariableName('foo-bar')11assert engine.validateVariableName('foo')12assert !engine.validateVariableName('foo-bar')13assert engine.validateVariableName('foo')14assert !engine.validateVariableName('foo-bar')15assert engine.validateVariableName('foo')16assert !engine.validateVariableName('foo-bar')17assert engine.validateVariableName('foo')18assert !engine.validateVariableName('foo-bar')

validateVariableName

Using AI Code Generation

1* def result = engine.validateVariableName('myVar')2* def result = engine.validateVariableName('myVar1')3* def result = engine.validateVariableName('myVar_1')4* def result = engine.validateVariableName('myVar#1')5* def result = engine.validateVariableName('myVar@1')6* def result = engine.validateVariableName('myVar$1')7* def result = engine.validateVariableName('myVar%1')8* def result = engine.validateVariableName('myVar^1')9* def result = engine.validateVariableName('myVar&1')10* def result = engine.validateVariableName('myVar*1')11* def result = engine.validateVariableName('myVar(1')12* def result = engine.validateVariableName('myVar)1')13* def result = engine.validateVariableName('myVar-1')14* def result = engine.validateVariableName('myVar_1')15* def result = engine.validateVariableName('myVar_1')16* def result = engine.validateVariableName('myVar_1')17* def result = engine.validateVariableName('myVar_1')18* def result = engine.validateVariableName('myVar_1')19* def result = engine.validateVariableName('myVar')20* def result = engine.validateVariableName('myVar1')21* def result = engine.validateVariableName('myVar_1')22* def result = engine.validateVariableName('myVar#1')

validateVariableName

Using AI Code Generation

1def valid = engine.validateVariableName('valid')2def invalid = engine.validateVariableName('invalid')3def valid = engine.validateVariableName('valid')4def invalid = engine.validateVariableName('invalid')5def valid = engine.validateVariableName('valid')6def invalid = engine.validateVariableName('invalid')7def valid = engine.validateVariableName('valid')8def invalid = engine.validateVariableName('invalid')9def valid = engine.validateVariableName('valid')10def invalid = engine.validateVariableName('invalid')11def valid = engine.validateVariableName('valid')12def invalid = engine.validateVariableName('invalid')13def valid = engine.validateVariableName('valid')14def invalid = engine.validateVariableName('invalid')15def valid = engine.validateVariableName('valid')16def invalid = engine.validateVariableName('invalid')

validateVariableName

Using AI Code Generation

1def testVariableNameValidity(variableName) {2    def engine = new com.intuit.karate.core.ScenarioEngine(null)3    try {4        engine.validateVariableName(variableName)5    } catch (e) {6    }7}8assert testVariableNameValidity('validVarName') == true9assert testVariableNameValidity('validVarName1') == true10assert testVariableNameValidity('validVarName_') == true11assert testVariableNameValidity('validVarName_1') == true12assert testVariableNameValidity('validVarName_1_') == true13assert testVariableNameValidity('validVarName_1_1') == true14assert testVariableNameValidity('validVarName_1_1_') == true15assert testVariableNameValidity('validVarName_1_1_1') == true16assert testVariableNameValidity('validVarName_1_1_1_') == true17assert testVariableNameValidity('validVarName_1_1_1_1') == true18assert testVariableNameValidity('validVarName_1_1_1_1_') == true19assert testVariableNameValidity('validVarName_1_1_1_1_1') == true20assert testVariableNameValidity('validVarName_1_1_1_1_1_') == true21assert testVariableNameValidity('validVarName_1_1_1_1_1_1') == true22assert testVariableNameValidity('validVarName_1_1_1_1_1_1_') == true23assert testVariableNameValidity('validVarName_1_1_1_1_1_1_1') == true24assert testVariableNameValidity('validVarName_1_1_1_1_1_1_1_') == true25assert testVariableNameValidity('validVarName_1_1_1_1_1_1_1_1') == true26assert testVariableNameValidity('validVarName_1_1_1_1_1_1_1_1_') == true27assert testVariableNameValidity('validVarName_1_1_1_1_1_1_1_1_1') == true

validateVariableName

Using AI Code Generation

1def engine = new com.intuit.karate.core.ScenarioEngine(null, null, null)2def varName8 = 'var1('3def varName12 = 'var1{'4def varName13 = 'var1}'5def varName25 = 'var1;'6def result = engine.validateVariableName(varName)7def result1 = engine.validateVariableName(varName1)8def result2 = engine.validateVariableName(varName2)9def result3 = engine.validateVariableName(varName3)10def result4 = engine.validateVariableName(varName4)11def result5 = engine.validateVariableName(varName5)12def result6 = engine.validateVariableName(varName6)13def result7 = engine.validateVariableName(varName7)14def result8 = engine.validateVariableName(varName8)15def result9 = engine.validateVariableName(varName9)16def result10 = engine.validateVariableName(varName10)17def result11 = engine.validateVariableName(varName11)18def result12 = engine.validateVariableName(varName12)

validateVariableName

Using AI Code Generation

1* engine.validateVariableName('foo')2* engine.validateVariableName('foo-bar')3* engine.validateVariableName('foo-bar-baz')4* engine.validateVariableName('foo_bar')5* engine.validateVariableName('foo_bar_baz')6* engine.validateVariableName('foo_bar-baz')7* engine.validateVariableName('foo_bar-baz-foo')8* engine.validateVariableName('foo_bar-baz-foo-bar')9* engine.validateVariableName('foo-bar_baz-foo-bar')10* engine.validateVariableName('foo-bar_baz-foo-bar-baz')11* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo')12* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar')13* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz')14* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo')15* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar')16* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz')17* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo')18* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo-bar')19* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo-bar_baz')20* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo-bar_baz-foo')21* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo-bar_baz-foo-bar')22* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo-bar_baz-foo-bar_baz')23* engine.validateVariableName('foo-bar_baz-foo-bar-baz-foo-bar_baz-foo-bar_baz-foo

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.