Adding IsHelm helper function (#335)

Author: manasachi

pkg/safeguards/preprocessing/preprocessing.go

@@ -79,19 +79,6 @@ func CreateTempDir(p string) error {
 	return err
 }
 
-// IsKustomize checks whether a given path should be treated as a kustomize project
-func IsKustomize(p string) bool {
-	var err error
-	if safeguards.IsYAML(p) {
-		return strings.Contains(p, "kustomization.yaml")
-	} else if _, err = os.Stat(filepath.Join(p, "kustomization.yaml")); err == nil {
-		return true
-	} else if _, err = os.Stat(filepath.Join(p, "kustomization.yml")); err == nil {
-		return true
-	}
-	return false
-}
-
 // Given a kustomization manifest file within kustomizationPath, RenderKustomizeManifest will render templates out to tempDir
 func RenderKustomizeManifest(kustomizationPath, tempDir string) ([]safeguards.ManifestFile, error) {
 	log.Debugf("Rendering kustomization.yaml...")

pkg/safeguards/preprocessing/preprocessing_helpers.go

@@ -3,7 +3,10 @@ package preprocessing
 import (
 	"fmt"
 	"os"
+	"path/filepath"
+	"strings"
 
+	"github.com/Azure/draft/pkg/safeguards"
 	"gopkg.in/yaml.v3"
 	"helm.sh/helm/v3/pkg/chart"
 	"helm.sh/helm/v3/pkg/chartutil"
@@ -52,3 +55,38 @@ func getReleaseOptions(chart *chart.Chart, vals map[string]interface{}) (chartut
 
 	return mergedValues, nil
 }
+
+// IsKustomize checks whether a given path should be treated as a kustomize project
+func IsKustomize(p string) bool {
+	var err error
+	if safeguards.IsYAML(p) {
+		return strings.Contains(p, "kustomization.yaml")
+	} else if _, err = os.Stat(filepath.Join(p, "kustomization.yaml")); err == nil {
+		return true
+	} else if _, err = os.Stat(filepath.Join(p, "kustomization.yml")); err == nil {
+		return true
+	}
+	return false
+}
+
+// Checks whether a given path is a helm directory or a path to a Helm Chart (contains/is Chart.yaml)
+func IsHelm(path string) bool {
+	fileInfo, err := os.Stat(path)
+	if os.IsNotExist(err) || err != nil {
+		return false
+	}
+
+	var chartPath string
+	if fileInfo.IsDir() {
+		chartPath = filepath.Join(path, "Chart.yaml")
+	} else {
+		chartPath = path
+	}
+
+	_, err = os.Stat(chartPath)
+	if err == nil && safeguards.IsYAML(chartPath) { // Couldn't find Chart.yaml in the directory
+		return true
+	}
+
+	return false
+}

pkg/safeguards/preprocessing/preprocessing_test.go

@@ -193,3 +193,21 @@ func TestIsKustomize(t *testing.T) {
 	isKustomize = IsKustomize(chartPath)
 	assert.False(t, isKustomize)
 }
+
+func TestIsHelm(t *testing.T) {
+	// path is a directory
+	isHelm := IsHelm(chartPath)
+	assert.True(t, isHelm)
+
+	// path is a Chart.yaml file
+	isHelm = IsHelm(directPath_ToValidChart)
+	assert.True(t, isHelm)
+
+	// Is a directory but does not contain Chart.yaml
+	isHelm = IsHelm(invalidNoChart)
+	assert.False(t, isHelm)
+
+	// invalid path
+	isHelm = IsHelm("invalid/path")
+	assert.False(t, isHelm)
+}

pkg/safeguards/preprocessing/preprocessing_test_helpers.go

@@ -10,6 +10,7 @@ import (
 const (
 	tempDir                 = "testdata" // Rendered files are stored here before they are read for comparison
 	chartPath               = "../tests/testmanifests/validchart"
+	invalidNoChart          = "../tests/testmanifests/nochart-invalid"
 	invalidChartPath        = "../tests/testmanifests/invalidchart"
 	invalidValuesChart      = "../tests/testmanifests/invalidvalues"
 	invalidDeploymentsChart = "../tests/testmanifests/invaliddeployment"

pkg/safeguards/tests/testmanifests/nochart-invalid/templates/deployment.yaml

@@ -0,0 +1,18 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ .Release.Name }}-deployment
+  namespace: {{ .Release.Namespace }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      app: my-web-app
+  template:
+    metadata:
+      labels:
+        app: my-web-app
+    spec:
+      containers:
+        - name: nginx
+          image: {{ .Values.image.repository }}:{{ .Values.image.tag }}

pkg/safeguards/tests/testmanifests/nochart-invalid/values.yaml

@@ -0,0 +1,12 @@
+replicaCount: 1
+image:
+  repository: nginx
+  tag: stable
+service:
+  type: ClusterIP
+  port: 80
+ingress:
+  enabled: true
+  hostname: example.com
+releaseName: test-release
+releaseNamespace: test-namespace