providers.*ProfileCredentialsProvider.getCredentialsProvider - Code Metrics - Inspection of "Add profile credentials provider" - aliyun/credentials-go - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a7ec9d...f14615 )

unknown

created 2024-08-20 09:49 UTC

CredentialsProvider F

↳ Parent: credentials/internal/providers/profile.go

Complexity

Conditions

Size

Total Lines	70
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	21
eloc	56
nop	1
dl	0
loc	70
rs	0
c	0
b	0
f	0

How to fix Long Method Complexity

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

If many parameters/temporary variables are present:
- Replace temporary variables with Query
- Introduce parameter object; often combined with preserve whole object
- If the above two are insufficient: Replace method with method object
If you have long conditionals: Decompose Conditional
Otherwise: Extract method

Complexity

Complex classes like providers.*ProfileCredentialsProvider.getCredentialsProvider often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

package providers

import (
	"errors"
	"fmt"
	"os"
	"path"

	"github.com/aliyun/credentials-go/credentials/internal/utils"
	"gopkg.in/ini.v1"
)

type ProfileCredentialsProvider struct {
	profileName   string
	innerProvider CredentialsProvider
}

type ProfileCredentialsProviderBuilder struct {
	provider *ProfileCredentialsProvider
}

func NewProfileCredentialsProviderBuilder() (builder *ProfileCredentialsProviderBuilder) {
	return &ProfileCredentialsProviderBuilder{
		provider: &ProfileCredentialsProvider{},
	}
}

func (b *ProfileCredentialsProviderBuilder) WithProfileName(profileName string) *ProfileCredentialsProviderBuilder {
	b.provider.profileName = profileName
	return b
}

func (b *ProfileCredentialsProviderBuilder) Build() (provider *ProfileCredentialsProvider) {
	// 优先级：
	// 1. 使用显示指定的 profileName
	// 2. 使用环境变量（ALIBABA_CLOUD_PROFILE）指定的 profileName
	// 3. 兜底使用 default 作为 profileName
	b.provider.profileName = utils.GetDefaultString(b.provider.profileName, os.Getenv("ALIBABA_CLOUD_PROFILE"), "default")

	provider = b.provider
	return
}

func (provider *ProfileCredentialsProvider) getCredentialsProvider(ini *ini.File) (credentialsProvider CredentialsProvider, err error) {
	section, err := ini.GetSection(provider.profileName)
	if err != nil {
		err = errors.New("ERROR: Can not load section" + err.Error())
		return
	}

	value, err := section.GetKey("type")
	if err != nil {
		err = errors.New("ERROR: Can not find credential type" + err.Error())
		return
	}

	switch value.String() {
	case "access_key":
		value1, err1 := section.GetKey("access_key_id")
		value2, err2 := section.GetKey("access_key_secret")
		if err1 != nil || err2 != nil {
			err = errors.New("ERROR: Failed to get value")
			return
		}

		if value1.String() == "" || value2.String() == "" {
			err = errors.New("ERROR: Value can't be empty")
			return
		}

		credentialsProvider, err = NewStaticAKCredentialsProviderBuilder().
			WithAccessKeyId(value1.String()).
			WithAccessKeySecret(value2.String()).
			Build()
	case "ecs_ram_role":
		value1, err1 := section.GetKey("role_name")
		if err1 != nil {
			err = errors.New("ERROR: Failed to get value")
			return
		}
		credentialsProvider, err = NewECSRAMRoleCredentialsProviderBuilder().WithRoleName(value1.String()).Build()
	case "ram_role_arn":
		value1, err1 := section.GetKey("access_key_id")
		value2, err2 := section.GetKey("access_key_secret")
		value3, err3 := section.GetKey("role_arn")
		value4, err4 := section.GetKey("role_session_name")
		if err1 != nil || err2 != nil || err3 != nil || err4 != nil {
			err = errors.New("ERROR: Failed to get value")
			return
		}
		if value1.String() == "" || value2.String() == "" || value3.String() == "" || value4.String() == "" {
			err = errors.New("ERROR: Value can't be empty")
			return
		}
		previous, err5 := NewStaticAKCredentialsProviderBuilder().
			WithAccessKeyId(value1.String()).
			WithAccessKeySecret(value2.String()).
			Build()
		if err5 != nil {
			err = errors.New("get previous credentials provider failed")
			return
		}

		credentialsProvider, err = NewRAMRoleARNCredentialsProviderBuilder().
			WithCredentialsProvider(previous).
			WithRoleArn(value3.String()).
			WithRoleSessionName(value4.String()).
			WithDurationSeconds(3600).
			Build()
	default:
		err = errors.New("ERROR: Failed to get credential")
	}
	return
}

func (provider *ProfileCredentialsProvider) GetCredentials() (cc *Credentials, err error) {
	if provider.innerProvider == nil {
		sharedCfgPath := os.Getenv("ALIBABA_CLOUD_CREDENTIALS_FILE")
		if sharedCfgPath == "" {
			homeDir := getHomePath()
			if homeDir == "" {
				err = fmt.Errorf("cannot found home dir")
				return
			}

			sharedCfgPath = path.Join(homeDir, ".alibabacloud/credentials")
		}

		ini, err1 := ini.Load(sharedCfgPath)
		if err1 != nil {
			err = errors.New("ERROR: Can not open file" + err1.Error())
			return
		}

		provider.innerProvider, err = provider.getCredentialsProvider(ini)
		if err != nil {
			return
		}
	}

	innerCC, err := provider.innerProvider.GetCredentials()
	if err != nil {
		return
	}

	cc = &Credentials{
		AccessKeyId:     innerCC.AccessKeyId,
		AccessKeySecret: innerCC.AccessKeySecret,
		SecurityToken:   innerCC.SecurityToken,
		ProviderName:    fmt.Sprintf("%s/%s", provider.GetProviderName(), provider.innerProvider.GetProviderName()),
	}

	return
}

func (provider *ProfileCredentialsProvider) GetProviderName() string {
	return "profile"
}


1			package providers
2
3			import (
4			"errors"
5			"fmt"
6			"os"
7			"path"
8
9			"github.com/aliyun/credentials-go/credentials/internal/utils"
10			"gopkg.in/ini.v1"
11			)
12
13			type ProfileCredentialsProvider struct {
14			profileName string
15			innerProvider CredentialsProvider
16			}
17
18			type ProfileCredentialsProviderBuilder struct {
19			provider *ProfileCredentialsProvider
20			}
21
22			func NewProfileCredentialsProviderBuilder() (builder *ProfileCredentialsProviderBuilder) {
23			return &ProfileCredentialsProviderBuilder{
24			provider: &ProfileCredentialsProvider{},
25			}
26			}
27
28			func (b ProfileCredentialsProviderBuilder) WithProfileName(profileName string) ProfileCredentialsProviderBuilder {
29			b.provider.profileName = profileName
30			return b
31			}
32
33			func (b ProfileCredentialsProviderBuilder) Build() (provider ProfileCredentialsProvider) {
34			// 优先级：
35			// 1. 使用显示指定的 profileName
36			// 2. 使用环境变量（ALIBABA_CLOUD_PROFILE）指定的 profileName
37			// 3. 兜底使用 default 作为 profileName
38			b.provider.profileName = utils.GetDefaultString(b.provider.profileName, os.Getenv("ALIBABA_CLOUD_PROFILE"), "default")
39
40			provider = b.provider
41			return
42			}
43
44			func (provider ProfileCredentialsProvider) getCredentialsProvider(ini ini.File) (credentialsProvider CredentialsProvider, err error) {
45			section, err := ini.GetSection(provider.profileName)
46			if err != nil {
47			err = errors.New("ERROR: Can not load section" + err.Error())
48			return
49			}
50
51			value, err := section.GetKey("type")
52			if err != nil {
53			err = errors.New("ERROR: Can not find credential type" + err.Error())
54			return
55			}
56
57			switch value.String() {
58			case "access_key":
59			value1, err1 := section.GetKey("access_key_id")
60			value2, err2 := section.GetKey("access_key_secret")
61			if err1 != nil \|\| err2 != nil {
62			err = errors.New("ERROR: Failed to get value")
63			return
64			}
65
66			if value1.String() == "" \|\| value2.String() == "" {
67			err = errors.New("ERROR: Value can't be empty")
68			return
69			}
70
71			credentialsProvider, err = NewStaticAKCredentialsProviderBuilder().
72			WithAccessKeyId(value1.String()).
73			WithAccessKeySecret(value2.String()).
74			Build()
75			case "ecs_ram_role":
76			value1, err1 := section.GetKey("role_name")
77			if err1 != nil {
78			err = errors.New("ERROR: Failed to get value")
79			return
80			}
81			credentialsProvider, err = NewECSRAMRoleCredentialsProviderBuilder().WithRoleName(value1.String()).Build()
82			case "ram_role_arn":
83			value1, err1 := section.GetKey("access_key_id")
84			value2, err2 := section.GetKey("access_key_secret")
85			value3, err3 := section.GetKey("role_arn")
86			value4, err4 := section.GetKey("role_session_name")
87			if err1 != nil \|\| err2 != nil \|\| err3 != nil \|\| err4 != nil {
88			err = errors.New("ERROR: Failed to get value")
89			return
90			}
91			if value1.String() == "" \|\| value2.String() == "" \|\| value3.String() == "" \|\| value4.String() == "" {
92			err = errors.New("ERROR: Value can't be empty")
93			return
94			}
95			previous, err5 := NewStaticAKCredentialsProviderBuilder().
96			WithAccessKeyId(value1.String()).
97			WithAccessKeySecret(value2.String()).
98			Build()
99			if err5 != nil {
100			err = errors.New("get previous credentials provider failed")
101			return
102			}
103
104			credentialsProvider, err = NewRAMRoleARNCredentialsProviderBuilder().
105			WithCredentialsProvider(previous).
106			WithRoleArn(value3.String()).
107			WithRoleSessionName(value4.String()).
108			WithDurationSeconds(3600).
109			Build()
110			default:
111			err = errors.New("ERROR: Failed to get credential")
112			}
113			return
114			}
115
116			func (provider ProfileCredentialsProvider) GetCredentials() (cc Credentials, err error) {
117			if provider.innerProvider == nil {
118			sharedCfgPath := os.Getenv("ALIBABA_CLOUD_CREDENTIALS_FILE")
119			if sharedCfgPath == "" {
120			homeDir := getHomePath()
121			if homeDir == "" {
122			err = fmt.Errorf("cannot found home dir")
123			return
124			}
125
126			sharedCfgPath = path.Join(homeDir, ".alibabacloud/credentials")
127			}
128
129			ini, err1 := ini.Load(sharedCfgPath)
130			if err1 != nil {
131			err = errors.New("ERROR: Can not open file" + err1.Error())
132			return
133			}
134
135			provider.innerProvider, err = provider.getCredentialsProvider(ini)
136			if err != nil {
137			return
138			}
139			}
140
141			innerCC, err := provider.innerProvider.GetCredentials()
142			if err != nil {
143			return
144			}
145
146			cc = &Credentials{
147			AccessKeyId: innerCC.AccessKeyId,
148			AccessKeySecret: innerCC.AccessKeySecret,
149			SecurityToken: innerCC.SecurityToken,
150			ProviderName: fmt.Sprintf("%s/%s", provider.GetProviderName(), provider.innerProvider.GetProviderName()),
151			}
152
153			return
154			}
155
156			func (provider *ProfileCredentialsProvider) GetProviderName() string {
157			return "profile"
158			}
159

aliyun / credentials-go

GitHub Access Token became invalid

Push — master ( a7ec9d...f14615 )

CredentialsProvider F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like