pkg/giterminism_manager/file_reader/fs.go

Summary

Maintainability
F
3 days
Test Coverage
C
79%

Method FileReader.walkFilesWithPathMatcher has a Cognitive Complexity of 44 (exceeds 20 allowed). Consider refactoring.
Open

func (r FileReader) walkFilesWithPathMatcher(ctx context.Context, relDir string, pathMatcher path_matcher.PathMatcher, skipFileFunc func(ctx context.Context, r FileReader, existingRelPath string) (bool, error), fileFunc func(notResolvedPath string) error) error {
    if !pathMatcher.IsDirOrSubmodulePathMatched(relDir) {
        return nil
    }

Severity: Minor
Found in pkg/giterminism_manager/file_reader/fs.go - 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

Method FileReader.resolveFilePath has a Cognitive Complexity of 34 (exceeds 20 allowed). Consider refactoring.
Open

func (r FileReader) resolveFilePath(ctx context.Context, relPath string, depth int, checkSymlinkTargetFunc func(resolvedPath string) error) (string, error) {
    if depth > 1000 {
        return "", fmt.Errorf("too many levels of symbolic links")
    }
    depth++
Severity: Minor
Found in pkg/giterminism_manager/file_reader/fs.go - 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

FileReader has 21 methods (exceeds 20 allowed). Consider refactoring.
Open

func (r FileReader) projectRelativePathToAbsolutePath(relPath string) string {
    return filepath.Join(r.sharedOptions.ProjectDir(), relPath)
}
Severity: Minor
Found in pkg/giterminism_manager/file_reader/fs.go - About 2 hrs to fix

    Method FileReader.walkFilesWithPathMatcher has 77 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func (r FileReader) walkFilesWithPathMatcher(ctx context.Context, relDir string, pathMatcher path_matcher.PathMatcher, skipFileFunc func(ctx context.Context, r FileReader, existingRelPath string) (bool, error), fileFunc func(notResolvedPath string) error) error {
        if !pathMatcher.IsDirOrSubmodulePathMatched(relDir) {
            return nil
        }
    
    
    Severity: Major
    Found in pkg/giterminism_manager/file_reader/fs.go - About 2 hrs to fix

      Method FileReader.checkFileExistenceAndAcceptance has 12 return statements (exceeds 4 allowed).
      Open

      func (r FileReader) checkFileExistenceAndAcceptance(ctx context.Context, relPath string, isFileAcceptedCheckFunc func(relPath string) bool) error {
          if r.sharedOptions.LooseGiterminism() {
              exist, err := r.IsRegularFileExist(ctx, relPath)
              if err != nil {
                  return err
      Severity: Major
      Found in pkg/giterminism_manager/file_reader/fs.go - About 1 hr to fix

        Method FileReader.resolveFilePath has 53 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func (r FileReader) resolveFilePath(ctx context.Context, relPath string, depth int, checkSymlinkTargetFunc func(resolvedPath string) error) (string, error) {
            if depth > 1000 {
                return "", fmt.Errorf("too many levels of symbolic links")
            }
            depth++
        Severity: Minor
        Found in pkg/giterminism_manager/file_reader/fs.go - About 1 hr to fix

          Method FileReader.resolveFilePath has 8 return statements (exceeds 4 allowed).
          Open

          func (r FileReader) resolveFilePath(ctx context.Context, relPath string, depth int, checkSymlinkTargetFunc func(resolvedPath string) error) (string, error) {
              if depth > 1000 {
                  return "", fmt.Errorf("too many levels of symbolic links")
              }
              depth++
          Severity: Major
          Found in pkg/giterminism_manager/file_reader/fs.go - About 50 mins to fix

            Method FileReader.listFilesWithGlob has 7 return statements (exceeds 4 allowed).
            Open

            func (r FileReader) listFilesWithGlob(ctx context.Context, relDir, glob string, skipFileFunc func(ctx context.Context, r FileReader, existingRelPath string) (bool, error)) ([]string, error) {
                var prefixWithoutPatterns string
                prefixWithoutPatterns, glob = util.GlobPrefixWithoutPatterns(glob)
                relDirOrFileWithGlobPart := filepath.Join(relDir, prefixWithoutPatterns)
            
            
            Severity: Major
            Found in pkg/giterminism_manager/file_reader/fs.go - About 45 mins to fix

              Method FileReader.walkFilesWithPathMatcher has 7 return statements (exceeds 4 allowed).
              Open

              func (r FileReader) walkFilesWithPathMatcher(ctx context.Context, relDir string, pathMatcher path_matcher.PathMatcher, skipFileFunc func(ctx context.Context, r FileReader, existingRelPath string) (bool, error), fileFunc func(notResolvedPath string) error) error {
                  if !pathMatcher.IsDirOrSubmodulePathMatched(relDir) {
                      return nil
                  }
              
              
              Severity: Major
              Found in pkg/giterminism_manager/file_reader/fs.go - About 45 mins to fix

                Method FileReader.walkFilesWithPathMatcher has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                func (r FileReader) walkFilesWithPathMatcher(ctx context.Context, relDir string, pathMatcher path_matcher.PathMatcher, skipFileFunc func(ctx context.Context, r FileReader, existingRelPath string) (bool, error), fileFunc func(notResolvedPath string) error) error {
                Severity: Minor
                Found in pkg/giterminism_manager/file_reader/fs.go - About 35 mins to fix

                  Method FileReader.skipFileFunc has a Cognitive Complexity of 21 (exceeds 20 allowed). Consider refactoring.
                  Open

                  func (r FileReader) skipFileFunc(acceptedFilePathMatcher path_matcher.PathMatcher) func(ctx context.Context, r FileReader, existingRelPath string) (bool, error) {
                      return func(ctx context.Context, r FileReader, existingRelPath string) (bool, error) {
                          if filepath.Base(existingRelPath) == ".git" {
                              return true, nil
                          }
                  Severity: Minor
                  Found in pkg/giterminism_manager/file_reader/fs.go - About 25 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 (r FileReader) CheckFileExistenceAndAcceptance(ctx context.Context, relPath string, isFileAcceptedCheckFunc func(relPath string) bool) (err error) {
                      logboek.Context(ctx).Debug().
                          LogBlock("CheckFileExistenceAndAcceptance %q", relPath).
                          Options(func(options types.LogBlockOptionsInterface) {
                              if !debug() {
                  Severity: Major
                  Found in pkg/giterminism_manager/file_reader/fs.go and 1 other location - About 2 hrs to fix
                  pkg/giterminism_manager/file_reader/configuration.go on lines 152..169

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

                  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 4 locations. Consider refactoring.
                  Open

                  func (r FileReader) IsRegularFileExist(ctx context.Context, relPath string) (exist bool, err error) {
                      logboek.Context(ctx).Debug().
                          LogBlock("IsRegularFileExist %q", relPath).
                          Options(func(options types.LogBlockOptionsInterface) {
                              if !debug() {
                  Severity: Major
                  Found in pkg/giterminism_manager/file_reader/fs.go and 3 other locations - About 1 hr to fix
                  pkg/giterminism_manager/file_reader/configuration.go on lines 185..202
                  pkg/giterminism_manager/file_reader/fs.go on lines 392..409
                  pkg/giterminism_manager/file_reader/git.go on lines 259..276

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

                  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 4 locations. Consider refactoring.
                  Open

                  func (r FileReader) IsDirectoryExist(ctx context.Context, relPath string) (exist bool, err error) {
                      logboek.Context(ctx).Debug().
                          LogBlock("IsDirectoryExist %q", relPath).
                          Options(func(options types.LogBlockOptionsInterface) {
                              if !debug() {
                  Severity: Major
                  Found in pkg/giterminism_manager/file_reader/fs.go and 3 other locations - About 1 hr to fix
                  pkg/giterminism_manager/file_reader/configuration.go on lines 185..202
                  pkg/giterminism_manager/file_reader/fs.go on lines 431..448
                  pkg/giterminism_manager/file_reader/git.go on lines 259..276

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

                  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 (r FileReader) isDirectoryExist(ctx context.Context, relPath string) (bool, error) {
                      resolvedPath, err := r.ResolveFilePath(ctx, relPath)
                      if err != nil {
                          if IsFileNotFoundInProjectDirectoryError(err) {
                              return false, nil
                  Severity: Major
                  Found in pkg/giterminism_manager/file_reader/fs.go and 1 other location - About 1 hr to fix
                  pkg/giterminism_manager/file_reader/fs.go on lines 450..467

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

                  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 (r FileReader) isRegularFileExist(ctx context.Context, relPath string) (bool, error) {
                      resolvedPath, err := r.ResolveFilePath(ctx, relPath)
                      if err != nil {
                          if IsFileNotFoundInProjectDirectoryError(err) {
                              return false, nil
                  Severity: Major
                  Found in pkg/giterminism_manager/file_reader/fs.go and 1 other location - About 1 hr to fix
                  pkg/giterminism_manager/file_reader/fs.go on lines 411..428

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

                  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