Sign upLogin

portainer/portainer

View on GitHub
Star
api/http/handler/endpointgroups/endpointgroup_update.go

Summary

Maintainability
D
1 day
Test Coverage

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

func (handler *Handler) updateEndpointGroup(tx dataservices.DataStoreTx, endpointGroupID portainer.EndpointGroupID, payload endpointGroupUpdatePayload) (*portainer.EndpointGroup, error) {
    endpointGroup, err := tx.EndpointGroup().Read(portainer.EndpointGroupID(endpointGroupID))
    if tx.IsErrObjectNotFound(err) {
        return nil, httperror.NotFound("Unable to find an environment group with the specified identifier inside the database", err)
    } else if err != nil {
Severity: Minor
Found in api/http/handler/endpointgroups/endpointgroup_update.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

Method Handler.updateEndpointGroup has 95 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (handler *Handler) updateEndpointGroup(tx dataservices.DataStoreTx, endpointGroupID portainer.EndpointGroupID, payload endpointGroupUpdatePayload) (*portainer.EndpointGroup, error) {
    endpointGroup, err := tx.EndpointGroup().Read(portainer.EndpointGroupID(endpointGroupID))
    if tx.IsErrObjectNotFound(err) {
        return nil, httperror.NotFound("Unable to find an environment group with the specified identifier inside the database", err)
    } else if err != nil {
Severity: Major
Found in api/http/handler/endpointgroups/endpointgroup_update.go - About 2 hrs to fix

    Method Handler.updateEndpointGroup has 11 return statements (exceeds 4 allowed).
    Open

    func (handler *Handler) updateEndpointGroup(tx dataservices.DataStoreTx, endpointGroupID portainer.EndpointGroupID, payload endpointGroupUpdatePayload) (*portainer.EndpointGroup, error) {
    endpointGroup, err := tx.EndpointGroup().Read(portainer.EndpointGroupID(endpointGroupID))
    if tx.IsErrObjectNotFound(err) {
        return nil, httperror.NotFound("Unable to find an environment group with the specified identifier inside the database", err)
    } else if err != nil {
    Severity: Major
    Found in api/http/handler/endpointgroups/endpointgroup_update.go - About 1 hr to fix

      Avoid deeply nested control flow statements.
      Open

                                  if err != nil {
                                log.Error().Err(err).Msgf("Unable to create pending action to clean NAP with override policies for endpoint (%d) and endpoint group (%d).", endpointID, endpointGroupID)
                            }
      Severity: Major
      Found in api/http/handler/endpointgroups/endpointgroup_update.go - About 45 mins to fix

        Method Handler.endpointGroupUpdate has 6 return statements (exceeds 4 allowed).
        Open

        func (handler *Handler) endpointGroupUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
    endpointGroupID, err := request.RetrieveNumericRouteVariableValue(r, "id")
    if err != nil {
        return httperror.BadRequest("Invalid environment group identifier route variable", err)
    }
        Severity: Major
        Found in api/http/handler/endpointgroups/endpointgroup_update.go - About 40 mins to fix

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

                      for _, tagID := range payload.TagIDs {
                tag, err := tx.Tag().Read(tagID)
                if err != nil {
                    return nil, httperror.InternalServerError("Unable to find a tag inside the database", err)
                }
          Severity: Minor
          Found in api/http/handler/endpointgroups/endpointgroup_update.go and 1 other location - About 45 mins to fix
          api/http/handler/endpointgroups/endpointgroup_create.go on lines 115..127

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

          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