Big refactorization

- reduce complexity
- use better tools to format the code
- add more tests
- and too many things to list here

We are rewriting for V3, so these commits are sometimes big and not
fully detailed. Of course, further work will be more documented.

Author: metal3d

cmd/katenary/main.go

@@ -9,11 +9,11 @@ import (
 	"os"
 	"strings"
 
-	"katenary/generator"
-	"katenary/utils"
-
 	"github.com/compose-spec/compose-go/cli"
 	"github.com/spf13/cobra"
+
+	"katenary/generator"
+	"katenary/utils"
 )
 
 const longHelp = `Katenary is a tool to convert compose files to Helm Charts.

doc/docs/packages/cmd/katenary.md

@@ -17,7 +17,7 @@ func NotesFile(services []string) string
 NotesFile returns the content of the note.txt file.
 
 <a name="ReadMeFile"></a>
-## func [ReadMeFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L25>)
+## func [ReadMeFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L24>)
 
 ```go
 func ReadMeFile(charname, description string, values map[string]any) string

doc/docs/packages/generator.md

@@ -158,7 +158,7 @@ func PortsFrom(data string) (Ports, error)
 PortsFrom returns a Ports from the given string.
 
 <a name="Probe"></a>
-## type [Probe](<https://github.com/metal3d/katenary/blob/develop/generator/labelStructs/probes.go#L8-L11>)
+## type [Probe](<https://github.com/metal3d/katenary/blob/develop/generator/labelStructs/probes.go#L11-L14>)
 
 
 
@@ -170,7 +170,7 @@ type Probe struct {
 ```
 
 <a name="ProbeFrom"></a>
-### func [ProbeFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labelStructs/probes.go#L13>)
+### func [ProbeFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labelStructs/probes.go#L16>)
 
 ```go
 func ProbeFrom(data string) (*Probe, error)

doc/docs/packages/generator/extrafiles.md

@@ -8,16 +8,34 @@ import "katenary/utils"
 
 Utils package provides some utility functions used in katenary. It defines some constants and functions used in the whole project.
 
-## func [CountStartingSpaces](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L31>)
+## func [Confirm](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L167>)
+
+```go
+func Confirm(question string, icon ...Icon) bool
+```
+
+Confirm asks a question and returns true if the answer is y.
+
+<a name="CountStartingSpaces"></a>
+## func [CountStartingSpaces](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L33>)
 
 ```go
 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#L179>)
+
+```go
+func EncodeBasicYaml(data any) ([]byte, error)
+```
+
+EncodeBasicYaml encodes a basic yaml from an interface.
+
 <a name="GetContainerByName"></a>
-## func [GetContainerByName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L82>)
+## func [GetContainerByName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L84>)
 
 ```go
 func GetContainerByName(name string, containers []corev1.Container) (*corev1.Container, int)
@@ -26,7 +44,7 @@ func GetContainerByName(name string, containers []corev1.Container) (*corev1.Con
 GetContainerByName returns a container by name and its index in the array. It returns nil, \-1 if not found.
 
 <a name="GetKind"></a>
-## func [GetKind](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L44>)
+## func [GetKind](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L46>)
 
 ```go
 func GetKind(path string) (kind string)
@@ -35,7 +53,7 @@ func GetKind(path string) (kind string)
 GetKind returns the kind of the resource from the file path.
 
 <a name="GetServiceNameByPort"></a>
-## func [GetServiceNameByPort](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L72>)
+## func [GetServiceNameByPort](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L74>)
 
 ```go
 func GetServiceNameByPort(port int) string
@@ -44,7 +62,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#L122>)
+## func [GetValuesFromLabel](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L124>)
 
 ```go
 func GetValuesFromLabel(service types.ServiceConfig, LabelValues string) map[string]*EnvConfig
@@ -62,7 +80,7 @@ func HashComposefiles(files []string) (string, error)
 HashComposefiles returns a hash of the compose files.
 
 <a name="Int32Ptr"></a>
-## func [Int32Ptr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L25>)
+## func [Int32Ptr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L27>)
 
 ```go
 func Int32Ptr(i int32) *int32
@@ -71,7 +89,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#L156>)
+## func [MapKeys](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L158>)
 
 ```go
 func MapKeys(m map[string]interface{}) []string
@@ -80,7 +98,7 @@ func MapKeys(m map[string]interface{}) []string
 
 
 <a name="PathToName"></a>
-## func [PathToName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L101>)
+## func [PathToName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L103>)
 
 ```go
 func PathToName(path string) string
@@ -89,7 +107,7 @@ func PathToName(path string) string
 PathToName converts a path to a kubernetes complient name.
 
 <a name="StrPtr"></a>
-## func [StrPtr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L28>)
+## func [StrPtr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L30>)
 
 ```go
 func StrPtr(s string) *string
@@ -98,7 +116,7 @@ func StrPtr(s string) *string
 StrPtr returns a pointer to a string.
 
 <a name="TplName"></a>
-## func [TplName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L17>)
+## func [TplName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L19>)
 
 ```go
 func TplName(serviceName, appname string, suffix ...string) string
@@ -107,7 +125,7 @@ func TplName(serviceName, appname string, suffix ...string) string
 TplName returns the name of the kubernetes resource as a template string. It is used in the templates and defined in \_helper.tpl file.
 
 <a name="TplValue"></a>
-## func [TplValue](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L92>)
+## func [TplValue](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L94>)
 
 ```go
 func TplValue(serviceName, variable string, pipes ...string) string
@@ -125,7 +143,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#L152>)
+## func [WordWrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L154>)
 
 ```go
 func WordWrap(text string, lineWidth int) string
@@ -134,7 +152,7 @@ func WordWrap(text string, lineWidth int) string
 WordWrap wraps a string to a given line width. Warning: it may break the string. You need to check the result.
 
 <a name="Wrap"></a>
-## func [Wrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L61>)
+## func [Wrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L63>)
 
 ```go
 func Wrap(src, above, below string) string
@@ -143,7 +161,7 @@ func Wrap(src, above, below string) string
 Wrap wraps a string with a string above and below. It will respect the indentation of the src string.
 
 <a name="WrapBytes"></a>
-## func [WrapBytes](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L67>)
+## func [WrapBytes](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L69>)
 
 ```go
 func WrapBytes(src, above, below []byte) []byte
@@ -152,14 +170,14 @@ 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#L116-L119>)
+## type [EnvConfig](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L118-L121>)
 
 EnvConfig is a struct to hold the description of an environment variable.
 
 ```go
 type EnvConfig struct {
-    Description string
     Service     types.ServiceConfig
+    Description string
 }
 ```
 

doc/docs/packages/generator/labelStructs.md

@@ -77,11 +77,6 @@ h3[id*="katenaryio"] {
 }
 
 /*Zoomable images*/
-
-/*[data-md-color-scheme="slate"] #logo {
-  background-image: url("logo-bright.svg");
-}*/
-
 .zoomable svg {
   background-color: var(--md-default-bg-color);
   padding: 1rem;

doc/docs/packages/utils.md

@@ -1,30 +1,46 @@
 package generator
 
-import "katenary/generator/labelStructs"
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"katenary/generator/labelStructs"
+	"katenary/utils"
+)
+
+// ConvertOptions are the options to convert a compose project to a helm chart.
+type ConvertOptions struct {
+	AppVersion   *string
+	OutputDir    string
+	ChartVersion string
+	Profiles     []string
+	Force        bool
+	HelmUpdate   bool
+}
 
 // ChartTemplate is a template of a chart. It contains the content of the template and the name of the service.
 // This is used internally to generate the templates.
-//
-// TODO: maybe we can set it private.
 type ChartTemplate struct {
-	Content     []byte
 	Servicename string
+	Content     []byte
 }
 
 // HelmChart is a Helm Chart representation. It contains all the
 // tempaltes, values, versions, helpers...
 type HelmChart struct {
+	Templates    map[string]*ChartTemplate `yaml:"-"`
+	Values       map[string]any            `yaml:"-"`
+	VolumeMounts map[string]any            `yaml:"-"`
+	composeHash  *string                   `yaml:"-"`
 	Name         string                    `yaml:"name"`
 	ApiVersion   string                    `yaml:"apiVersion"`
 	Version      string                    `yaml:"version"`
 	AppVersion   string                    `yaml:"appVersion"`
 	Description  string                    `yaml:"description"`
+	Helper       string                    `yaml:"-"`
 	Dependencies []labelStructs.Dependency `yaml:"dependencies,omitempty"`
-	Templates    map[string]*ChartTemplate `yaml:"-"` // do not export to yaml
-	Helper       string                    `yaml:"-"` // do not export to yaml
-	Values       map[string]any            `yaml:"-"` // do not export to yaml
-	VolumeMounts map[string]any            `yaml:"-"` // do not export to yaml
-	composeHash  *string                   `yaml:"-"` // do not export to yaml
 }
 
 // NewChart creates a new empty chart with the given name.
@@ -42,12 +58,59 @@ func NewChart(name string) *HelmChart {
 	}
 }
 
-// ConvertOptions are the options to convert a compose project to a helm chart.
-type ConvertOptions struct {
-	Force        bool     // Force the chart directory deletion if it already exists.
-	OutputDir    string   // The output directory of the chart.
-	Profiles     []string // Profile to use for the conversion.
-	HelmUpdate   bool     // If true, the "helm dep update" command will be run after the chart generation.
-	AppVersion   *string  // Set the chart "appVersion" field. If nil, the version will be set to 0.1.0.
-	ChartVersion string   // Set the chart "version" field.
+// SaveTemplates the templates of the chart to the given directory.
+func (chart *HelmChart) SaveTemplates(templateDir string) {
+	for name, template := range chart.Templates {
+		t := template.Content
+		t = removeNewlinesInsideBrackets(t)
+		t = removeUnwantedLines(t)
+		t = addModeline(t)
+
+		kind := utils.GetKind(name)
+		var icon utils.Icon
+		switch kind {
+		case "deployment":
+			icon = utils.IconPackage
+		case "service":
+			icon = utils.IconPlug
+		case "ingress":
+			icon = utils.IconWorld
+		case "volumeclaim":
+			icon = utils.IconCabinet
+		case "configmap":
+			icon = utils.IconConfig
+		case "secret":
+			icon = utils.IconSecret
+		default:
+			icon = utils.IconInfo
+		}
+
+		servicename := template.Servicename
+		if err := os.MkdirAll(filepath.Join(templateDir, servicename), 0o755); err != nil {
+			fmt.Println(utils.IconFailure, err)
+			os.Exit(1)
+		}
+		fmt.Println(icon, "Creating", kind, servicename)
+		// if the name is a path, create the directory
+		if strings.Contains(name, string(filepath.Separator)) {
+			name = filepath.Join(templateDir, name)
+			err := os.MkdirAll(filepath.Dir(name), 0o755)
+			if err != nil {
+				fmt.Println(utils.IconFailure, err)
+				os.Exit(1)
+			}
+		} else {
+			// remove the serivce name from the template name
+			name = strings.Replace(name, servicename+".", "", 1)
+			name = filepath.Join(templateDir, servicename, name)
+		}
+		f, err := os.Create(name)
+		if err != nil {
+			fmt.Println(utils.IconFailure, err)
+			os.Exit(1)
+		}
+
+		f.Write(t)
+		f.Close()
+	}
 }