netman icon indicating copy to clipboard operation
netman copied to clipboard

Missing compliance tests / nomenclature violations

Open mat128 opened this issue 10 years ago • 2 comments

The following methods have been identified as violating the nomenclature guidelines. Proper compliance tests for those would help us move forward.

$ grep 'TODO' -A1 netman/core/objects/switch_base.py
    # TODO(mmitchell): Should be called unset_access_vlan
    def remove_access_vlan(self, interface_id):
--
    # TODO(mmitchell): Should be called set_interface_state
    def shutdown_interface(self, interface_id):
--
    # TODO(mmitchell): Should be part of set_interface_state
    def openup_interface(self, interface_id):
--
    # TODO(mmitchell): Should be called set_native_vlan
    def configure_native_vlan(self, interface_id, vlan):
--
    # TODO(mmitchell): Should be called unset_native_vlan
    def remove_native_vlan(self, interface_id):
--
    # TODO(mmitchell): Should be called unset_vlan_access_group
    def remove_vlan_access_group(self, vlan_number, direction):
--
    # TODO(mmitchell): Should be called unset_vlan_vrf
    def remove_vlan_vrf(self, vlan_number):
--
    # TODO(mmitchell): Should be called unset_interface_description
    def remove_interface_description(self, interface_id):
--
    # TODO(mmitchell): Should be called set_interface_spanning_tree_state
    def edit_interface_spanning_tree(self, interface_id, edge=None):
--
    # TODO(mmitchell): Should be called unset_bond_description
    def remove_bond_description(self, number):
--
    # TODO(mmitchell): Should be called set_bond_native_vlan
    def configure_bond_native_vlan(self, number, vlan):
--
    # TODO(mmitchell): Should be called unset_bond_native_vlan
    def remove_bond_native_vlan(self, number):
--
    # TODO(mmitchell): Should be called set_bond_interface_spanning_tree_state
    def edit_bond_spanning_tree(self, number, edge=None):
--
    # TODO(mmitchell): Should be called set_interface_lldp_state
    def enable_lldp(self, interface_id, enabled):

mat128 avatar Jan 12 '16 15:01 mat128

# TODO(mmitchell): Should be called set_interface_state
def shutdown_interface(self, interface_id):

# TODO(mmitchell): Should be part of set_interface_state
def openup_interface(self, interface_id):

So these two methods should be merge together and a second parameter define the action to perform?

emmurd avatar Feb 01 '16 21:02 emmurd

There's only two methods left to refactorate due to responsability issue :

# TODO(mmitchell): Should be called set_interface_spanning_tree_state
def edit_interface_spanning_tree(self, interface_id, edge=None):

# TODO(mmitchell): Should be called set_bond_interface_spanning_tree_state
def edit_bond_spanning_tree(self, number, edge=None):

emmurd avatar Feb 05 '16 16:02 emmurd