Rename symbols for more clarity

- The review identified few ambiguities in symbol names.
- This commit try to fix these ambiguities after discussion out of band.

Author: Franck Rupin

ovs/datapath.go

@@ -30,22 +30,22 @@ var (
 	errWrongZoneArgument            = errors.New("wrong argument while setting zone ct limits")
 )
 
-// Zone defines the type used to store a zone as it is returned
+// CTLimit defines the type used to store a zone as it is returned
 // by ovs-dpctl ct-*-limits commands
-type Zone map[string]uint64
+type CTLimit map[string]uint64
 
-// ConnTrackOutput is a type defined to store the output
+// ConntrackOutput is a type defined to store the output
 // of ovs-dpctl ct-*-limits commands. For example it stores
 // such a cli output:
 // # ovs-dpctl ct-get-limits system@ovs-system zone=2,3
 // default limit=0
 // zone=2,limit=0,count=0
 // zone=3,limit=0,count=0
-type ConnTrackOutput struct {
-	// defaulCT is used to store the global setting: default
-	defaultLimit Zone
+type ConntrackOutput struct {
+	// defaultLimit is used to store the global setting: default
+	defaultLimit CTLimit
 	// zones stores all remaning zone's settings
-	zones []Zone
+	zoneLimits []CTLimit
 }
 
 // DataPathReader is the interface defining the read operations
@@ -72,7 +72,7 @@ type DataPathWriter interface {
 type ConnTrackReader interface {
 	// GetCTLimits is the method used to querying conntrack limits for a
 	// datapath on a switch
-	GetCTLimits(string, []uint64) (ConnTrackOutput, error)
+	GetCTLimits(string, []uint64) (ConntrackOutput, error)
 }
 
 // ConnTrackWriter is the interface defining the write operations
@@ -149,7 +149,7 @@ func (dp *DataPathService) DelDataPath(dpName string) error {
 
 // GetCTLimits returns the conntrack limits  for a given datapath
 // equivalent to running: 'sudo ovs-dpctl ct-get-limits <datapath_name> zone=<#1>,<#2>,...'
-func (dp *DataPathService) GetCTLimits(dpName string, zones []uint64) (*ConnTrackOutput, error) {
+func (dp *DataPathService) GetCTLimits(dpName string, zones []uint64) (*ConntrackOutput, error) {
 	// Start by building the args
 	if dpName == "" {
 		return nil, errMissingMandatoryDataPathName
@@ -170,7 +170,7 @@ func (dp *DataPathService) GetCTLimits(dpName string, zones []uint64) (*ConnTrac
 
 	// Process the results
 	entries := strings.Split(string(results), "\n")
-	ctOut := &ConnTrackOutput{}
+	ctOut := &ConntrackOutput{}
 
 	r, err := regexp.Compile(`default`)
 	if err != nil {
@@ -181,7 +181,7 @@ func (dp *DataPathService) GetCTLimits(dpName string, zones []uint64) (*ConnTrac
 	// If found the default value is removed from the entries
 	for i, entry := range entries {
 		if r.MatchString(entry) {
-			ctOut.defaultLimit = make(Zone)
+			ctOut.defaultLimit = make(CTLimit)
 			limit, err := strconv.Atoi(strings.Split(entry, "=")[1])
 			if err != nil {
 				return nil, err
@@ -195,13 +195,13 @@ func (dp *DataPathService) GetCTLimits(dpName string, zones []uint64) (*ConnTrac
 	// Now process the zones setup
 	for _, entry := range entries {
 		fields := strings.Split(entry, ",")
-		z := make(Zone)
+		z := make(CTLimit)
 		for _, field := range fields {
 			buf := strings.Split(field, "=")
 			val, _ := strconv.Atoi(buf[1])
 			z[buf[0]] = uint64(val)
 		}
-		ctOut.zones = append(ctOut.zones, z)
+		ctOut.zoneLimits = append(ctOut.zoneLimits, z)
 	}
 
 	return ctOut, nil

ovs/datapath_test.go

@@ -179,30 +179,30 @@ func TestDelDataPath(t *testing.T) {
 }
 
 func TestGetCTLimits(t *testing.T) {
-	z0 := make(Zone)
-	z0["default"] = 0
-	z1 := make(Zone)
+	d := make(CTLimit)
+	d["default"] = 0
+	z1 := make(CTLimit)
 	z1["zone"] = 2
 	z1["count"] = 0
 	z1["limit"] = 1000000
-	z2 := make(Zone)
+	z2 := make(CTLimit)
 	z2["zone"] = 3
 	z2["count"] = 0
 	z2["limit"] = 1000000
-	zones := make([]Zone, 0)
+	zones := make([]CTLimit, 0)
 	zones = append(zones, z1)
 	zones = append(zones, z2)
-	out := &ConnTrackOutput{
-		defaultLimit: z0,
-		zones:        zones,
+	out := &ConntrackOutput{
+		defaultLimit: d,
+		zoneLimits:   zones,
 	}
 
 	var tests = []struct {
 		desc     string
 		dp       *DataPathService
 		dpName   string
 		zones    []uint64
-		want     *ConnTrackOutput
+		want     *ConntrackOutput
 		err      string
 		testCase uint8
 	}{
@@ -258,9 +258,9 @@ func TestGetCTLimits(t *testing.T) {
 				if tt.want.defaultLimit["default"] != results.defaultLimit["default"] {
 					t.Errorf("mismatched values, want %q  but got %q", tt.want.defaultLimit["default"], results.defaultLimit["default"])
 				}
-				for i, z := range results.zones {
-					if tt.want.zones[i]["zone"] != z["zone"] {
-						t.Errorf("mismatched values, want %q  but got %q", tt.want.zones[i]["zone"], z["zone"])
+				for i, z := range results.zoneLimits {
+					if tt.want.zoneLimits[i]["zone"] != z["zone"] {
+						t.Errorf("mismatched values, want %q  but got %q", tt.want.zoneLimits[i]["zone"], z["zone"])
 					}
 				}
 			case handleError:
@@ -282,44 +282,32 @@ func TestGetCTLimitsWithBinary(t *testing.T) {
 		t.Skip("skipping test in short mode.")
 	}
 
-	z0 := make(Zone)
-	z0["default"] = 200
-	z1 := make(Zone)
+	d := make(CTLimit)
+	d["default"] = 200
+	z1 := make(CTLimit)
 	z1["zone"] = 2
 	z1["count"] = 0
 	z1["limit"] = 200
-	z2 := make(Zone)
-	z2["zone"] = 3
-	z2["count"] = 0
-	z2["limit"] = 200
-	zones1 := make([]Zone, 0)
+	zones1 := make([]CTLimit, 0)
 	zones1 = append(zones1, z1)
-	zones1 = append(zones1, z2)
-	out := &ConnTrackOutput{
-		defaultLimit: z0,
-		zones:        zones1,
-	}
-	zones2 := make([]Zone, 0)
-	zones2 = append(zones2, z2)
-	outTest2 := &ConnTrackOutput{
-		defaultLimit: z0,
-		zones:        zones2,
+	out := &ConntrackOutput{
+		defaultLimit: d,
+		zoneLimits:   zones1,
 	}
-
 	var tests = []struct {
 		desc     string
 		dp       *DataPathService
 		dpName   string
 		zones    []uint64
-		want     *ConnTrackOutput
+		want     *ConntrackOutput
 		err      string
 		testCase uint8
 	}{
 		{
 			desc:     "Test valid ovs-dpctl ct-get-limits system@ovs-system zone=2,3 ",
 			dp:       NewDataPathService(),
 			dpName:   "ovs-system",
-			zones:    []uint64{2, 3},
+			zones:    []uint64{2},
 			want:     out,
 			err:      "",
 			testCase: validTest,
@@ -329,7 +317,7 @@ func TestGetCTLimitsWithBinary(t *testing.T) {
 			dp:       NewDataPathService(),
 			dpName:   "ovs-system",
 			zones:    []uint64{},
-			want:     outTest2,
+			want:     out,
 			err:      "",
 			testCase: validTest,
 		},
@@ -351,9 +339,9 @@ func TestGetCTLimitsWithBinary(t *testing.T) {
 				if tt.want.defaultLimit["default"] != results.defaultLimit["default"] {
 					t.Errorf("mismatched values, want %q  but got %q", tt.want.defaultLimit["default"], results.defaultLimit["default"])
 				}
-				for i, z := range results.zones {
-					if tt.want.zones[i]["zone"] != z["zone"] {
-						t.Errorf("mismatched values, want %q  but got %q", tt.want.zones[i]["zone"], z["zone"])
+				for i, z := range results.zoneLimits {
+					if tt.want.zoneLimits[i]["zone"] != z["zone"] {
+						t.Errorf("mismatched values, want %q  but got %q", tt.want.zoneLimits[i]["zone"], z["zone"])
 					}
 				}
 			case handleError: