forked from notaryproject/notation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update to add cache error test case
Signed-off-by: Junjie Gao <[email protected]>
- Loading branch information
Showing
11 changed files
with
265 additions
and
12 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,80 @@ | ||
| // Copyright The Notary Project 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 crl | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "sync" | ||
|
|
||
| corecrl "github.com/notaryproject/notation-core-go/revocation/crl" | ||
| "github.com/notaryproject/notation-go/log" | ||
| ) | ||
|
|
||
| // CacheWithLog implements corecrl.Cache with logging | ||
| type CacheWithLog struct { | ||
| corecrl.Cache | ||
|
|
||
| //DiscardCacheError is set to true to enable logging the discard cache error | ||
| //warning | ||
| DiscardCacheError bool | ||
|
|
||
| // logDiscardCrlCacheErrorOnce guarantees the discard cache error | ||
| // warning is logged only once | ||
| logDiscardCrlCacheErrorOnce sync.Once | ||
| } | ||
|
|
||
| // Get retrieves the CRL bundle with the given url | ||
| func (c *CacheWithLog) Get(ctx context.Context, url string) (*corecrl.Bundle, error) { | ||
| if c.Cache == nil { | ||
| return nil, errors.New("cache cannot be nil") | ||
| } | ||
| logger := log.GetLogger(ctx) | ||
|
|
||
| bundle, err := c.Cache.Get(ctx, url) | ||
| if err != nil && !errors.Is(err, corecrl.ErrCacheMiss) { | ||
| if c.DiscardCacheError { | ||
| c.logDiscardCrlCacheErrorOnce.Do(c.logDiscardCrlCacheError) | ||
| } | ||
| logger.Debug(err.Error()) | ||
| return nil, err | ||
| } | ||
| return bundle, err | ||
| } | ||
|
|
||
| // Set stores the CRL bundle with the given url | ||
| func (c *CacheWithLog) Set(ctx context.Context, url string, bundle *corecrl.Bundle) error { | ||
| if c.Cache == nil { | ||
| return errors.New("cache cannot be nil") | ||
| } | ||
| logger := log.GetLogger(ctx) | ||
|
|
||
| err := c.Cache.Set(ctx, url, bundle) | ||
| if err != nil { | ||
| if c.DiscardCacheError { | ||
| c.logDiscardCrlCacheErrorOnce.Do(c.logDiscardCrlCacheError) | ||
| } | ||
| logger.Debug(err.Error()) | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // logDiscardCrlCacheError logs the warning when CRL cache error is | ||
| // discarded | ||
| func (c *CacheWithLog) logDiscardCrlCacheError() { | ||
| fmt.Fprintln(os.Stderr, "Warning: CRL cache error discarded. Enable debug log through '-d' for error details.") | ||
| } |
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,135 @@ | ||
| // Copyright The Notary Project 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 crl | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "os" | ||
| "sync" | ||
| "testing" | ||
|
|
||
| corecrl "github.com/notaryproject/notation-core-go/revocation/crl" | ||
| ) | ||
|
|
||
| func TestGet(t *testing.T) { | ||
| cache := &CacheWithLog{} | ||
| expectedErrMsg := "cache cannot be nil" | ||
| _, err := cache.Get(context.Background(), "") | ||
| if err == nil || err.Error() != expectedErrMsg { | ||
| t.Fatalf("expected error %q, but got %q", expectedErrMsg, err) | ||
| } | ||
|
|
||
| cache = &CacheWithLog{ | ||
| Cache: &dummyCache{}, | ||
| } | ||
| expectedErrMsg = "cache get failed" | ||
| _, err = cache.Get(context.Background(), "") | ||
| if err == nil || err.Error() != expectedErrMsg { | ||
| t.Fatalf("expected error %q, but got %q", expectedErrMsg, err) | ||
| } | ||
|
|
||
| cache = &CacheWithLog{ | ||
| Cache: &dummyCache{ | ||
| cacheMiss: true, | ||
| }, | ||
| } | ||
| _, err = cache.Get(context.Background(), "") | ||
| if err == nil || !errors.Is(err, corecrl.ErrCacheMiss) { | ||
| t.Fatalf("expected error %q, but got %q", corecrl.ErrCacheMiss, err) | ||
| } | ||
| } | ||
|
|
||
| func TestSet(t *testing.T) { | ||
| cache := &CacheWithLog{} | ||
| expectedErrMsg := "cache cannot be nil" | ||
| err := cache.Set(context.Background(), "", nil) | ||
| if err == nil || err.Error() != expectedErrMsg { | ||
| t.Fatalf("expected error %q, but got %q", expectedErrMsg, err) | ||
| } | ||
|
|
||
| cache = &CacheWithLog{ | ||
| Cache: &dummyCache{}, | ||
| } | ||
| expectedErrMsg = "cache set failed" | ||
| err = cache.Set(context.Background(), "", nil) | ||
| if err == nil || err.Error() != expectedErrMsg { | ||
| t.Fatalf("expected error %q, but got %q", expectedErrMsg, err) | ||
| } | ||
|
|
||
| cache = &CacheWithLog{ | ||
| Cache: &dummyCache{ | ||
| setSuccess: true, | ||
| }, | ||
| } | ||
| err = cache.Set(context.Background(), "", nil) | ||
| if err != nil { | ||
| t.Fatalf("expected nil error, but got %q", err) | ||
| } | ||
| } | ||
|
|
||
| func TestLogDiscardErrorOnce(t *testing.T) { | ||
| cache := &CacheWithLog{ | ||
| Cache: &dummyCache{}, | ||
| DiscardCacheError: true, | ||
| } | ||
| oldStderr := os.Stderr | ||
| defer func() { | ||
| os.Stderr = oldStderr | ||
| }() | ||
| testFile, err := os.CreateTemp(t.TempDir(), "testNotation") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer testFile.Close() | ||
| os.Stderr = testFile | ||
| var wg sync.WaitGroup | ||
| for i := 0; i < 3; i++ { | ||
| wg.Add(1) | ||
| go func() { | ||
| defer wg.Done() | ||
| cache.Get(context.Background(), "") | ||
| cache.Set(context.Background(), "", nil) | ||
| }() | ||
| } | ||
| wg.Wait() | ||
|
|
||
| b, err := os.ReadFile(testFile.Name()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| expectedMsg := "Warning: CRL cache error discarded. Enable debug log through '-d' for error details.\n" | ||
| if string(b) != expectedMsg { | ||
| t.Fatalf("expected to get %q, but got %q", expectedMsg, string(b)) | ||
| } | ||
| } | ||
|
|
||
| type dummyCache struct { | ||
| cacheMiss bool | ||
| setSuccess bool | ||
| } | ||
|
|
||
| func (d *dummyCache) Get(ctx context.Context, url string) (*corecrl.Bundle, error) { | ||
| if d.cacheMiss { | ||
| return nil, corecrl.ErrCacheMiss | ||
| } | ||
| return nil, errors.New("cache get failed") | ||
| } | ||
|
|
||
| func (d *dummyCache) Set(ctx context.Context, url string, bundle *corecrl.Bundle) error { | ||
| if d.setSuccess { | ||
| return nil | ||
| } | ||
| return errors.New("cache set failed") | ||
| } |
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