Add unit tests for model package (#38)

Author: vanekjar

pkg/cloudmap/client.go

@@ -179,7 +179,7 @@ func (sdc *serviceDiscoveryClient) RegisterEndpoints(ctx context.Context, servic
 
 	for _, endpt := range service.Endpoints {
 		go func(endpt *model.Endpoint) {
-			opId, endptErr := sdc.sdApi.RegisterInstance(ctx, svcId, endpt.Id, endpt.GetAttributes())
+			opId, endptErr := sdc.sdApi.RegisterInstance(ctx, svcId, endpt.Id, endpt.GetCloudMapAttributes())
 			opCollector.Add(endpt.Id, opId, endptErr)
 		}(endpt)
 	}

pkg/model/types.go

@@ -62,8 +62,8 @@ func NewEndpointFromInstance(inst *types.InstanceSummary) (*Endpoint, error) {
 	return &endpoint, nil
 }
 
-// GetAttributes extracts endpoint attributes for Cloud Map service instance registration
-func (e *Endpoint) GetAttributes() map[string]string {
+// GetCloudMapAttributes extracts endpoint attributes for Cloud Map service instance registration
+func (e *Endpoint) GetCloudMapAttributes() map[string]string {
 	attrs := make(map[string]string, 0)
 
 	attrs[Ipv4Attr] = e.IP
@@ -78,6 +78,7 @@ func (e *Endpoint) GetAttributes() map[string]string {
 	return attrs
 }
 
+// Equals evaluates if two Endpoints are "deeply equal" (including all fields)
 func (e *Endpoint) Equals(other *Endpoint) bool {
 	return reflect.DeepEqual(e, other)
 }

pkg/model/types_test.go

@@ -7,6 +7,7 @@ import (
 )
 
 var instId = "my-instance"
+var ip = "192.168.0.1"
 
 func TestNewEndpointFromInstance(t *testing.T) {
 	tests := []struct {
@@ -20,14 +21,14 @@ func TestNewEndpointFromInstance(t *testing.T) {
 			inst: &types.InstanceSummary{
 				Id: &instId,
 				Attributes: map[string]string{
-					Ipv4Attr:      "192.168.0.1",
+					Ipv4Attr:      ip,
 					PortAttr:      "65535",
 					"custom-attr": "custom-val",
 				},
 			},
 			want: &Endpoint{
 				Id:   instId,
-				IP:   "192.168.0.1",
+				IP:   ip,
 				Port: 65535,
 				Attributes: map[string]string{
 					"custom-attr": "custom-val",
@@ -39,13 +40,35 @@ func TestNewEndpointFromInstance(t *testing.T) {
 			inst: &types.InstanceSummary{
 				Id: &instId,
 				Attributes: map[string]string{
-					Ipv4Attr:      "192.168.0.1",
+					Ipv4Attr:      ip,
 					PortAttr:      "99999",
 					"custom-attr": "custom-val",
 				},
 			},
 			wantErr: true,
 		},
+		{
+			name: "missing IP",
+			inst: &types.InstanceSummary{
+				Id: &instId,
+				Attributes: map[string]string{
+					PortAttr:      "80",
+					"custom-attr": "custom-val",
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "missing port",
+			inst: &types.InstanceSummary{
+				Id: &instId,
+				Attributes: map[string]string{
+					Ipv4Attr:      ip,
+					"custom-attr": "custom-val",
+				},
+			},
+			wantErr: true,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -60,3 +83,114 @@ func TestNewEndpointFromInstance(t *testing.T) {
 		})
 	}
 }
+
+func TestEndpoint_GetAttributes(t *testing.T) {
+	type fields struct {
+		Id         string
+		IP         string
+		Port       int32
+		Attributes map[string]string
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   map[string]string
+	}{
+		{
+			name: "happy case",
+			fields: fields{
+				IP:   ip,
+				Port: 30,
+				Attributes: map[string]string{
+					"custom-attr": "custom-val",
+				},
+			},
+			want: map[string]string{
+				Ipv4Attr:      ip,
+				PortAttr:      "30",
+				"custom-attr": "custom-val",
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			e := &Endpoint{
+				Id:         tt.fields.Id,
+				IP:         tt.fields.IP,
+				Port:       tt.fields.Port,
+				Attributes: tt.fields.Attributes,
+			}
+			if got := e.GetCloudMapAttributes(); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("GetAttributes() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestEndpointIdFromIPAddress(t *testing.T) {
+	tests := []struct {
+		name    string
+		address string
+		want    string
+	}{
+		{
+			name:    "happy case",
+			address: "192.168.0.1",
+			want:    "192_168_0_1",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := EndpointIdFromIPAddress(tt.address); got != tt.want {
+				t.Errorf("EndpointIdFromIPAddress() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestEndpoint_Equals(t *testing.T) {
+	firstEndpoint := Endpoint{
+		Id:   instId,
+		IP:   ip,
+		Port: 80,
+		Attributes: map[string]string{
+			"custom-key": "custom-val",
+		},
+	}
+
+	secondEndpoint := Endpoint{
+		Id:   instId,
+		IP:   ip,
+		Port: 80,
+		Attributes: map[string]string{
+			"custom-key": "different-val",
+		},
+	}
+
+	tests := []struct {
+		name string
+		x    Endpoint
+		y    Endpoint
+		want bool
+	}{
+		{
+			name: "identical",
+			x:    firstEndpoint,
+			y:    firstEndpoint,
+			want: true,
+		},
+		{
+			name: "different",
+			x:    firstEndpoint,
+			y:    secondEndpoint,
+			want: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.x.Equals(&tt.y); got != tt.want {
+				t.Errorf("Equals() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}