devfile 0.0.5.pre.alpha1-x86_64-linux

data/ext/main.go

@@ -0,0 +1,203 @@
+package main
+
+import (
+	"fmt"
+	"k8s.io/apimachinery/pkg/util/yaml"
+	"os"
+	"strconv"
+
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+type Result struct {
+	content string
+	err     error
+}
+
+func main() {
+	args := os.Args
+
+	if len(args) <= 1 {
+		fmt.Fprint(os.Stderr, "Function name and devfile are required")
+		os.Exit(1)
+	}
+
+	fnName := os.Args[1]
+	devfile := os.Args[2]
+
+	var result Result
+
+	switch fnName {
+	case "deployment":
+		result = getDeployment(devfile, args[3], args[4], args[5], args[6], args[7])
+	case "service":
+		result = getService(devfile, args[3], args[4], args[5], args[6])
+	case "ingress":
+		result = getIngress(devfile, args[3], args[4], args[5], args[6], args[7], args[8])
+	case "all":
+		result = getAll(devfile, args[3], args[4], args[5], args[6], args[7], args[8], args[9])
+	case "flatten":
+		result = flatten(devfile)
+	}
+
+	if result.err != nil {
+		fmt.Fprint(os.Stderr, result.err)
+		os.Exit(1)
+	}
+
+	fmt.Print(result.content)
+}
+
+func unmarshalKeyValuePair(data string) (map[string]string, error) {
+	values := map[string]string{}
+	err := yaml.Unmarshal([]byte(data), &values)
+	if err != nil {
+		return nil, err
+	}
+	return values, err
+}
+
+func getDeployment(devfile, name, namespace, labelsStr, annotationsStr, replicas string) Result {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	exists, err := d.hasContainerComponents()
+	if err != nil {
+		return Result{"", err}
+	}
+	if exists == false {
+		return Result{"", err}
+	}
+	labels, err := unmarshalKeyValuePair(labelsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	annotations, err := unmarshalKeyValuePair(annotationsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	replicasInt, err := strconv.Atoi(replicas)
+	if err != nil {
+		return Result{"", err}
+	}
+	deployment, err := d.getDeployment(name, namespace, labels, annotations, replicasInt)
+	if err != nil {
+		return Result{"", err}
+	}
+	content, err := marshalResources([]runtime.Object{deployment})
+	if err != nil {
+		return Result{"", err}
+	}
+	return Result{content, nil}
+}
+
+func getService(devfile, name, namespace, labelsStr, annotationsStr string) Result {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	exists, err := d.hasContainerComponents()
+	if err != nil {
+		return Result{"", err}
+	}
+	if exists == false {
+		return Result{"", err}
+	}
+	labels, err := unmarshalKeyValuePair(labelsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	annotations, err := unmarshalKeyValuePair(annotationsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	service, err := d.getService(name, namespace, labels, annotations)
+	if err != nil {
+		return Result{"", err}
+	}
+	content, err := marshalResources([]runtime.Object{service})
+	if err != nil {
+		return Result{"", err}
+	}
+	return Result{content, nil}
+}
+
+func getIngress(devfile, name, namespace, labelsStr, annotationsStr, domainTemplate, ingressClass string) Result {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	exists, err := d.hasContainerComponents()
+	if err != nil {
+		return Result{"", err}
+	}
+	if exists == false {
+		return Result{"", err}
+	}
+	labels, err := unmarshalKeyValuePair(labelsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	annotations, err := unmarshalKeyValuePair(annotationsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	ingress, err := d.getIngress(name, namespace, labels, annotations, domainTemplate, ingressClass)
+	if err != nil {
+		return Result{"", err}
+	}
+	content, err := marshalResources([]runtime.Object{ingress})
+	if err != nil {
+		return Result{"", err}
+	}
+	return Result{content, nil}
+}
+
+func getAll(devfile string, name, namespace, labelsStr, annotationsStr, replicas, domainTemplate, ingressClass string) Result {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	exists, err := d.hasContainerComponents()
+	if err != nil {
+		return Result{"", err}
+	}
+	if exists == false {
+		return Result{"", err}
+	}
+	labels, err := unmarshalKeyValuePair(labelsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	annotations, err := unmarshalKeyValuePair(annotationsStr)
+	if err != nil {
+		return Result{"", err}
+	}
+	replicasInt, err := strconv.Atoi(replicas)
+	if err != nil {
+		return Result{"", err}
+	}
+	resources, err := d.getAll(name, namespace, labels, annotations, replicasInt, domainTemplate, ingressClass)
+	if err != nil {
+		return Result{"", err}
+	}
+	content, err := marshalResources(resources)
+	if err != nil {
+		return Result{"", err}
+	}
+	return Result{content, nil}
+}
+
+func flatten(devfile string) Result {
+	d, err := parseDevfile(devfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	flattenedDevfile := d.getFlattenedDevfileContent()
+	content, err := marshalDevfile(flattenedDevfile)
+	if err != nil {
+		return Result{"", err}
+	}
+	return Result{content, nil}
+}

data/ext/volume.go

@@ -0,0 +1,114 @@
+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
+}

data/lib/devfile.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+# Module that works with the Devfile standard
+module Devfile
+  # Set of services to parse a devfile and output k8s manifests
+  class Parser
+    FILE_PATH = File.expand_path('./../bin/devfile', File.dirname(__FILE__))
+
+    class << self
+      def get_deployment(devfile, name, namespace, labels, annotations, replicas)
+        stdout, stderr, status = Open3.capture3(
+          "#{FILE_PATH} deployment '#{devfile}' #{name} #{namespace} '#{labels}' '#{annotations}' #{replicas}"
+        )
+
+        raise stderr unless status.success?
+
+        stdout
+      end
+
+      def get_service(devfile, name, namespace, labels, annotations)
+        stdout, stderr, status = Open3.capture3(
+          "#{FILE_PATH} service '#{devfile}' #{name} #{namespace} '#{labels}' '#{annotations}'"
+        )
+
+        raise stderr unless status.success?
+
+        stdout
+      end
+
+      def get_ingress(devfile, name, namespace, labels, annotations, domain_template, ingress_class)
+        stdout, stderr, status = Open3.capture3(
+          "#{FILE_PATH} ingress '#{devfile}' #{name} #{namespace} '#{labels}' '#{annotations}' #{domain_template} #{ingress_class}"
+        )
+
+        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}"
+        )
+
+        raise stderr unless status.success?
+
+        stdout
+      end
+
+      def flatten(devfile)
+        stdout, stderr, status = Open3.capture3("#{FILE_PATH} flatten '#{devfile}'")
+
+        raise stderr unless status.success?
+
+        stdout
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: devfile
+version: !ruby/object:Gem::Version
+  version: 0.0.5.pre.alpha1
+platform: x86_64-linux
+authors:
+- GitLab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-09 00:00:00.000000000 Z
+dependencies: []
+description: Library used to generate kubernetes manifests from a Devfile.
+email: spatnaik@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/devfile
+- ext/devfile.go
+- ext/go.mod
+- ext/go.sum
+- ext/main.go
+- ext/volume.go
+- lib/devfile.rb
+homepage: https://gitlab.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://gitlab.com/gitlab-org/remote-development/devfile-gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Parse and generate kubernetes manifests from a Devfile
+test_files: []