Sign upLogin

cloudamatic/mu

View on GitHub
Star
modules/mu/master/ldap.rb

Summary

Maintainability
D
1 day
Test Coverage

Assignment Branch Condition size for manageUser is too high. [203.4/75]
Open

      def self.manageUser(user, name: nil, password: nil, email: nil, admin: false, mu_acct: true, unlock: false, ou: $MU_CFG["ldap"]["user_ou"], enable: false, disable: false, change_uid: -1)
        cur_users = listUsers

        first = last = nil
        if !name.nil?
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method manageUser has a Cognitive Complexity of 121 (exceeds 75 allowed). Consider refactoring.
Open

      def self.manageUser(user, name: nil, password: nil, email: nil, admin: false, mu_acct: true, unlock: false, ou: $MU_CFG["ldap"]["user_ou"], enable: false, disable: false, change_uid: -1)
        cur_users = listUsers

        first = last = nil
        if !name.nil?
Severity: Minor
Found in modules/mu/master/ldap.rb - About 7 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

Assignment Branch Condition size for initLocalLDAP is too high. [117.3/75]
Open

      def self.initLocalLDAP
        validateConfig
        if $MU_CFG["ldap"]["type"] != "389 Directory Services" or
            # XXX this should check all of the IPs and hostnames we're known by
            (!$MU_CFG["ldap"]["dcs"].include?("localhost") and
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for findUsers is too high. [112.5/75]
Open

      def self.findUsers(search = [], exact: false, searchbase: $MU_CFG['ldap']['base_dn'], extra_attrs: [], matchgroups: [])
        # We want to search groups, but can't search on memberOf with wildcards.
        # So search groups independently, build a list of full CNs, and use
        # those.
        if search.size > 0
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Perceived complexity for manageUser is too high. [60/35]
Open

      def self.manageUser(user, name: nil, password: nil, email: nil, admin: false, mu_acct: true, unlock: false, ou: $MU_CFG["ldap"]["user_ou"], enable: false, disable: false, change_uid: -1)
        cur_users = listUsers

        first = last = nil
        if !name.nil?
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Cyclomatic complexity for manageUser is too high. [50/30]
Open

      def self.manageUser(user, name: nil, password: nil, email: nil, admin: false, mu_acct: true, unlock: false, ou: $MU_CFG["ldap"]["user_ou"], enable: false, disable: false, change_uid: -1)
        cur_users = listUsers

        first = last = nil
        if !name.nil?
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Assignment Branch Condition size for validateConfig is too high. [80.59/75]
Open

      def self.validateConfig(skipvaults: false)
        ok = true
        supported = ["Active Directory", "389 Directory Services"]
        if !$MU_CFG
          raise MuLDAPError, "Configuration not loaded yet, but MU::Master::LDAP.validateConfig was called!"
Severity: Minor
Found in modules/mu/master/ldap.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method manageUser has 178 lines of code (exceeds 150 allowed). Consider refactoring.
Open

      def self.manageUser(user, name: nil, password: nil, email: nil, admin: false, mu_acct: true, unlock: false, ou: $MU_CFG["ldap"]["user_ou"], enable: false, disable: false, change_uid: -1)
        cur_users = listUsers

        first = last = nil
        if !name.nil?
Severity: Major
Found in modules/mu/master/ldap.rb - About 2 hrs to fix

    Avoid deeply nested control flow statements.
    Open

                  if disable
                attr[:userAccountControl] = (attr[:userAccountControl].to_i & AD_PW_ATTRS['disable']).to_s
              end
    Severity: Major
    Found in modules/mu/master/ldap.rb - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                    if mu_acct
                attr[:userAccountControl] = (attr[:userAccountControl].to_i & AD_PW_ATTRS['pwdNeverExpires']).to_s
              end
      Severity: Major
      Found in modules/mu/master/ldap.rb - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                      if wait >= 30
                MU.log "User #{user} has been created in LDAP, but local system can't see it. Are PAM/LDAP configured correctly?", MU::ERR
                return false
              end
        Severity: Major
        Found in modules/mu/master/ldap.rb - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                          if used_uids.include?(change_uid)
                  raise MuLDAPError, "Uid #{change_uid} is unavailable, cannot allocate to user #{user}"
                end
          Severity: Major
          Found in modules/mu/master/ldap.rb - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                            if used_uids.include?(change_uid)
                  raise MuLDAPError, "Uid #{change_uid} is unavailable, cannot allocate to user #{user}"
                end
            Severity: Major
            Found in modules/mu/master/ldap.rb - About 45 mins to fix

              Avoid too many return statements within this method.
              Open

                      return false
              Severity: Major
              Found in modules/mu/master/ldap.rb - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                          return true if shortname == require_group
                Severity: Major
                Found in modules/mu/master/ldap.rb - About 30 mins to fix

                  Avoid more than 4 levels of block nesting.
                  Open

                                  if used_uids.include?(change_uid)
                  raise MuLDAPError, "Uid #{change_uid} is unavailable, cannot allocate to user #{user}"
                end
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop checks for excessive nesting of conditional and looping constructs.

                  You can configure if blocks are considered using the CountBlocks option. When set to false (the default) blocks are not counted towards the nesting level. Set to true to count blocks as well.

                  The maximum level of nesting allowed is configurable.

                  Avoid more than 4 levels of block nesting.
                  Open

                                if wait >= 30
                MU.log "User #{user} has been created in LDAP, but local system can't see it. Are PAM/LDAP configured correctly?", MU::ERR
                return false
              end
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop checks for excessive nesting of conditional and looping constructs.

                  You can configure if blocks are considered using the CountBlocks option. When set to false (the default) blocks are not counted towards the nesting level. Set to true to count blocks as well.

                  The maximum level of nesting allowed is configurable.

                  Avoid more than 4 levels of block nesting.
                  Open

                                  if used_uids.include?(change_uid)
                  raise MuLDAPError, "Uid #{change_uid} is unavailable, cannot allocate to user #{user}"
                end
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop checks for excessive nesting of conditional and looping constructs.

                  You can configure if blocks are considered using the CountBlocks option. When set to false (the default) blocks are not counted towards the nesting level. Set to true to count blocks as well.

                  The maximum level of nesting allowed is configurable.

                  Use =~ in places where the MatchData returned by #match will not be used.
                  Open

                                if getLDAPErr.match(/53 Unwilling to perform/)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies the use of Regexp#match or String#match, which returns #<MatchData>/nil. The return value of =~ is an integral index/nil and is more performant.

                  Example:

                  # bad
do_something if str.match(/regex/)
while regex.match('str')
  do_something
end

# good
method(str =~ /regex/)
return value unless regex =~ 'str'

                  Use =~ in places where the MatchData returned by #match will not be used.
                  Open

                              next if chunk.match(/^DC=/i)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies the use of Regexp#match or String#match, which returns #<MatchData>/nil. The return value of =~ is an integral index/nil and is more performant.

                  Example:

                  # bad
do_something if str.match(/regex/)
while regex.match('str')
  do_something
end

# good
method(str =~ /regex/)
return value unless regex =~ 'str'

                  Use =~ in places where the MatchData returned by #match will not be used.
                  Open

                              if chunk.match(/^OU=(.*)/i)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies the use of Regexp#match or String#match, which returns #<MatchData>/nil. The return value of =~ is an integral index/nil and is more performant.

                  Example:

                  # bad
do_something if str.match(/regex/)
while regex.match('str')
  do_something
end

# good
method(str =~ /regex/)
return value unless regex =~ 'str'

                  Use =~ in places where the MatchData returned by #match will not be used.
                  Open

                              elsif chunk.match(/^CN=(.*)/i)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies the use of Regexp#match or String#match, which returns #<MatchData>/nil. The return value of =~ is an integral index/nil and is more performant.

                  Example:

                  # bad
do_something if str.match(/regex/)
while regex.match('str')
  do_something
end

# good
method(str =~ /regex/)
return value unless regex =~ 'str'

                  Use =~ in places where the MatchData returned by #match will not be used.
                  Open

                            user_dn.match(/^CN=(.*?),/i)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies the use of Regexp#match or String#match, which returns #<MatchData>/nil. The return value of =~ is an integral index/nil and is more performant.

                  Example:

                  # bad
do_something if str.match(/regex/)
while regex.match('str')
  do_something
end

# good
method(str =~ /regex/)
return value unless regex =~ 'str'

                  Use casecmp instead of downcase ==.
                  Open

                                  if member.downcase == user or (!dn.nil? and member.downcase == dn.downcase)
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop identifies places where a case-insensitive string comparison can better be implemented using casecmp.

                  Example:

                  # bad
str.downcase == 'abc'
str.upcase.eql? 'ABC'
'abc' == str.downcase
'ABC'.eql? str.upcase
str.downcase == str.downcase

# good
str.casecmp('ABC').zero?
'abc'.casecmp(str).zero?

                  Redundant use of Object#to_s in interpolation.
                  Open

                              MU.log "Couldn't modify write-test user #{dn} field #{field.to_s}, operating in read-only LDAP mode (#{getLDAPErr})", MU::NOTICE
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop checks for string conversion in string interpolation, which is redundant.

                  Example:

                  # bad

"result is #{something.to_s}"

                  Example:

                  # good

"result is #{something}"

                  Redundant use of Object#to_s in interpolation.
                  Open

                                  raise MuLDAPError, "Failed to create user #{user} (#{getLDAPErr}) from add(:dn => #{user_dn}, :attributes => #{attr.to_s})"
                  Severity: Minor
                  Found in modules/mu/master/ldap.rb by rubocop

                  This cop checks for string conversion in string interpolation, which is redundant.

                  Example:

                  # bad

"result is #{something.to_s}"

                  Example:

                  # good

"result is #{something}"

                  There are no issues that match your filters.

                  Category
                  Status