README.md

   1 # Getting Started
   2 ## Prerequisites
   3 This guide assumes you have run git clone on https://gerrit.onap.org/r/testsuite.git
   4
   5 For more info please see the [Development Guide](https://wiki.onap.org/display/DW/Robot+Framework+Development+Guide)
   6
   7 ## Development Environment Setup
   8 ### Python Installation
   9 You should install 2.7.12: [https://www.python.org/downloads/release/python-2712](https://www.python.org/downloads/release/python-2712)
  10
  11
  12 ### Pip Install
  13 Install pip with the get-pip.py file from [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py)
  14 once downloaded run
  15
  16 ```
  17 python get-pip.py
  18 ```
  19 let it install.
  20
  21 From the desktop, right click the Computer icon.
  22 Choose Properties from the context menu.
  23 Click the Advanced system settings link.
  24 Click Environment Variables. In the section System Variables, click New.
  25 In the New System Variable window, set the name as 'HTTPS\_PROXY' then specify the value of the HTTPS_PROXY environment variable as your proxy.
  26 Click OK.
  27 Close all remaining windows by clicking OK.
  28
  29
  30 ### Robot Install
  31 Reopen Command prompt window, and run below code to install robot.
  32
  33 ```
  34 pip install robotframework
  35 ```
  36
  37
  38 ### IDE Install
  39 Most further documents will use the RED environment for Robot.
  40 [https://github.com/nokia/RED/releases/download/0.7.0/RED\_0.7.0.20160914115048-win32.win32.x86_64.zip](https://github.com/nokia/RED/releases/download/0.7.0/RED\_0.7.0.20160914115048-win32.win32.x86_64.zip)
  41
  42 Once you install that IDE you probably will want to have a python editor to edit python files better.
  43 Go to Help > Eclipse Marketplace and search for PyDev and click install on PyDev for Eclipse 5.2.0
  44
  45 Once you install that IDE you will need EGit to check in git code.
  46 Go to Help > Eclipse Marketplace and search for Egit git team provider and click install on EGit Git Team Provider 4.5.0
  47
  48 Once you install that IDE you will probably want a json editor to edit json better.
  49 Go to Help > Eclipse Marketplace and search for Json Tools and click install on Json Tools 1.1.0
  50
  51 ### Project Setup
  52 Note: You do not need to run these commands every time, only on a library update or initial checkout.
  53
  54 ```
  55 ./setup.sh
  56 ```
  57
  58 Note that this script will download the chromedriver for the current OS. The default is linux64 which will download the appropriate chromedriver to /usr/local/bin so that it will be in the execution PATH.
  59
  60 Windows and Mac hosts will download into the current working directory. Windows and MAC users will need to ensure that the driver is
  61 in the execution PATH.
  62
  63
  64 ## Executing ETE Testcases
  65 ### Overview
  66 Two scripts have been provided in the root of the ete-testsuite project to enable test execution
  67
  68 * runTags.sh - This shell uses Robot [Tags] to drive which tests are executed and is designed for automated testing.
  69 * oneTest.sh - This shell is designed for unit testing of individual .robot files. It accepts a single argument identifying the .robot file in robot/testsuites to execute.
  70
  71 #### runTags.sh
  72 For further information on using Robot [Tags], see [http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#configuring-execution] and [http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#simple-patterns]
  73
  74 When executing tests via tags, all of the robot files in the project are scanned for tests cases with the specified tags.
  75
  76 There are 3 flavors of runTags.sh
  77 * runTags.sh with no arguments. This defaults to the default tag or runTags.sh -i health
  78 * runTags.sh with a single include tag. In this case the -i or --include may be omitted. So runTags.sh ete is the same as runTags.sh -i ete
  79 * runTags.sh with multiple tags. In this case, tags must be accompanied by a -i/--include or -e/--exclude to properly identify the disposition of the tagged testcase.
  80
  81 ```
  82 runTags.sh -i health -i ete -e garbage
  83 ```
  84
  85 ## Contributing
  86 Follow [Robot Framework Development Guide](https://wiki.onap.org/display/DW/Robot+Framework+Development+Guide).