-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move index storage into interface (#1741)
* move index storage into interface Signed-off-by: Bob Callaway <[email protected]> * fix nits, add unit tests Signed-off-by: Bob Callaway <[email protected]> --------- Signed-off-by: Bob Callaway <[email protected]>
- Loading branch information
1 parent
bcd004b
commit 7fa3cd5
Showing
8 changed files
with
229 additions
and
21 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
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
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
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
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
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,38 @@ | ||
| // Copyright 2023 The Sigstore 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 indexstorage | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/sigstore/rekor/pkg/indexstorage/redis" | ||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| type IndexStorage interface { | ||
| LookupIndices(context.Context, string) ([]string, error) // Returns indices for specified key | ||
| WriteIndex(context.Context, string, string) error // Writes index for specified key | ||
| } | ||
|
|
||
| // NewIndexStorage instantiates a new IndexStorage provider based on the requested type | ||
| func NewIndexStorage(providerType string) (IndexStorage, error) { | ||
| switch providerType { | ||
| case redis.ProviderType: | ||
| return redis.NewProvider(viper.GetString("redis_server.address"), viper.GetString("redis_server.port")) | ||
| default: | ||
| return nil, fmt.Errorf("invalid index storage provider type: %v", providerType) | ||
| } | ||
| } |
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,62 @@ | ||
| // Copyright 2023 The Sigstore 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 redis | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| redis "github.com/redis/go-redis/v9" | ||
| ) | ||
|
|
||
| const ProviderType = "redis" | ||
|
|
||
| // IndexStorageProvider implements indexstorage.IndexStorage | ||
| type IndexStorageProvider struct { | ||
| client *redis.Client | ||
| } | ||
|
|
||
| func NewProvider(address, port string) (*IndexStorageProvider, error) { | ||
| provider := &IndexStorageProvider{} | ||
| provider.client = redis.NewClient(&redis.Options{ | ||
| Addr: fmt.Sprintf("%v:%v", address, port), | ||
| Network: "tcp", | ||
| DB: 0, // default DB | ||
| }) | ||
| return provider, nil | ||
| } | ||
|
|
||
| // LookupIndices looks up and returns all indices for the specified key. The key value will be canonicalized | ||
| // by converting all characters into a lowercase value before looking up in Redis | ||
| func (isp *IndexStorageProvider) LookupIndices(ctx context.Context, key string) ([]string, error) { | ||
| if isp.client == nil { | ||
| return []string{}, errors.New("redis client has not been initialized") | ||
| } | ||
| return isp.client.LRange(ctx, strings.ToLower(key), 0, -1).Result() | ||
| } | ||
|
|
||
| // WriteIndex adds the index for the specified key. The key value will be canonicalized | ||
| // by converting all characters into a lowercase value before appending the index in Redis | ||
| func (isp *IndexStorageProvider) WriteIndex(ctx context.Context, key, index string) error { | ||
| if isp.client == nil { | ||
| return errors.New("redis client has not been initialized") | ||
| } | ||
| if _, err := isp.client.LPush(ctx, strings.ToLower(key), index).Result(); err != nil { | ||
| return fmt.Errorf("redis client: %w", err) | ||
| } | ||
| 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,100 @@ | ||
| // Copyright 2023 The Sigstore 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 redis | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/go-redis/redismock/v9" | ||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| "go.uber.org/goleak" | ||
| ) | ||
|
|
||
| func TestLookupIndices(t *testing.T) { | ||
| key := "87c1b129fbadd7b6e9abc0a9ef7695436d767aece042bec198a97e949fcbe14c" | ||
| value := []string{"1e1f2c881ae0608ec77ebf88a75c66d3099113a7343238f2f7a0ebb91a4ed335"} | ||
| redisClient, mock := redismock.NewClientMock() | ||
| mock.Regexp().ExpectLRange(key, 0, -1).SetVal(value) | ||
|
|
||
| isp := IndexStorageProvider{redisClient} | ||
|
|
||
| indices, err := isp.LookupIndices(context.Background(), key) | ||
| if err != nil { | ||
| t.Error(err) | ||
| } | ||
|
|
||
| less := func(a, b string) bool { return a < b } | ||
| if cmp.Diff(value, indices, cmpopts.SortSlices(less)) != "" { | ||
| t.Errorf("expected %s, got %s", value, indices) | ||
| } | ||
|
|
||
| if err := mock.ExpectationsWereMet(); err != nil { | ||
| t.Error(err) | ||
| } | ||
|
|
||
| mock.ClearExpect() | ||
| errRedis := errors.New("redis error") | ||
| mock.Regexp().ExpectLRange(key, 0, -1).SetErr(errRedis) | ||
| if _, err := isp.LookupIndices(context.Background(), key); err == nil { | ||
| t.Error("unexpected success") | ||
| } | ||
| if err := mock.ExpectationsWereMet(); err != nil { | ||
| t.Error(err) | ||
| } | ||
| } | ||
|
|
||
| func TestWriteIndex(t *testing.T) { | ||
| key := "87c1b129fbadd7b6e9abc0a9ef7695436d767aece042bec198a97e949fcbe14c" | ||
| value := []string{"1e1f2c881ae0608ec77ebf88a75c66d3099113a7343238f2f7a0ebb91a4ed335"} | ||
| redisClient, mock := redismock.NewClientMock() | ||
| mock.Regexp().ExpectLPush(key, value).SetVal(1) | ||
|
|
||
| isp := IndexStorageProvider{redisClient} | ||
| if err := isp.WriteIndex(context.Background(), key, value[0]); err != nil { | ||
| t.Error(err) | ||
| } | ||
|
|
||
| if err := mock.ExpectationsWereMet(); err != nil { | ||
| t.Error(err) | ||
| } | ||
|
|
||
| mock.ClearExpect() | ||
| errRedis := errors.New("redis error") | ||
| mock.Regexp().ExpectLPush(key, value).SetErr(errRedis) | ||
| if err := isp.WriteIndex(context.Background(), key, value[0]); err == nil { | ||
| t.Error("unexpected success") | ||
| } | ||
| if err := mock.ExpectationsWereMet(); err != nil { | ||
| t.Error(err) | ||
| } | ||
| } | ||
|
|
||
| func TestUninitializedClient(t *testing.T) { | ||
| // this is not initialized with a real Redis client | ||
| isp := IndexStorageProvider{} | ||
| if _, err := isp.LookupIndices(context.Background(), "key"); err == nil { | ||
| t.Error("unexpected success") | ||
| } | ||
| if err := isp.WriteIndex(context.Background(), "key", "value"); err == nil { | ||
| t.Error("unexpected success") | ||
| } | ||
| } | ||
|
|
||
| func TestMain(m *testing.M) { | ||
| goleak.VerifyTestMain(m) | ||
| } |