Sign upLogin

portainer/portainer

View on GitHub
Star
api/http/proxy/factory/docker/transport.go

Summary

Maintainability
F
3 days
Test Coverage

File transport.go has 591 lines of code (exceeds 500 allowed). Consider refactoring.
Open

package docker

import (
    "bytes"
    "encoding/base64"
Severity: Minor
Found in api/http/proxy/factory/docker/transport.go - About 4 hrs to fix

    Transport has 31 methods (exceeds 20 allowed). Consider refactoring.
    Open

        Transport struct {
        HTTPTransport        *http.Transport
        endpoint             *portainer.Endpoint
        dataStore            dataservices.DataStore
        signatureService     portainer.DigitalSignatureService
    Severity: Minor
    Found in api/http/proxy/factory/docker/transport.go - About 3 hrs to fix

      Method Transport.restrictedResourceOperation has a Cognitive Complexity of 31 (exceeds 20 allowed). Consider refactoring.
      Open

      func (transport *Transport) restrictedResourceOperation(request *http.Request, resourceID string, dockerResourceID string, resourceType portainer.ResourceControlType, volumeBrowseRestrictionCheck bool) (*http.Response, error) {
    var err error
    tokenData, err := security.RetrieveTokenData(request)
    if err != nil {
        return nil, err
      Severity: Minor
      Found in api/http/proxy/factory/docker/transport.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

      Method Transport.restrictedResourceOperation has 9 return statements (exceeds 4 allowed).
      Open

      func (transport *Transport) restrictedResourceOperation(request *http.Request, resourceID string, dockerResourceID string, resourceType portainer.ResourceControlType, volumeBrowseRestrictionCheck bool) (*http.Response, error) {
    var err error
    tokenData, err := security.RetrieveTokenData(request)
    if err != nil {
        return nil, err
      Severity: Major
      Found in api/http/proxy/factory/docker/transport.go - About 55 mins to fix

        Method Transport.decorateRegistryAuthenticationHeader has 8 return statements (exceeds 4 allowed).
        Open

        func (transport *Transport) decorateRegistryAuthenticationHeader(request *http.Request) error {
    accessContext, err := transport.createRegistryAccessContext(request)
    if err != nil {
        return err
    }
        Severity: Major
        Found in api/http/proxy/factory/docker/transport.go - About 50 mins to fix

          Method Transport.proxyAgentRequest has 8 return statements (exceeds 4 allowed).
          Open

          func (transport *Transport) proxyAgentRequest(r *http.Request) (*http.Response, error) {
    requestPath := strings.TrimPrefix(r.URL.Path, "/v2")

    switch {
    case strings.HasPrefix(requestPath, "/browse"):
          Severity: Major
          Found in api/http/proxy/factory/docker/transport.go - About 50 mins to fix

            Method Transport.restrictedResourceOperation has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            func (transport *Transport) restrictedResourceOperation(request *http.Request, resourceID string, dockerResourceID string, resourceType portainer.ResourceControlType, volumeBrowseRestrictionCheck bool) (*http.Response, error) {
            Severity: Minor
            Found in api/http/proxy/factory/docker/transport.go - About 35 mins to fix

              Method Transport.proxyContainerRequest has 5 return statements (exceeds 4 allowed).
              Open

              func (transport *Transport) proxyContainerRequest(request *http.Request) (*http.Response, error) {
    switch requestPath := request.URL.Path; requestPath {
    case "/containers/create":
        return transport.decorateContainerCreationOperation(request, containerObjectIdentifier, portainer.ContainerResourceControl)
              Severity: Major
              Found in api/http/proxy/factory/docker/transport.go - About 35 mins to fix

                Method Transport.executeGenericResourceDeletionOperation has 5 return statements (exceeds 4 allowed).
                Open

                func (transport *Transport) executeGenericResourceDeletionOperation(request *http.Request, resourceIdentifierAttribute string, volumeName string, resourceType portainer.ResourceControlType) (*http.Response, error) {
    response, err := transport.restrictedResourceOperation(request, resourceIdentifierAttribute, volumeName, resourceType, false)
    if err != nil {
        return response, err
    }
                Severity: Major
                Found in api/http/proxy/factory/docker/transport.go - About 35 mins to fix

                  Method Transport.createRegistryAccessContext has 5 return statements (exceeds 4 allowed).
                  Open

                  func (transport *Transport) createRegistryAccessContext(request *http.Request) (*registryAccessContext, error) {
    tokenData, err := security.RetrieveTokenData(request)
    if err != nil {
        return nil, err
    }
                  Severity: Major
                  Found in api/http/proxy/factory/docker/transport.go - About 35 mins to fix

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

                    func (transport *Transport) createOperationContext(request *http.Request) (*restrictedDockerOperationContext, error) {
    var err error
    tokenData, err := security.RetrieveTokenData(request)
    if err != nil {
        return nil, err
                    Severity: Major
                    Found in api/http/proxy/factory/docker/transport.go and 1 other location - About 3 hrs to fix
                    api/http/proxy/factory/azure/access_control.go on lines 13..48

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

                    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 (transport *Transport) proxySecretRequest(request *http.Request) (*http.Response, error) {
    switch requestPath := request.URL.Path; requestPath {
    case "/secrets/create":
        return transport.decorateGenericResourceCreationOperation(request, secretObjectIdentifier, portainer.SecretResourceControl)
                    Severity: Major
                    Found in api/http/proxy/factory/docker/transport.go and 2 other locations - About 2 hrs to fix
                    api/http/proxy/factory/docker/transport.go on lines 206..226
                    api/http/proxy/factory/docker/transport.go on lines 312..331

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

                    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 (transport *Transport) proxyNetworkRequest(request *http.Request) (*http.Response, error) {
    switch requestPath := request.URL.Path; requestPath {
    case "/networks/create":
        return transport.decorateGenericResourceCreationOperation(request, networkObjectIdentifier, portainer.NetworkResourceControl)
                    Severity: Major
                    Found in api/http/proxy/factory/docker/transport.go and 2 other locations - About 2 hrs to fix
                    api/http/proxy/factory/docker/transport.go on lines 206..226
                    api/http/proxy/factory/docker/transport.go on lines 333..352

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

                    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 (transport *Transport) proxyConfigRequest(request *http.Request) (*http.Response, error) {
    switch requestPath := request.URL.Path; requestPath {
    case "/configs/create":
        return transport.decorateGenericResourceCreationOperation(request, configObjectIdentifier, portainer.ConfigResourceControl)
                    Severity: Major
                    Found in api/http/proxy/factory/docker/transport.go and 2 other locations - About 2 hrs to fix
                    api/http/proxy/factory/docker/transport.go on lines 312..331
                    api/http/proxy/factory/docker/transport.go on lines 333..352

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

                    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