Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / c3ab301e008110291895ef2eea14e6c795abc866 / . / TestON / Documentation / TestON_Document / TestON.examples.Topology.Topology-pysrc.html
blob: c3174e055f3eba177dbf32198b50260426e56130 [file] [log] [blame]
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TestON.examples.Topology.Topology</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="TestON-module.html">Package&nbsp;TestON</a> ::
<a href="TestON.examples-module.html">Package&nbsp;examples</a> ::
<a href="TestON.examples.Topology-module.html">Package&nbsp;Topology</a> ::
Module&nbsp;Topology
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="TestON.examples.Topology.Topology-pysrc.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="TestON.examples.Topology.Topology-module.html">Module TestON.examples.Topology.Topology</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<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>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<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>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="Topology"></a><div id="Topology-def"><a name="L7"></a><tt class="py-lineno"> 7</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>
</div><div id="Topology-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Topology-expanded"><a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"> <tt class="py-docstring">'''</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> This example shows, how we can use the topology file:</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-docstring"> In topo file we can specify the component like below:</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-docstring"> [TOPOLOGY] </tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> [[COMPONENT]]</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring"> [[["Mininet1"]]]</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> The usage of this component in the test script like below:</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"><tt class="py-docstring"> main.Mininet1.checkIP(main.params['CASE1']['destination'])</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"><tt class="py-docstring"> Here we are using the Mininet1 which of type Mininet </tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"><tt class="py-docstring"> ofautomation&gt;run Topology example 1</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-docstring"> will execute this example.</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"><tt class="py-docstring"> '''</tt> </tt>
<a name="Topology.__init__"></a><div id="Topology.__init__-def"><a name="L29"></a><tt class="py-lineno">29</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>
</div><div id="Topology.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Topology.__init__-expanded"><a name="L30"></a><tt class="py-lineno">30</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>
</div><a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"> </tt>
<a name="Topology.CASE1"></a><div id="Topology.CASE1-def"><a name="L32"></a><tt class="py-lineno">32</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>
</div><div id="Topology.CASE1-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Topology.CASE1-expanded"><a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"> <tt class="py-docstring">'''</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"><tt class="py-docstring"> This will showcase the usage of Topology</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"><tt class="py-docstring"> '''</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</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>
<a name="L37"></a><tt class="py-lineno">37</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>
<a name="L38"></a><tt class="py-lineno">38</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>
<a name="L39"></a><tt class="py-lineno">39</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>
<a name="L40"></a><tt class="py-lineno">40</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
TestON.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>
</div></div><a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>