forked from sonic-net/sonic-buildimage
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CVL database access layer changes (sonic-net#100)
* cvl database access layer changes * cvl database access layer changes to fix test code * cvl database access layer changes to fix benchmark test code * cvl database access layer changes to fix CvlEditConfigData test cases * cvl database access layer - removed the cvl_db_test.go, will be added it after integerating the changes
- Loading branch information
1 parent
ee3029d
commit 14962fe
Showing
5 changed files
with
760 additions
and
62 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,57 @@ | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
| // // | ||
| // Copyright 2022 Broadcom. The term Broadcom refers to Broadcom Inc. and/or // | ||
| // its subsidiaries. // | ||
| // // | ||
| // 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 common | ||
|
|
||
| import ( | ||
| "github.com/antchfx/xmlquery" | ||
| ) | ||
|
|
||
| // CVLEditConfigData Strcture for key and data in API | ||
| type CVLEditConfigData struct { | ||
| VType CVLValidateType //Validation type | ||
| VOp CVLOperation //Operation type | ||
| Key string //Key format : "PORT|Ethernet4" | ||
| Data map[string]string //Value : {"alias": "40GE0/28", "mtu" : 9100, "admin_status": down} | ||
| ReplaceOp bool | ||
| } | ||
|
|
||
| type CVLValidateType uint | ||
|
|
||
| const ( | ||
| VALIDATE_NONE CVLValidateType = iota //Data is used as dependent data | ||
| VALIDATE_SYNTAX //Syntax is checked and data is used as dependent data | ||
| VALIDATE_SEMANTICS //Semantics is checked | ||
| VALIDATE_ALL //Syntax and Semantics are checked | ||
| ) | ||
|
|
||
| type CVLOperation uint | ||
|
|
||
| const ( | ||
| OP_NONE CVLOperation = 0 //Used to just validate the config without any operation | ||
| OP_CREATE = 1 << 0 //For Create operation | ||
| OP_UPDATE = 1 << 1 //For Update operation | ||
| OP_DELETE = 1 << 2 //For Delete operation | ||
| ) | ||
|
|
||
| // RequestCacheType Struct for request data and YANG data | ||
| type RequestCacheType struct { | ||
| ReqData CVLEditConfigData | ||
| YangData *xmlquery.Node | ||
| } |
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,92 @@ | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
| // // | ||
| // Copyright 2023 Broadcom. The term Broadcom refers to Broadcom Inc. and/or // | ||
| // its subsidiaries. // | ||
| // // | ||
| // 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 common | ||
|
|
||
| // DBAccess is used by cvl and custom validation functions to access the ConfigDB. | ||
| // This allows cvl clients to plugin additional data source, like transaction cache, | ||
| // into cvl. Most of the interface methods mimic the go-redis APIs. It also defines | ||
| // Lookup and Count methods to perform advanced search by matching hash field values. | ||
| type DBAccess interface { | ||
| Exists(key string) IntResult | ||
| Keys(pattern string) StrSliceResult | ||
| HGet(key, field string) StrResult | ||
| HMGet(key string, fields ...string) SliceResult | ||
| HGetAll(key string) StrMapResult | ||
| Pipeline() PipeResult | ||
|
|
||
| // Lookup entries using a Search criteria and return them in sonic db json format. | ||
| // E.g, {"INTERFACE": {"Ethernet0": {"vrf", "Vrf1"}, "Ethernet0|1.2.3.4": {"NULL": "NULL"}}} | ||
| // TODO fix the return value for not found case | ||
| Lookup(s Search) JsonResult | ||
| // Count entries using a Search criteria. Returns 0 if there are no matches. | ||
| Count(s Search) IntResult | ||
| } | ||
|
|
||
| type IntResult interface { | ||
| Result() (int64, error) | ||
| } | ||
|
|
||
| type StrResult interface { | ||
| Result() (string, error) | ||
| } | ||
|
|
||
| type StrSliceResult interface { | ||
| Result() ([]string, error) | ||
| } | ||
|
|
||
| type SliceResult interface { | ||
| Result() ([]interface{}, error) | ||
| } | ||
|
|
||
| type StrMapResult interface { | ||
| Result() (map[string]string, error) | ||
| } | ||
|
|
||
| type JsonResult interface { | ||
| Result() (string, error) //TODO have it as map instead of string | ||
| } | ||
|
|
||
| type PipeResult interface { | ||
| Keys(pattern string) StrSliceResult | ||
| HGet(key, field string) StrResult | ||
| HMGet(key string, fields ...string) SliceResult | ||
| HGetAll(key string) StrMapResult | ||
| Exec() error | ||
| Close() | ||
| } | ||
|
|
||
| // Search criteria for advanced lookup. Initial filtering is done by matching the key Pattern. | ||
| // Results are further refined by applying Predicate, WithField and Limit constraints (optional) | ||
| type Search struct { | ||
| // Pattern to match the keys from a redis table. Must contain a table name prefix. | ||
| // E.g, `INTERFACE|Ethernet0` `INTERFACE|*` "INTERFACE|*|*" | ||
| Pattern string | ||
| // Predicate is a lua condition statement to inspect an entry's key and hash attributes. | ||
| // It can use map variables 'k' and 'h' to access key & hash attributes. | ||
| // E.g, `k['type'] == 'L3' and h['enabled'] == true` | ||
| Predicate string | ||
| // KeyNames must contain the key component names in order. Required only if Predicate uses 'k'. | ||
| // E.g, if ["name","type"], a key "ACL|TEST|L3" will expand to lua map {name="TEST", type="L3"} | ||
| KeyNames []string | ||
| // WithField selects a entry only if it contains this hash field | ||
| WithField string | ||
| // Limit the results to maximum these number of entries | ||
| Limit int | ||
| } |
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
Oops, something went wrong.