Add PathElemsMatchQuery helper for checking path membership to a telemetry path #467
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,131 @@ | ||
| // Copyright 2020 Google Inc. | ||
| // | ||
| // 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 util | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| gnmipb "github.com/openconfig/gnmi/proto/gnmi" | ||
| ) | ||
|
|
||
| // stringToStructuredPath takes a string representing a path, and converts it to | ||
| // a gnmi.Path, using the PathElem element message that is defined in gNMI 0.4.0. | ||
| // XXX: This is copied code from ygot package. ygot's code should probably | ||
|
There was a problem hiding this comment. Same comment here about making the change to avoid code duplication. |
||
| // live in this package instead. | ||
| func stringToStructuredPath(path string) (*gnmipb.Path, error) { | ||
| parts := PathStringToElements(path) | ||
|
|
||
| gpath := &gnmipb.Path{} | ||
| for _, p := range parts { | ||
| name, kv, err := extractKV(p) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error parsing path %s: %v", path, err) | ||
| } | ||
| gpath.Elem = append(gpath.Elem, &gnmipb.PathElem{ | ||
| Name: name, | ||
| Key: kv, | ||
| }) | ||
| } | ||
| return gpath, nil | ||
| } | ||
|
|
||
| // extractKV extracts key value predicates from the input string in. It returns | ||
| // the name of the element, a map keyed by key name with values of the predicates | ||
| // specified. It removes escape characters from keys and values where they are | ||
| // specified. | ||
| // XXX: This is copied code from ygot package. ygot's code should probably | ||
|
There was a problem hiding this comment. Same as above - please don't duplicate code. |
||
| // live in this package instead. | ||
| func extractKV(in string) (string, map[string]string, error) { | ||
| var inEscape, inKey, inValue bool | ||
| var name, currentKey string | ||
| var buf bytes.Buffer | ||
| keys := map[string]string{} | ||
|
|
||
| for _, ch := range in { | ||
| switch { | ||
| case ch == '[' && !inEscape && !inValue && inKey: | ||
| return "", nil, fmt.Errorf("received an unescaped [ in key of element %s", name) | ||
| case ch == '[' && !inEscape && !inKey: | ||
| inKey = true | ||
| if len(keys) == 0 { | ||
| if buf.Len() == 0 { | ||
| return "", nil, errors.New("received a value when the element name was null") | ||
| } | ||
| name = buf.String() | ||
| buf.Reset() | ||
| } | ||
| continue | ||
| case ch == ']' && !inEscape && !inKey: | ||
| return "", nil, fmt.Errorf("received an unescaped ] when not in a key for element %s", buf.String()) | ||
| case ch == ']' && !inEscape: | ||
| inKey = false | ||
| inValue = false | ||
| if err := addKey(keys, name, currentKey, buf.String()); err != nil { | ||
| return "", nil, err | ||
| } | ||
| buf.Reset() | ||
| currentKey = "" | ||
| continue | ||
| case ch == '\\' && !inEscape: | ||
| inEscape = true | ||
| continue | ||
| case ch == '=' && inKey && !inEscape && !inValue: | ||
| currentKey = buf.String() | ||
| buf.Reset() | ||
| inValue = true | ||
| continue | ||
| } | ||
|
|
||
| buf.WriteRune(ch) | ||
| inEscape = false | ||
| } | ||
|
|
||
| if len(keys) == 0 { | ||
| name = buf.String() | ||
| } | ||
|
|
||
| if len(keys) != 0 && buf.Len() != 0 { | ||
| // In this case, we have trailing garbage following the key. | ||
| return "", nil, fmt.Errorf("trailing garbage following keys in element %s, got: %v", name, buf.String()) | ||
| } | ||
|
|
||
| if strings.Contains(name, " ") { | ||
| return "", nil, fmt.Errorf("invalid space character included in element name '%s'", name) | ||
| } | ||
|
|
||
| return name, keys, nil | ||
| } | ||
|
|
||
| // addKey adds key k with value v to the key's map. The key, value pair is specified | ||
| // to be for an element named e. | ||
| // XXX: This is copied code from ygot package. ygot's code should probably | ||
| // live in this package instead. | ||
| func addKey(keys map[string]string, e, k, v string) error { | ||
| switch { | ||
| case strings.Contains(k, " "): | ||
| return fmt.Errorf("received an invalid space in element %s key name '%s'", e, k) | ||
| case e == "": | ||
| return fmt.Errorf("received null element value with key and value %s=%s", k, v) | ||
| case k == "": | ||
| return fmt.Errorf("received null key name for element %s", e) | ||
| case v == "": | ||
| return fmt.Errorf("received null value for key %s of element %s", k, e) | ||
| } | ||
| keys[k] = v | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you clarify
concretehere? I think that you're trying to say if the given query element matches the reference element -- but theno wildcarddisclaimer is throwing me off, because it seems like wildcards are handled?