Merge pull request #732 from floreks/refactor-service-backend

Refactor services backend

Author: bryk

src/app/backend/handler/apihandler.go

@@ -262,8 +262,8 @@ func CreateHttpApiHandler(client *client.Client, heapsterClient HeapsterClient,
 			Writes(resourceService.ServiceList{}))
 	servicesWs.Route(
 		servicesWs.GET("/{namespace}/{service}").
-			To(apiHandler.handleGetService).
-			Writes(resourceService.Service{}))
+			To(apiHandler.handleGetServiceDetail).
+			Writes(resourceService.ServiceDetail{}))
 	wsContainer.Add(servicesWs)
 
 	return wsContainer
@@ -281,10 +281,10 @@ func (apiHandler *ApiHandler) handleGetServiceList(request *restful.Request, res
 }
 
 // Handles get service detail API call.
-func (apiHandler *ApiHandler) handleGetService(request *restful.Request, response *restful.Response) {
+func (apiHandler *ApiHandler) handleGetServiceDetail(request *restful.Request, response *restful.Response) {
 	namespace := request.PathParameter("namespace")
 	service := request.PathParameter("service")
-	result, err := resourceService.GetService(apiHandler.client, namespace, service)
+	result, err := resourceService.GetServiceDetail(apiHandler.client, namespace, service)
 	if err != nil {
 		handleInternalError(response, err)
 		return

src/app/backend/resource/replicationcontroller/replicationcontrollerdetail.go

@@ -45,7 +45,7 @@ type ReplicationControllerDetail struct {
 	Pods pod.PodList `json:"pods"`
 
 	// Detailed information about service related to Replication Controller.
-	Services []resourceService.Service `json:"services"`
+	ServiceList resourceService.ServiceList `json:"serviceList"`
 
 	// True when the data contains at least one pod with metrics information, false otherwise.
 	HasMetrics bool `json:"hasMetrics"`
@@ -89,12 +89,14 @@ func GetReplicationControllerDetail(client k8sClient.Interface, heapsterClient c
 		TypeMeta:      common.CreateTypeMeta(replicationController.TypeMeta),
 		LabelSelector: replicationController.Spec.Selector,
 		PodInfo:       getReplicationPodInfo(replicationController, pods.Items),
+		ServiceList:   resourceService.ServiceList{Services: make([]resourceService.Service, 0)},
 	}
 
 	matchingServices := getMatchingServices(services.Items, replicationController)
 
 	for _, service := range matchingServices {
-		replicationControllerDetail.Services = append(replicationControllerDetail.Services,
+		replicationControllerDetail.ServiceList.Services = append(
+			replicationControllerDetail.ServiceList.Services,
 			getService(service, *replicationController, pods.Items, nodes.Items))
 	}
 
@@ -204,10 +206,10 @@ func UpdateReplicasCount(client k8sClient.Interface, namespace, name string,
 func getService(service api.Service, replicationController api.ReplicationController,
 	pods []api.Pod, nodes []api.Node) resourceService.Service {
 
-	result := resourceService.GetServiceDetails(&service);
+	result := resourceService.ToService(&service)
 	result.ExternalEndpoints = getExternalEndpoints(replicationController, pods, service, nodes)
 
-	return result;
+	return result
 }
 
 // Returns array of external endpoints for a replication controller.

src/app/backend/resource/service/servicecommon.go

@@ -0,0 +1,46 @@
+// Copyright 2015 Google Inc. All Rights Reserved.
+//
+// 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 service
+
+import (
+	"k8s.io/kubernetes/pkg/api"
+
+	"github.com/kubernetes/dashboard/resource/common"
+)
+
+// ToService returns api service object based on kubernetes service object
+func ToService(service *api.Service) Service {
+	return Service{
+		ObjectMeta:       common.CreateObjectMeta(service.ObjectMeta),
+		TypeMeta:         common.CreateTypeMeta(service.TypeMeta),
+		InternalEndpoint: common.GetInternalEndpoint(service.Name, service.Namespace, service.Spec.Ports),
+		// TODO(maciaszczykm): Fill ExternalEndpoints with data.
+		Selector:  service.Spec.Selector,
+		ClusterIP: service.Spec.ClusterIP,
+	}
+}
+
+// ToServiceDetails returns api service object based on kubernetes service object
+func ToServiceDetail(service *api.Service) ServiceDetail {
+	return ServiceDetail{
+		ObjectMeta:       common.CreateObjectMeta(service.ObjectMeta),
+		TypeMeta:         common.CreateTypeMeta(service.TypeMeta),
+		InternalEndpoint: common.GetInternalEndpoint(service.Name, service.Namespace, service.Spec.Ports),
+		// TODO(maciaszczykm): Fill ExternalEndpoints with data.
+		Selector:  service.Spec.Selector,
+		ClusterIP: service.Spec.ClusterIP,
+		Type:      service.Spec.Type,
+	}
+}

src/app/backend/resource/service/servicedetail.go

@@ -0,0 +1,62 @@
+// Copyright 2015 Google Inc. All Rights Reserved.
+//
+// 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 service
+
+import (
+	"log"
+
+	"k8s.io/kubernetes/pkg/api"
+	client "k8s.io/kubernetes/pkg/client/unversioned"
+
+	"github.com/kubernetes/dashboard/resource/common"
+)
+
+// Service is a representation of a service.
+type ServiceDetail struct {
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
+
+	// InternalEndpoint of all Kubernetes services that have the same label selector as connected Replication
+	// Controller. Endpoint is DNS name merged with ports.
+	InternalEndpoint common.Endpoint `json:"internalEndpoint"`
+
+	// ExternalEndpoints of all Kubernetes services that have the same label selector as connected Replication
+	// Controller. Endpoint is external IP address name merged with ports.
+	ExternalEndpoints []common.Endpoint `json:"externalEndpoints"`
+
+	// Label selector of the service.
+	Selector map[string]string `json:"selector"`
+
+	// Type determines how the service will be exposed.  Valid options: ClusterIP, NodePort, LoadBalancer
+	Type api.ServiceType `json:"type"`
+
+	// ClusterIP is usually assigned by the master. Valid values are None, empty string (""), or
+	// a valid IP address. None can be specified for headless services when proxying is not required
+	ClusterIP string `json:"clusterIP"`
+}
+
+// GetServiceDetail gets service details.
+func GetServiceDetail(client client.Interface, namespace, name string) (*ServiceDetail, error) {
+	log.Printf("Getting details of %s service in %s namespace", name, namespace)
+
+	// TODO(maciaszczykm): Use channels.
+	serviceData, err := client.Services(namespace).Get(name)
+	if err != nil {
+		return nil, err
+	}
+
+	service := ToServiceDetail(serviceData)
+	return &service, nil
+}

src/app/backend/resource/service/services.go renamed to src/app/backend/resource/service/servicelist.go

@@ -17,9 +17,9 @@ package service
 import (
 	"log"
 
-	"github.com/kubernetes/dashboard/resource/common"
-	"k8s.io/kubernetes/pkg/api"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
+
+	"github.com/kubernetes/dashboard/resource/common"
 )
 
 // Service is a representation of a service.
@@ -38,9 +38,6 @@ type Service struct {
 	// Label selector of the service.
 	Selector map[string]string `json:"selector"`
 
-	// Type determines how the service will be exposed.  Valid options: ClusterIP, NodePort, LoadBalancer
-	Type api.ServiceType `json:"type"`
-
 	// ClusterIP is usually assigned by the master. Valid values are None, empty string (""), or
 	// a valid IP address. None can be specified for headless services when proxying is not required
 	ClusterIP string `json:"clusterIP"`
@@ -52,20 +49,6 @@ type ServiceList struct {
 	Services []Service `json:"services"`
 }
 
-// GetService gets service details.
-func GetService(client client.Interface, namespace, name string) (*Service, error) {
-	log.Printf("Getting details of %s service in %s namespace", name, namespace)
-
-	// TODO(maciaszczykm): Use channels.
-	serviceData, err := client.Services(namespace).Get(name)
-	if err != nil {
-		return nil, err
-	}
-
-	service := GetServiceDetails(serviceData)
-	return &service, nil
-}
-
 // GetServiceList returns a list of all services in the cluster.
 func GetServiceList(client client.Interface) (*ServiceList, error) {
 	log.Printf("Getting list of all services in the cluster")
@@ -81,21 +64,8 @@ func GetServiceList(client client.Interface) (*ServiceList, error) {
 
 	serviceList := &ServiceList{Services: make([]Service, 0)}
 	for _, service := range services.Items {
-		serviceList.Services = append(serviceList.Services, GetServiceDetails(&service))
+		serviceList.Services = append(serviceList.Services, ToService(&service))
 	}
 
 	return serviceList, nil
 }
-
-// GetServiceDetails returns api service object based on kubernetes service object
-func GetServiceDetails(service *api.Service) Service {
-	return Service{
-		ObjectMeta:       common.CreateObjectMeta(service.ObjectMeta),
-		TypeMeta:         common.CreateTypeMeta(service.TypeMeta),
-		InternalEndpoint: common.GetInternalEndpoint(service.Name, service.Namespace, service.Spec.Ports),
-		// TODO(maciaszczykm): Fill ExternalEndpoints with data.
-		Selector:  service.Spec.Selector,
-		ClusterIP: service.Spec.ClusterIP,
-		Type:      service.Spec.Type,
-	}
-}

src/app/externs/backendapi.js

@@ -214,7 +214,7 @@ backendApi.TypeMeta;
  *   containerImages: !Array<string>,
  *   podInfo: !backendApi.PodInfo,
  *   pods: !backendApi.PodList,
- *   services: !Array<!backendApi.ServiceDetail>,
+ *   serviceList: !backendApi.ServiceList,
  *   hasMetrics: boolean
  * }}
  */
@@ -254,16 +254,27 @@ backendApi.Pod;
  *  internalEndpoint: !backendApi.Endpoint,
  *  externalEndpoints: !Array<!backendApi.Endpoint>,
  *  selector: !Object<string, string>,
- *  labels: !Object<string, string>,
- *  clusterIP: string,
- *  type: string
+ *  type: string,
+ *  clusterIP: string
  * }}
  */
 backendApi.ServiceDetail;
 
 /**
  * @typedef {{
- *  services: !Array<backendApi.ServiceDetail>
+ *  objectMeta: !backendApi.ObjectMeta,
+ *  typeMeta: !backendApi.TypeMeta,
+ *  internalEndpoint: !backendApi.Endpoint,
+ *  externalEndpoints: !Array<!backendApi.Endpoint>,
+ *  selector: !Object<string, string>,
+ *  clusterIP: string
+ * }}
+ */
+backendApi.Service;
+
+/**
+ * @typedef {{
+ *  services: !Array<backendApi.Service>
  * }}
  */
 backendApi.ServiceList;

src/app/frontend/replicationcontrollerdetail/replicationcontrollerdetail.html

@@ -21,10 +21,11 @@
         <kd-replication-controller-info replication-controller="::ctrl.replicationControllerDetail">
         </kd-replication-controller-info>
 
-        <kd-content-card ng-if="::ctrl.replicationControllerDetail.services">
+        <kd-content-card ng-if="::ctrl.replicationControllerDetail.serviceList.services">
           <kd-title>Services</kd-title>
           <kd-content>
-            <kd-service-card-list services="::ctrl.replicationControllerDetail.services">
+            <kd-service-card-list
+                    services="::ctrl.replicationControllerDetail.serviceList.services">
             </kd-service-card-list>
           </kd-content>
         </kd-content-card>

src/app/frontend/servicelist/servicecardlist_component.js

@@ -25,7 +25,7 @@ export class ServiceCardListController {
   constructor($state) { this.state_ = $state; }
 
   /**
-   * @param {!backendApi.ServiceDetail} service
+   * @param {!backendApi.Service} service
    * @return {string}
    * @export
    */
@@ -44,7 +44,7 @@ export const serviceCardListComponent = {
   templateUrl: 'servicelist/servicecardlist.html',
   controller: ServiceCardListController,
   bindings: {
-    /** {!Array<!backendApi.ServiceDetail>} */
+    /** {!Array<!backendApi.Service>} */
     'services': '<',
     /** {boolean} */
     'selectable': '<',

src/test/backend/resource/service/servicecommon_test.go

@@ -0,0 +1,88 @@
+// Copyright 2015 Google Inc. All Rights Reserved.
+//
+// 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 service
+
+import (
+	"reflect"
+	"testing"
+
+	"k8s.io/kubernetes/pkg/api"
+
+	"github.com/kubernetes/dashboard/resource/common"
+)
+
+func TestToServiceDetail(t *testing.T) {
+	cases := []struct {
+		service  *api.Service
+		expected ServiceDetail
+	}{
+		{
+			service: &api.Service{}, expected: ServiceDetail{},
+		}, {
+			service: &api.Service{
+				ObjectMeta: api.ObjectMeta{
+					Name: "test-service", Namespace: "test-namespace",
+				}},
+			expected: ServiceDetail{
+				ObjectMeta: common.ObjectMeta{
+					Name:      "test-service",
+					Namespace: "test-namespace",
+				},
+				InternalEndpoint: common.Endpoint{Host: "test-service.test-namespace"},
+			},
+		},
+	}
+
+	for _, c := range cases {
+		actual := ToServiceDetail(c.service)
+
+		if !reflect.DeepEqual(actual, c.expected) {
+			t.Errorf("ToServiceDetail(%#v) == \ngot %#v, \nexpected %#v", c.service, actual,
+				c.expected)
+		}
+	}
+}
+
+func TestToService(t *testing.T) {
+	cases := []struct {
+		service  *api.Service
+		expected Service
+	}{
+		{
+			service: &api.Service{}, expected: Service{},
+		}, {
+			service: &api.Service{
+				ObjectMeta: api.ObjectMeta{
+					Name: "test-service", Namespace: "test-namespace",
+				}},
+			expected: Service{
+				ObjectMeta: common.ObjectMeta{
+					Name:      "test-service",
+					Namespace: "test-namespace",
+				},
+				InternalEndpoint: common.Endpoint{Host: "test-service.test-namespace"},
+			},
+		},
+	}
+
+	for _, c := range cases {
+		actual := ToService(c.service)
+
+		if !reflect.DeepEqual(actual, c.expected) {
+			t.Errorf("ToService(%#v) == \ngot %#v, \nexpected %#v", c.service, actual,
+				c.expected)
+		}
+	}
+}