feature(data): add deployments, daemonsets to cluster data (#95)

* feature(data): add deployments, daemonsets to cluster data

* test(data): basic clusterIDFromPersistentStorage.Get() coverage

and installedDeisData.Get() test coverage scaffolding and TODO note

* chore(swagger): image is a versionData property

this was inadvertently duplicated as a property of version

* chore(data): version annotation = component.deis.io/version

see deis/charts#331

Author: jackfrancis

api/swagger-spec/swagger.yml

@@ -401,10 +401,10 @@ definitions:
         minLength: 1
       description:
         type: string
+      type:
+        type: string
   version:
     type: object
-    required:
-      - train
     properties:
       train:
         type: string
@@ -416,8 +416,8 @@ definitions:
         type: string
         minLength: 1
       data:
-        $ref: "#/definitions/data"
-  data:
+        $ref: "#/definitions/versionData"
+  versionData:
     type: object
     properties:
       description:
@@ -426,6 +426,8 @@ definitions:
       fixes:
         type: string
         minLength: 1
+      image:
+        type: string
   error:
     type: object
     required:

data/cluster_id_test.go

@@ -0,0 +1,35 @@
+package data
+
+import (
+	"sync"
+	"testing"
+
+	"github.com/arschles/assert"
+	"github.com/deis/kubeapp/api/secret"
+	"github.com/deis/workflow-manager/k8s"
+	"github.com/satori/go.uuid"
+	"k8s.io/kubernetes/pkg/api"
+)
+
+func TestClusterIDFromPersistentStorage(t *testing.T) {
+	sec := api.Secret{}
+	secretGetter := &secret.FakeGetter{
+		Secret: &sec,
+	}
+	secretCreator := &secret.FakeCreator{
+		CreateFunc: func(sec *api.Secret) (*api.Secret, error) {
+			return sec, nil
+		},
+	}
+	secrets := k8s.NewFakeKubeSecretGetterCreator(secretGetter, secretCreator)
+	clusterID := clusterIDFromPersistentStorage{
+		rwm:                 new(sync.RWMutex),
+		cache:               "",
+		secretGetterCreator: secrets,
+	}
+	resp, err := clusterID.Get()
+	assert.NoErr(t, err)
+	// verify that the secret is a UUID
+	_, err = uuid.FromString(resp)
+	assert.NoErr(t, err)
+}

data/installed_data.go

@@ -7,6 +7,14 @@ import (
 	"github.com/deis/workflow-manager/pkg/swagger/models"
 )
 
+var (
+	daemonSetType  = "Daemon Set"
+	deploymentType = "Deployment"
+	rcType         = "Replication Controller"
+)
+
+const versionAnnotation = "component.deis.io/version"
+
 // InstalledData is an interface for managing installed cluster metadata
 type InstalledData interface {
 	// will have a Get method to retrieve installed data
@@ -25,19 +33,62 @@ func NewInstalledDeisData(ri *k8s.ResourceInterfaceNamespaced) InstalledData {
 
 // Get method for InstalledDeisData
 func (g *installedDeisData) Get() ([]byte, error) {
-	rcItems, err := k8s.GetReplicationControllers(g.k8sResources.ReplicationControllers())
+	var cluster models.Cluster
+	deployments, err := k8s.GetDeployments(g.k8sResources.Deployments())
 	if err != nil {
 		return nil, err
 	}
-	var cluster models.Cluster
-	for _, rc := range rcItems {
-		component := models.ComponentVersion{}
-		component.Component = &models.Component{}
-		component.Version = &models.Version{}
-		component.Component.Name = rc.Name
-		desc := rc.Annotations["chart.helm.sh/description"]
-		component.Component.Description = &desc
-		component.Version.Version = rc.Annotations["chart.helm.sh/version"]
+	for _, deployment := range deployments {
+		component := models.ComponentVersion{
+			Component: &models.Component{
+				Name: deployment.Name,
+				Type: &deploymentType,
+			},
+			Version: &models.Version{
+				Version: deployment.Annotations[versionAnnotation],
+				Data: &models.VersionData{
+					Image: &deployment.Spec.Template.Spec.Containers[0].Image,
+				},
+			},
+		}
+		cluster.Components = append(cluster.Components, &component)
+	}
+	daemonSets, err := k8s.GetDaemonSets(g.k8sResources.DaemonSets())
+	if err != nil {
+		return nil, err
+	}
+	for _, daemonSet := range daemonSets {
+		component := models.ComponentVersion{
+			Component: &models.Component{
+				Name: daemonSet.Name,
+				Type: &daemonSetType,
+			},
+			Version: &models.Version{
+				Version: daemonSet.Annotations[versionAnnotation],
+				Data: &models.VersionData{
+					Image: &daemonSet.Spec.Template.Spec.Containers[0].Image,
+				},
+			},
+		}
+		cluster.Components = append(cluster.Components, &component)
+	}
+	replicationControllers, err := k8s.GetReplicationControllers(g.k8sResources.ReplicationControllers())
+	if err != nil {
+		return nil, err
+	}
+	for _, rc := range replicationControllers {
+		component := models.ComponentVersion{
+			Component: &models.Component{
+				Name: rc.Name,
+				Type: &rcType,
+			},
+			Version: &models.Version{
+				Version: rc.Annotations[versionAnnotation],
+				Data: &models.VersionData{
+					Image: &rc.Spec.Template.Spec.Containers[0].Image,
+				},
+			},
+		}
 		cluster.Components = append(cluster.Components, &component)
 	}
 	js, err := json.Marshal(cluster)

data/installed_data_test.go

@@ -0,0 +1,55 @@
+package data
+
+import (
+	"testing"
+
+	"github.com/deis/workflow-manager/k8s"
+	"k8s.io/kubernetes/pkg/api"
+	"k8s.io/kubernetes/pkg/api/testapi"
+	"k8s.io/kubernetes/pkg/apis/extensions"
+	"k8s.io/kubernetes/pkg/client/unversioned/testclient/simple"
+)
+
+const namespace = "deis"
+
+func TestInstalledDeisData(t *testing.T) {
+	client := getK8sClient(t)
+	k := k8s.NewResourceInterfaceNamespaced(client, namespace)
+	installedData := installedDeisData{
+		k8sResources: k,
+	}
+	_, _ = installedData.Get()
+	//TODO: we need to create a fake client interface that is a union of api+extension fake clients
+}
+
+func getK8sClient(t *testing.T) *simple.Client {
+	c := &simple.Client{
+		Request: simple.Request{
+			Method: "GET",
+			Path:   testapi.Extensions.ResourcePath("deployments", namespace, ""),
+		},
+		Response: simple.Response{StatusCode: 200,
+			Body: &extensions.DeploymentList{
+				Items: []extensions.Deployment{
+					{
+						ObjectMeta: api.ObjectMeta{
+							Name: "deis-builder",
+						},
+						Spec: extensions.DeploymentSpec{
+							Template: api.PodTemplateSpec{
+								Spec: api.PodSpec{
+									Containers: []api.Container{
+										{
+											Image: "container-image",
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+	return c.Setup(t)
+}

k8s/k8s.go

@@ -63,7 +63,7 @@ func NewRunningK8sData(r *ResourceInterfaceNamespaced) RunningK8sData {
 
 // DaemonSets method for runningK8sData
 func (rkd *runningK8sData) DaemonSets() ([]*models.K8sResource, error) {
-	ds, err := getDaemonSets(rkd.daemonSetLister)
+	ds, err := GetDaemonSets(rkd.daemonSetLister)
 	if err != nil {
 		return nil, err
 	}
@@ -80,7 +80,7 @@ func (rkd *runningK8sData) DaemonSets() ([]*models.K8sResource, error) {
 
 // Deployments method for runningK8sData
 func (rkd *runningK8sData) Deployments() ([]*models.K8sResource, error) {
-	ds, err := getDeployments(rkd.deploymentLister)
+	ds, err := GetDeployments(rkd.deploymentLister)
 	if err != nil {
 		return nil, err
 	}
@@ -269,6 +269,30 @@ func GetServicesModels(k RunningK8sData) ([]*models.K8sResource, error) {
 	return services, nil
 }
 
+// GetDaemonSets is a helper function that returns a slice of
+// DaemonSet objects given a daemonset.Lister interface
+func GetDaemonSets(dLister daemonset.Lister) ([]extensions.DaemonSet, error) {
+	ds, err := dLister.List(api.ListOptions{
+		LabelSelector: labels.Everything(),
+	})
+	if err != nil {
+		return nil, err
+	}
+	return ds.Items, nil
+}
+
+// GetDeployments is a helper function that returns a slice of
+// Deployment objects given a deployment.Lister interface
+func GetDeployments(depsLister deployment.Lister) ([]extensions.Deployment, error) {
+	deps, err := depsLister.List(api.ListOptions{
+		LabelSelector: labels.Everything(),
+	})
+	if err != nil {
+		return nil, err
+	}
+	return deps.Items, nil
+}
+
 // GetReplicationControllers is a helper function that returns a slice of
 // ReplicationController objects given a rc.Lister interface
 func GetReplicationControllers(rcLister rc.Lister) ([]api.ReplicationController, error) {
@@ -305,30 +329,6 @@ func getPods(podLister pod.Lister) ([]api.Pod, error) {
 	return pods.Items, nil
 }
 
-// getDaemonSets is a helper function that returns a slice of
-// DaemonSet objects given a daemonset.Lister interface
-func getDaemonSets(dsLister daemonset.Lister) ([]extensions.DaemonSet, error) {
-	daemonSets, err := dsLister.List(api.ListOptions{
-		LabelSelector: labels.Everything(),
-	})
-	if err != nil {
-		return []extensions.DaemonSet{}, err
-	}
-	return daemonSets.Items, nil
-}
-
-// getDeployments is a helper function that returns a slice of
-// Deployment objects given a deployment.Lister interface
-func getDeployments(dLister deployment.Lister) ([]extensions.Deployment, error) {
-	deployments, err := dLister.List(api.ListOptions{
-		LabelSelector: labels.Everything(),
-	})
-	if err != nil {
-		return []extensions.Deployment{}, err
-	}
-	return deployments.Items, nil
-}
-
 // getEvents is a helper function that returns a slice of
 // Event objects given an event.Lister interface
 func getEvents(eLister event.Lister) ([]api.Event, error) {

pkg/swagger/models/component.go

@@ -26,6 +26,10 @@ type Component struct {
 	Min Length: 1
 	*/
 	Name string `json:"name"`
+
+	/* type
+	 */
+	Type *string `json:"type,omitempty"`
 }
 
 // Validate validates this component

pkg/swagger/models/version.go

@@ -19,7 +19,7 @@ type Version struct {
 
 	/* data
 	 */
-	Data *Data `json:"data,omitempty"`
+	Data *VersionData `json:"data,omitempty"`
 
 	/* released
 
@@ -29,10 +29,9 @@ type Version struct {
 
 	/* train
 
-	Required: true
 	Min Length: 1
 	*/
-	Train string `json:"train"`
+	Train string `json:"train,omitempty"`
 
 	/* version
 
@@ -81,8 +80,8 @@ func (m *Version) validateReleased(formats strfmt.Registry) error {
 
 func (m *Version) validateTrain(formats strfmt.Registry) error {
 
-	if err := validate.RequiredString("train", "body", string(m.Train)); err != nil {
-		return err
+	if swag.IsZero(m.Train) { // not required
+		return nil
 	}
 
 	if err := validate.MinLength("train", "body", string(m.Train), 1); err != nil {

pkg/swagger/models/data.go pkg/swagger/models/version_data.gopkg/swagger/models/data.go renamed to pkg/swagger/models/version_data.go

@@ -11,11 +11,11 @@ import (
 	"github.com/go-swagger/go-swagger/httpkit/validate"
 )
 
-/*Data data
+/*VersionData version data
 
-swagger:model data
+swagger:model versionData
 */
-type Data struct {
+type VersionData struct {
 
 	/* description
 
@@ -28,10 +28,14 @@ type Data struct {
 	Min Length: 1
 	*/
 	Fixes string `json:"fixes,omitempty"`
+
+	/* image
+	 */
+	Image *string `json:"image,omitempty"`
 }
 
-// Validate validates this data
-func (m *Data) Validate(formats strfmt.Registry) error {
+// Validate validates this version data
+func (m *VersionData) Validate(formats strfmt.Registry) error {
 	var res []error
 
 	if err := m.validateDescription(formats); err != nil {
@@ -50,7 +54,7 @@ func (m *Data) Validate(formats strfmt.Registry) error {
 	return nil
 }
 
-func (m *Data) validateDescription(formats strfmt.Registry) error {
+func (m *VersionData) validateDescription(formats strfmt.Registry) error {
 
 	if swag.IsZero(m.Description) { // not required
 		return nil
@@ -63,7 +67,7 @@ func (m *Data) validateDescription(formats strfmt.Registry) error {
 	return nil
 }
 
-func (m *Data) validateFixes(formats strfmt.Registry) error {
+func (m *VersionData) validateFixes(formats strfmt.Registry) error {
 
 	if swag.IsZero(m.Fixes) { // not required
 		return nil