kubenetworks/kubevpn

View on GitHub
pkg/ssh/ssh.go

Summary

Maintainability
F
5 days
Test Coverage

Function SshJump has a Cognitive Complexity of 76 (exceeds 20 allowed). Consider refactoring.
Open

func SshJump(ctx context.Context, conf *SshConfig, flags *pflag.FlagSet, print bool) (path string, err error) {
    if conf.Addr == "" && conf.ConfigAlias == "" {
        if flags != nil {
            lookup := flags.Lookup("kubeconfig")
            if lookup != nil {
Severity: Minor
Found in pkg/ssh/ssh.go - About 1 day 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 ssh.go has 810 lines of code (exceeds 500 allowed). Consider refactoring.
Open

package ssh

import (
    "bytes"
    "context"
Severity: Major
Found in pkg/ssh/ssh.go - About 1 day to fix

    Function SshJump has 186 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func SshJump(ctx context.Context, conf *SshConfig, flags *pflag.FlagSet, print bool) (path string, err error) {
        if conf.Addr == "" && conf.ConfigAlias == "" {
            if flags != nil {
                lookup := flags.Lookup("kubeconfig")
                if lookup != nil {
    Severity: Major
    Found in pkg/ssh/ssh.go - About 6 hrs to fix

      Function PortMapUntil has a Cognitive Complexity of 51 (exceeds 20 allowed). Consider refactoring.
      Open

      func PortMapUntil(ctx context.Context, conf *SshConfig, remote, local netip.AddrPort) error {
          // Listen on remote server port
          var lc net.ListenConfig
          localListen, e := lc.Listen(ctx, "tcp", local.String())
          if e != nil {
      Severity: Minor
      Found in pkg/ssh/ssh.go - 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

      Function PortMapUntil has 94 lines of code (exceeds 50 allowed). Consider refactoring.
      Open

      func PortMapUntil(ctx context.Context, conf *SshConfig, remote, local netip.AddrPort) error {
          // Listen on remote server port
          var lc net.ListenConfig
          localListen, e := lc.Listen(ctx, "tcp", local.String())
          if e != nil {
      Severity: Major
      Found in pkg/ssh/ssh.go - About 2 hrs to fix

        Function SshJump has 28 return statements (exceeds 4 allowed).
        Open

        func SshJump(ctx context.Context, conf *SshConfig, flags *pflag.FlagSet, print bool) (path string, err error) {
            if conf.Addr == "" && conf.ConfigAlias == "" {
                if flags != nil {
                    lookup := flags.Lookup("kubeconfig")
                    if lookup != nil {
        Severity: Major
        Found in pkg/ssh/ssh.go - About 2 hrs to fix

          Function PortMapUntil has 9 return statements (exceeds 4 allowed).
          Open

          func PortMapUntil(ctx context.Context, conf *SshConfig, remote, local netip.AddrPort) error {
              // Listen on remote server port
              var lc net.ListenConfig
              localListen, e := lc.Listen(ctx, "tcp", local.String())
              if e != nil {
          Severity: Major
          Found in pkg/ssh/ssh.go - About 55 mins to fix

            Avoid deeply nested control flow statements.
            Open

                    if config.Keyfile == "" {
                        config.Keyfile = filepath.Join(homedir.HomeDir(), ".ssh", "id_rsa")
                    }
            Severity: Major
            Found in pkg/ssh/ssh.go - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                      if err != nil {
                          return nil, err
                      }
              Severity: Major
              Found in pkg/ssh/ssh.go - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                                } else if lookup.DefValue != "" {
                                    configFlags.KubeConfig = pointer.String(lookup.DefValue)
                                }
                Severity: Major
                Found in pkg/ssh/ssh.go - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                          if err != nil {
                              return nil, err
                          }
                  Severity: Major
                  Found in pkg/ssh/ssh.go - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                                    } else if lookup.DefValue != "" {
                                        path = lookup.DefValue
                                    } else {
                                        path = lookup.NoOptDefVal
                                    }
                    Severity: Major
                    Found in pkg/ssh/ssh.go - About 45 mins to fix

                      Method SshConfig.GetAuth has 5 return statements (exceeds 4 allowed).
                      Open

                      func (config SshConfig) GetAuth() ([]ssh.AuthMethod, error) {
                          host, _, _ := net.SplitHostPort(config.Addr)
                          var auth []ssh.AuthMethod
                          var c Krb5InitiatorClient
                          var err error
                      Severity: Major
                      Found in pkg/ssh/ssh.go - About 35 mins to fix

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

                            go func() {
                                buf := config.LPool.Get().([]byte)[:]
                                defer config.LPool.Put(buf[:])
                                _, err := io.CopyBuffer(local, remote, buf)
                                if err != nil && !errors.Is(err, net.ErrClosed) && !errors.Is(err, io.EOF) {
                        Severity: Major
                        Found in pkg/ssh/ssh.go and 1 other location - About 1 hr to fix
                        pkg/ssh/ssh.go on lines 273..284

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

                        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

                            go func() {
                                buf := config.LPool.Get().([]byte)[:]
                                defer config.LPool.Put(buf[:])
                                _, err := io.CopyBuffer(remote, local, buf)
                                if err != nil && !errors.Is(err, net.ErrClosed) && !errors.Is(err, io.EOF) {
                        Severity: Major
                        Found in pkg/ssh/ssh.go and 1 other location - About 1 hr to fix
                        pkg/ssh/ssh.go on lines 259..270

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

                        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