cleanup, adding comments

Signed-off-by: manasachi <manasachinta7@gmail.com>

pkg/safeguards/preprocessing_helpers.go

@@ -12,17 +12,18 @@ import (
 	"helm.sh/helm/v3/pkg/engine"
 )
 
-// Given a Helm chart directory or file, render all templates and write them to a temporary directory
+// Given a Helm chart directory or file, renders all templates and writes them to the specified directory
 func RenderHelmChart(isFile bool, mainChartPath, tempDir string) error {
-	if isFile { //get the directory that the chart lives in
+	if isFile { // Get the directory that the Chart.yaml lives in
 		mainChartPath = filepath.Dir(mainChartPath)
 	}
-	loadedCharts := make(map[string]*chart.Chart) // map of chart path to chart object
 
 	mainChart, err := loader.Load(mainChartPath)
 	if err != nil {
 		return fmt.Errorf("failed to load main chart: %s", err)
 	}
+
+	loadedCharts := make(map[string]*chart.Chart) // map of chart path to chart object
 	loadedCharts[mainChartPath] = mainChart
 
 	// Load subcharts and dependencies
@@ -67,6 +68,7 @@ func RenderHelmChart(isFile bool, mainChartPath, tempDir string) error {
 	return nil
 }
 
+// Returns values from values.yaml and release options specified in values.yaml
 func getValues(chart *chart.Chart, valuesPath string) (chartutil.Values, error) {
 	// Load values file
 	valuesFile, err := os.ReadFile(valuesPath)

pkg/safeguards/preprocessing_helpers_test.go

@@ -43,6 +43,7 @@ func setup(t *testing.T) {
 	}
 }
 
+// Test rendering a valid Helm chart with no subcharts and three templates
 func TestRenderHelmChart_Valid(t *testing.T) {
 	setup(t)
 	t.Cleanup(func() { cleanupDir(t, tempDir) })
@@ -79,6 +80,7 @@ func TestRenderHelmChart_Valid(t *testing.T) {
 	assert.Equal(t, parseYAML(t, getManifestAsString(t, "expectedingress.yaml")), parseYAML(t, readFile(t, filepath.Join(tempDir, "ingress.yaml"))))
 }
 
+// Should successfully render a Helm chart with sub charts and be able to render subchart separately within a helm chart
 func TestSubCharts(t *testing.T) {
 	setup(t)
 	t.Cleanup(func() { cleanupDir(t, tempDir) })
@@ -124,7 +126,8 @@ func TestSubCharts(t *testing.T) {
 	//expect mainchart.yaml to not exist
 	outputFilePath := filepath.Join(tempDir, "maindeployment.yaml")
 	assert.NoFileExists(t, outputFilePath, "Unexpected file was created: %s", outputFilePath)
-
+	assert.Equal(t, parseYAML(t, getManifestAsString(t, "expected-subchart1.yaml")), parseYAML(t, readFile(t, filepath.Join(tempDir, "deployment1.yaml"))))
+	assert.Equal(t, parseYAML(t, getManifestAsString(t, "expected-subchart2.yaml")), parseYAML(t, readFile(t, filepath.Join(tempDir, "deployment2.yaml"))))
 }
 
 /**
@@ -163,6 +166,7 @@ func TestInvalidDeployments(t *testing.T) {
 	assert.Contains(t, err.Error(), "map has no entry for key")
 }
 
+/** Test different helm folder structures */
 func TestDifferentFolderStructures(t *testing.T) {
 	setup(t)
 	t.Cleanup(func() { cleanupDir(t, tempDir) })