portainer/portainer

View on GitHub
api/filesystem/filesystem.go

Summary

Maintainability
D
2 days
Test Coverage

Service has 57 methods (exceeds 20 allowed). Consider refactoring.
Open

type Service struct {
    dataStorePath string
    fileStorePath string
}
Severity: Major
Found in api/filesystem/filesystem.go - About 1 day to fix

    File filesystem.go has 746 lines of code (exceeds 500 allowed). Consider refactoring.
    Open

    package filesystem
    
    import (
        "bytes"
        "encoding/pem"
    Severity: Minor
    Found in api/filesystem/filesystem.go - About 7 hrs to fix

      Method Service.Copy has 10 return statements (exceeds 4 allowed).
      Open

      func (service *Service) Copy(fromFilePath string, toFilePath string, deleteIfExists bool) error {
          exists, err := service.FileExists(fromFilePath)
          if err != nil {
              return err
          }
      Severity: Major
      Found in api/filesystem/filesystem.go - About 1 hr to fix

        Function NewService has 7 return statements (exceeds 4 allowed).
        Open

        func NewService(dataStorePath, fileStorePath string) (*Service, error) {
            service := &Service{
                dataStorePath: dataStorePath,
                fileStorePath: JoinPaths(dataStorePath, fileStorePath),
            }
        Severity: Major
        Found in api/filesystem/filesystem.go - About 45 mins to fix

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

          func (service *Service) StoreStackFileFromBytes(stackIdentifier, fileName string, data []byte) (string, error) {
              stackStorePath := JoinPaths(ComposeStorePath, stackIdentifier)
              err := service.createDirectoryInStore(stackStorePath)
              if err != nil {
                  return "", err
          Severity: Major
          Found in api/filesystem/filesystem.go and 2 other locations - About 1 hr to fix
          api/filesystem/filesystem.go on lines 419..435
          api/filesystem/filesystem.go on lines 731..747

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

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

          func (service *Service) StoreCustomTemplateFileFromBytes(identifier, fileName string, data []byte) (string, error) {
              customTemplateStorePath := JoinPaths(CustomTemplateStorePath, identifier)
              err := service.createDirectoryInStore(customTemplateStorePath)
              if err != nil {
                  return "", err
          Severity: Major
          Found in api/filesystem/filesystem.go and 2 other locations - About 1 hr to fix
          api/filesystem/filesystem.go on lines 243..259
          api/filesystem/filesystem.go on lines 419..435

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

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

          func (service *Service) StoreEdgeStackFileFromBytes(edgeStackIdentifier, fileName string, data []byte) (string, error) {
              stackStorePath := JoinPaths(EdgeStackStorePath, edgeStackIdentifier)
              err := service.createDirectoryInStore(stackStorePath)
              if err != nil {
                  return "", err
          Severity: Major
          Found in api/filesystem/filesystem.go and 2 other locations - About 1 hr to fix
          api/filesystem/filesystem.go on lines 243..259
          api/filesystem/filesystem.go on lines 731..747

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

          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