Skip to content

rename URLCredential to URLCredentialsProvider #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2024
Merged

rename URLCredential to URLCredentialsProvider #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3224288
rename URLCredential to URLCredentialsProvider
JacksonTian Jul 26, 2024
2b216a1
improve URICredentialsProvider
JacksonTian Jul 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 28 additions & 40 deletions credentials/uri_credential.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
)

// URLCredential is a kind of credential
type URLCredential struct {
type URLCredentialsProvider struct {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这是个非兼容更新，需要谨慎发布

URL string
*credentialUpdater
*sessionCredential
Expand All @@ -26,18 +26,18 @@ type URLResponse struct {
Expiration string `json:"Expiration" xml:"Expiration"`
}

func newURLCredential(URL string) *URLCredential {
func newURLCredential(URL string) *URLCredentialsProvider {
credentialUpdater := new(credentialUpdater)
if URL == "" {
URL = os.Getenv("ALIBABA_CLOUD_CREDENTIALS_URI")
}
return &URLCredential{
return &URLCredentialsProvider{
URL: URL,
credentialUpdater: credentialUpdater,
}
}

func (e *URLCredential) GetCredential() (*CredentialModel, error) {
func (e *URLCredentialsProvider) GetCredential() (*CredentialModel, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -55,60 +55,48 @@ func (e *URLCredential) GetCredential() (*CredentialModel, error) {

// GetAccessKeyId reutrns URLCredential's AccessKeyId
// if AccessKeyId is not exist or out of date, the function will update it.
func (e *URLCredential) GetAccessKeyId() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
if e.credentialExpiration > (int(time.Now().Unix()) - int(e.lastUpdateTimestamp)) {
return &e.sessionCredential.AccessKeyId, nil
}
return tea.String(""), err
}
func (e *URLCredentialsProvider) GetAccessKeyId() (accessKeyId *string, err error) {
c, err := e.GetCredential()
if err != nil {
return
}
return tea.String(e.sessionCredential.AccessKeyId), nil
accessKeyId = c.AccessKeyId
return
}

// GetAccessSecret reutrns URLCredential's AccessKeySecret
// if AccessKeySecret is not exist or out of date, the function will update it.
func (e *URLCredential) GetAccessKeySecret() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
if e.credentialExpiration > (int(time.Now().Unix()) - int(e.lastUpdateTimestamp)) {
return &e.sessionCredential.AccessKeySecret, nil
}
return tea.String(""), err
}
func (e *URLCredentialsProvider) GetAccessKeySecret() (accessKeySecret *string, err error) {
c, err := e.GetCredential()
if err != nil {
return
}
return tea.String(e.sessionCredential.AccessKeySecret), nil
accessKeySecret = c.AccessKeySecret
return
}

// GetSecurityToken reutrns URLCredential's SecurityToken
// if SecurityToken is not exist or out of date, the function will update it.
func (e *URLCredential) GetSecurityToken() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
if e.credentialExpiration > (int(time.Now().Unix()) - int(e.lastUpdateTimestamp)) {
return &e.sessionCredential.SecurityToken, nil
}
return tea.String(""), err
}
func (e *URLCredentialsProvider) GetSecurityToken() (securityToken *string, err error) {
c, err := e.GetCredential()
if err != nil {
return
}
return tea.String(e.sessionCredential.SecurityToken), nil
securityToken = c.SecurityToken
return
}

// GetBearerToken is useless for URLCredential
func (e *URLCredential) GetBearerToken() *string {
func (e *URLCredentialsProvider) GetBearerToken() *string {
return tea.String("")
}

// GetType reutrns URLCredential's type
func (e *URLCredential) GetType() *string {
func (e *URLCredentialsProvider) GetType() *string {
return tea.String("credential_uri")
}

func (e *URLCredential) updateCredential() (err error) {
func (e *URLCredentialsProvider) updateCredential() (err error) {
if e.runtime == nil {
e.runtime = new(utils.Runtime)
}
Expand All @@ -117,15 +105,15 @@ func (e *URLCredential) updateCredential() (err error) {
request.Method = "GET"
content, err := doAction(request, e.runtime)
if err != nil {
return fmt.Errorf("refresh Ecs sts token err: %s", err.Error())
return fmt.Errorf("get credentials from %s failed with error: %s", e.URL, err.Error())
}
var resp *URLResponse
err = json.Unmarshal(content, &resp)
if err != nil {
return fmt.Errorf("refresh Ecs sts token err: Json Unmarshal fail: %s", err.Error())
return fmt.Errorf("get credentials from %s failed with error, json unmarshal fail: %s", e.URL, err.Error())
}
if resp.AccessKeyId == "" || resp.AccessKeySecret == "" || resp.SecurityToken == "" || resp.Expiration == "" {
return fmt.Errorf("refresh Ecs sts token err: AccessKeyId: %s, AccessKeySecret: %s, SecurityToken: %s, Expiration: %s", resp.AccessKeyId, resp.AccessKeySecret, resp.SecurityToken, resp.Expiration)
return fmt.Errorf("get credentials failed: AccessKeyId: %s, AccessKeySecret: %s, SecurityToken: %s, Expiration: %s", resp.AccessKeyId, resp.AccessKeySecret, resp.SecurityToken, resp.Expiration)
}

expirationTime, err := time.Parse("2006-01-02T15:04:05Z", resp.Expiration)
Expand Down
85 changes: 76 additions & 9 deletions credentials/uri_credential_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,88 @@ import (
"github.com/stretchr/testify/assert"
)

func TestURLCredential_updateCredential(t *testing.T) {
URLCredential := newURLCredential("http://127.0.0.1")
func TestURLCredentialsProvider_updateCredential(t *testing.T) {
provider := newURLCredential("http://127.0.0.1")

origTestHookDo := hookDo
defer func() { hookDo = origTestHookDo }()
hookDo = func(fn func(req *http.Request) (*http.Response, error)) func(req *http.Request) (*http.Response, error) {
return func(req *http.Request) (*http.Response, error) {
return mockResponse(300, ``, errors.New("sdk test"))
}
}
accesskeyId, err := URLCredential.GetAccessKeyId()
// assert.NotNil(t, err)
assert.Equal(t, "refresh Ecs sts token err: sdk test", err.Error())
assert.Equal(t, "", *accesskeyId)

assert.Equal(t, "credential_uri", *URLCredential.GetType())
cred, err := provider.GetCredential()
assert.NotNil(t, err)
assert.Equal(t, "get credentials from http://127.0.0.1 failed with error: sdk test", err.Error())
assert.Nil(t, cred)

_, err = provider.GetAccessKeyId()
assert.NotNil(t, err)
assert.Equal(t, "get credentials from http://127.0.0.1 failed with error: sdk test", err.Error())

_, err = provider.GetAccessKeySecret()
assert.NotNil(t, err)
assert.Equal(t, "get credentials from http://127.0.0.1 failed with error: sdk test", err.Error())

_, err = provider.GetSecurityToken()
assert.NotNil(t, err)
assert.Equal(t, "get credentials from http://127.0.0.1 failed with error: sdk test", err.Error())

hookDo = func(fn func(req *http.Request) (*http.Response, error)) func(req *http.Request) (*http.Response, error) {
return func(req *http.Request) (*http.Response, error) {
return mockResponse(200, `invalid json`, nil)
}
}

cred, err = provider.GetCredential()
assert.NotNil(t, err)
assert.Equal(t, "get credentials from http://127.0.0.1 failed with error, json unmarshal fail: invalid character 'i' looking for beginning of value", err.Error())
assert.Nil(t, cred)

hookDo = func(fn func(req *http.Request) (*http.Response, error)) func(req *http.Request) (*http.Response, error) {
return func(req *http.Request) (*http.Response, error) {
return mockResponse(200, `{}`, nil)
}
}

cred, err := URLCredential.GetCredential()
assert.Equal(t, "refresh Ecs sts token err: sdk test", err.Error())
cred, err = provider.GetCredential()
assert.NotNil(t, err)
assert.Equal(t, "get credentials failed: AccessKeyId: , AccessKeySecret: , SecurityToken: , Expiration: ", err.Error())
assert.Nil(t, cred)

hookDo = func(fn func(req *http.Request) (*http.Response, error)) func(req *http.Request) (*http.Response, error) {
return func(req *http.Request) (*http.Response, error) {
return mockResponse(200, `{"AccessKeyId":"akid", "AccessKeySecret":"aksecret","SecurityToken":"sts","Expiration":"2006-01-02T15:04:05Z"}`, nil)
}
}

cred, err = provider.GetCredential()
assert.Nil(t, err)
assert.NotNil(t, cred)
assert.Equal(t, "akid", *cred.AccessKeyId)
assert.Equal(t, "aksecret", *cred.AccessKeySecret)
assert.Equal(t, "sts", *cred.SecurityToken)

akid, err := provider.GetAccessKeyId()
assert.Nil(t, err)
assert.Equal(t, "akid", *akid)

aksecret, err := provider.GetAccessKeySecret()
assert.Nil(t, err)
assert.Equal(t, "aksecret", *aksecret)

sts, err := provider.GetSecurityToken()
assert.Nil(t, err)
assert.Equal(t, "sts", *sts)
}

func TestURLCredentialsProviderGetBearerToken(t *testing.T) {
provider := newURLCredential("http://127.0.0.1")
assert.Equal(t, "", *provider.GetBearerToken())
}

func TestURLCredentialsProviderGetType(t *testing.T) {
provider := newURLCredential("http://127.0.0.1")
assert.Equal(t, "credential_uri", *provider.GetType())
}
Loading