README.md

   1 # AURUM(Tizen UI Automator)
   2 - Aurum is a UI automation framework without UI Toolkit dependency.
   3
   4   Provides Commands to interact with the device¡¯s UI by simulation user actions and introspection of the screen content.
   5
   6   It relies on the platform accessibility APIs to introspect the screen.
   7
   8 - User can use the IDL defined in Proto to create an automation app or script in a variety of languages without a language dependency.
   9
  10   [List of Supported Command With Python Example](https://code.sec.samsung.net/confluence/pages/viewpage.action?pageId=212993496)
  11
  12
  13 ### Running on TV
  14 - Known issue
  15
  16   grpc not support environment that uses proxy on host PC
  17
  18 - Pre-condition
  19
  20   The TV device and Host PC should be already connected through SDB
  21
  22 - Gets Aurum latest version and checkout to tizen branch
  23
  24   [Aurum Github](https://github.sec.samsung.net/tizen/aurum)
  25
  26 - Set up a python virtual environment and run UI Automation (working directory: aurum/)
  27
  28   (host) cd ui_automation/python/tv
  29
  30   #### Create virtual env
  31   (host) python3 -m venv v
  32
  33   #### Activate a virtual env
  34   Linux
  35   (host) source v/bin/activate
  36   Window
  37   (host) v/Scripts/activate.bat
  38
  39   #### Install required pkg (only once)
  40   (python_virtual) pip3 install -r ../../../protocol/resources/python/requirements.txt
  41
  42   #### Generate aurum.proto file for python (only once)
  43   (python_virtual) python3 -m grpc_tools.protoc --python_out=./ --grpc_python_out=./ -I ./../../../protocol/ ../../../protocol/aurum.proto
  44
  45   #### Target setup such as sdb forward, bootstrap execution
  46   (python_virtual) python3 ../../../protocol/resources/python/tv/tvSetup.py
  47
  48   #### Then Run your test script (Please refer sample scripts in 'aurum/protocol/resources/python/tv')
  49   (python_virtual) python3 myTest.py
  50
  51   #### Deactivate a virtual env
  52   (python_virtual) deactivate
  53
  54 ### Reference and Tip
  55 - [How to run aurum on TM1](https://code.sec.samsung.net/confluence/display/GFX/04.+NUITizenGallery+Test+Script+Guide)
  56