devfile 0.0.11.pre.alpha1-x86_64-linux → 0.0.12.pre.alpha1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1791e8e7ff6b1f3de970040c705db46fef04cfb524b95f1e0a41d57f97e6d61d
-  data.tar.gz: 26ede5ee22624b25fa8142879703a1c80b0fd78bf7e6598da89eec1c4310afbe
+  metadata.gz: 1cc3363280657ceecbb55931395fc354e8d13cb814c2a83b11dd679e0a67edd6
+  data.tar.gz: b8bdad6991ddc7a87cd72c49fc2d684f8fe055245ae8747136e08df8608a7bd0
 SHA512:
-  metadata.gz: cfba06a846d7ec1a8c18b51cf86d4ff1c96af5ccef21df42e21ddfe0004bcbefabc4fde89c86c67077c1769b44a0a3d4ef7cd237278324b6c26090d8fd2e3b8d
-  data.tar.gz: de8183ccfddadb4e3e59a21df545cedcd2b59967c3be488bccf93e8882c37e8e3bc728dbb670dbc62e15460b9f7bfa35ac517acb89421ea24569dcf140a21e19
+  metadata.gz: 928d238a1651d90afb2d1e81e8eafbfbbbb421487a51a21eba8b5262f6649619fcedcbc25ea1bcb4db2632e6e011491eb3abc41bd4736fc3540f2c14fe3b6ef6
+  data.tar.gz: 2dec36f8b4bd994a41cc3b20c2fb7099b54558dc1864dcd80b13594a036d84c55932d688dc595b38652c0479329e616ee92090f09a8fb0388877b638d1213a47

data/ext/devfile.go

@@ -1,8 +1,9 @@
 package main
 
-import "C"
 import (
 	"bytes"
+	"fmt"
+	"sort"
 	"strconv"
 	"text/template"
 
@@ -12,6 +13,7 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/cli-runtime/pkg/printers"
@@ -22,16 +24,14 @@ type Devfile struct {
 	devfileObj parser.DevfileObj
 }
 
+type volumeOptions struct {
+	Info        generator.VolumeInfo
+	Size        string
+	IsEphemeral bool
+}
+
 func (d Devfile) getDeployment(name, namespace string, labels, annotations map[string]string, replicas int) (*appsv1.Deployment, error) {
-	containers, err := generator.GetContainers(d.devfileObj, common.DevfileOptions{})
-	if err != nil {
-		return nil, err
-	}
-	initContainers, err := generator.GetInitContainers(d.devfileObj)
-	if err != nil {
-		return nil, err
-	}
-	volumes, err := d.getVolumesAndVolumeMounts(containers, initContainers, name)
+	containers, initContainers, volumes, _, err := d.getContainersAndVolumes(name)
 	if err != nil {
 		return nil, err
 	}
@@ -146,6 +146,37 @@ func (d Devfile) getIngress(name, namespace string, labels, annotations map[stri
 	return ingress, nil
 }
 
+func (d Devfile) getPVC(name, namespace string, labels, annotations map[string]string) ([]*corev1.PersistentVolumeClaim, error) {
+	_, _, volumes, volumeNameToVolumeOptions, err := d.getContainersAndVolumes(name)
+	if err != nil {
+		return nil, err
+	}
+	pvcs := make([]*corev1.PersistentVolumeClaim, 0)
+	for _, volume := range volumes {
+		volumeOptions := volumeNameToVolumeOptions[volume.Name]
+		if volumeOptions.IsEphemeral {
+			continue
+		}
+		quantity, err := resource.ParseQuantity(volumeOptions.Size)
+		if err != nil {
+			return nil, err
+		}
+		pvcParams := generator.PVCParams{
+			TypeMeta: generator.GetTypeMeta("PersistentVolumeClaim", "v1"),
+			ObjectMeta: metav1.ObjectMeta{
+				Name:        volumeOptions.Info.PVCName,
+				Namespace:   namespace,
+				Labels:      labels,
+				Annotations: annotations,
+			},
+			Quantity: quantity,
+		}
+		pvc := generator.GetPVC(pvcParams)
+		pvcs = append(pvcs, pvc)
+	}
+	return pvcs, nil
+}
+
 func (d Devfile) getAll(name, namespace string, labels, annotations map[string]string, replicas int, domainTemplate, ingressClass string) ([]runtime.Object, error) {
 
 	var result []runtime.Object
@@ -170,9 +201,76 @@ func (d Devfile) getAll(name, namespace string, labels, annotations map[string]s
 		result = append(result, ingress)
 	}
 
+	pvcs, err := d.getPVC(name, namespace, labels, annotations)
+	if err != nil {
+		return nil, err
+	}
+	for _, pvc := range pvcs {
+		result = append(result, pvc)
+	}
+
 	return result, nil
 }
 
+func (d Devfile) getContainersAndVolumes(name string) ([]corev1.Container, []corev1.Container, []corev1.Volume, map[string]volumeOptions, error) {
+	containers, err := generator.GetContainers(d.devfileObj, common.DevfileOptions{})
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	initContainers, err := generator.GetInitContainers(d.devfileObj)
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	allContainers := append(containers, initContainers...)
+
+	volumeComponents, err := d.devfileObj.Data.GetDevfileVolumeComponents(common.DevfileOptions{})
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	volumeNameToVolumeOptions := map[string]volumeOptions{}
+	volumeNameToVolumeInfo := map[string]generator.VolumeInfo{}
+	for _, volumeComponent := range volumeComponents {
+		info := generator.VolumeInfo{
+			PVCName:    fmt.Sprintf("%s-%s", name, volumeComponent.Name),
+			VolumeName: volumeComponent.Name,
+		}
+		volumeNameToVolumeInfo[volumeComponent.Name] = info
+		volumeNameToVolumeOptions[volumeComponent.Name] = volumeOptions{
+			Info:        info,
+			Size:        volumeComponent.Volume.Size,
+			IsEphemeral: *volumeComponent.Volume.Ephemeral,
+		}
+	}
+
+	volumeParams := generator.VolumeParams{
+		Containers:             allContainers,
+		VolumeNameToVolumeInfo: volumeNameToVolumeInfo,
+	}
+	options := common.DevfileOptions{}
+	// "containers" and "initContainers" are updated in place with the volume mounts parameters
+	// after the following function is called
+	volumes, err := generator.GetVolumesAndVolumeMounts(d.devfileObj, volumeParams, options)
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	// sort all volumes and volume mounts in the containers and initContainers
+	// to keep the array order deterministic
+	sort.SliceStable(volumes, func(i, j int) bool {
+		return volumes[i].Name < volumes[j].Name
+	})
+	for _, container := range containers {
+		sort.SliceStable(container.VolumeMounts, func(i, j int) bool {
+			return container.VolumeMounts[i].Name < container.VolumeMounts[j].Name
+		})
+	}
+	for _, initContainer := range initContainers {
+		sort.SliceStable(initContainer.VolumeMounts, func(i, j int) bool {
+			return initContainer.VolumeMounts[i].Name < initContainer.VolumeMounts[j].Name
+		})
+	}
+	return containers, initContainers, volumes, volumeNameToVolumeOptions, nil
+}
+
 func (d Devfile) hasContainerComponents() (bool, error) {
 	containers, err := generator.GetContainers(d.devfileObj, common.DevfileOptions{})
 	if err != nil {

data/ext/go.mod

@@ -1,4 +1,4 @@
-module gitlab.com/gitlab-org/incubation-engineering/server-runtime/devfilerubyffi
+module gitlab-org/remote-development/devfile-gem
 
 go 1.18
 
@@ -7,6 +7,7 @@ require (
 	k8s.io/api v0.26.1
 	k8s.io/apimachinery v0.26.1
 	k8s.io/cli-runtime v0.26.1
+	sigs.k8s.io/yaml v1.3.0
 )
 
 require (
@@ -115,5 +116,4 @@ require (
 	sigs.k8s.io/controller-runtime v0.13.1 // indirect
 	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
-	sigs.k8s.io/yaml v1.3.0 // indirect
 )

data/ext/main.go

@@ -30,6 +30,8 @@ func main() {
 		content, err = getService(devfile, args[3], args[4], args[5], args[6])
 	case "ingress":
 		content, err = getIngress(devfile, args[3], args[4], args[5], args[6], args[7], args[8])
+	case "pvc":
+		content, err = getPVC(devfile, args[3], args[4], args[5], args[6])
 	case "all":
 		content, err = getAll(devfile, args[3], args[4], args[5], args[6], args[7], args[8], args[9])
 	case "flatten":
@@ -62,8 +64,8 @@ func getDeployment(devfile, name, namespace, labelsStr, annotationsStr, replicas
 	if err != nil {
 		return "", err
 	}
-	if exists == false {
-		return "", err
+	if !exists {
+		return "", nil
 	}
 	labels, err := unmarshalKeyValuePair(labelsStr)
 	if err != nil {
@@ -97,8 +99,8 @@ func getService(devfile, name, namespace, labelsStr, annotationsStr string) (str
 	if err != nil {
 		return "", err
 	}
-	if exists == false {
-		return "", err
+	if !exists {
+		return "", nil
 	}
 	labels, err := unmarshalKeyValuePair(labelsStr)
 	if err != nil {
@@ -128,8 +130,8 @@ func getIngress(devfile, name, namespace, labelsStr, annotationsStr, domainTempl
 	if err != nil {
 		return "", err
 	}
-	if exists == false {
-		return "", err
+	if !exists {
+		return "", nil
 	}
 	labels, err := unmarshalKeyValuePair(labelsStr)
 	if err != nil {
@@ -155,7 +157,7 @@ func getIngress(devfile, name, namespace, labelsStr, annotationsStr, domainTempl
 	return content, nil
 }
 
-func getAll(devfile string, name, namespace, labelsStr, annotationsStr, replicas, domainTemplate, ingressClass string) (string, error) {
+func getPVC(devfile, name, namespace, labelsStr, annotationsStr string) (string, error) {
 	d, err := parseDevfile(devfile)
 	if err != nil {
 		return "", err
@@ -164,9 +166,44 @@ func getAll(devfile string, name, namespace, labelsStr, annotationsStr, replicas
 	if err != nil {
 		return "", err
 	}
-	if exists == false {
+	if !exists {
+		return "", nil
+	}
+	labels, err := unmarshalKeyValuePair(labelsStr)
+	if err != nil {
+		return "", err
+	}
+	annotations, err := unmarshalKeyValuePair(annotationsStr)
+	if err != nil {
+		return "", err
+	}
+	pvcs, err := d.getPVC(name, namespace, labels, annotations)
+	if err != nil {
+		return "", err
+	}
+	var result []runtime.Object
+	for _, pvc := range pvcs {
+		result = append(result, pvc)
+	}
+	content, err := marshalResources(result)
+	if err != nil {
+		return "", err
+	}
+	return content, nil
+}
+
+func getAll(devfile string, name, namespace, labelsStr, annotationsStr, replicas, domainTemplate, ingressClass string) (string, error) {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return "", err
+	}
+	exists, err := d.hasContainerComponents()
+	if err != nil {
 		return "", err
 	}
+	if !exists {
+		return "", nil
+	}
 	labels, err := unmarshalKeyValuePair(labelsStr)
 	if err != nil {
 		return "", err

data/lib/devfile.rb

@@ -39,6 +39,16 @@ module Devfile
         stdout
       end
 
+      def get_pvc(devfile, name, namespace, labels, annotations)
+        stdout, stderr, status = Open3.capture3(
+          "#{FILE_PATH} deployment '#{devfile}' #{name} #{namespace} '#{labels}' '#{annotations}'"
+        )
+
+        raise stderr unless status.success?
+
+        stdout
+      end
+
       def get_all(devfile, name, namespace, labels, annotations, replicas, domain_template, ingress_class)
         stdout, stderr, status = Open3.capture3(
           "#{FILE_PATH} all '#{devfile}' #{name} #{namespace}  '#{labels}' '#{annotations}' #{replicas} #{domain_template} #{ingress_class}"

metadata

@@ -1,17 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: devfile
 version: !ruby/object:Gem::Version
-  version: 0.0.11.pre.alpha1
+  version: 0.0.12.pre.alpha1
 platform: x86_64-linux
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Library used to generate kubernetes manifests from a Devfile.
-email: spatnaik@gitlab.com
+email:
+- cwoolley@gitlab.com
+- vtak@gitlab.com
+- spatnaik@gitlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -21,7 +24,6 @@ files:
 - ext/go.mod
 - ext/go.sum
 - ext/main.go
-- ext/volume.go
 - lib/devfile.rb
 homepage: https://gitlab.com
 licenses:

data/ext/volume.go

@@ -1,114 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"github.com/devfile/library/v2/pkg/devfile/generator"
-	"github.com/devfile/library/v2/pkg/devfile/parser/data/v2/common"
-	corev1 "k8s.io/api/core/v1"
-	"k8s.io/apimachinery/pkg/api/resource"
-	"strings"
-)
-
-func (d Devfile) getVolumesAndVolumeMounts(containers []corev1.Container, initContainers []corev1.Container, pvcNamePrefix string) ([]corev1.Volume, error) {
-	containerComponents, err := d.devfileObj.Data.GetDevfileContainerComponents(common.DevfileOptions{})
-	if err != nil {
-		return nil, err
-	}
-	volumeComponents, err := d.devfileObj.Data.GetDevfileVolumeComponents(common.DevfileOptions{})
-	if err != nil {
-		return nil, err
-	}
-
-	var volumes []corev1.Volume
-	for _, volumeComponent := range volumeComponents {
-		volName := volumeComponent.Name
-		if bool(*volumeComponent.Volume.Ephemeral) == true {
-			emptyDir, err := getEmptyDir(volName, volumeComponent.Volume.Size)
-			if err != nil {
-				return nil, err
-			}
-			volumes = append(volumes, emptyDir)
-		} else {
-			// TODO: figure this out; how should we pass PVC name? should the object be generated here?
-			pvcName := fmt.Sprintf("%s-%s", pvcNamePrefix, volName)
-			volumes = append(volumes, getPVC(volName, pvcName))
-		}
-		// containerNameToMountPaths is a map of the Devfile container name to their Devfile Volume Mount Paths for a given Volume Name
-		containerNameToMountPaths := make(map[string][]string)
-		for _, containerComp := range containerComponents {
-			for _, volumeMount := range containerComp.Container.VolumeMounts {
-				if volName == volumeMount.Name {
-					containerNameToMountPaths[containerComp.Name] = append(containerNameToMountPaths[containerComp.Name], generator.GetVolumeMountPath(volumeMount))
-				}
-			}
-		}
-
-		addVolumeMountToContainers(containers, initContainers, volName, containerNameToMountPaths)
-	}
-
-	return volumes, nil
-}
-
-// addVolumeMountToContainers adds the Volume Mounts in containerNameToMountPaths to the containers for a given pvc and volumeName
-// containerNameToMountPaths is a map of a container name to an array of its Mount Paths.
-// To be moved to devfile/library.
-func addVolumeMountToContainers(containers []corev1.Container, initContainers []corev1.Container, volumeName string, containerNameToMountPaths map[string][]string) {
-
-	for containerName, mountPaths := range containerNameToMountPaths {
-		for i := range containers {
-			if containers[i].Name == containerName {
-				for _, mountPath := range mountPaths {
-					containers[i].VolumeMounts = append(containers[i].VolumeMounts, corev1.VolumeMount{
-						Name:      volumeName,
-						MountPath: mountPath,
-						SubPath:   "",
-					},
-					)
-				}
-			}
-		}
-		for i := range initContainers {
-			if strings.HasPrefix(initContainers[i].Name, containerName) {
-				for _, mountPath := range mountPaths {
-					initContainers[i].VolumeMounts = append(initContainers[i].VolumeMounts, corev1.VolumeMount{
-						Name:      volumeName,
-						MountPath: mountPath,
-						SubPath:   "",
-					},
-					)
-				}
-			}
-		}
-	}
-}
-
-// getPVC gets a pvc type volume with the given volume name and pvc name.
-func getPVC(volumeName, pvcName string) corev1.Volume {
-
-	return corev1.Volume{
-		Name: volumeName,
-		VolumeSource: corev1.VolumeSource{
-			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
-				ClaimName: pvcName,
-			},
-		},
-	}
-}
-
-// getEmptyDir gets an emptyDir type volume with the given volume name and size.
-// size should be parseable as a Kubernetes `Quantity` or an error will be returned
-func getEmptyDir(volumeName string, size string) (corev1.Volume, error) {
-
-	emptyDir := &corev1.EmptyDirVolumeSource{}
-	qty, err := resource.ParseQuantity(size)
-	if err != nil {
-		return corev1.Volume{}, err
-	}
-	emptyDir.SizeLimit = &qty
-	return corev1.Volume{
-		Name: volumeName,
-		VolumeSource: corev1.VolumeSource{
-			EmptyDir: emptyDir,
-		},
-	}, nil
-}