Skip to content

correct use of keyflow.init() and refactoring #2889

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

correct use of keyflow.init() and refactoring #2889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 29 additions & 19 deletions core/clients/key_flow_continuous_refresh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,17 +133,22 @@ func TestContinuousRefreshToken(t *testing.T) {
ctx, cancel := context.WithTimeout(ctx, tt.contextClosesIn)
defer cancel()

keyFlow := &KeyFlow{
config: &KeyFlowConfig{
BackgroundTokenRefreshContext: ctx,
},
authClient: &http.Client{
keyFlow := &KeyFlow{}
keyFlowConfig := &KeyFlowConfig{
BackgroundTokenRefreshContext: ctx,
AuthHTTPClient: &http.Client{
Transport: mockTransportFn{mockDo},
},
token: &TokenResponseBody{
AccessToken: accessToken,
RefreshToken: refreshToken,
},
}
err = keyFlow.Init(keyFlowConfig)
if err != nil {
t.Fatalf("failed to initialize key flow: %v", err)
}

// Set the token after initialization
err = keyFlow.SetToken(accessToken, refreshToken)
if err != nil {
t.Fatalf("failed to set token: %v", err)
}

refresher := &continuousTokenRefresher{
Expand Down Expand Up @@ -328,18 +333,23 @@ func TestContinuousRefreshTokenConcurrency(t *testing.T) {
}
}

keyFlow := &KeyFlow{
config: &KeyFlowConfig{
BackgroundTokenRefreshContext: ctx,
},
authClient: &http.Client{
keyFlow := &KeyFlow{}
keyFlowConfig := &KeyFlowConfig{
BackgroundTokenRefreshContext: ctx,
AuthHTTPClient: &http.Client{
Transport: mockTransportFn{mockDo},
},
rt: mockTransportFn{mockDo},
token: &TokenResponseBody{
AccessToken: accessTokenFirst,
RefreshToken: refreshToken,
},
HTTPTransport: mockTransportFn{mockDo},
}
err = keyFlow.Init(keyFlowConfig)
if err != nil {
t.Fatalf("failed to initialize key flow: %v", err)
}

// Set the token after initialization
err = keyFlow.SetToken(accessTokenFirst, refreshToken)
if err != nil {
t.Fatalf("failed to set token: %v", err)
}

// TEST START
Expand Down
141 changes: 73 additions & 68 deletions core/clients/key_flow_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,25 +105,25 @@ func TestKeyFlowInit(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
c := &KeyFlow{}
cfg := &KeyFlowConfig{}
keyFlow := &KeyFlow{}
keyFlowConfig := &KeyFlowConfig{}
t.Setenv("STACKIT_SERVICE_ACCOUNT_KEY", "")
if tt.genPrivateKey {
privateKeyBytes, err := generatePrivateKey()
if err != nil {
t.Fatalf("Error generating private key: %s", err)
}
cfg.PrivateKey = string(privateKeyBytes)
keyFlowConfig.PrivateKey = string(privateKeyBytes)
}
if tt.invalidPrivateKey {
cfg.PrivateKey = "invalid_key"
keyFlowConfig.PrivateKey = "invalid_key"
}

cfg.ServiceAccountKey = tt.serviceAccountKey
if err := c.Init(cfg); (err != nil) != tt.wantErr {
keyFlowConfig.ServiceAccountKey = tt.serviceAccountKey
if err := keyFlow.Init(keyFlowConfig); (err != nil) != tt.wantErr {
t.Errorf("KeyFlow.Init() error = %v, wantErr %v", err, tt.wantErr)
}
if c.config == nil {
if keyFlow.config == nil {
t.Error("config is nil")
}
})
Expand Down Expand Up @@ -167,8 +167,8 @@ func TestSetToken(t *testing.T) {
}
}

c := &KeyFlow{}
err = c.SetToken(accessToken, tt.refreshToken)
keyFlow := &KeyFlow{}
err = keyFlow.SetToken(accessToken, tt.refreshToken)

if (err != nil) != tt.wantErr {
t.Errorf("KeyFlow.SetToken() error = %v, wantErr %v", err, tt.wantErr)
Expand All @@ -181,8 +181,8 @@ func TestSetToken(t *testing.T) {
Scope: defaultScope,
TokenType: defaultTokenType,
}
if !cmp.Equal(expectedKeyFlowToken, c.token) {
t.Errorf("The returned result is wrong. Expected %+v, got %+v", expectedKeyFlowToken, c.token)
if !cmp.Equal(expectedKeyFlowToken, keyFlow.token) {
t.Errorf("The returned result is wrong. Expected %+v, got %+v", expectedKeyFlowToken, keyFlow.token)
}
}
})
Expand Down Expand Up @@ -282,17 +282,21 @@ func TestRequestToken(t *testing.T) {

for _, tt := range testCases {
t.Run(tt.name, func(t *testing.T) {
c := &KeyFlow{
authClient: &http.Client{
keyFlow := &KeyFlow{}
keyFlowConfig := &KeyFlowConfig{
AuthHTTPClient: &http.Client{
Transport: mockTransportFn{func(_ *http.Request) (*http.Response, error) {
return tt.mockResponse, tt.mockError
}},
},
config: &KeyFlowConfig{},
rt: http.DefaultTransport,
HTTPTransport: http.DefaultTransport,
}
err := keyFlow.Init(keyFlowConfig)
if err != nil {
t.Fatalf("failed to initialize key flow: %v", err)
}

res, err := c.requestToken(tt.grant, tt.assertion)
res, err := keyFlow.requestToken(tt.grant, tt.assertion)
defer func() {
if res != nil {
tempErr := res.Body.Close()
Expand Down Expand Up @@ -324,14 +328,12 @@ func TestKeyFlow_Do(t *testing.T) {

tests := []struct {
name string
keyFlow *KeyFlow
handlerFn func(tb testing.TB) http.HandlerFunc
want int
wantErr bool
}{
{
name: "success",
keyFlow: &KeyFlow{rt: http.DefaultTransport, config: &KeyFlowConfig{}},
name: "success",
handlerFn: func(tb testing.TB) http.HandlerFunc {
tb.Helper()

Expand All @@ -349,8 +351,7 @@ func TestKeyFlow_Do(t *testing.T) {
wantErr: false,
},
{
name: "success with code 500",
keyFlow: &KeyFlow{rt: http.DefaultTransport, config: &KeyFlowConfig{}},
name: "success with code 500",
handlerFn: func(_ testing.TB) http.HandlerFunc {
return func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "text/html")
Expand All @@ -363,16 +364,6 @@ func TestKeyFlow_Do(t *testing.T) {
},
{
name: "success with custom transport",
keyFlow: &KeyFlow{
rt: mockTransportFn{
fn: func(req *http.Request) (*http.Response, error) {
req.Header.Set("User-Agent", "custom_transport")

return http.DefaultTransport.RoundTrip(req)
},
},
config: &KeyFlowConfig{},
},
handlerFn: func(tb testing.TB) http.HandlerFunc {
tb.Helper()

Expand All @@ -391,14 +382,6 @@ func TestKeyFlow_Do(t *testing.T) {
},
{
name: "fail with custom proxy",
keyFlow: &KeyFlow{
rt: &http.Transport{
Proxy: func(_ *http.Request) (*url.URL, error) {
return nil, fmt.Errorf("proxy error")
},
},
config: &KeyFlowConfig{},
},
handlerFn: func(testing.TB) http.HandlerFunc {
return func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
Expand All @@ -421,37 +404,59 @@ func TestKeyFlow_Do(t *testing.T) {
t.Errorf("no error is expected, but got %v", err)
}

tt.keyFlow.config.ServiceAccountKey = fixtureServiceAccountKey()
tt.keyFlow.config.PrivateKey = string(privateKeyBytes)
tt.keyFlow.config.BackgroundTokenRefreshContext = ctx
tt.keyFlow.authClient = &http.Client{
Transport: mockTransportFn{
fn: func(_ *http.Request) (*http.Response, error) {
res := httptest.NewRecorder()
res.WriteHeader(http.StatusOK)
res.Header().Set("Content-Type", "application/json")

token := &TokenResponseBody{
AccessToken: testBearerToken,
ExpiresIn: 2147483647,
RefreshToken: testBearerToken,
TokenType: "Bearer",
keyFlow := &KeyFlow{}
keyFlowConfig := &KeyFlowConfig{
ServiceAccountKey: fixtureServiceAccountKey(),
PrivateKey: string(privateKeyBytes),
BackgroundTokenRefreshContext: ctx,
HTTPTransport: func() http.RoundTripper {
switch tt.name {
case "success with custom transport":
return mockTransportFn{
fn: func(req *http.Request) (*http.Response, error) {
req.Header.Set("User-Agent", "custom_transport")
return http.DefaultTransport.RoundTrip(req)
},
}

if err := json.NewEncoder(res.Body).Encode(token); err != nil {
t.Logf("no error is expected, but got %v", err)
case "fail with custom proxy":
return &http.Transport{
Proxy: func(_ *http.Request) (*url.URL, error) {
return nil, fmt.Errorf("proxy error")
},
}

return res.Result(), nil
default:
return http.DefaultTransport
}
}(),
AuthHTTPClient: &http.Client{
Transport: mockTransportFn{
fn: func(_ *http.Request) (*http.Response, error) {
res := httptest.NewRecorder()
res.WriteHeader(http.StatusOK)
res.Header().Set("Content-Type", "application/json")

token := &TokenResponseBody{
AccessToken: testBearerToken,
ExpiresIn: 2147483647,
RefreshToken: testBearerToken,
TokenType: "Bearer",
}

if err := json.NewEncoder(res.Body).Encode(token); err != nil {
t.Logf("no error is expected, but got %v", err)
}

return res.Result(), nil
},
},
},
}

if err := tt.keyFlow.validate(); err != nil {
t.Errorf("no error is expected, but got %v", err)
err = keyFlow.Init(keyFlowConfig)
if err != nil {
t.Fatalf("failed to initialize key flow: %v", err)
}

go continuousRefreshToken(tt.keyFlow)
go continuousRefreshToken(keyFlow)

tokenCtx, tokenCancel := context.WithTimeout(context.Background(), 1*time.Second)

Expand All @@ -461,14 +466,14 @@ func TestKeyFlow_Do(t *testing.T) {
case <-tokenCtx.Done():
t.Error(tokenCtx.Err())
case <-time.After(50 * time.Millisecond):
tt.keyFlow.tokenMutex.RLock()
if tt.keyFlow.token != nil {
tt.keyFlow.tokenMutex.RUnlock()
keyFlow.tokenMutex.RLock()
if keyFlow.token != nil {
keyFlow.tokenMutex.RUnlock()
tokenCancel()
break token
}

tt.keyFlow.tokenMutex.RUnlock()
keyFlow.tokenMutex.RUnlock()
}
}

Expand All @@ -486,7 +491,7 @@ func TestKeyFlow_Do(t *testing.T) {
}

httpClient := &http.Client{
Transport: tt.keyFlow,
Transport: keyFlow,
}

res, err := httpClient.Do(req)
Expand Down
Loading