TestON/examples/StepParams/StepParams.py

#!/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 StepParams:
    '''
    This example shows the usage of the STEP level parameters, in params file the
    [[CASE1]]
    [[[STEP1]]]
        'host'  = 'h2'

    We can get this STEP level parameter like :
    main.params['CASE1']['STEP1']['host']


    ofautomation>run StepParams example 1
    '''
    def __init__(self):
        self.default = ""

    def CASE1(self,main):
        '''
        This example will showcase the usage of STEP level parameters to specify the host as h2
        '''
        main.case("Using STEP level parameters to specify the host as h2")
        main.step("Host IP Checking using checkIP")
        result = main.Mininet1.checkIP(main.params['CASE1']['STEP1']['host'])
        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")


    def CASE2(self,main):
        '''
                This example will showcase the usage of STEP level parameters to specify the host as h3
        '''
        main.case("Using STEP level parameters to specify the host as h3")
        main.step("Host IP Checking using checkIP")
        result = main.Mininet1.checkIP(main.params['CASE2']['STEP1']['host'])
        main.step("Verifying the result")
        utilities.assert_equals(expect=main.TRUE,actual=result,onpass="Host h3 IP address configured",onfail="Host h3 IP address didn't configured")