Merge pull request #738 from floreks/refactor-backend-common

Refactor backend and extract globally used methods to common packages

Author: bryk

src/app/backend/resource/common/event.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 common
+
+import (
+	"k8s.io/kubernetes/pkg/api/unversioned"
+)
+
+// Events response structure.
+type EventList struct {
+	// Namespace.
+	Namespace string `json:"namespace"`
+
+	// List of events from given namespace.
+	Events []Event `json:"events"`
+}
+
+// Event is a single event representation.
+type Event struct {
+	// A human-readable description of the status of related object.
+	Message string `json:"message"`
+
+	// Component from which the event is generated.
+	SourceComponent string `json:"sourceComponent"`
+
+	// Host name on which the event is generated.
+	SourceHost string `json:"sourceHost"`
+
+	// Reference to a piece of an object, which triggered an event. For example
+	// "spec.containers{name}" refers to container within pod with given name, if no container
+	// name is specified, for example "spec.containers[2]", then it refers to container with
+	// index 2 in this pod.
+	SubObject string `json:"object"`
+
+	// The number of times this event has occurred.
+	Count int `json:"count"`
+
+	// The time at which the event was first recorded.
+	FirstSeen unversioned.Time `json:"firstSeen"`
+
+	// The time at which the most recent occurrence of this event was recorded.
+	LastSeen unversioned.Time `json:"lastSeen"`
+
+	// Short, machine understandable string that gives the reason
+	// for this event being generated.
+	Reason string `json:"reason"`
+
+	// Event type (at the moment only normal and warning are supported).
+	Type string `json:"type"`
+}

src/app/backend/resource/common/pod.go

@@ -0,0 +1,54 @@
+// 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 common
+
+import (
+	"k8s.io/kubernetes/pkg/api"
+)
+
+func FilterNamespacedPodsBySelector(pods []api.Pod, namespace string,
+	resourceSelector map[string]string) []api.Pod {
+
+	var matchingPods []api.Pod
+	for _, pod := range pods {
+		if pod.ObjectMeta.Namespace == namespace &&
+			IsLabelSelectorMatching(resourceSelector, pod.Labels) {
+			matchingPods = append(matchingPods, pod)
+		}
+	}
+
+	return matchingPods
+}
+
+// Returns pods targeted by given selector.
+func FilterPodsBySelector(pods []api.Pod, resourceSelector map[string]string) []api.Pod {
+
+	var matchingPods []api.Pod
+	for _, pod := range pods {
+		if IsLabelSelectorMatching(resourceSelector, pod.Labels) {
+			matchingPods = append(matchingPods, pod)
+		}
+	}
+	return matchingPods
+}
+
+// GetContainerImages returns container image strings from the given pod spec.
+func GetContainerImages(podTemplate *api.PodSpec) []string {
+	var containerImages []string
+	for _, container := range podTemplate.Containers {
+		containerImages = append(containerImages, container.Image)
+	}
+	return containerImages
+}

src/app/backend/resource/common/serviceport.go

@@ -0,0 +1,37 @@
+// 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 common
+
+import (
+	"k8s.io/kubernetes/pkg/api"
+)
+
+// ServicePort is a pair of port and protocol, e.g. a service endpoint.
+type ServicePort struct {
+	// Positive port number.
+	Port int `json:"port"`
+
+	// Protocol name, e.g., TCP or UDP.
+	Protocol api.Protocol `json:"protocol"`
+}
+
+// GetServicePorts returns human readable name for the given service ports list.
+func GetServicePorts(apiPorts []api.ServicePort) []ServicePort {
+	var ports []ServicePort
+	for _, port := range apiPorts {
+		ports = append(ports, ServicePort{port.Port, port.Protocol})
+	}
+	return ports
+}

src/app/backend/resource/common/types.go

@@ -63,58 +63,6 @@ type TypeMeta struct {
 	Kind ResourceKind `json:"kind,omitempty"`
 }
 
-// ServicePort is a pair of port and protocol, e.g. a service endpoint.
-type ServicePort struct {
-	// Positive port number.
-	Port int `json:"port"`
-
-	// Protocol name, e.g., TCP or UDP.
-	Protocol api.Protocol `json:"protocol"`
-}
-
-// Events response structure.
-type EventList struct {
-	// Namespace.
-	Namespace string `json:"namespace"`
-
-	// List of events from given namespace.
-	Events []Event `json:"events"`
-}
-
-// Event is a single event representation.
-type Event struct {
-	// A human-readable description of the status of related object.
-	Message string `json:"message"`
-
-	// Component from which the event is generated.
-	SourceComponent string `json:"sourceComponent"`
-
-	// Host name on which the event is generated.
-	SourceHost string `json:"sourceHost"`
-
-	// Reference to a piece of an object, which triggered an event. For example
-	// "spec.containers{name}" refers to container within pod with given name, if no container
-	// name is specified, for example "spec.containers[2]", then it refers to container with
-	// index 2 in this pod.
-	SubObject string `json:"object"`
-
-	// The number of times this event has occurred.
-	Count int `json:"count"`
-
-	// The time at which the event was first recorded.
-	FirstSeen unversioned.Time `json:"firstSeen"`
-
-	// The time at which the most recent occurrence of this event was recorded.
-	LastSeen unversioned.Time `json:"lastSeen"`
-
-	// Short, machine understandable string that gives the reason
-	// for this event being generated.
-	Reason string `json:"reason"`
-
-	// Event type (at the moment only normal and warning are supported).
-	Type string `json:"type"`
-}
-
 // Returns internal endpoint name for the given service properties, e.g.,
 // NewObjectMeta creates a new instance of ObjectMeta struct based on K8s object meta.
 func NewObjectMeta(k8SObjectMeta api.ObjectMeta) ObjectMeta {
@@ -158,15 +106,6 @@ var kindToAPIPathMapping = map[string]string{
 	ResourceKindReplicaSet:            "replicasets",
 }
 
-// GetServicePorts returns human readable name for the given service ports list.
-func GetServicePorts(apiPorts []api.ServicePort) []ServicePort {
-	var ports []ServicePort
-	for _, port := range apiPorts {
-		ports = append(ports, ServicePort{port.Port, port.Protocol})
-	}
-	return ports
-}
-
 // IsLabelSelectorMatching returns true when an object with the given
 // selector targets the same Resources (or subset) that
 // the tested object with the given selector.
@@ -186,29 +125,3 @@ func IsLabelSelectorMatching(labelSelector map[string]string,
 
 	return true
 }
-
-func FilterNamespacedPodsBySelector(pods []api.Pod, namespace string,
-	resourceSelector map[string]string) []api.Pod {
-
-	var matchingPods []api.Pod
-	for _, pod := range pods {
-		if pod.ObjectMeta.Namespace == namespace &&
-			IsLabelSelectorMatching(resourceSelector, pod.Labels) {
-			matchingPods = append(matchingPods, pod)
-		}
-	}
-
-	return matchingPods
-}
-
-// Returns pods targeted by given selector.
-func FilterPodsBySelector(pods []api.Pod, resourceSelector map[string]string) []api.Pod {
-
-	var matchingPods []api.Pod
-	for _, pod := range pods {
-		if IsLabelSelectorMatching(resourceSelector, pod.Labels) {
-			matchingPods = append(matchingPods, pod)
-		}
-	}
-	return matchingPods
-}

src/app/backend/resource/deployment/deploymentcommon.go

@@ -16,13 +16,12 @@ package deployment
 
 import (
 	"github.com/kubernetes/dashboard/resource/common"
+
 	"k8s.io/kubernetes/pkg/api"
 	"k8s.io/kubernetes/pkg/apis/extensions"
 )
 
 // getPodInfo returns aggregate information about deployment pods.
-func getPodInfo(resource *extensions.Deployment,
-	pods []api.Pod) common.PodInfo {
-
+func getPodInfo(resource *extensions.Deployment, pods []api.Pod) common.PodInfo {
 	return common.GetPodInfo(resource.Status.Replicas, resource.Spec.Replicas, pods)
 }

src/app/backend/resource/deployment/deploymentlist.go

@@ -18,7 +18,7 @@ import (
 	"log"
 
 	"github.com/kubernetes/dashboard/resource/common"
-	"github.com/kubernetes/dashboard/resource/replicationcontroller"
+
 	"k8s.io/kubernetes/pkg/api"
 	k8serrors "k8s.io/kubernetes/pkg/api/errors"
 	"k8s.io/kubernetes/pkg/apis/extensions"
@@ -118,7 +118,7 @@ func getDeploymentList(deployments []extensions.Deployment,
 			Deployment{
 				ObjectMeta:      common.NewObjectMeta(deployment.ObjectMeta),
 				TypeMeta:        common.NewTypeMeta(common.ResourceKindDeployment),
-				ContainerImages: replicationcontroller.GetContainerImages(&deployment.Spec.Template.Spec),
+				ContainerImages: common.GetContainerImages(&deployment.Spec.Template.Spec),
 				Pods:            podInfo,
 			})
 	}

src/app/backend/resource/event/event.go

@@ -18,6 +18,7 @@ import (
 	"strings"
 
 	"github.com/kubernetes/dashboard/resource/common"
+
 	"k8s.io/kubernetes/pkg/api"
 	"k8s.io/kubernetes/pkg/types"
 )

src/app/backend/resource/event/eventcommon.go

@@ -16,6 +16,7 @@ package event
 
 import (
 	"github.com/kubernetes/dashboard/resource/common"
+
 	"k8s.io/kubernetes/pkg/api"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
 	"k8s.io/kubernetes/pkg/fields"

src/app/backend/resource/namespace/namespace.go

@@ -17,7 +17,7 @@ package namespace
 import (
 	"log"
 
-	api "k8s.io/kubernetes/pkg/api"
+	"k8s.io/kubernetes/pkg/api"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
 	"k8s.io/kubernetes/pkg/fields"
 	"k8s.io/kubernetes/pkg/labels"

src/app/backend/resource/pod/podlist.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/kubernetes/dashboard/client"
 	"github.com/kubernetes/dashboard/resource/common"
+
 	"k8s.io/kubernetes/pkg/api"
 	k8sClient "k8s.io/kubernetes/pkg/client/unversioned"
 )