Add feature for parsing raw kubernetes manifest rather helm chart or relase

Below command would fetch images from raw kubernetes manifests:
helm template example/chart/sample | helm images get --raw - -o yaml

fixes #44

Author: nikhilsbhat

cmd/commands.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"io"
 	"os"
 	"strings"
 
@@ -38,19 +39,33 @@ func getImagesCommand() *cobra.Command {
   helm images get prometheus-standalone --from-release --registry quay.io --unique
   helm images get prometheus-standalone --from-release --registry quay.io -o yaml
   helm images get oci://registry-1.docker.io/bitnamicharts/airflow -o yaml
-  helm images get kong-2.35.0.tgz -o json`,
+  helm images get kong-2.35.0.tgz -o json
+  helm template example/chart/sample | helm images get --raw -
+  helm template example/chart/sample | helm images get --raw - -o yaml`,
 		Args:    validateAndSetArgs,
 		PreRunE: setCLIClient,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			cmd.SilenceUsage = true
 
+			if images.Raw {
+				stdIn := cmd.InOrStdin()
+				imagesRaw, err := io.ReadAll(stdIn)
+				if err != nil {
+					return err
+				}
+
+				images.SetRaw(imagesRaw)
+			}
+
 			return images.GetImages()
 		},
 	}
 
 	registerCommonFlags(imageCommand)
 	registerGetFlags(imageCommand)
 
+	imageCommand.MarkFlagsMutuallyExclusive("raw", "from-release")
+
 	return imageCommand
 }
 
@@ -149,6 +164,10 @@ func validateAndSetArgs(cmd *cobra.Command, args []string) error {
 	defaultReleaseName := "sample"
 	cmd.SilenceUsage = true
 
+	if images.Raw {
+		return nil
+	}
+
 	if images.Revision != 0 && !images.FromRelease {
 		cliLogger.Fatalf("the '--revision' flag can only be used when retrieving images from a release, i.e., when the '--from-release' flag is set")
 	}
@@ -174,6 +193,10 @@ func validateAndSetArgs(cmd *cobra.Command, args []string) error {
 		cliLogger.Fatal(oneOfThemError)
 	}
 
+	if len(args) == 0 {
+		cliLogger.Fatal("[RELEASE] name missing")
+	}
+
 	images.SetRelease(args[0])
 
 	return nil

cmd/flags.go

@@ -58,6 +58,8 @@ func registerCommonFlags(cmd *cobra.Command) {
 func registerGetFlags(cmd *cobra.Command) {
 	cmd.PersistentFlags().BoolVarP(&images.FromRelease, "from-release", "", false,
 		"enable the flag to fetch the images from release instead (disabled by default)")
+	cmd.PersistentFlags().BoolVarP(&images.Raw, "raw", "", false,
+		"when enabled, expects raw kubernetes manifests rather helm release or chart")
 }
 
 func registerGetAllFlags(cmd *cobra.Command) {

docs/doc/images.md

@@ -32,4 +32,4 @@ images [command] [flags]
 * [images get](images_get.md)	 - Fetches all images those are part of specified chart/release
 * [images version](images_version.md)	 - Command to fetch the version of helm-images installed
 
-###### Auto generated by spf13/cobra on 6-Aug-2024
+###### Auto generated by spf13/cobra on 12-Oct-2024

docs/doc/images_all.md

@@ -7,7 +7,7 @@ Fetches all images from all release
 Lists all images part of all release present in the cluster with matching pattern or part of specified registry.
 
 ```
-images all [RELEASE] [CHART] [flags]
+images all [flags]
 ```
 
 ### Examples
@@ -55,4 +55,4 @@ images all [RELEASE] [CHART] [flags]
 
 * [images](images.md)	 - Utility that helps in fetching images which are part of deployment
 
-###### Auto generated by spf13/cobra on 6-Aug-2024
+###### Auto generated by spf13/cobra on 12-Oct-2024

docs/doc/images_get.md

@@ -19,6 +19,8 @@ images get [RELEASE] [CHART] [flags]
   helm images get prometheus-standalone --from-release --registry quay.io -o yaml
   helm images get oci://registry-1.docker.io/bitnamicharts/airflow -o yaml
   helm images get kong-2.35.0.tgz -o json
+  helm template example/chart/sample | helm images get --raw -
+  helm template example/chart/sample | helm images get --raw - -o yaml
 ```
 
 ### Options
@@ -32,6 +34,7 @@ images get [RELEASE] [CHART] [flags]
   -l, --log-level string               log level for the plugin helm images (defaults to info) (default "info")
       --no-color                       when enabled does not color encode the output
   -o, --output string                  the format to which the output should be rendered to, it should be one of yaml|json|table|csv, if nothing specified it sets to default
+      --raw                            when enabled, expects raw kubernetes manifests rather helm release or chart
   -r, --registry strings               registry name (docker images belonging to this registry)
       --skip strings                   list of resources to skip from identifying images, ex: ConfigMap=sample-configmap | configmap=sample-configmap
   -u, --unique                         enable the flag if duplicates to be removed from the retrieved list (disabled by default also overrides --kind)
@@ -56,4 +59,4 @@ images get [RELEASE] [CHART] [flags]
 
 * [images](images.md)	 - Utility that helps in fetching images which are part of deployment
 
-###### Auto generated by spf13/cobra on 6-Aug-2024
+###### Auto generated by spf13/cobra on 12-Oct-2024

docs/doc/images_version.md

@@ -35,4 +35,4 @@ images version [flags]
 
 * [images](images.md)	 - Utility that helps in fetching images which are part of deployment
 
-###### Auto generated by spf13/cobra on 6-Aug-2024
+###### Auto generated by spf13/cobra on 12-Oct-2024

pkg/images.go

@@ -40,6 +40,7 @@ type Images struct {
 	LogLevel            string     `json:"log_level,omitempty"               yaml:"log_level,omitempty"`
 	OutputFormat        string     `json:"output_format,omitempty"           yaml:"output_format,omitempty"`
 	Revision            int        `json:"revision,omitempty"                yaml:"revision,omitempty"`
+	Raw                 bool       `json:"raw,omitempty"                     yaml:"raw,omitempty"`
 	SkipTests           bool       `json:"skip_tests,omitempty"              yaml:"skip_tests,omitempty"`
 	SkipCRDS            bool       `json:"skip_crds,omitempty"               yaml:"skip_crds,omitempty"`
 	FromRelease         bool       `json:"from_release,omitempty"            yaml:"from_release,omitempty"`
@@ -53,6 +54,7 @@ type Images struct {
 	table               bool
 	csv                 bool
 	all                 bool
+	raw                 []byte
 	release             string
 	chart               string
 	namespace           string
@@ -85,6 +87,11 @@ func (image *Images) SetChart(chart string) {
 	image.chart = chart
 }
 
+// SetRaw sets raw.
+func (image *Images) SetRaw(raw []byte) {
+	image.raw = raw
+}
+
 // SetRenderer sets renderer to Images.
 func (image *Images) SetRenderer() {
 	render := renderer.GetRenderer(os.Stdout, image.log, image.NoColor, image.yaml, image.json, image.csv, image.table)
@@ -183,6 +190,12 @@ func (image *Images) GetImages() error {
 }
 
 func (image *Images) getChartManifests() ([]byte, error) {
+	if image.Raw {
+		image.log.Debug("reading the manifest from stdin")
+
+		return image.raw, nil
+	}
+
 	if image.FromRelease {
 		image.log.Debugf("from-release is selected, hence fetching manifests for '%s' from helm release", image.release)
 

pkg/k8s/k8s.go

@@ -123,6 +123,7 @@ func (kin *Kind) Get(dataMap string, log *logrus.Logger) (string, error) {
 	kind, kindExists := kindYaml[kubeKind].(string)
 	if !kindExists {
 		log.Warn("failed to get 'kind' from the manifest")
+
 		return "", nil
 	}
 

pkg/k8s/k8s_test.go

@@ -5,12 +5,15 @@ import (
 	"testing"
 
 	"github.com/ghodss/yaml"
+	"github.com/nikhilsbhat/helm-images/pkg"
 	"github.com/nikhilsbhat/helm-images/pkg/k8s"
+	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 func TestGetVal(t *testing.T) {
+	log := logrus.New()
 	yamlData := `image: 'ghcr.io/example/sample:v2.2.0'
 enemies: aliens
 lives: '3'
@@ -35,7 +38,7 @@ config:
 		err := yaml.Unmarshal([]byte(yamlData), &valueMap)
 		require.NoError(t, err)
 
-		valueFound, _ := k8s.GetImage(valueMap, "image", "", nil)
+		valueFound, _ := k8s.GetImage(valueMap, "image", pkg.ConfigMapImageRegex, log)
 		assert.ElementsMatch(t, []string{
 			"ghcr.io/example/config:v2.3.0",
 			"ghcr.io/example/testConfig:v2.3.0",
@@ -49,9 +52,8 @@ config:
 		err := json.Unmarshal([]byte(jsonData), &valueMap)
 		require.NoError(t, err)
 
-		valueFound, _ := k8s.GetImage(valueMap, "image", "", nil)
+		valueFound, _ := k8s.GetImage(valueMap, "image", pkg.ConfigMapImageRegex, log)
 		assert.ElementsMatch(t, []string{
-			"ghcr.io/prometheus/prom:v2.0.0",
 			"ghcr.io/example/sample:v2.2.0",
 			"ghcr.io/example/config:v2.3.0",
 		}, valueFound)