-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move BucketCacheKey to a new package
Signed-off-by: akanshat <[email protected]>
- Loading branch information
Showing
5 changed files
with
253 additions
and
279 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package cachekey | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrInvalidBucketCacheKeyFormat = errors.New("key has invalid format") | ||
| ErrInvalidBucketCacheKeyVerb = errors.New("key has invalid verb") | ||
| ErrParseKeyInt = errors.New("failed to parse integer in key") | ||
| ) | ||
|
|
||
| // VerbType is the type of operation whose result has been stored in the caching bucket's cache. | ||
| type VerbType string | ||
|
|
||
| const ( | ||
| ExistsVerb VerbType = "exists" | ||
| ContentVerb VerbType = "content" | ||
| IterVerb VerbType = "iter" | ||
| AttributesVerb VerbType = "attrs" | ||
| SubrangeVerb VerbType = "subrange" | ||
| ) | ||
|
|
||
| type BucketCacheKey struct { | ||
| Verb VerbType | ||
| Name string | ||
| Start int64 | ||
| End int64 | ||
| } | ||
|
|
||
| // String returns the string representation of BucketCacheKey. | ||
| func (ck BucketCacheKey) String() string { | ||
| if ck.Start == 0 && ck.End == 0 { | ||
| return fmt.Sprintf("%s:%s", ck.Verb, ck.Name) | ||
| } | ||
|
|
||
| return fmt.Sprintf("%s:%s:%d:%d", ck.Verb, ck.Name, ck.Start, ck.End) | ||
| } | ||
|
|
||
| // IsValidVerb checks if the VerbType matches the predefined verbs. | ||
| func IsValidVerb(v VerbType) bool { | ||
| switch v { | ||
| case | ||
| ExistsVerb, | ||
| ContentVerb, | ||
| IterVerb, | ||
| AttributesVerb, | ||
| SubrangeVerb: | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // ParseBucketCacheKey parses a string and returns BucketCacheKey. | ||
| func ParseBucketCacheKey(key string) (BucketCacheKey, error) { | ||
| ck := BucketCacheKey{} | ||
| slice := strings.Split(key, ":") | ||
| if len(slice) < 2 { | ||
| return ck, ErrInvalidBucketCacheKeyFormat | ||
| } | ||
|
|
||
| verb := VerbType(slice[0]) | ||
| if !IsValidVerb(verb) { | ||
| return BucketCacheKey{}, ErrInvalidBucketCacheKeyVerb | ||
| } | ||
|
|
||
| if verb == SubrangeVerb { | ||
| if len(slice) != 4 { | ||
| return BucketCacheKey{}, ErrInvalidBucketCacheKeyFormat | ||
| } | ||
|
|
||
| start, err := strconv.ParseInt(slice[2], 10, 64) | ||
| if err != nil { | ||
| return BucketCacheKey{}, ErrParseKeyInt | ||
| } | ||
|
|
||
| end, err := strconv.ParseInt(slice[3], 10, 64) | ||
| if err != nil { | ||
| return BucketCacheKey{}, ErrParseKeyInt | ||
| } | ||
|
|
||
| ck.Start = start | ||
| ck.End = end | ||
| } else { | ||
| if len(slice) != 2 { | ||
| return BucketCacheKey{}, ErrInvalidBucketCacheKeyFormat | ||
| } | ||
| } | ||
|
|
||
| ck.Verb = verb | ||
| ck.Name = slice[1] | ||
| return ck, 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,120 @@ | ||
| package cachekey | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/thanos-io/thanos/pkg/testutil" | ||
| ) | ||
|
|
||
| func TestParseBucketCacheKey(t *testing.T) { | ||
| testcases := []struct { | ||
| key string | ||
| expected BucketCacheKey | ||
| expectedErr error | ||
| }{ | ||
| { | ||
| key: "exists:name", | ||
| expected: BucketCacheKey{ | ||
| Verb: ExistsVerb, | ||
| Name: "name", | ||
| Start: 0, | ||
| End: 0, | ||
| }, | ||
| expectedErr: nil, | ||
| }, | ||
| { | ||
| key: "content:name", | ||
| expected: BucketCacheKey{ | ||
| Verb: ContentVerb, | ||
| Name: "name", | ||
| Start: 0, | ||
| End: 0, | ||
| }, | ||
| expectedErr: nil, | ||
| }, | ||
| { | ||
| key: "iter:name", | ||
| expected: BucketCacheKey{ | ||
| Verb: IterVerb, | ||
| Name: "name", | ||
| Start: 0, | ||
| End: 0, | ||
| }, | ||
| expectedErr: nil, | ||
| }, | ||
| { | ||
| key: "attrs:name", | ||
| expected: BucketCacheKey{ | ||
| Verb: AttributesVerb, | ||
| Name: "name", | ||
| Start: 0, | ||
| End: 0, | ||
| }, | ||
| expectedErr: nil, | ||
| }, | ||
| { | ||
| key: "subrange:name:10:20", | ||
| expected: BucketCacheKey{ | ||
| Verb: SubrangeVerb, | ||
| Name: "name", | ||
| Start: 10, | ||
| End: 20, | ||
| }, | ||
| expectedErr: nil, | ||
| }, | ||
| // Any VerbType other than SubrangeVerb should not have a "start" and "end". | ||
| { | ||
| key: "iter:name:10:20", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyFormat, | ||
| }, | ||
| // Key must always have a name. | ||
| { | ||
| key: "iter", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyFormat, | ||
| }, | ||
| // Invalid VerbType should return an error. | ||
| { | ||
| key: "random:name", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyVerb, | ||
| }, | ||
| // Start must be an integer. | ||
| { | ||
| key: "subrange:name:random:10", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrParseKeyInt, | ||
| }, | ||
| // End must be an integer. | ||
| { | ||
| key: "subrange:name:10:random", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrParseKeyInt, | ||
| }, | ||
| // SubrangeVerb must have start and end. | ||
| { | ||
| key: "subrange:name", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyFormat, | ||
| }, | ||
| // SubrangeVerb must have start and end both. | ||
| { | ||
| key: "subrange:name:10", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyFormat, | ||
| }, | ||
| // Key must not be an empty string. | ||
| { | ||
| key: "", | ||
| expected: BucketCacheKey{}, | ||
| expectedErr: ErrInvalidBucketCacheKeyFormat, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testcases { | ||
| res, err := ParseBucketCacheKey(tc.key) | ||
| testutil.Equals(t, tc.expectedErr, err) | ||
| testutil.Equals(t, tc.expected, res) | ||
| } | ||
| } |
Oops, something went wrong.