#!/usr/bin/env python
'''
Created on 28-Nov-2012
Copyright 2012 Open Networking Foundation (ONF)

@author: Anil Kumar (anilkumar.s@paxterrasolutions.com)

Please refer questions to either the onos test mailing list at <onos-test@onosproject.org>,
the System Testing Plans and Results wiki page at <https://wiki.onosproject.org/x/voMg>,
or the System Testing Guide page at <https://wiki.onosproject.org/x/WYQg>

    TestON is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 2 of the License, or
    (at your option) any later version.

    TestON is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with TestON.  If not, see <http://www.gnu.org/licenses/>.
'''
class Topology:
    '''

    This example shows, how we can use the topology file:

    In topo file we can specify the component like below:
    [TOPOLOGY]

        [[COMPONENT]]
            [[["Mininet1"]]]

    The usage of this component in the test script like below:

    main.Mininet1.checkIP(main.params['CASE1']['destination'])

    Here we are using the Mininet1 which of type Mininet


    ofautomation>run Topology example 1
       will execute this example.
    '''
    def __init__(self):
        self.default = ""

    def CASE1(self,main):
        '''
        This will showcase the usage of Topology
        '''
        main.case("Usage of Topology")
        main.step("Mininet1 specified in Topology , using the Mininet1 to check host ip")
        result = main.Mininet1.checkIP(main.params['CASE1']['destination'])
        main.step("Verifying the result")
        utilities.assert_equals(expect=main.TRUE,actual=result,onpass="Host h2 IP address configured",onfail="Host h2 IP address didn't configured")