version: 5.7.7
session: 682f60bf2856e2eb4066427f
steps:
  - commands:
    - command: run
      file: testdriver/snippets/login.yaml
  - prompt: click on the image of a shopping cart
    commands:
      - command: focus-application
        name: Google Chrome
      - command: hover-image
        description: shopping cart icon next to the Cart text in the top right corner
        action: click
  - prompt: assert that you see an empty shopping cart
    commands:
      - command: assert
        expect: Your cart is empty

​
Description

The hover-image command is used to locate an image on the screen based on a description and perform an action on it. This can include hovering, clicking, right-clicking, or double-clicking the image.

​
Arguments

ArgumentTypeDescription
descriptionstringA description of the image and what it represents. Don’t include the image itself here.
actionstringThe action to take when the image is found. Available actions are: click, right-click, double-click, hover.
The hover-image command is useful for interacting with visual elements that can’t be identified using text-based selectors.

​
Example usage

command: hover-image
description: search icon in the webpage content
action: click

​
Protips

  • Use clear and concise descriptions for the image to improve detection accuracy.
  • Ensure the action specified matches the intended interaction with the image.
  • If the hover-image command fails to locate an image based on the provided description, consider using the match-image command instead. The match-image command is specifically designed for scenarios where precise image matching is required, such as when the visual element can’t be reliably described with text. It works by directly comparing the image on the screen with a reference image file.

​
Gotchas

  • If the image can’t be located based on the description, the command will fail.
  • Ensure the screen resolution and scaling settings are consistent to avoid detection issues.