KaneAI - World’s First E2E Software Testing Agent.Book a Demo 
How to use highlight method of com.intuit.karate.driver.MissingElement class
Best Karate code snippet using com.intuit.karate.driver.MissingElement.highlight
Source:RobotBase.java 
...74 private Integer retryIntervalOverride = null;75 private Integer retryCountOverride = null;76 // debug77 protected boolean debug;78 public boolean highlight;79 public int highlightDuration;80 public void setDebug(boolean debug) {81 this.debug = debug;82 }83 public void setHighlight(boolean highlight) {84 this.highlight = highlight;85 }86 public void setHighlightDuration(int highlightDuration) {87 this.highlightDuration = highlightDuration;88 }89 public void disableRetry() {90 retryEnabled = false;91 retryCountOverride = null;92 retryIntervalOverride = null;93 }94 public void enableRetry(Integer count, Integer interval) {95 retryEnabled = true;96 retryCountOverride = count; // can be null97 retryIntervalOverride = interval; // can be null98 }99 private int getRetryCount() {100 return retryCountOverride == null ? context.getConfig().getRetryCount() : retryCountOverride;101 }102 private int getRetryInterval() {103 return retryIntervalOverride == null ? context.getConfig().getRetryInterval() : retryIntervalOverride;104 }105 private <T> T get(String key, T defaultValue) {106 T temp = (T) options.get(key);107 return temp == null ? defaultValue : temp;108 }109 public RobotBase(ScenarioContext context) {110 this(context, Collections.EMPTY_MAP);111 }112 public RobotBase(ScenarioContext context, Map<String, Object> options) {113 this.context = context;114 this.logger = context.logger;115 bridge = context.bindings.bridge;116 try {117 this.options = options;118 basePath = get("basePath", null);119 highlight = get("highlight", false);120 highlightDuration = get("highlightDuration", Config.DEFAULT_HIGHLIGHT_DURATION);121 autoDelay = get("autoDelay", 0);122 tessData = get("tessData", "tessdata");123 tessLang = get("tessLang", "eng");124 toolkit = Toolkit.getDefaultToolkit();125 dimension = toolkit.getScreenSize();126 screen = new Region(this, 0, 0, dimension.width, dimension.height);127 logger.debug("screen dimensions: {}", screen);128 robot = new java.awt.Robot();129 robot.setAutoDelay(autoDelay);130 robot.setAutoWaitForIdle(true);131 //==================================================================132 autoClose = get("autoClose", true);133 boolean attach = get("attach", true);134 String window = get("window", null);135 if (window != null) {136 currentWindow = window(window, false, false); // don't retry137 }138 if (currentWindow != null && attach) {139 logger.debug("window found, will re-use: {}", window);140 } else {141 ScriptValue sv = new ScriptValue(options.get("fork"));142 if (sv.isString()) {143 command = bridge.fork(sv.getAsString());144 } else if (sv.isListLike()) {145 command = bridge.fork(sv.getAsList());146 } else if (sv.isMapLike()) {147 command = bridge.fork(sv.getAsMap());148 }149 if (command != null) {150 delay(500); // give process time to start151 if (command.isFailed()) {152 throw new KarateException("robot fork command failed: " + command.getFailureReason().getMessage());153 }154 if (window != null) {155 retryCountOverride = get("retryCount", null);156 retryIntervalOverride = get("retryInterval", null);157 currentWindow = window(window); // will retry158 logger.debug("attached to process window: {} - {}", currentWindow, command.getArgList());159 }160 }161 if (currentWindow == null && window != null) {162 throw new KarateException("failed to find window: " + window);163 }164 }165 } catch (Exception e) {166 String message = "robot init failed: " + e.getMessage();167 throw new KarateException(message, e);168 }169 }170 public <T> T retry(Supplier<T> action, Predicate<T> condition, String logDescription, boolean failWithException) {171 long startTime = System.currentTimeMillis();172 int count = 0, max = getRetryCount();173 int interval = getRetryInterval();174 disableRetry(); // always reset175 T result;176 boolean success;177 do {178 if (count > 0) {179 logger.debug("{} - retry #{}", logDescription, count);180 delay(interval);181 }182 result = action.get();183 success = condition.test(result);184 } while (!success && count++ < max);185 if (!success) {186 long elapsedTime = System.currentTimeMillis() - startTime;187 String message = logDescription + ": failed after " + (count - 1) + " retries and " + elapsedTime + " milliseconds";188 logger.warn(message);189 if (failWithException) {190 throw new RuntimeException(message);191 }192 }193 return result;194 }195 public void setBasePath(String basePath) {196 this.basePath = basePath;197 }198 private byte[] readBytes(String path) {199 if (basePath != null) {200 String slash = basePath.endsWith(":") ? "" : "/";201 path = basePath + slash + path;202 }203 ScriptValue sv = FileUtils.readFile(path, context);204 return sv.getAsByteArray();205 }206 @Override207 public void setContext(ScenarioContext context) {208 this.context = context;209 }210 @Override211 public Robot retry() {212 return retry(null, null);213 }214 @Override215 public Robot retry(int count) {216 return retry(count, null);217 }218 @Override219 public Robot retry(Integer count, Integer interval) {220 enableRetry(count, interval);221 return this;222 }223 @Override224 public Robot delay(int millis) {225 robot.delay(millis);226 return this;227 }228 private static int mask(int num) {229 switch (num) {230 case 2:231 return InputEvent.BUTTON2_DOWN_MASK;232 case 3:233 return InputEvent.BUTTON3_DOWN_MASK;234 default:235 return InputEvent.BUTTON1_DOWN_MASK;236 }237 }238 @Override239 public Robot click() {240 return click(1);241 }242 243 @Override244 public Robot rightClick() {245 return click(3);246 } 247 @Override248 public Robot click(int num) {249 int mask = mask(num);250 robot.mousePress(mask);251 if (highlight) {252 getLocation().highlight(highlightDuration);253 int toDelay = CLICK_POST_DELAY - highlightDuration;254 if (toDelay > 0) {255 RobotUtils.delay(toDelay);256 }257 } else {258 RobotUtils.delay(CLICK_POST_DELAY);259 }260 robot.mouseRelease(mask);261 return this;262 }263 @Override264 public Robot doubleClick() {265 click();266 delay(40);267 click();268 return this;269 }270 @Override271 public Robot press() {272 robot.mousePress(1);273 return this;274 }275 @Override276 public Robot release() {277 robot.mouseRelease(1);278 return this;279 }280 @Override281 public Robot input(String[] values) {282 return input(values, 0);283 }284 @Override285 public Robot input(String chars, int delay) {286 String[] array = new String[chars.length()];287 for (int i = 0; i < array.length; i++) {288 array[i] = Character.toString(chars.charAt(i));289 }290 return input(array, delay);291 }292 @Override293 public Robot input(String[] values, int delay) {294 for (String s : values) {295 if (delay > 0) {296 delay(delay);297 }298 input(s);299 }300 return this;301 }302 @Override303 public Robot input(String value) {304 if (highlight) {305 getFocused().highlight(highlightDuration);306 }307 StringBuilder sb = new StringBuilder();308 for (char c : value.toCharArray()) {309 if (Keys.isModifier(c)) {310 sb.append(c);311 int[] codes = RobotUtils.KEY_CODES.get(c);312 if (codes == null) {313 logger.warn("cannot resolve char: {}", c);314 robot.keyPress(c);315 } else {316 robot.keyPress(codes[0]);317 }318 continue;319 }320 int[] codes = RobotUtils.KEY_CODES.get(c);321 if (codes == null) {322 logger.warn("cannot resolve char: {}", c);323 robot.keyPress(c);324 robot.keyRelease(c);325 } else if (codes.length > 1) {326 robot.keyPress(codes[0]);327 robot.keyPress(codes[1]);328 robot.keyRelease(codes[1]);329 robot.keyRelease(codes[0]);330 } else {331 robot.keyPress(codes[0]);332 robot.keyRelease(codes[0]);333 }334 }335 for (char c : sb.toString().toCharArray()) {336 int[] codes = RobotUtils.KEY_CODES.get(c);337 if (codes == null) {338 logger.warn("cannot resolve char: {}", c);339 robot.keyRelease(c);340 } else {341 robot.keyRelease(codes[0]);342 }343 }344 return this;345 }346 public Robot clearFocused() {347 return input(Keys.CONTROL + "a" + Keys.DELETE);348 }349 protected int getHighlightDuration() {350 return highlight ? highlightDuration : -1;351 }352 @Override353 public Element input(String locator, String value) {354 return locate(locator).input(value);355 }356 @Override357 public byte[] screenshot() {358 return screenshot(screen);359 }360 @Override361 public byte[] screenshotActive() {362 return getActive().screenshot();363 }364 public byte[] screenshot(int x, int y, int width, int height) {365 return screenshot(new Region(this, x, y, width, height));366 }367 public byte[] screenshot(Region region) {368 BufferedImage image = region.capture();369 byte[] bytes = OpenCvUtils.toBytes(image);370 context.embed(bytes, "image/png");371 return bytes;372 }373 @Override374 public Robot move(int x, int y) {375 robot.mouseMove(x, y);376 return this;377 }378 @Override379 public Robot click(int x, int y) {380 return move(x, y).click();381 }382 @Override383 public Element highlight(String locator) {384 return locate(Config.DEFAULT_HIGHLIGHT_DURATION, getSearchRoot(), locator);385 }386 @Override387 public List<Element> highlightAll(String locator) {388 return locateAll(Config.DEFAULT_HIGHLIGHT_DURATION, getSearchRoot(), locator);389 }390 @Override391 public Element focus(String locator) {392 return locate(getHighlightDuration(), getSearchRoot(), locator).focus();393 }394 @Override395 public Element locate(String locator) {396 return locate(getHighlightDuration(), getSearchRoot(), locator);397 }398 @Override399 public List<Element> locateAll(String locator) {400 return locateAll(getHighlightDuration(), getSearchRoot(), locator);401 }402 @Override403 public boolean exists(String locator) {404 return optional(locator).isPresent();405 }406 @Override407 public Element optional(String locator) {408 return optional(getSearchRoot(), locator);409 }410 @Override411 public boolean windowExists(String locator) {412 return windowOptional(locator).isPresent();413 }414 @Override415 public Element windowOptional(String locator) {416 return waitForWindowOptional(locator, false);417 }418 @Override419 public Element waitForWindowOptional(String locator) {420 return waitForWindowOptional(locator, true);421 }422 protected Element waitForWindowOptional(String locator, boolean retry) {423 Element prevWindow = currentWindow;424 Element window = window(locator, retry, false); // will update currentWindow 425 currentWindow = prevWindow; // so we reset it426 if (window == null) {427 return new MissingElement(this);428 }429 // note that currentWindow will NOT point to the new window located430 return window;431 }432 protected Element optional(Element searchRoot, String locator) {433 Element found = locateImageOrElement(searchRoot, locator);434 if (found == null) {435 logger.warn("element does not exist: {}", locator);436 return new MissingElement(this);437 }438 if (highlight) {439 found.highlight();440 }441 return found;442 }443 protected Element locate(int duration, Element searchRoot, String locator) {444 Element found;445 if (retryEnabled) {446 found = retryForAny(true, searchRoot, locator);447 } else {448 found = locateImageOrElement(searchRoot, locator);449 if (found == null) {450 String message = "cannot locate: '" + locator + "' (" + searchRoot.getDebugString() + ")";451 logger.error(message);452 throw new RuntimeException(message);453 }454 if (duration > 0) {455 found.getRegion().highlight(duration);456 }457 }458 return found;459 }460 protected List<Element> locateAll(int duration, Element searchRoot, String locator) {461 List<Element> found;462 if (locator.endsWith(".png")) {463 found = locateAllImages(searchRoot, locator);464 } else if (locator.startsWith("{")) {465 found = locateAllText(searchRoot, locator);466 } else {467 found = locateAllInternal(searchRoot, locator);468 }469 if (duration > 0) {470 RobotUtils.highlightAll(searchRoot.getRegion(), found, duration, false);471 }472 return found;473 }474 @Override475 public Element move(String locator) {476 return locate(getHighlightDuration(), getSearchRoot(), locator).move();477 }478 @Override479 public Element click(String locator) {480 return locate(getHighlightDuration(), getSearchRoot(), locator).click();481 }482 @Override483 public Element select(String locator) {484 return locate(getHighlightDuration(), getSearchRoot(), locator).select();485 }486 @Override487 public Element press(String locator) {488 return locate(getHighlightDuration(), getSearchRoot(), locator).press();489 }490 @Override491 public Element release(String locator) {492 return locate(getHighlightDuration(), getSearchRoot(), locator).release();493 }494 private StringUtils.Pair parseOcr(String raw) { // TODO make object495 int pos = raw.indexOf('}');496 String lang = raw.substring(1, pos);497 if (lang.length() < 2) {498 lang = lang + tessLang;499 }500 String text = raw.substring(pos + 1);501 return StringUtils.pair(lang, text);502 }503 public List<Element> locateAllText(Element searchRoot, String path) {504 StringUtils.Pair pair = parseOcr(path);505 String lang = pair.left;506 boolean negative = lang.charAt(0) == '-';507 if (negative) {508 lang = lang.substring(1);509 }510 String text = pair.right;511 return Tesseract.findAll(this, lang, searchRoot.getRegion(), text, negative);512 }513 public Element locateText(Element searchRoot, String path) {514 StringUtils.Pair pair = parseOcr(path);515 String lang = pair.left;516 boolean negative = lang.charAt(0) == '-';517 if (negative) {518 lang = lang.substring(1);519 }520 String text = pair.right;521 return Tesseract.find(this, lang, searchRoot.getRegion(), text, negative);522 }523 private static class PathAndStrict {524 final int strictness;525 final String path;526 public PathAndStrict(String path) {527 int pos = path.indexOf(':');528 if (pos > 0 && pos < 3) {529 strictness = Integer.valueOf(path.substring(0, pos));530 this.path = path.substring(pos + 1);531 } else {532 strictness = 10;533 this.path = path;534 }535 }536 }537 public List<Element> locateAllImages(Element searchRoot, String path) {538 PathAndStrict ps = new PathAndStrict(path);539 List<Region> found = OpenCvUtils.findAll(ps.strictness, this, searchRoot.getRegion(), readBytes(ps.path), true);540 List<Element> list = new ArrayList(found.size());541 for (Region region : found) {542 list.add(new ImageElement(region));543 }544 return list;545 }546 public Element locateImage(Region region, String path) {547 PathAndStrict ps = new PathAndStrict(path);548 return locateImage(region, ps.strictness, readBytes(ps.path));549 }550 public Element locateImage(Region searchRegion, int strictness, byte[] bytes) {551 Region region = OpenCvUtils.find(strictness, this, searchRegion, bytes, true);552 if (region == null) {553 return null;554 }555 return new ImageElement(region);556 }557 @Override558 public Element window(String title) {559 return window(title, true, true);560 }561 private Element window(String title, boolean retry, boolean failWithException) {562 return window(new StringMatcher(title), retry, failWithException);563 }564 @Override565 public Element window(Predicate<String> condition) {566 return window(condition, true, true);567 }568 private Element window(Predicate<String> condition, boolean retry, boolean failWithException) {569 try {570 currentWindow = retry ? retry(() -> windowInternal(condition), w -> w != null, "find window", failWithException) : windowInternal(condition);571 } catch (Exception e) {572 if (failWithException) {573 throw e;574 }575 logger.warn("failed to find window: {}", e.getMessage());576 currentWindow = null;577 }578 if (currentWindow != null && highlight) { // currentWindow can be null579 currentWindow.highlight(getHighlightDuration());580 }581 return currentWindow;582 }583 protected Element getSearchRoot() {584 if (currentWindow == null) {585 logger.warn("using desktop as search root, activate a window or parent element for better performance");586 return getRoot();587 }588 return currentWindow;589 }590 @Override591 public Object waitUntil(Supplier<Object> condition) {592 return waitUntil(condition, true);593 }594 @Override595 public Object waitUntilOptional(Supplier<Object> condition) {596 return waitUntil(condition, false);597 }598 protected Object waitUntil(Supplier<Object> condition, boolean failWithException) {599 return retry(() -> condition.get(), o -> o != null, "waitUntil (function)", failWithException);600 }601 @Override602 public Element waitFor(String locator) {603 return retryForAny(true, getSearchRoot(), locator);604 }605 @Override606 public Element waitForOptional(String locator) {607 return retryForAny(false, getSearchRoot(), locator);608 }609 @Override610 public Element waitForAny(String locator1, String locator2) {611 return retryForAny(true, getSearchRoot(), locator1, locator2);612 }613 @Override614 public Element waitForAny(String[] locators) {615 return retryForAny(true, getSearchRoot(), locators);616 }617 protected Element retryForAny(boolean failWithException, Element searchRoot, String... locators) {618 Element found = retry(() -> waitForAny(searchRoot, locators), r -> r != null, "find by locator(s): " + Arrays.asList(locators), failWithException);619 return found == null ? new MissingElement(this) : found;620 }621 private Element waitForAny(Element searchRoot, String... locators) {622 for (String locator : locators) {623 Element found = locateImageOrElement(searchRoot, locator);624 if (found != null) {625 if (highlight) {626 found.getRegion().highlight(highlightDuration);627 }628 return found;629 }630 }631 return null;632 }633 private Element locateImageOrElement(Element searchRoot, String locator) {634 if (locator.endsWith(".png")) {635 return locateImage(searchRoot.getRegion(), locator);636 } else if (locator.startsWith("{")) {637 return locateText(searchRoot, locator);638 } else if (searchRoot.isImage()) {639 // TODO640 throw new RuntimeException("todo find non-image elements within region");...
Source:MissingFinder.java
...61 public Element find(String tag) {62 return element;63 }64 @Override65 public Element highlight() {66 return element;67 }68 @Override69 public Element retry() {70 return element;71 }72 @Override73 public Element retry(int count) {74 return element;75 }76 @Override77 public Element retry(Integer count, Integer interval) {78 return element;79 }...
highlight
Using AI Code Generation
1import com.intuit.karate.driver.MissingElement;2import com.intuit.karate.driver.DriverOptions;3import com.intuit.karate.driver.Driver;4import com.intuit.karate.driver.Element;5DriverOptions options = new DriverOptions();6options.setHeadless(true);7Element element = driver.getElement("name", "q");8MissingElement missingElement = new MissingElement(element);9missingElement.highlight();10driver.quit();11import com.intuit.karate.driver.MissingElement;12import com.intuit.karate.driver.DriverOptions;13import com.intuit.karate.driver.Driver;14import com.intuit.karate.driver.Element;15DriverOptions options = new DriverOptions();16options.setHeadless(true);17Element element = driver.getElement("name", "q");18MissingElement missingElement = new MissingElement(element);19missingElement.highlight(1000);20driver.quit();21import com.intuit.karate.driver.MissingElement;22import com.intuit.karate.driver.DriverOptions;23import com.intuit.karate.driver.Driver;24import com.intuit.karate.driver.Element;25DriverOptions options = new DriverOptions();26options.setHeadless(true);27Element element = driver.getElement("name", "q");28MissingElement missingElement = new MissingElement(element);29missingElement.highlight("red");30driver.quit();31import com.intuit.karate.driver.MissingElement;32import com.intuit.karate.driver.DriverOptions;33import com.intuit.karate.driver.Driver;34import com.intuit.karate.driver.Element;35DriverOptions options = new DriverOptions();36options.setHeadless(true);37Element element = driver.getElement("name", "q");38MissingElement missingElement = new MissingElement(element);39missingElement.highlight("red", 1000);40driver.quit();
highlight
Using AI Code Generation
1import com.intuit.karate.driver.MissingElement2import com.intuit.karate.driver.DriverOptions3import com.intuit.karate.driver.DriverOptions.DriverType4import com.intuit.karate.driver.DriverOptions.DriverType.CHROME5import com.intuit.karate.driver.DriverOptions.DriverType.FIREFOX6import com.intuit.karate.driver.DriverOptions.DriverType.HTMLUNIT7import com.intuit.karate.driver.DriverOptions.DriverType.IE8import com.intuit.karate.driver.DriverOptions.DriverType.PHANTOMJS9import com.intuit.karate.driver.DriverOptions.DriverType.SAFARI10import com.intuit.karate.driver.DriverOptions.DriverType.EDGE11import com.intuit.karate.driver.DriverOp
highlight
Using AI Code Generation
1package com.intuit.karate.driver;2import org.openqa.selenium.By;3import org.openqa.selenium.WebDriver;4import org.openqa.selenium.WebElement;5import org.openqa.selenium.chrome.ChromeDriver;6public class Highlight {7public static void main(String[] args) throws InterruptedException {8System.setProperty("webdriver.chrome.driver","C:\\Users\\hp\\Desktop\\chromedriver.exe");9WebDriver driver=new ChromeDriver();10driver.manage().window().maximize();11MissingElement.highlight(element, driver);12driver.close();13}14}
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.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Karate automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used method in MissingElement
- MissingElement
- getLocator
- isPresent
- isEnabled
- getPosition
- screenshot
- highlight
- focus
- clear
- click
- submit
- scroll
- mouse
- input
- select
- switchFrame
- delay
- retry
- waitFor
- waitForText
- waitUntil
- script
- scriptAll
- optional
- exists
- locate
- locateAll
- attribute
- property
- getHtml
- setHtml
- getText
- setText
- getValue
- setValue
- getParent
- getChildren
- getFirstChild
- getLastChild
- getPreviousSibling
- getNextSibling
- rightOf
- leftOf
- above
- below
- near
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
