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

Passed

Push — master ( f5d62c...a7ec9d )

by Jackson

created 2024-08-20 09:16 UTC

dentialsProvider B

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

Complexity

Conditions

Size

Total Lines	95
Code Lines	65

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	65
nop	1
dl	0
loc	95
rs	8.1454
c	0
b	0
f	0

How to fix Long Method

package providers

import (
	"os"
	"path"
	"strings"
	"testing"

	"github.com/aliyun/credentials-go/credentials/internal/utils"
	"github.com/stretchr/testify/assert"
)

func TestCLIProfileCredentialsProvider(t *testing.T) {
	rollback := utils.Memory("ALIBABA_CLOUD_PROFILE")
	defer rollback()
	b := NewCLIProfileCredentialsProviderBuilder().Build()
	assert.Equal(t, "", b.profileName)

	// get from env
	os.Setenv("ALIBABA_CLOUD_PROFILE", "custom_profile")
	b = NewCLIProfileCredentialsProviderBuilder().Build()
	assert.Equal(t, "custom_profile", b.profileName)

	b = NewCLIProfileCredentialsProviderBuilder().WithProfileName("profilename").Build()
	assert.Equal(t, "profilename", b.profileName)
}

func Test_configuration(t *testing.T) {
	wd, _ := os.Getwd()
	_, err := newConfigurationFromPath(path.Join(wd, "fixtures/inexist_cli_config.json"))
	assert.NotNil(t, err)
	assert.True(t, strings.HasPrefix(err.Error(), "reading aliyun cli config from "))

	_, err = newConfigurationFromPath(path.Join(wd, "fixtures/invalid_cli_config.json"))
	assert.NotNil(t, err)
	assert.True(t, strings.HasPrefix(err.Error(), "unmarshal aliyun cli config from "))

	_, err = newConfigurationFromPath(path.Join(wd, "fixtures/mock_empty_cli_config.json"))
	assert.True(t, strings.HasPrefix(err.Error(), "no any configured profiles in "))

	conf, err := newConfigurationFromPath(path.Join(wd, "fixtures/mock_cli_config.json"))
	assert.Nil(t, err)
	assert.Equal(t, &configuration{
		Current: "default",
		Profiles: []*profile{
			{
				Mode:            "AK",
				Name:            "default",
				AccessKeyID:     "akid",
				AccessKeySecret: "secret",
			},
			{
				Mode:            "AK",
				Name:            "jacksontian",
				AccessKeyID:     "akid",
				AccessKeySecret: "secret",
			},
		},
	}, conf)

	_, err = conf.getProfile("inexists")
	assert.EqualError(t, err, "unable to get profile with 'inexists'")

	p, err := conf.getProfile("jacksontian")
	assert.Nil(t, err)
	assert.Equal(t, p.Name, "jacksontian")
	assert.Equal(t, p.Mode, "AK")
}

func TestCLIProfileCredentialsProvider_getCredentialsProvider(t *testing.T) {
	conf := &configuration{
		Current: "AK",
		Profiles: []*profile{
			{
				Mode:            "AK",
				Name:            "AK",
				AccessKeyID:     "akid",
				AccessKeySecret: "secret",
			},
			{
				Mode:            "RamRoleArn",
				Name:            "RamRoleArn",
				AccessKeyID:     "akid",
				AccessKeySecret: "secret",
				RoleArn:         "arn",
			},
			{
				Mode: "RamRoleArn",
				Name: "Invalid_RamRoleArn",
			},
			{
				Mode:     "EcsRamRole",
				Name:     "EcsRamRole",
				RoleName: "rolename",
			},
			{
				Mode:            "OIDC",
				Name:            "OIDC",
				RoleArn:         "role_arn",
				OIDCTokenFile:   "path/to/oidc/file",
				OIDCProviderARN: "provider_arn",
			},
			{
				Mode:          "ChainableRamRoleArn",
				Name:          "ChainableRamRoleArn",
				RoleArn:       "arn",
				SourceProfile: "AK",
			},
			{
				Mode:          "ChainableRamRoleArn",
				Name:          "ChainableRamRoleArn2",
				SourceProfile: "InvalidSource",
			},
			{
				Mode: "Unsupported",
				Name: "Unsupported",
			},
		},
	}

	provider := NewCLIProfileCredentialsProviderBuilder().Build()
	_, err := provider.getCredentialsProvider(conf, "inexist")
	assert.EqualError(t, err, "unable to get profile with 'inexist'")

	// AK
	cp, err := provider.getCredentialsProvider(conf, "AK")
	assert.Nil(t, err)
	akcp, ok := cp.(*StaticAKCredentialsProvider)
	assert.True(t, ok)
	cc, err := akcp.GetCredentials()
	assert.Nil(t, err)
	assert.Equal(t, cc, &Credentials{AccessKeyId: "akid", AccessKeySecret: "secret", SecurityToken: "", ProviderName: "static_ak"})
	// RamRoleArn
	cp, err = provider.getCredentialsProvider(conf, "RamRoleArn")
	assert.Nil(t, err)
	_, ok = cp.(*RAMRoleARNCredentialsProvider)
	assert.True(t, ok)
	// RamRoleArn invalid ak
	_, err = provider.getCredentialsProvider(conf, "Invalid_RamRoleArn")
	assert.EqualError(t, err, "the access key id is empty")
	// EcsRamRole
	cp, err = provider.getCredentialsProvider(conf, "EcsRamRole")
	assert.Nil(t, err)
	_, ok = cp.(*ECSRAMRoleCredentialsProvider)
	assert.True(t, ok)
	// OIDC
	cp, err = provider.getCredentialsProvider(conf, "OIDC")
	assert.Nil(t, err)
	_, ok = cp.(*OIDCCredentialsProvider)
	assert.True(t, ok)

	// ChainableRamRoleArn
	cp, err = provider.getCredentialsProvider(conf, "ChainableRamRoleArn")
	assert.Nil(t, err)
	_, ok = cp.(*RAMRoleARNCredentialsProvider)
	assert.True(t, ok)

	// ChainableRamRoleArn with invalid source profile
	_, err = provider.getCredentialsProvider(conf, "ChainableRamRoleArn2")
	assert.EqualError(t, err, "get source profile failed: unable to get profile with 'InvalidSource'")

	// Unsupported
	_, err = provider.getCredentialsProvider(conf, "Unsupported")
	assert.EqualError(t, err, "unsupported profile mode 'Unsupported'")
}

func TestCLIProfileCredentialsProvider_GetCredentials(t *testing.T) {
	defer func() {
		getHomePath = utils.GetHomePath
	}()

	getHomePath = func() string {
		return ""
	}
	provider := NewCLIProfileCredentialsProviderBuilder().Build()
	_, err := provider.GetCredentials()
	assert.EqualError(t, err, "cannot found home dir")

	getHomePath = func() string {
		return "/path/invalid/home/dir"
	}
	provider = NewCLIProfileCredentialsProviderBuilder().Build()
	_, err = provider.GetCredentials()
	assert.EqualError(t, err, "reading aliyun cli config from '/path/invalid/home/dir/.aliyun/config.json' failed open /path/invalid/home/dir/.aliyun/config.json: no such file or directory")

	getHomePath = func() string {
		wd, _ := os.Getwd()
		return path.Join(wd, "fixtures")
	}

	// get credentials by current profile
	provider = NewCLIProfileCredentialsProviderBuilder().Build()
	cc, err := provider.GetCredentials()
	assert.Nil(t, err)
	assert.Equal(t, &Credentials{AccessKeyId: "akid", AccessKeySecret: "secret", SecurityToken: "", ProviderName: "cli_profile/static_ak"}, cc)

	provider = NewCLIProfileCredentialsProviderBuilder().WithProfileName("inexist").Build()
	_, err = provider.GetCredentials()
	assert.EqualError(t, err, "unable to get profile with 'inexist'")

	// The get_credentials_error profile is invalid
	provider = NewCLIProfileCredentialsProviderBuilder().WithProfileName("get_credentials_error").Build()
	_, err = provider.GetCredentials()
	assert.Contains(t, err.Error(), "InvalidAccessKeyId.NotFound")
}


1			package providers
2
3			import (
4			"os"
5			"path"
6			"strings"
7			"testing"
8
9			"github.com/aliyun/credentials-go/credentials/internal/utils"
10			"github.com/stretchr/testify/assert"
11			)
12
13			func TestCLIProfileCredentialsProvider(t *testing.T) {
14			rollback := utils.Memory("ALIBABA_CLOUD_PROFILE")
15			defer rollback()
16			b := NewCLIProfileCredentialsProviderBuilder().Build()
17			assert.Equal(t, "", b.profileName)
18
19			// get from env
20			os.Setenv("ALIBABA_CLOUD_PROFILE", "custom_profile")
21			b = NewCLIProfileCredentialsProviderBuilder().Build()
22			assert.Equal(t, "custom_profile", b.profileName)
23
24			b = NewCLIProfileCredentialsProviderBuilder().WithProfileName("profilename").Build()
25			assert.Equal(t, "profilename", b.profileName)
26			}
27
28			func Test_configuration(t *testing.T) {
29			wd, _ := os.Getwd()
30			_, err := newConfigurationFromPath(path.Join(wd, "fixtures/inexist_cli_config.json"))
31			assert.NotNil(t, err)
32			assert.True(t, strings.HasPrefix(err.Error(), "reading aliyun cli config from "))
33
34			_, err = newConfigurationFromPath(path.Join(wd, "fixtures/invalid_cli_config.json"))
35			assert.NotNil(t, err)
36			assert.True(t, strings.HasPrefix(err.Error(), "unmarshal aliyun cli config from "))
37
38			_, err = newConfigurationFromPath(path.Join(wd, "fixtures/mock_empty_cli_config.json"))
39			assert.True(t, strings.HasPrefix(err.Error(), "no any configured profiles in "))
40
41			conf, err := newConfigurationFromPath(path.Join(wd, "fixtures/mock_cli_config.json"))
42			assert.Nil(t, err)
43			assert.Equal(t, &configuration{
44			Current: "default",
45			Profiles: []*profile{
46			{
47			Mode: "AK",
48			Name: "default",
49			AccessKeyID: "akid",
50			AccessKeySecret: "secret",
51			},
52			{
53			Mode: "AK",
54			Name: "jacksontian",
55			AccessKeyID: "akid",
56			AccessKeySecret: "secret",
57			},
58			},
59			}, conf)
60
61			_, err = conf.getProfile("inexists")
62			assert.EqualError(t, err, "unable to get profile with 'inexists'")
63
64			p, err := conf.getProfile("jacksontian")
65			assert.Nil(t, err)
66			assert.Equal(t, p.Name, "jacksontian")
67			assert.Equal(t, p.Mode, "AK")
68			}
69
70			func TestCLIProfileCredentialsProvider_getCredentialsProvider(t *testing.T) {
71			conf := &configuration{
72			Current: "AK",
73			Profiles: []*profile{
74			{
75			Mode: "AK",
76			Name: "AK",
77			AccessKeyID: "akid",
78			AccessKeySecret: "secret",
79			},
80			{
81			Mode: "RamRoleArn",
82			Name: "RamRoleArn",
83			AccessKeyID: "akid",
84			AccessKeySecret: "secret",
85			RoleArn: "arn",
86			},
87			{
88			Mode: "RamRoleArn",
89			Name: "Invalid_RamRoleArn",
90			},
91			{
92			Mode: "EcsRamRole",
93			Name: "EcsRamRole",
94			RoleName: "rolename",
95			},
96			{
97			Mode: "OIDC",
98			Name: "OIDC",
99			RoleArn: "role_arn",
100			OIDCTokenFile: "path/to/oidc/file",
101			OIDCProviderARN: "provider_arn",
102			},
103			{
104			Mode: "ChainableRamRoleArn",
105			Name: "ChainableRamRoleArn",
106			RoleArn: "arn",
107			SourceProfile: "AK",
108			},
109			{
110			Mode: "ChainableRamRoleArn",
111			Name: "ChainableRamRoleArn2",
112			SourceProfile: "InvalidSource",
113			},
114			{
115			Mode: "Unsupported",
116			Name: "Unsupported",
117			},
118			},
119			}
120
121			provider := NewCLIProfileCredentialsProviderBuilder().Build()
122			_, err := provider.getCredentialsProvider(conf, "inexist")
123			assert.EqualError(t, err, "unable to get profile with 'inexist'")
124
125			// AK
126			cp, err := provider.getCredentialsProvider(conf, "AK")
127			assert.Nil(t, err)
128			akcp, ok := cp.(*StaticAKCredentialsProvider)
129			assert.True(t, ok)
130			cc, err := akcp.GetCredentials()
131			assert.Nil(t, err)
132			assert.Equal(t, cc, &Credentials{AccessKeyId: "akid", AccessKeySecret: "secret", SecurityToken: "", ProviderName: "static_ak"})
133			// RamRoleArn
134			cp, err = provider.getCredentialsProvider(conf, "RamRoleArn")
135			assert.Nil(t, err)
136			_, ok = cp.(*RAMRoleARNCredentialsProvider)
137			assert.True(t, ok)
138			// RamRoleArn invalid ak
139			_, err = provider.getCredentialsProvider(conf, "Invalid_RamRoleArn")
140			assert.EqualError(t, err, "the access key id is empty")
141			// EcsRamRole
142			cp, err = provider.getCredentialsProvider(conf, "EcsRamRole")
143			assert.Nil(t, err)
144			_, ok = cp.(*ECSRAMRoleCredentialsProvider)
145			assert.True(t, ok)
146			// OIDC
147			cp, err = provider.getCredentialsProvider(conf, "OIDC")
148			assert.Nil(t, err)
149			_, ok = cp.(*OIDCCredentialsProvider)
150			assert.True(t, ok)
151
152			// ChainableRamRoleArn
153			cp, err = provider.getCredentialsProvider(conf, "ChainableRamRoleArn")
154			assert.Nil(t, err)
155			_, ok = cp.(*RAMRoleARNCredentialsProvider)
156			assert.True(t, ok)
157
158			// ChainableRamRoleArn with invalid source profile
159			_, err = provider.getCredentialsProvider(conf, "ChainableRamRoleArn2")
160			assert.EqualError(t, err, "get source profile failed: unable to get profile with 'InvalidSource'")
161
162			// Unsupported
163			_, err = provider.getCredentialsProvider(conf, "Unsupported")
164			assert.EqualError(t, err, "unsupported profile mode 'Unsupported'")
165			}
166
167			func TestCLIProfileCredentialsProvider_GetCredentials(t *testing.T) {
168			defer func() {
169			getHomePath = utils.GetHomePath
170			}()
171
172			getHomePath = func() string {
173			return ""
174			}
175			provider := NewCLIProfileCredentialsProviderBuilder().Build()
176			_, err := provider.GetCredentials()
177			assert.EqualError(t, err, "cannot found home dir")
178
179			getHomePath = func() string {
180			return "/path/invalid/home/dir"
181			}
182			provider = NewCLIProfileCredentialsProviderBuilder().Build()
183			_, err = provider.GetCredentials()
184			assert.EqualError(t, err, "reading aliyun cli config from '/path/invalid/home/dir/.aliyun/config.json' failed open /path/invalid/home/dir/.aliyun/config.json: no such file or directory")
185
186			getHomePath = func() string {
187			wd, _ := os.Getwd()
188			return path.Join(wd, "fixtures")
189			}
190
191			// get credentials by current profile
192			provider = NewCLIProfileCredentialsProviderBuilder().Build()
193			cc, err := provider.GetCredentials()
194			assert.Nil(t, err)
195			assert.Equal(t, &Credentials{AccessKeyId: "akid", AccessKeySecret: "secret", SecurityToken: "", ProviderName: "cli_profile/static_ak"}, cc)
196
197			provider = NewCLIProfileCredentialsProviderBuilder().WithProfileName("inexist").Build()
198			_, err = provider.GetCredentials()
199			assert.EqualError(t, err, "unable to get profile with 'inexist'")
200
201			// The get_credentials_error profile is invalid
202			provider = NewCLIProfileCredentialsProviderBuilder().WithProfileName("get_credentials_error").Build()
203			_, err = provider.GetCredentials()
204			assert.Contains(t, err.Error(), "InvalidAccessKeyId.NotFound")
205			}
206

aliyun / credentials-go

GitHub Access Token became invalid

Push — master ( f5d62c...a7ec9d )

dentialsProvider B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like