devfile 0.0.10.pre.alpha1 → 0.0.13.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ffc2558fc821c9b249b7ca050985cf42e747093c6f1268833c75d8e0880a72
-  data.tar.gz: 54e90aac87a83464f3dcf6e7421e8e4c12d7b671231e56d351f540d563ec10ff
+  metadata.gz: 794a08b4df806752813a0ab4df2561291220f1ffd1e52886688c2af7929b62ad
+  data.tar.gz: 21afe7859698dc11d52a0e26ec3dc24fb51749ae1ab6d2a2fc2dde1e96ac41b4
 SHA512:
-  metadata.gz: 44296fcffbb0418ecf18534b4fc999f0fb175b29959eb1fcbb205bbd2a0b5446d7506cb6a3ae6aa3a2e23b70263dc79cb4c04101afdff2a00a3ce0ef199e73b8
-  data.tar.gz: f3ff2153186857c6a5db7ca31151f4091a728065366d2a488b7e7fd91b2b3d609a07c881a01633cea31d05ed095325085d17086cc87cb0fb7642b490bed39391
+  metadata.gz: 63809486c1e80f8b5648a094409ffa2d47baa2e5837be47eb587634bb6a20e8cba49a3647faeda9a3add4082cc466955fec31a42941a36d40973d776eb2d9299
+  data.tar.gz: de34040a781b618c4dfa222cf5518cb77d6104b82df762ecf8bec51b72c479fcfe6d0dd2be338e920d5e1de5b71f84a27a50f02da44ff3ec5037978d173f53e0

data/ext/devfile.go

@@ -1,6 +1,5 @@
 package main
 
-import "C"
 import (
 	"bytes"
 	"strconv"
@@ -12,6 +11,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,6 +22,11 @@ type Devfile struct {
 	devfileObj parser.DevfileObj
 }
 
+type pvcOptions struct {
+	Name string
+	Size string
+}
+
 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 {
@@ -31,7 +36,7 @@ func (d Devfile) getDeployment(name, namespace string, labels, annotations map[s
 	if err != nil {
 		return nil, err
 	}
-	volumes, err := d.getVolumesAndVolumeMounts(containers, initContainers, name)
+	volumes, _, err := d.getVolumesAndVolumeMounts(containers, initContainers, name)
 	if err != nil {
 		return nil, err
 	}
@@ -146,6 +151,42 @@ 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) {
+	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
+	}
+	_, pvcNameToPvcOptions, err := d.getVolumesAndVolumeMounts(containers, initContainers, name)
+	if err != nil {
+		return nil, err
+	}
+
+	pvcs := make([]*corev1.PersistentVolumeClaim, 0)
+	for _, options := range pvcNameToPvcOptions {
+		quantity, err := resource.ParseQuantity(options.Size)
+		if err != nil {
+			return nil, err
+		}
+		pvcParams := generator.PVCParams{
+			TypeMeta: generator.GetTypeMeta("PersistentVolumeClaim", "v1"),
+			ObjectMeta: metav1.ObjectMeta{
+				Name:        options.Name,
+				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,6 +211,14 @@ 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
 }
 

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/ext/volume.go

@@ -9,44 +9,47 @@ import (
 	"strings"
 )
 
-func (d Devfile) getVolumesAndVolumeMounts(containers []corev1.Container, initContainers []corev1.Container, pvcNamePrefix string) ([]corev1.Volume, error) {
+func (d Devfile) getVolumesAndVolumeMounts(containers []corev1.Container, initContainers []corev1.Container, volumeNamePrefix string) ([]corev1.Volume, map[string]pvcOptions, error) {
 	containerComponents, err := d.devfileObj.Data.GetDevfileContainerComponents(common.DevfileOptions{})
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 	volumeComponents, err := d.devfileObj.Data.GetDevfileVolumeComponents(common.DevfileOptions{})
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 
 	var volumes []corev1.Volume
+	pvcNameToPvcOptions := map[string]pvcOptions{}
 	for _, volumeComponent := range volumeComponents {
-		volName := volumeComponent.Name
+		volumeName := fmt.Sprintf("%s-%s", volumeNamePrefix, volumeComponent.Name)
 		if bool(*volumeComponent.Volume.Ephemeral) == true {
-			emptyDir, err := getEmptyDir(volName, volumeComponent.Volume.Size)
+			emptyDir, err := getEmptyDir(volumeName, volumeComponent.Volume.Size)
 			if err != nil {
-				return nil, err
+				return nil, 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))
+			volumes = append(volumes, getPersistentVolumeClaim(volumeName, volumeName))
+			pvcNameToPvcOptions[volumeComponent.Name] = pvcOptions{
+				Name: volumeName,
+				Size: volumeComponent.Volume.Size,
+			}
 		}
 		// 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 {
+				if volumeComponent.Name == volumeMount.Name {
 					containerNameToMountPaths[containerComp.Name] = append(containerNameToMountPaths[containerComp.Name], generator.GetVolumeMountPath(volumeMount))
 				}
 			}
 		}
 
-		addVolumeMountToContainers(containers, initContainers, volName, containerNameToMountPaths)
+		addVolumeMountToContainers(containers, initContainers, volumeName, containerNameToMountPaths)
 	}
 
-	return volumes, nil
+	return volumes, pvcNameToPvcOptions, nil
 }
 
 // addVolumeMountToContainers adds the Volume Mounts in containerNameToMountPaths to the containers for a given pvc and volumeName
@@ -82,8 +85,8 @@ func addVolumeMountToContainers(containers []corev1.Container, initContainers []
 	}
 }
 
-// getPVC gets a pvc type volume with the given volume name and pvc name.
-func getPVC(volumeName, pvcName string) corev1.Volume {
+// getPersistentVolumeClaim gets a pvc type volume with the given volume name and pvc name.
+func getPersistentVolumeClaim(volumeName, pvcName string) corev1.Volume {
 
 	return corev1.Volume{
 		Name: volumeName,

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,23 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: devfile
 version: !ruby/object:Gem::Version
-  version: 0.0.10.pre.alpha1
+  version: 0.0.13.pre.alpha1
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-19 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:
-- "./ext/extconf.rb"
+extensions: []
 extra_rdoc_files: []
 files:
-- "./ext/extconf.rb"
+- bin/devfile
 - ext/devfile.go
 - ext/go.mod
 - ext/go.sum
@@ -44,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Parse and generate kubernetes manifests from a Devfile

data/ext/extconf.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-makefile_contents = "all:\n\techo \"Starting...\"\n\ninstall:\n\tmkdir -p ../bin && go build -o ../bin/devfile ./...\n\n"
-
-File.write('Makefile', makefile_contents)