Skip to main content

Example Configuration File

The Robot Eyes configuration file allows you to control various aspects of Eyes testing. The file is in YAML format.

### applitools.yaml 1.3
### START `SHARED SECTION` ###
#server_url: "https://eyesapi.applitools.com" #optional

#Could be specified as APPLITOOLS_API_KEY env variable
#api_key: YOUR_API_KEY

#proxy:
#  url: "http://someproxy-url.com"
#  host: HOST_ADDRESS  #optional
#  port: HOST_PORT  #optional
#  username: YOUR_NAME  #optional
#  password: YOUR_PASS  #optional

#properties:
#  - name: YOUR_PROPERTY_NAME
#   value: YOUR_PROPERTY_VALUE

# Propagate Eyes results to robot `report.html`
#propagate_eyes_test_results: true

#accessibility_validation:
#  level: AA                       # names from AccessibilityLevel
#  guidelines_version: WCAG_2_0    # names from AccessibilityGuidelinesVersion

###### START `AVAILABLE DURING `Eyes Open` CALL SECTION` ######
app_name: YOUR_APP_NAME
#viewport_size:
#  width: 1920
#  height: 1080
#branch_name: YOUR_BRANCH_NAME
#parent_branch_name: YOUR_PARENT_BRANCH_NAME
#baseline_branch_name: YOUR_BASELINE_BRANCH_NAME
#baseline_env_name: YOUR_BASELINE_ENV_NAME
#dont_close_batches: true
#save_diffs: false
#match_timeout: 600
#save_new_tests: true  #optional
#save_failed_tests: false  #optional
#wait_before_capture: 100  #optional

#batch:  #optional
#  id: YOUR_BATCH_ID  #optional
#  name: YOUR_BATCH_NAME
#  notify_on_completion: true
#  batch_sequence_name: YOUR_BATCH_SEQUENCE_NAME  #optional
#  properties:    #optional
#    - name: YOUR_BATCH_PROPERTY_NAME
#      value: YOUR_BATCH_PROPERTY_VALUE

###### END `AVAILABLE DURING `Eyes Open` CALL SECTION` ######


### END `SHARED SECTION` ###

web:
  force_full_page_screenshot: false  #optional
  wait_before_screenshots: 100  #optional
#  stitch_mode: CSS   # Scroll | CSS
#  hide_scrollbars: true
#  hide_caret: true
# ALL SETTINGS FROM `SHARED SECTION` COULD BE PASSED HERE AS WELL

mobile_native:
  is_simulator: false
# ALL SETTINGS FROM `SHARED SECTION` COULD BE PASSED HERE AS WELL


web_ufg:
#  runner_options:
#    test_concurrency: 5
#  visual_grid_options:
#    - key: YOUR_VISUAL_GRID_OPTION
#      value: YOUR_VISUAL_GRID_OPTION_VALUE
#  disable_browser_fetching: false
#  enable_cross_origin_rendering: false
#  dont_use_cookies: false
#  layout_breakpoints:
#    breakpoints: true
#    reload: true
  browsers:
    desktop:
      - browser_type: CHROME  # names from BrowserType
        width: 800
        height: 600
#    ios:
#      - device_name: iPhone_12_Pro  # names from IosDeviceName
#        screen_orientation: PORTRAIT  # PORTRAIT | LANDSCAPE
#        ios_version: LATEST  # LATEST | ONE_VERSION_BACK
#    chrome_emulation:
#      - device_name: iPhone_4  # names from DeviceName
#        screen_orientation: PORTRAIT  # PORTRAIT | LANDSCAPE


native_mobile_grid:
  devices:
    ios:
      - device_name: iPhone_12_Pro  # names from IosDeviceName
        screen_orientation: PORTRAIT  # PORTRAIT | LANDSCAPE
        ios_version: LATEST  # LATEST | ONE_VERSION_BACK
#    android:
#      - device_name: Pixel_3_XL  # names from AndroidDeviceName
#        screen_orientation: PORTRAIT  # PORTRAIT | LANDSCAPE
#        android_version: LATEST  # LATEST | ONE_VERSION_BACK