VOL-3121 - Separated out LogicalDevices' low-level flow/meter/group handling into separate packages.
The new implementation hides the compexity of locking, caching, and interacting with the db.
An attempt was made to ensure that locks are held while updates are made, by returning a "handle" object from each flow/group/meter lock() call, and only allowing access through this call.
An attempt was also made to remove proto.Clone-ing. flows/groups/meters which are returned are NOT cloned, and MUST NOT be modified by users of the flow/group/meter loaders. In addition, flows/groups/meters which are given to the loaders MUST NOT be modified afterward.
There remain many cases where errors during particular kv updates may cause inconsistent state. TODOs have been added for many of these cases. Resolving this may require exposing (through voltha-lib-go) the transaction mechanism from etcd.
There is also the issue that locking a flow/meter/group while another flow/meter/group is held could cause deadlocks. This can be avoided by acquiring locks in a consistent order. Something to keep in mind while fixing the previous issue.
Change-Id: I146eb319c3564635fdc461ec17be13e6f3968cf7
diff --git a/rw_core/core/device/flow/loader_test.go b/rw_core/core/device/flow/loader_test.go
new file mode 100644
index 0000000..b739272
--- /dev/null
+++ b/rw_core/core/device/flow/loader_test.go
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+
+ * 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 flow
+
+import (
+ "bufio"
+ "fmt"
+ "os"
+ "regexp"
+ "strconv"
+ "strings"
+ "testing"
+)
+
+// TestLoadersIdentical ensures that the group, flow, and meter loaders always have an identical implementation.
+func TestLoadersIdentical(t *testing.T) {
+ identical := [][]string{
+ {"ofp\\.OfpFlowStats", "ofp\\.OfpGroupEntry", "ofp\\.OfpMeterEntry"},
+ {"\\.Id", "\\.Desc\\.GroupId", "\\.Config.MeterId"},
+ {"uint64", "uint32", "uint32"},
+ {"Flow", "Group", "Meter"},
+ {"flow", "group", "meter"},
+ }
+
+ regexes := make([]*regexp.Regexp, len(identical))
+ for i, group := range identical {
+ regexes[i] = regexp.MustCompile(strings.Join(group, "|"))
+ }
+
+ for i := 1; i < len(identical[0]); i++ {
+ if err := compare(regexes, "../"+identical[4][0]+"/loader.go", "../"+identical[4][i]+"/loader.go"); err != nil {
+ t.Error(err)
+ return
+ }
+ }
+}
+
+func compare(regexes []*regexp.Regexp, fileNameA, fileNameB string) error {
+ fileA, err := os.Open(fileNameA)
+ if err != nil {
+ return err
+ }
+ defer fileA.Close()
+
+ fileB, err := os.Open(fileNameB)
+ if err != nil {
+ return err
+ }
+ defer fileB.Close()
+
+ scannerA, scannerB := bufio.NewScanner(fileA), bufio.NewScanner(fileB)
+
+ spaceRegex := regexp.MustCompile(" +")
+
+ line := 1
+ for {
+ if continueA, continueB := scannerA.Scan(), scannerB.Scan(); continueA != continueB {
+ if !continueA && continueB {
+ if err := scannerA.Err(); err != nil {
+ return err
+ }
+ }
+ if continueA && !continueB {
+ if err := scannerB.Err(); err != nil {
+ return err
+ }
+ }
+ return fmt.Errorf("line %d: files are not the same length", line)
+ } else if !continueA {
+ // EOF from both files
+ break
+ }
+
+ textA, textB := scannerA.Text(), scannerB.Text()
+
+ replacedA, replacedB := textA, textB
+ for i, regex := range regexes {
+ replacement := "{{type" + strconv.Itoa(i) + "}}"
+ replacedA, replacedB = regex.ReplaceAllString(replacedA, replacement), regex.ReplaceAllString(replacedB, replacement)
+ }
+
+ // replace multiple spaces with single space
+ replacedA, replacedB = spaceRegex.ReplaceAllString(replacedA, " "), spaceRegex.ReplaceAllString(replacedB, " ")
+
+ if replacedA != replacedB {
+ return fmt.Errorf("line %d: files %s and %s do not match: \n\t%s\n\t%s\n\n\t%s\n\t%s", line, fileNameA, fileNameB, textA, textB, replacedA, replacedB)
+ }
+
+ line++
+ }
+
+ if err := scannerA.Err(); err != nil {
+ return err
+ }
+ if err := scannerB.Err(); err != nil {
+ return err
+ }
+ return nil
+}