Sign upLogin

saltstack/salt

View on GitHub
Star
salt/modules/timezone.py

Summary

Maintainability
F
1 wk
Test Coverage

Function get_hwclock has a Cognitive Complexity of 105 (exceeds 5 allowed). Consider refactoring.
Open

def get_hwclock():
    '''
    Get current hardware clock setting (UTC or localtime)

    CLI Example:
Severity: Minor
Found in salt/modules/timezone.py - About 2 days 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

File timezone.py has 444 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Module for managing timezone on POSIX-like systems.
'''
Severity: Minor
Found in salt/modules/timezone.py - About 6 hrs to fix

    Function set_hwclock has a Cognitive Complexity of 41 (exceeds 5 allowed). Consider refactoring.
    Open

    def set_hwclock(clock):
    '''
    Sets the hardware clock to be either UTC or localtime

    CLI Example:
    Severity: Minor
    Found in salt/modules/timezone.py - About 6 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_hwclock. (36)
    Open

    def get_hwclock():
    '''
    Get current hardware clock setting (UTC or localtime)

    CLI Example:
    Severity: Minor
    Found in salt/modules/timezone.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_zone_etc_localtime has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_zone_etc_localtime():
    tzfile = _get_localtime_path()
    tzdir = '/usr/share/zoneinfo/'
    tzdir_len = len(tzdir)
    try:
    Severity: Minor
    Found in salt/modules/timezone.py - About 4 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

    Function get_zone has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_zone():
    '''
    Get current timezone (i.e. America/Denver)

    .. versionchanged:: 2016.11.4
    Severity: Minor
    Found in salt/modules/timezone.py - About 3 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

    Function set_zone has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def set_zone(timezone):
    '''
    Unlinks, then symlinks /etc/localtime to the set timezone.

    The timezone is crucial to several system processes, each of which SHOULD
    Severity: Minor
    Found in salt/modules/timezone.py - About 2 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

    Avoid deeply nested control flow statements.
    Open

                            if 'UTC=' in line:
                            is_utc = line.rstrip('\n').split('=')[-1].lower()
                            if is_utc == 'yes':
                                return 'UTC'
                            else:
    Severity: Major
    Found in salt/modules/timezone.py - About 45 mins to fix

      Function zone_compare has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

      def zone_compare(timezone):
    '''
    Compares the given timezone name with the system timezone name.
    Checks the hash sum between the given timezone, and the one set in
    /etc/localtime. Returns True if names and hash sums match, and False if not.
      Severity: Minor
      Found in salt/modules/timezone.py - About 45 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

      Avoid deeply nested control flow statements.
      Open

                              if line.startswith('TZ=UTC'):
                            return 'UTC'
                    return 'localtime'
      Severity: Major
      Found in salt/modules/timezone.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                for line in fp_:
                            line = salt.utils.stringutils.to_unicode(line)
                            if line.startswith('clock='):
                                line = line.rstrip('\n')
                                line = line.split('=')[-1].strip('\'"')
        Severity: Major
        Found in salt/modules/timezone.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                                  if line.startswith('zone_info=GMT'):
                            return 'UTC'
                    return 'localtime'
          Severity: Major
          Found in salt/modules/timezone.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                    if re.match(r'^\s*#', line):
                            continue
                        if 'UTC=' in line:
            Severity: Major
            Found in salt/modules/timezone.py - About 45 mins to fix

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

              def _get_zone_sysconfig():
    tzfile = '/etc/sysconfig/clock'
    with salt.utils.files.fopen(tzfile, 'r') as fp_:
        for line in fp_:
            line = salt.utils.stringutils.to_unicode(line)
              Severity: Minor
              Found in salt/modules/timezone.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

              Avoid too many return statements within this function.
              Open

                                                  return line
              Severity: Major
              Found in salt/modules/timezone.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return 'localtime'
                Severity: Major
                Found in salt/modules/timezone.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                      return 'localtime'
                  Severity: Major
                  Found in salt/modules/timezone.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                                return 'UTC'
                    Severity: Major
                    Found in salt/modules/timezone.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                          return True
                      Severity: Major
                      Found in salt/modules/timezone.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                    return _get_zone_aix()
                        Severity: Major
                        Found in salt/modules/timezone.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                              return 'UTC'
                          Severity: Major
                          Found in salt/modules/timezone.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                        return _get_zone_etc_localtime()
                            Severity: Major
                            Found in salt/modules/timezone.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                                  return 'UTC'
                              Severity: Major
                              Found in salt/modules/timezone.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                            return 'UTC'
                                Severity: Major
                                Found in salt/modules/timezone.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                              return _get_zone_solaris()
                                  Severity: Major
                                  Found in salt/modules/timezone.py - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                                                    return 'localtime'
                                    Severity: Major
                                    Found in salt/modules/timezone.py - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                                  return _get_adjtime_timezone()
                                      Severity: Major
                                      Found in salt/modules/timezone.py - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                                    return _get_adjtime_timezone()
                                        Severity: Major
                                        Found in salt/modules/timezone.py - About 30 mins to fix

                                          Avoid too many return statements within this function.
                                          Open

                                                                              return 'LOCAL'
                                          Severity: Major
                                          Found in salt/modules/timezone.py - About 30 mins to fix

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

                                                    if 'AIX' in __grains__['os_family']:
            offset_file = '/etc/environment'
            try:
                with salt.utils.files.fopen(offset_file, 'r') as fp_:
                    for line in fp_:
                                            Severity: Major
                                            Found in salt/modules/timezone.py and 1 other location - About 6 hrs to fix
                                            salt/modules/timezone.py on lines 454..469

                                            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 117.

                                            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 'Solaris' in __grains__['os_family']:
            offset_file = '/etc/rtc_config'
            try:
                with salt.utils.files.fopen(offset_file, 'r') as fp_:
                    for line in fp_:
                                            Severity: Major
                                            Found in salt/modules/timezone.py and 1 other location - About 6 hrs to fix
                                            salt/modules/timezone.py on lines 472..487

                                            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 117.

                                            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 _get_zone_aix():
    tzfile = '/etc/environment'
    with salt.utils.files.fopen(tzfile, 'r') as fp_:
        for line in fp_:
            line = salt.utils.stringutils.to_unicode(line)
                                            Severity: Major
                                            Found in salt/modules/timezone.py and 1 other location - About 6 hrs to fix
                                            salt/modules/timezone.py on lines 59..67

                                            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 107.

                                            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 _get_zone_solaris():
    tzfile = '/etc/TIMEZONE'
    with salt.utils.files.fopen(tzfile, 'r') as fp_:
        for line in fp_:
            line = salt.utils.stringutils.to_unicode(line)
                                            Severity: Major
                                            Found in salt/modules/timezone.py and 1 other location - About 6 hrs to fix
                                            salt/modules/timezone.py on lines 150..158

                                            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 107.

                                            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 'Arch' in __grains__['os_family']:
            cmd = ['timezonectl', 'set-local-rtc',
                   'true' if clock == 'localtime' else 'false']
            return __salt__['cmd.retcode'](cmd, python_shell=False) == 0
                                            Severity: Minor
                                            Found in salt/modules/timezone.py and 1 other location - About 55 mins to fix
                                            salt/modules/timezone.py on lines 501..504

                                            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 45.

                                            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 salt.utils.path.which('timedatectl'):
        cmd = ['timedatectl', 'set-local-rtc',
               'true' if clock == 'localtime' else 'false']
        return __salt__['cmd.retcode'](cmd, python_shell=False) == 0
                                            Severity: Minor
                                            Found in salt/modules/timezone.py and 1 other location - About 55 mins to fix
                                            salt/modules/timezone.py on lines 538..541

                                            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 45.

                                            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