portainer/portainer

View on GitHub
api/http/handler/stacks/create_compose_stack.go

Summary

Maintainability
C
1 day
Test Coverage

Method Handler.createComposeStackFromGitRepository has 67 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (handler *Handler) createComposeStackFromGitRepository(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
    var payload composeStackFromGitRepositoryPayload
    err := request.DecodeAndValidateJSONPayload(r, &payload)
    if err != nil {
        return httperror.BadRequest("Invalid request payload", err)
Severity: Minor
Found in api/http/handler/stacks/create_compose_stack.go - About 1 hr to fix

    Method Handler.createComposeStackFromGitRepository has a Cognitive Complexity of 25 (exceeds 20 allowed). Consider refactoring.
    Open

    func (handler *Handler) createComposeStackFromGitRepository(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
        var payload composeStackFromGitRepositoryPayload
        err := request.DecodeAndValidateJSONPayload(r, &payload)
        if err != nil {
            return httperror.BadRequest("Invalid request payload", err)
    Severity: Minor
    Found in api/http/handler/stacks/create_compose_stack.go - About 1 hr 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 createStackPayloadFromComposeGitPayload has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    func createStackPayloadFromComposeGitPayload(name, repoUrl, repoReference, repoUsername, repoPassword string, repoAuthentication bool, composeFile string, additionalFiles []string, autoUpdate *portainer.AutoUpdateSettings, env []portainer.Pair, fromAppTemplate bool, repoSkipSSLVerify bool) stackbuilders.StackPayload {
    Severity: Major
    Found in api/http/handler/stacks/create_compose_stack.go - About 1 hr to fix

      Method Handler.createComposeStackFromGitRepository has 10 return statements (exceeds 4 allowed).
      Open

      func (handler *Handler) createComposeStackFromGitRepository(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
          var payload composeStackFromGitRepositoryPayload
          err := request.DecodeAndValidateJSONPayload(r, &payload)
          if err != nil {
              return httperror.BadRequest("Invalid request payload", err)
      Severity: Major
      Found in api/http/handler/stacks/create_compose_stack.go - About 1 hr to fix

        Method Handler.createComposeStackFromFileUpload has 8 return statements (exceeds 4 allowed).
        Open

        func (handler *Handler) createComposeStackFromFileUpload(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
            payload, err := decodeRequestForm(r)
            if err != nil {
                return httperror.BadRequest("Invalid request payload", err)
            }
        Severity: Major
        Found in api/http/handler/stacks/create_compose_stack.go - About 50 mins to fix

          Method Handler.createComposeStackFromFileContent has 8 return statements (exceeds 4 allowed).
          Open

          func (handler *Handler) createComposeStackFromFileContent(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
              var payload composeStackFromFileContentPayload
              err := request.DecodeAndValidateJSONPayload(r, &payload)
              if err != nil {
                  return httperror.BadRequest("Invalid request payload", err)
          Severity: Major
          Found in api/http/handler/stacks/create_compose_stack.go - About 50 mins to fix

            Method Handler.checkAndCleanStackDupFromSwarm has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            func (handler *Handler) checkAndCleanStackDupFromSwarm(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID, stack *portainer.Stack) error {
            Severity: Minor
            Found in api/http/handler/stacks/create_compose_stack.go - About 35 mins to fix

              Method composeStackFromGitRepositoryPayload.Validate has 5 return statements (exceeds 4 allowed).
              Open

              func (payload *composeStackFromGitRepositoryPayload) Validate(r *http.Request) error {
                  if govalidator.IsNull(payload.Name) {
                      return errors.New("Invalid stack name")
                  }
                  if govalidator.IsNull(payload.RepositoryURL) || !govalidator.IsURL(payload.RepositoryURL) {
              Severity: Major
              Found in api/http/handler/stacks/create_compose_stack.go - About 35 mins to fix

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

                    if !isUnique {
                        stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
                        if err != nil {
                            return stackExistsError(payload.Name)
                        }
                Severity: Major
                Found in api/http/handler/stacks/create_compose_stack.go and 2 other locations - About 1 hr to fix
                api/http/handler/stacks/create_compose_stack.go on lines 252..267
                api/http/handler/stacks/create_compose_stack.go on lines 382..397

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

                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

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

                    if !isUnique {
                        stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
                        if err != nil {
                            return stackExistsError(payload.Name)
                        }
                Severity: Major
                Found in api/http/handler/stacks/create_compose_stack.go and 2 other locations - About 1 hr to fix
                api/http/handler/stacks/create_compose_stack.go on lines 119..134
                api/http/handler/stacks/create_compose_stack.go on lines 382..397

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

                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

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

                    if !isUnique {
                        stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
                        if err != nil {
                            return stackExistsError(payload.Name)
                        }
                Severity: Major
                Found in api/http/handler/stacks/create_compose_stack.go and 2 other locations - About 1 hr to fix
                api/http/handler/stacks/create_compose_stack.go on lines 119..134
                api/http/handler/stacks/create_compose_stack.go on lines 252..267

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

                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

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

                    if payload.AutoUpdate != nil && payload.AutoUpdate.Webhook != "" {
                        isUnique, err := handler.checkUniqueWebhookID(payload.AutoUpdate.Webhook)
                        if err != nil {
                            return httperror.InternalServerError("Unable to check for webhook ID collision", err)
                        }
                Severity: Major
                Found in api/http/handler/stacks/create_compose_stack.go and 2 other locations - About 45 mins to fix
                api/http/handler/stacks/create_kubernetes_stack.go on lines 217..225
                api/http/handler/stacks/create_swarm_stack.go on lines 211..219

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

                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