Merge pull request #78 from metal3d/develop

Fixes template injection and variable names on volumes

Author: metal3d

.github/workflows/go-test.yaml

@@ -12,11 +12,11 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.21
+          go-version: 1.23
       - name: Install Helm
         run: |
           curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
@@ -37,4 +37,3 @@ jobs:
           slug: metal3d/katenary
           file: ./coverprofile.out
           fail_ci_if_error: true
-

Makefile

@@ -4,7 +4,7 @@ VERSION=$(shell git describe --exact-match --tags $(CUR_SHA) 2>/dev/null || echo
 CTN:=$(shell which podman 2>&1 1>/dev/null && echo "podman" || echo "docker")
 PREFIX=~/.local
 
-GOVERSION=1.22
+GOVERSION=1.23
 GO=container
 OUT=katenary
 BLD_CMD=go build -ldflags="-X 'katenary/generator.Version=$(VERSION)'" -o $(OUT)  ./cmd/katenary

doc/docs/labels.md

@@ -187,9 +187,10 @@ Health check to be added to the deployment.
 ```yaml
 labels:
   katenary.v3/health-check: |-
-    httpGet:
-      path: /health
-      port: 8080
+    livenessProbe:
+      httpGet:
+        path: /health
+        port: 8080
 ```
 
 ### katenary.v3/ignore

doc/docs/packages/generator.md

@@ -8,7 +8,7 @@ import "katenary/utils"
 
 Utils package provides some utility functions used in katenary. It defines some constants and functions used in the whole project.
 
-## func [Confirm](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L173>)
+## func [Confirm](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L174>)
 
 ```go
 func Confirm(question string, icon ...Icon) bool
@@ -26,14 +26,23 @@ func CountStartingSpaces(line string) int
 CountStartingSpaces counts the number of spaces at the beginning of a string.
 
 <a name="EncodeBasicYaml"></a>
-## func [EncodeBasicYaml](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L185>)
+## func [EncodeBasicYaml](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L186>)
 
 ```go
 func EncodeBasicYaml(data any) ([]byte, error)
 ```
 
 EncodeBasicYaml encodes a basic yaml from an interface.
 
+<a name="FixedResourceName"></a>
+## func [FixedResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L198>)
+
+```go
+func FixedResourceName(name string) string
+```
+
+FixedResourceName returns a resource name without underscores to respect the kubernetes naming convention.
+
 <a name="GetContainerByName"></a>
 ## func [GetContainerByName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L89>)
 
@@ -62,7 +71,7 @@ func GetServiceNameByPort(port int) string
 GetServiceNameByPort returns the service name for a port. It the service name is not found, it returns an empty string.
 
 <a name="GetValuesFromLabel"></a>
-## func [GetValuesFromLabel](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L130>)
+## func [GetValuesFromLabel](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L131>)
 
 ```go
 func GetValuesFromLabel(service types.ServiceConfig, LabelValues string) map[string]*EnvConfig
@@ -89,7 +98,7 @@ func Int32Ptr(i int32) *int32
 Int32Ptr returns a pointer to an int32.
 
 <a name="MapKeys"></a>
-## func [MapKeys](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L164>)
+## func [MapKeys](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L165>)
 
 ```go
 func MapKeys(m map[string]interface{}) []string
@@ -143,7 +152,7 @@ func Warn(msg ...interface{})
 Warn prints a warning message
 
 <a name="WordWrap"></a>
-## func [WordWrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L160>)
+## func [WordWrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L161>)
 
 ```go
 func WordWrap(text string, lineWidth int) string
@@ -170,7 +179,7 @@ func WrapBytes(src, above, below []byte) []byte
 WrapBytes wraps a byte array with a byte array above and below. It will respect the indentation of the src string.
 
 <a name="EnvConfig"></a>
-## type [EnvConfig](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L124-L127>)
+## type [EnvConfig](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L125-L128>)
 
 EnvConfig is a struct to hold the description of an environment variable.
 

doc/docs/packages/utils.md

@@ -232,5 +232,9 @@ func (c *ConfigMap) SetData(data map[string]string) {
 
 // Yaml returns the yaml representation of the configmap
 func (c *ConfigMap) Yaml() ([]byte, error) {
-	return yaml.Marshal(c)
+	if o, err := yaml.Marshal(c); err != nil {
+		return nil, err
+	} else {
+		return UnWrapTPL(o), nil
+	}
 }

generator/configMap.go

@@ -1,6 +1,8 @@
 package generator
 
 import (
+	"katenary/generator/labelStructs"
+	"katenary/utils"
 	"log"
 	"strings"
 
@@ -9,9 +11,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
-
-	"katenary/generator/labelStructs"
-	"katenary/utils"
 )
 
 // only used to check interface implementation
@@ -120,5 +119,9 @@ func (c *CronJob) Filename() string {
 //
 // Implements the Yaml interface.
 func (c *CronJob) Yaml() ([]byte, error) {
-	return yaml.Marshal(c)
+	if o, err := yaml.Marshal(c); err != nil {
+		return nil, err
+	} else {
+		return UnWrapTPL(o), nil
+	}
 }

generator/cronJob.go

@@ -370,6 +370,7 @@ func (d *Deployment) Yaml() ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
+	y = UnWrapTPL(y)
 
 	// for each volume mount, add a condition "if values has persistence"
 	changing := false
@@ -399,6 +400,7 @@ func (d *Deployment) Yaml() ([]byte, error) {
 		if strings.Contains(volume, "mountPath: ") {
 			spaces = strings.Repeat(" ", utils.CountStartingSpaces(volume))
 			varName := d.volumeMap[volumeName]
+			varName = strings.ReplaceAll(varName, "-", "_")
 			content[line] = spaces + `{{- if .Values.` + serviceName + `.persistence.` + varName + `.enabled }}` + "\n" + volume
 			changing = true
 		}
@@ -442,6 +444,7 @@ func (d *Deployment) Yaml() ([]byte, error) {
 		if strings.Contains(line, "- name: ") && inVolumes {
 			spaces = strings.Repeat(" ", utils.CountStartingSpaces(line))
 			varName := d.volumeMap[volumeName]
+			varName = strings.ReplaceAll(varName, "-", "_")
 			content[i] = spaces + `{{- if .Values.` + serviceName + `.persistence.` + varName + `.enabled }}` + "\n" + line
 			changing = true
 		}

generator/deployment.go

@@ -271,6 +271,7 @@ func buildVolumes(service types.ServiceConfig, chart *HelmChart, deployments map
 		}
 		switch v.Type {
 		case "volume":
+			v.Source = strings.ReplaceAll(v.Source, "-", "_")
 			pvc := NewVolumeClaim(service, v.Source, appName)
 
 			// if the service is integrated in another deployment, we need to add the volume

generator/generator.go

@@ -1,16 +1,15 @@
 package generator
 
 import (
+	"katenary/generator/labelStructs"
+	"katenary/utils"
 	"log"
 	"strings"
 
 	"github.com/compose-spec/compose-go/types"
 	networkv1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
-
-	"katenary/generator/labelStructs"
-	"katenary/utils"
 )
 
 var _ Yaml = (*Ingress)(nil)
@@ -129,6 +128,7 @@ func (ingress *Ingress) Yaml() ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
+	ret = UnWrapTPL(ret)
 
 	lines := strings.Split(string(ret), "\n")
 	out := []string{

generator/ingress.go

@@ -1,13 +1,13 @@
 package generator
 
 import (
+	"katenary/utils"
+
 	"github.com/compose-spec/compose-go/types"
 	corev1 "k8s.io/api/core/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
-
-	"katenary/utils"
 )
 
 var (
@@ -121,7 +121,11 @@ func (r *Role) Filename() string {
 }
 
 func (r *Role) Yaml() ([]byte, error) {
-	return yaml.Marshal(r)
+	if o, err := yaml.Marshal(r); err != nil {
+		return nil, err
+	} else {
+		return UnWrapTPL(o), nil
+	}
 }
 
 // ServiceAccount is a kubernetes ServiceAccount.

generator/rbac.go

@@ -3,14 +3,13 @@ package generator
 import (
 	"encoding/base64"
 	"fmt"
+	"katenary/utils"
 	"strings"
 
 	"github.com/compose-spec/compose-go/types"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
-
-	"katenary/utils"
 )
 
 var (
@@ -102,6 +101,7 @@ func (s *Secret) Yaml() ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
+	y = UnWrapTPL(y)
 
 	// replace the b64 value by the real value
 	for _, value := range s.Data {

generator/secret.go

@@ -1,6 +1,7 @@
 package generator
 
 import (
+	"katenary/utils"
 	"regexp"
 	"strings"
 
@@ -9,8 +10,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
 	"sigs.k8s.io/yaml"
-
-	"katenary/utils"
 )
 
 var _ Yaml = (*Service)(nil)
@@ -82,6 +81,11 @@ func (s *Service) Filename() string {
 // Yaml returns the yaml representation of the service.
 func (s *Service) Yaml() ([]byte, error) {
 	y, err := yaml.Marshal(s)
+	if err != nil {
+		return nil, err
+	}
+	y = UnWrapTPL(y)
+
 	lines := []string{}
 	for _, line := range strings.Split(string(y), "\n") {
 		if regexp.MustCompile(`^\s*loadBalancer:\s*`).MatchString(line) {

generator/service.go

@@ -1,16 +1,18 @@
 package generator
 
 import (
+	"katenary/generator/labelStructs"
+	"katenary/utils"
+	"regexp"
 	"strconv"
 	"strings"
 
 	"github.com/compose-spec/compose-go/types"
 	corev1 "k8s.io/api/core/v1"
-
-	"katenary/generator/labelStructs"
-	"katenary/utils"
 )
 
+var regexpLineWrap = regexp.MustCompile(`\n\s+}}`)
+
 // findDeployment finds the corresponding target deployment for a service.
 func findDeployment(serviceName string, deployments map[string]*Deployment) *Deployment {
 	for _, d := range deployments {
@@ -77,3 +79,8 @@ func isIgnored(service types.ServiceConfig) bool {
 	}
 	return false
 }
+
+// UnWrapTPL removes the line wrapping from a template.
+func UnWrapTPL(in []byte) []byte {
+	return regexpLineWrap.ReplaceAll(in, []byte(" }}"))
+}

generator/utils.go

@@ -92,6 +92,7 @@ func (v *Value) AddIngress(host, path string) {
 
 // AddPersistence adds persistence configuration to the Value.
 func (v *Value) AddPersistence(volumeName string) {
+	volumeName = strings.ReplaceAll(volumeName, "-", "_")
 	if v.Persistence == nil {
 		v.Persistence = make(map[string]*PersistenceValue, 0)
 	}

generator/values.go

@@ -76,6 +76,8 @@ func (v *VolumeClaim) Yaml() ([]byte, error) {
 		return nil, err
 	}
 
+	out = UnWrapTPL(out)
+
 	// replace 1Gi to {{ .Values.serviceName.volume.size }}
 	out = []byte(
 		strings.Replace(