johnsonjh/gfpsgo

View on GitHub

Showing 20 of 20 total issues

File psgo.go has 685 lines of code (exceeds 500 allowed). Consider refactoring.
Open

// Copyright 2021 Jeffery H. Johnson <trnsz@pobox.com>
// Copyright 2021 Gridfinity, LLC.
// Copyright 2020 The psgo authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
Severity: Minor
Found in psgo.go - About 6 hrs to fix

    Function parseStatus has 126 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func parseStatus(pid string, lines []string) (*Status, error) {
        s := Status{}
        errUnexpectedInput := fmt.Errorf(
            "unexpected input from /proc/%s/status",
            pid,
    Severity: Major
    Found in internal/proc/status.go - About 4 hrs to fix

      Function main has 74 lines of code (exceeds 50 allowed). Consider refactoring.
      Open

      func main() {
          var (
              descriptors []string
              pidsList    []string
              data        [][]string
      Severity: Minor
      Found in cmd/sample.go - About 1 hr to fix

        Function JoinNamespaceAndProcessInfoWithOptions has 68 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func JoinNamespaceAndProcessInfoWithOptions(
            pid string,
            descriptors []string,
            options *JoinNamespaceOpts,
        ) ([][]string, error) {
        Severity: Minor
        Found in psgo.go - About 1 hr to fix

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

          func processHUSER(p *process.Process, ctx *psContext) (string, error) {
              if hp := findHostProcess(p, ctx); hp != nil {
                  if ctx.opts != nil && len(ctx.opts.UIDMap) > 0 {
                      return findID(
                          hp.Status.Uids[1],
          Severity: Major
          Found in psgo.go and 1 other location - About 1 hr to fix
          psgo.go on lines 933..946

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

          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

          func processHGROUP(p *process.Process, ctx *psContext) (string, error) {
              if hp := findHostProcess(p, ctx); hp != nil {
                  if ctx.opts != nil && len(ctx.opts.GIDMap) > 0 {
                      return findID(
                          hp.Status.Gids[1],
          Severity: Major
          Found in psgo.go and 1 other location - About 1 hr to fix
          psgo.go on lines 915..928

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

          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

          Function JoinNamespaceAndProcessInfoWithOptions has 10 return statements (exceeds 4 allowed).
          Open

          func JoinNamespaceAndProcessInfoWithOptions(
              pid string,
              descriptors []string,
              options *JoinNamespaceOpts,
          ) ([][]string, error) {
          Severity: Major
          Found in psgo.go - About 1 hr to fix

            Function TTYs has 6 return statements (exceeds 4 allowed).
            Open

            func TTYs() (*[]TTY, error) {
                devDir, err := os.Open("/dev/")
                if err != nil {
                    return nil, err
                }
            Severity: Major
            Found in internal/dev/tty.go - About 40 mins to fix

              Function New has 6 return statements (exceeds 4 allowed).
              Open

              func New(pid string, joinUserNS bool) (*Process, error) {
                  p := Process{Pid: pid}
              
                  if err := p.parseStat(); err != nil {
                      return nil, err
              Severity: Major
              Found in internal/process/process.go - About 40 mins to fix

                Function BootTime has 5 return statements (exceeds 4 allowed).
                Open

                func BootTime() (int64, error) {
                    if bootTime != nil {
                        return *bootTime, nil
                    }
                
                
                Severity: Major
                Found in internal/host/host.go - About 35 mins to fix

                  Function ReadMappings has 5 return statements (exceeds 4 allowed).
                  Open

                  func ReadMappings(path string) ([]IDMap, error) {
                      file, err := os.Open(path)
                      if err != nil {
                          return nil, errors.Wrapf(err, "cannot open %s", path)
                      }
                  Severity: Major
                  Found in internal/proc/ns.go - About 35 mins to fix

                    Function findID has 5 return statements (exceeds 4 allowed).
                    Open

                    func findID(
                        idStr string,
                        mapping []IDMap,
                        lookupFunc func(uid string) (string, error),
                        overflowFile string,
                    Severity: Major
                    Found in psgo.go - About 35 mins to fix

                      Function JoinNamespaceAndProcessInfoWithOptions has a Cognitive Complexity of 22 (exceeds 20 allowed). Consider refactoring.
                      Open

                      func JoinNamespaceAndProcessInfoWithOptions(
                          pid string,
                          descriptors []string,
                          options *JoinNamespaceOpts,
                      ) ([][]string, error) {
                      Severity: Minor
                      Found in psgo.go - 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

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

                      func LookupUID(uid string) (string, error) {
                          uidNum, err := strconv.Atoi(uid)
                          if err != nil {
                              return "", errors.Wrap(err, "error parsing user ID")
                          }
                      Severity: Minor
                      Found in internal/process/process.go and 1 other location - About 35 mins to fix
                      internal/process/process.go on lines 51..61

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

                      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

                      func LookupGID(gid string) (string, error) {
                          gidNum, err := strconv.Atoi(gid)
                          if err != nil {
                              return "", errors.Wrap(err, "error parsing group ID")
                          }
                      Severity: Minor
                      Found in internal/process/process.go and 1 other location - About 35 mins to fix
                      internal/process/process.go on lines 65..75

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

                      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

                      Your code does not pass gofmt in 1 place. Go fmt your code!
                      Open

                      // Copyright 2021 Jeffery H. Johnson <trnsz@pobox.com>
                      Severity: Minor
                      Found in psgo.go by gofmt

                      2: cannot find package "github.com/johnsonjh/gfpsgo" in any of:
                      Open

                          psgo "github.com/johnsonjh/gfpsgo"
                      Severity: Minor
                      Found in cmd/sample.go by govet

                      Line length
                      Open

                      - `psgo.JoinNamespaceAndProcessInfo(pid string, descriptors []string) ([][]string, error)`
                      Severity: Info
                      Found in README.md by markdownlint

                      MD013 - Line length

                      Tags: line_length

                      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

                      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

                      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

                      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

                      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

                      Line length
                      Open

                      - `psgo.JoinNamespaceAndProcessInfoByPids(pids []string, descriptors []string) ([][]string, error)`
                      Severity: Info
                      Found in README.md by markdownlint

                      MD013 - Line length

                      Tags: line_length

                      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

                      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

                      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

                      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

                      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

                      XXX found
                      Open

                      .XXX
                      Severity: Minor
                      Found in .gitignore by fixme
                      Severity
                      Category
                      Status
                      Source
                      Language