-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Features: - Add `MemoryStore` I submitted a pull request for MemoryStore to `oras-credentials-go` a week ago. However, the repository has since been deprecated. I've created an identical PR to [this one](oras-project/oras-credentials-go#92). Reference Issue: [Here](oras-project/oras-credentials-go#89) Signed-off-by: Uanid <[email protected]>
- Loading branch information
Showing
2 changed files
with
283 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* | ||
Copyright The ORAS Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package credentials | ||
|
||
import ( | ||
"context" | ||
"sync" | ||
|
||
"oras.land/oras-go/v2/registry/remote/auth" | ||
) | ||
|
||
// MemoryStore is a store that keeps credentials in memory. | ||
type MemoryStore struct { | ||
store sync.Map | ||
} | ||
|
||
// NewMemoryStore creates a new in-memory credentials store. | ||
func NewMemoryStore() *MemoryStore { | ||
return &MemoryStore{} | ||
} | ||
|
||
// Get retrieves credentials from the store for the given server address. | ||
func (ms *MemoryStore) Get(_ context.Context, serverAddress string) (auth.Credential, error) { | ||
cred, found := ms.store.Load(serverAddress) | ||
if !found { | ||
return auth.EmptyCredential, nil | ||
} | ||
return cred.(auth.Credential), nil | ||
} | ||
|
||
// Put saves credentials into the store for the given server address. | ||
func (ms *MemoryStore) Put(_ context.Context, serverAddress string, cred auth.Credential) error { | ||
ms.store.Store(serverAddress, cred) | ||
return nil | ||
} | ||
|
||
// Delete removes credentials from the store for the given server address. | ||
func (ms *MemoryStore) Delete(_ context.Context, serverAddress string) error { | ||
ms.store.Delete(serverAddress) | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,229 @@ | ||
/* | ||
Copyright The ORAS Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package credentials | ||
|
||
import ( | ||
"context" | ||
"reflect" | ||
"testing" | ||
|
||
"oras.land/oras-go/v2/registry/remote/auth" | ||
) | ||
|
||
func TestMemoryStore_Get_notExistRecord(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
serverAddress := "registry.example.com" | ||
got, err := ms.Get(ctx, serverAddress) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got, auth.EmptyCredential) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got, auth.EmptyCredential) | ||
} | ||
} | ||
|
||
func TestMemoryStore_Get_validRecord(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
serverAddress := "registry.example.com" | ||
want := auth.Credential{ | ||
Username: "username", | ||
Password: "password", | ||
RefreshToken: "identity_token", | ||
AccessToken: "registry_token", | ||
} | ||
ms.store.Store(serverAddress, want) | ||
|
||
got, err := ms.Get(ctx, serverAddress) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got, want) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got, want) | ||
} | ||
} | ||
|
||
func TestMemoryStore_Put_addNew(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
// Test Put | ||
server1 := "registry.example.com" | ||
cred1 := auth.Credential{ | ||
Username: "username", | ||
Password: "password", | ||
RefreshToken: "identity_token", | ||
AccessToken: "registry_token", | ||
} | ||
if err := ms.Put(ctx, server1, cred1); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
server2 := "registry2.example.com" | ||
cred2 := auth.Credential{ | ||
Username: "username2", | ||
Password: "password2", | ||
RefreshToken: "identity_token2", | ||
AccessToken: "registry_token2", | ||
} | ||
if err := ms.Put(ctx, server2, cred2); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
// Verify Content | ||
got1, err := ms.Get(ctx, server1) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got1, cred1) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got1, cred1) | ||
return | ||
} | ||
|
||
got2, err := ms.Get(ctx, server2) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got2, cred2) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got2, cred2) | ||
return | ||
} | ||
} | ||
|
||
func TestMemoryStore_Put_update(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
// Test Put | ||
serverAddress := "registry.example.com" | ||
cred1 := auth.Credential{ | ||
Username: "username", | ||
Password: "password", | ||
RefreshToken: "identity_token", | ||
AccessToken: "registry_token", | ||
} | ||
if err := ms.Put(ctx, serverAddress, cred1); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
cred2 := auth.Credential{ | ||
Username: "username2", | ||
Password: "password2", | ||
RefreshToken: "identity_token2", | ||
AccessToken: "registry_token2", | ||
} | ||
if err := ms.Put(ctx, serverAddress, cred2); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
got, err := ms.Get(ctx, serverAddress) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got, cred2) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got, cred2) | ||
return | ||
} | ||
} | ||
|
||
func TestMemoryStore_Delete_existRecord(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
// Test Put | ||
serverAddress := "registry.example.com" | ||
cred := auth.Credential{ | ||
Username: "username", | ||
Password: "password", | ||
RefreshToken: "identity_token", | ||
AccessToken: "registry_token", | ||
} | ||
if err := ms.Put(ctx, serverAddress, cred); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
// Test Get | ||
got, err := ms.Get(ctx, serverAddress) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got, cred) { | ||
t.Errorf("MemoryStore.Get(%s) = %v, want %v", serverAddress, got, cred) | ||
return | ||
} | ||
|
||
// Test Delete | ||
if err := ms.Delete(ctx, serverAddress); err != nil { | ||
t.Errorf("MemoryStore.Delete() error = %v", err) | ||
return | ||
} | ||
|
||
// Test Get again | ||
got, err = ms.Get(ctx, serverAddress) | ||
if err != nil { | ||
t.Errorf("MemoryStore.Get() error = %v", err) | ||
return | ||
} | ||
if !reflect.DeepEqual(got, auth.EmptyCredential) { | ||
t.Errorf("MemoryStore.Get() = %v, want %v", got, auth.EmptyCredential) | ||
return | ||
} | ||
} | ||
|
||
func TestMemoryStore_Delete_notExistRecord(t *testing.T) { | ||
ctx := context.Background() | ||
ms := NewMemoryStore() | ||
|
||
// Test Put | ||
serverAddress := "registry.example.com" | ||
cred := auth.Credential{ | ||
Username: "username", | ||
Password: "password", | ||
RefreshToken: "identity_token", | ||
AccessToken: "registry_token", | ||
} | ||
if err := ms.Put(ctx, serverAddress, cred); err != nil { | ||
t.Errorf("MemoryStore.Put() error = %v", err) | ||
return | ||
} | ||
|
||
// Test Delete | ||
if err := ms.Delete(ctx, serverAddress); err != nil { | ||
t.Errorf("MemoryStore.Delete() error = %v", err) | ||
return | ||
} | ||
|
||
// Test Delete again | ||
// Expect no error if target record does not exist | ||
if err := ms.Delete(ctx, serverAddress); err != nil { | ||
t.Errorf("MemoryStore.Delete() error = %v", err) | ||
return | ||
} | ||
} |