tools/Robot_Tool/README.md

   1 robot_tool
   2 ==========
   3 *robot test tool for OpenDaylight Project.*
   4
   5 * Version: 0.1
   6 * Authors: [Baohua Yang](mailto:yangbaohua@gmail.com), [Denghui Huang](mailto:huangdenghui@gmail.com)
   7 * Homepage: <https://github.com/yeasy/robot_tool>
   8
   9 ##Get Code
  10
  11 `git clone https://github.com/yeasy/robot_tool.git`
  12
  13
  14 ##Usage
  15 ###Prerequisites
  16 * Python 2.6/2.7
  17 * Python [Roboframework-requests library](https://github.com/bulkan/robotframework-requests/)
  18
  19   pip install -U robotframework-requests
  20
  21 * [OpenDaylight Controller](https://wiki.opendaylight.org/view/GettingStarted:Developer_Main)
  22    ```
  23    # Download and build OpenDaylight Controller
  24    git clone https://git.opendaylight.org/gerrit/p/controller.git
  25    cd controller/opendaylight/distribution/opendaylight
  26    mvn clean install -DskipTests -Dmaven.compile.fork=true -U
  27    ```
  28 * [Mininet](http://mininet.org/walkthrough/)
  29 * [Robotframework](http://robotframework.org/)
  30
  31 ###Run Test
  32 * Start the [OpenDaylight Controller](https://wiki.opendaylight.org/view/GettingStarted:Developer_Main)
  33
  34  ```
  35   cd controller/target/distribution.opendaylight-0.1.0-SNAPSHOT-osgipackage/opendaylight/
  36   ./run.sh
  37   ```
  38 * Start mininet, and make sure mininet has all switches connected to the controller, for example,
  39       `sudo mn --controller=remote,ip=your_controller_ip --topo tree,2`
  40 *  Go to the suites directory, executing the suite such as `pybot --variable topo_tree_level:2 base` which will run all tests in the base edition or `pybot --variable topo_tree_level:2 switch_manager.txt` to test the switch manager module.
  41
  42 ##Code Structure
  43
  44     robot_tool
  45     \---------suites       # all robot test suites
  46     |         \-----base                # all test suites for the base edition
  47     |         |
  48     |         \-----service_provider    # all test suites for the service provider edition
  49     |         |
  50     |         \-----virtualization      # all test suites for the service provider edition
  51     |
  52     \---------libraries    # all keywords
  53     |
  54     \---------resources    # resources related files
  55     |
  56     \---------variables    # all variables
  57
  58
  59 ##Development Plan
  60 * Finish test suites for the base edition.
  61
  62 ##About OpenDaylight
  63 OpenDaylight is the first production-quality open-source SDN management platform sponsored by Linux Foundation.
  64 Lead SDN enterprises (Ericsson, IBM, Microsoft, Redhat, Cisco, Juniper, NEC, VMWare etc.) are involved to develop and support the project.
  65 Please go to the official [homepage](http://www.opendaylight.org) page to find more information.
  66
  67
  68 ##Robot framework user guide.
  69    http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.1
  70
  71 ##Testlibraries references.
  72    3.1 A list of available test libraries for Robot Framework
  73    http://code.google.com/p/robotframework/wiki/TestLibraries