Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a5cb341e4df8a1f500c1421d98fc03fd546dc8f0 / . / TestON / Documentation / TestON_Document / TestON.examples.Topology.Topology-pysrc.html
blob: 04bfa406ffba6db7b930cd4cdf80ea0356af1c2b [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.examples.Topology.Topology</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.examples-module.html">Package&nbsp;examples</a> ::
47 <a href="TestON.examples.Topology-module.html">Package&nbsp;Topology</a> ::
48 Module&nbsp;Topology
49 </span>
50 </td>
51 <td>
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >]&nbsp;|&nbsp;<a href="TestON.examples.Topology.Topology-pysrc.html"
59 target="_top">no&nbsp;frames</a>]</span></td></tr>
60 </table>
61 </td>
62 </tr>
63</table>
64<h1 class="epydoc">Source Code for <a href="TestON.examples.Topology.Topology-module.html">Module TestON.examples.Topology.Topology</a></h1>
65<pre class="py-src">
66<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
67<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
68<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring">Created on 28-Nov-2012</tt> </tt>
69<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
70<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring">@author: Anil Kumar (anilkumar.s@paxterrasolutions.com)</tt> </tt>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]71<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
72<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
73<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring"> TestON is free software: you can redistribute it and/or modify</tt> </tt>
74<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> it under the terms of the GNU General Public License as published by</tt> </tt>
75<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> the Free Software Foundation, either version 2 of the License, or</tt> </tt>
76<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-docstring"> (at your option) any later version.</tt> </tt>
77<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
78<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-docstring"> TestON is distributed in the hope that it will be useful,</tt> </tt>
79<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"><tt class="py-docstring"> but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
80<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</tt> </tt>
81<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring"> GNU General Public License for more details.</tt> </tt>
82<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
83<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> You should have received a copy of the GNU General Public License</tt> </tt>
84<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring"> along with TestON. If not, see &lt;http://www.gnu.org/licenses/&gt;.</tt> </tt>
85<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
86<a name="Topology"></a><div id="Topology-def"><a name="L21"></a><tt class="py-lineno">21</tt> <a class="py-toggle" href="#" id="Topology-toggle" onclick="return toggle('Topology');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="TestON.examples.Topology.Topology.Topology-class.html">Topology</a><tt class="py-op">:</tt> </tt>
87</div><div id="Topology-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Topology-expanded"><a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> <tt class="py-docstring">'''</tt> </tt>
88<a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
89<a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring"> This example shows, how we can use the topology file:</tt> </tt>
90<a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
91<a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"><tt class="py-docstring"> In topo file we can specify the component like below:</tt> </tt>
92<a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-docstring"> [TOPOLOGY]</tt> </tt>
93<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
94<a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"><tt class="py-docstring"> [[COMPONENT]]</tt> </tt>
95<a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"> [[["Mininet1"]]]</tt> </tt>
96<a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
97<a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"><tt class="py-docstring"> The usage of this component in the test script like below:</tt> </tt>
98<a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
99<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"><tt class="py-docstring"> main.Mininet1.checkIP(main.params['CASE1']['destination'])</tt> </tt>
100<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
101<a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"><tt class="py-docstring"> Here we are using the Mininet1 which of type Mininet</tt> </tt>
102<a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
103<a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
104<a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
105<a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"><tt class="py-docstring"> ofautomation&gt;run Topology example 1</tt> </tt>
106<a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt class="py-docstring"> will execute this example.</tt> </tt>
107<a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-docstring"> '''</tt> </tt>
108<a name="Topology.__init__"></a><div id="Topology.__init__-def"><a name="L43"></a><tt class="py-lineno">43</tt> <a class="py-toggle" href="#" id="Topology.__init__-toggle" onclick="return toggle('Topology.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="TestON.examples.Topology.Topology.Topology-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
109</div><div id="Topology.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Topology.__init__-expanded"><a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method TestON.bin.cli.CLI.default()=TestON.bin.cli.CLI-class.html#default"><a title="TestON.bin.cli.CLI.default" class="py-name" href="#" onclick="return doclink('link-0', 'default', 'link-0');">default</a></tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
110</div><a name="L45"></a><tt class="py-lineno">45</tt> <tt class="py-line"> </tt>
111<a name="Topology.CASE1"></a><div id="Topology.CASE1-def"><a name="L46"></a><tt class="py-lineno">46</tt> <a class="py-toggle" href="#" id="Topology.CASE1-toggle" onclick="return toggle('Topology.CASE1');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="TestON.examples.Topology.Topology.Topology-class.html#CASE1">CASE1</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt><tt class="py-param">main</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
112</div><div id="Topology.CASE1-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Topology.CASE1-expanded"><a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"> <tt class="py-docstring">'''</tt> </tt>
113<a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"><tt class="py-docstring"> This will showcase the usage of Topology</tt> </tt>
114<a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"><tt class="py-docstring"> '''</tt> </tt>
115<a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"> <tt class="py-name">main</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method TestON.core.teston.TestON.case()=TestON.core.teston.TestON-class.html#case"><a title="TestON.core.teston.TestON.case" class="py-name" href="#" onclick="return doclink('link-1', 'case', 'link-1');">case</a></tt><tt class="py-op">(</tt><tt class="py-string">"Usage of Topology"</tt><tt class="py-op">)</tt> </tt>
116<a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"> <tt class="py-name">main</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method TestON.core.teston.TestON.step()=TestON.core.teston.TestON-class.html#step"><a title="TestON.core.teston.TestON.step" class="py-name" href="#" onclick="return doclink('link-2', 'step', 'link-2');">step</a></tt><tt class="py-op">(</tt><tt class="py-string">"Mininet1 specified in Topology , using the Mininet1 to check host ip"</tt><tt class="py-op">)</tt> </tt>
117<a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">main</tt><tt class="py-op">.</tt><tt class="py-name">Mininet1</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver.checkIP()=TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#checkIP"><a title="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver.checkIP" class="py-name" href="#" onclick="return doclink('link-3', 'checkIP', 'link-3');">checkIP</a></tt><tt class="py-op">(</tt><tt class="py-name">main</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'CASE1'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'destination'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
118<a name="L53"></a><tt class="py-lineno">53</tt> <tt class="py-line"> <tt class="py-name">main</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="TestON.core.teston.TestON.step" class="py-name" href="#" onclick="return doclink('link-4', 'step', 'link-2');">step</a></tt><tt class="py-op">(</tt><tt class="py-string">"Verifying the result"</tt><tt class="py-op">)</tt> </tt>
119<a name="L54"></a><tt class="py-lineno">54</tt> <tt class="py-line"> <tt class="py-name">utilities</tt><tt class="py-op">.</tt><tt class="py-name">assert_equals</tt><tt class="py-op">(</tt><tt class="py-name">expect</tt><tt class="py-op">=</tt><tt class="py-name">main</tt><tt class="py-op">.</tt><tt class="py-name">TRUE</tt><tt class="py-op">,</tt><tt class="py-name">actual</tt><tt class="py-op">=</tt><tt class="py-name">result</tt><tt class="py-op">,</tt><tt class="py-name">onpass</tt><tt class="py-op">=</tt><tt class="py-string">"Host h2 IP address configured"</tt><tt class="py-op">,</tt><tt id="link-5" class="py-name" targets="Method TestON.core.teston.TestON.onfail()=TestON.core.teston.TestON-class.html#onfail,Method TestON.drivers.common.clidriver.CLI.onfail()=TestON.drivers.common.clidriver.CLI-class.html#onfail"><a title="TestON.core.teston.TestON.onfail
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]120TestON.drivers.common.clidriver.CLI.onfail" class="py-name" href="#" onclick="return doclink('link-5', 'onfail', 'link-5');">onfail</a></tt><tt class="py-op">=</tt><tt class="py-string">"Host h2 IP address didn't configured"</tt><tt class="py-op">)</tt> </tt>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]121</div></div><a name="L55"></a><tt class="py-lineno">55</tt> <tt class="py-line"> </tt><script type="text/javascript">
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]122<!--
123expandto(location.href);
124// -->
125</script>
126</pre>
127<br />
128<!-- ==================== NAVIGATION BAR ==================== -->
129<table class="navbar" border="0" width="100%" cellpadding="0"
130 bgcolor="#a0c0ff" cellspacing="0">
131 <tr valign="middle">
132 <!-- Home link -->
133 <th>&nbsp;&nbsp;&nbsp;<a
134 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
135
136 <!-- Tree link -->
137 <th>&nbsp;&nbsp;&nbsp;<a
138 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
139
140 <!-- Index link -->
141 <th>&nbsp;&nbsp;&nbsp;<a
142 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
143
144 <!-- Help link -->
145 <th>&nbsp;&nbsp;&nbsp;<a
146 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
147
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]148 <!-- Project homepage -->
149 <th class="navbar" align="right" width="100%">
150 <table border="0" cellpadding="0" cellspacing="0">
151 <tr><th class="navbar" align="center"
152 >TestON</th>
153 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]154 </tr>
155</table>
156<table border="0" cellpadding="0" cellspacing="0" width="100%%">
157 <tr>
158 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]159 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:39 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]160 </td>
161 <td align="right" class="footer">
162 <a target="mainFrame" href="http://epydoc.sourceforge.net"
163 >http://epydoc.sourceforge.net</a>
164 </td>
165 </tr>
166</table>
167
168<script type="text/javascript">
169 <!--
170 // Private objects are initially displayed (because if
171 // javascript is turned off then we want them to be
172 // visible); but by default, we want to hide them. So hide
173 // them unless we have a cookie that says to show them.
174 checkCookie();
175 // -->
176</script>
177</body>
178</html>