CiscoUcs/ucsmsdk

View on GitHub
ucsmsdk/utils/ucstechsupport.py

Summary

Maintainability
D
2 days
Test Coverage

File ucstechsupport.py has 459 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Copyright 2013 Cisco Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
Severity: Minor
Found in ucsmsdk/utils/ucstechsupport.py - About 7 hrs to fix

    Function get_ucs_tech_support has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_ucs_tech_support(handle,
                             ucs_manager=False,
                             ucs_mgmt=False,
                             chassis_id=None, cimc_id=None,
                             adapter_id=None, iom_id=None,
    Severity: Minor
    Found in ucsmsdk/utils/ucstechsupport.py - About 5 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Cyclomatic complexity is too high in function get_ucs_tech_support. (22)
    Open

    @deprecated(get_tech_support)
    def get_ucs_tech_support(handle,
                             ucs_manager=False,
                             ucs_mgmt=False,
                             chassis_id=None, cimc_id=None,
    Severity: Minor
    Found in ucsmsdk/utils/ucstechsupport.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function poll_wait_for_tech_support. (8)
    Open

    def poll_wait_for_tech_support(handle, ts_mo, timeout):
        from ..mometa.sysdebug.SysdebugTechSupport import \
            SysdebugTechSupportConsts as TechSupConsts
    
        poll_interval = 5
    Severity: Minor
    Found in ucsmsdk/utils/ucstechsupport.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function _set_ts_options_chassis. (7)
    Open

    def _set_ts_options_chassis(ts_cmd_opt, kwargs):
        _validate_chassis_options(kwargs)
        ts_cmd_opt.chassis_id = str(kwargs["chassis_id"])
        ts_cmd_opt.major_opt_type = TechSupOptsConsts.MAJOR_OPT_TYPE_CHASSIS
        if _is_valid_arg("cimc_id", kwargs):
    Severity: Minor
    Found in ucsmsdk/utils/ucstechsupport.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function _set_ts_options. (7)
    Open

    def _set_ts_options(option, ts_cmd_opt, kwargs):
        if option == "ucsm":
            _set_ts_options_ucsm(ts_cmd_opt, kwargs)
        elif option == "ucsm-mgmt":
            _set_ts_options_ucsm_mgmt(ts_cmd_opt, kwargs)
    Severity: Minor
    Found in ucsmsdk/utils/ucstechsupport.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function get_ucs_tech_support has 15 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def get_ucs_tech_support(handle,
    Severity: Major
    Found in ucsmsdk/utils/ucstechsupport.py - About 1 hr to fix

      Function _set_ts_options_chassis has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

      def _set_ts_options_chassis(ts_cmd_opt, kwargs):
          _validate_chassis_options(kwargs)
          ts_cmd_opt.chassis_id = str(kwargs["chassis_id"])
          ts_cmd_opt.major_opt_type = TechSupOptsConsts.MAJOR_OPT_TYPE_CHASSIS
          if _is_valid_arg("cimc_id", kwargs):
      Severity: Minor
      Found in ucsmsdk/utils/ucstechsupport.py - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function poll_wait_for_tech_support has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

      def poll_wait_for_tech_support(handle, ts_mo, timeout):
          from ..mometa.sysdebug.SysdebugTechSupport import \
              SysdebugTechSupportConsts as TechSupConsts
      
          poll_interval = 5
      Severity: Minor
      Found in ucsmsdk/utils/ucstechsupport.py - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function get_tech_support has 8 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def get_tech_support(handle,
      Severity: Major
      Found in ucsmsdk/utils/ucstechsupport.py - About 1 hr to fix

        Function _set_ts_options has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def _set_ts_options(option, ts_cmd_opt, kwargs):
            if option == "ucsm":
                _set_ts_options_ucsm(ts_cmd_opt, kwargs)
            elif option == "ucsm-mgmt":
                _set_ts_options_ucsm_mgmt(ts_cmd_opt, kwargs)
        Severity: Minor
        Found in ucsmsdk/utils/ucstechsupport.py - About 35 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Refactor this function to reduce its Cognitive Complexity from 35 to the 15 allowed.
        Open

        def get_ucs_tech_support(handle,
        Severity: Critical
        Found in ucsmsdk/utils/ucstechsupport.py by sonar-python

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Function "get_tech_support" has 8 parameters, which is greater than the 7 authorized.
        Open

        def get_tech_support(handle,
                             option="ucsm",
                             remove_from_ucs=False,
                             download=True, file_dir=".", file_name="techsupport.tar",
                             timeout=1200,

        A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

        Noncompliant Code Example

        With a maximum number of 4 parameters:

        def do_something(param1, param2, param3, param4, param5):
            ...
        

        Compliant Solution

        def do_something(param1, param2, param3, param4):
            ...
        

        Function "get_ucs_tech_support" has 15 parameters, which is greater than the 7 authorized.
        Open

        def get_ucs_tech_support(handle,
                                 ucs_manager=False,
                                 ucs_mgmt=False,
                                 chassis_id=None, cimc_id=None,
                                 adapter_id=None, iom_id=None,

        A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

        Noncompliant Code Example

        With a maximum number of 4 parameters:

        def do_something(param1, param2, param3, param4, param5):
            ...
        

        Compliant Solution

        def do_something(param1, param2, param3, param4):
            ...
        

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        def _set_ts_options_fex(ts_cmd_opt, kwargs):
            _validate_fex_options(kwargs)
            ts_cmd_opt.fab_ext_id = str(kwargs["fex_id"])
            ts_cmd_opt.major_opt_type = TechSupOptsConsts.MAJOR_OPT_TYPE_FEX
        Severity: Major
        Found in ucsmsdk/utils/ucstechsupport.py and 1 other location - About 1 hr to fix
        ucsmsdk/utils/ucstechsupport.py on lines 141..144

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 40.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        def _set_ts_options_servermemory(ts_cmd_opt, kwargs):
            _validate_servermemory_options(kwargs)
            ts_cmd_opt.server_id_list = str(kwargs["server_id_list"])
            ts_cmd_opt.major_opt_type = TechSupOptsConsts.MAJOR_OPT_TYPE_SERVER_MEMORY
        Severity: Major
        Found in ucsmsdk/utils/ucstechsupport.py and 1 other location - About 1 hr to fix
        ucsmsdk/utils/ucstechsupport.py on lines 130..133

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 40.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

            if _is_valid_arg("rack_adapter_id", kwargs):
                ts_cmd_opt.rack_server_adapter_id = str(kwargs["rack_adapter_id"])
            else:
                ts_cmd_opt.rack_server_adapter_id = TechSupOptsConsts.RACK_SERVER_ADAPTER_ID_ALL
        Severity: Minor
        Found in ucsmsdk/utils/ucstechsupport.py and 1 other location - About 50 mins to fix
        ucsmsdk/utils/ucstechsupport.py on lines 94..97

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 36.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

                if _is_valid_arg("adapter_id", kwargs):
                    ts_cmd_opt.cimc_adapter_id = str(kwargs["adapter_id"])
                else:
                    ts_cmd_opt.cimc_adapter_id = TechSupOptsConsts.CIMC_ADAPTER_ID_ALL
        Severity: Minor
        Found in ucsmsdk/utils/ucstechsupport.py and 1 other location - About 50 mins to fix
        ucsmsdk/utils/ucstechsupport.py on lines 119..122

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 36.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

                if duration == 0:
                    handle.remove_mo(tech_support)
                    handle.commit()
                    raise UcsValidationException('TechSupport file creation timed out')
        Severity: Minor
        Found in ucsmsdk/utils/ucstechsupport.py and 1 other location - About 35 mins to fix
        ucsmsdk/utils/ucsbackup.py on lines 115..118

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 33.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        There are no issues that match your filters.

        Category
        Status