Merge pull request #127 from diogoasouza/icons-script

adding make icon script instead of doing it inside make charts

Author: nicholasSUSE

main.go

@@ -230,6 +230,12 @@ func main() {
 			Usage:  "Checks if there are any images with RC tags or charts with RC versions in the charts repository",
 			Action: checkRCTagsAndVersions,
 		},
+		{
+			Name:   "icon",
+			Usage:  "Download the chart icon locally and use it",
+			Action: downloadIcon,
+			Flags:  []cli.Flag{packageFlag, configFlag, cacheFlag},
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -290,13 +296,23 @@ func generateCharts(c *cli.Context) {
 		logrus.Infof("No packages found.")
 		return
 	}
-	validateOnly := false
-	if c.Command.Name == "validate" {
-		validateOnly = true
-	}
 	chartsScriptOptions := parseScriptOptions()
 	for _, p := range packages {
-		if err := p.GenerateCharts(chartsScriptOptions.OmitBuildMetadataOnExport, validateOnly); err != nil {
+		if err := p.GenerateCharts(chartsScriptOptions.OmitBuildMetadataOnExport); err != nil {
+			logrus.Fatal(err)
+		}
+	}
+}
+
+func downloadIcon(c *cli.Context) {
+	packages := getPackages()
+	if len(packages) == 0 {
+		logrus.Infof("No packages found.")
+		return
+	}
+	for _, p := range packages {
+		err := p.DownloadIcon()
+		if err != nil {
 			logrus.Fatal(err)
 		}
 	}

pkg/charts/additionalchart.go

@@ -214,11 +214,11 @@ func (c *AdditionalChart) GeneratePatch(rootFs, pkgFs billy.Filesystem) error {
 }
 
 // GenerateChart generates the chart and stores it in the assets and charts directory
-func (c *AdditionalChart) GenerateChart(rootFs, pkgFs billy.Filesystem, packageVersion *int, version *semver.Version, omitBuildMetadataOnExport, validateOnly bool) error {
+func (c *AdditionalChart) GenerateChart(rootFs, pkgFs billy.Filesystem, packageVersion *int, version *semver.Version, omitBuildMetadataOnExport bool) error {
 	if c.upstreamChartVersion == nil {
 		return fmt.Errorf("cannot generate chart since it has never been prepared: upstreamChartVersion is not set")
 	}
-	if err := helm.ExportHelmChart(rootFs, pkgFs, c.WorkingDir, packageVersion, version, *c.upstreamChartVersion, omitBuildMetadataOnExport, validateOnly); err != nil {
+	if err := helm.ExportHelmChart(rootFs, pkgFs, c.WorkingDir, packageVersion, version, *c.upstreamChartVersion, omitBuildMetadataOnExport); err != nil {
 		return fmt.Errorf("encountered error while trying to export Helm chart for %s: %s", c.WorkingDir, err)
 	}
 	return nil

pkg/charts/chart.go

@@ -103,11 +103,11 @@ func (c *Chart) GeneratePatch(rootFs, pkgFs billy.Filesystem) error {
 }
 
 // GenerateChart generates the chart and stores it in the assets and charts directory
-func (c *Chart) GenerateChart(rootFs, pkgFs billy.Filesystem, packageVersion *int, version *semver.Version, omitBuildMetadataOnExport, validateOnly bool) error {
+func (c *Chart) GenerateChart(rootFs, pkgFs billy.Filesystem, packageVersion *int, version *semver.Version, omitBuildMetadataOnExport bool) error {
 	if c.upstreamChartVersion == nil {
 		return fmt.Errorf("cannot generate chart since it has never been prepared: upstreamChartVersion is not set")
 	}
-	if err := helm.ExportHelmChart(rootFs, pkgFs, c.WorkingDir, packageVersion, version, *c.upstreamChartVersion, omitBuildMetadataOnExport, validateOnly); err != nil {
+	if err := helm.ExportHelmChart(rootFs, pkgFs, c.WorkingDir, packageVersion, version, *c.upstreamChartVersion, omitBuildMetadataOnExport); err != nil {
 		return fmt.Errorf("encountered error while trying to export Helm chart for %s: %s", c.WorkingDir, err)
 	}
 	return nil

pkg/charts/package.go

@@ -2,13 +2,18 @@ package charts
 
 import (
 	"fmt"
+	"net/url"
 	"path/filepath"
 
 	"github.com/blang/semver"
 	"github.com/go-git/go-billy/v5"
 	"github.com/rancher/charts-build-scripts/pkg/filesystem"
 	"github.com/rancher/charts-build-scripts/pkg/helm"
+	"github.com/rancher/charts-build-scripts/pkg/icons"
+	"github.com/rancher/charts-build-scripts/pkg/path"
 	"github.com/sirupsen/logrus"
+	helmLoader "helm.sh/helm/v3/pkg/chart/loader"
+	"helm.sh/helm/v3/pkg/chartutil"
 )
 
 // Package represents the configuration of a particular forked Helm chart
@@ -85,8 +90,43 @@ func (p *Package) GeneratePatch() error {
 	return nil
 }
 
+// DownloadIcon Downloads the icon from the charts.yaml file to the assets/logos folder
+// and changes the chart.yaml file to use it
+func (p *Package) DownloadIcon() error {
+	exists, err := filesystem.PathExists(p.fs, path.RepositoryChartsDir)
+	if err != nil {
+		return fmt.Errorf("failed to check for charts dir. Err: %w", err)
+	}
+	if !exists {
+		logrus.Infof("Charts dir does not exists. Please run `make prepare` first")
+		return nil
+	}
+	absHelmChartPath := filesystem.GetAbsPath(p.fs, path.RepositoryChartsDir)
+	chart, err := helmLoader.Load(absHelmChartPath)
+	if err != nil {
+		return fmt.Errorf("could not load Helm chart: %s", err)
+	}
+	u, err := url.Parse(chart.Metadata.Icon)
+	if err == nil && (u.Scheme == "http" || u.Scheme == "https") {
+		logrus.Infof("Chart icon is pointing to a remote url. Downloading it...")
+		// download icon and change the icon property to point to it
+		p, err := icons.Download(p.rootFs, chart.Metadata)
+		if err == nil { // managed to download the icon and save it locally
+			chart.Metadata.Icon = fmt.Sprintf("file://%s", p)
+		} else {
+			logrus.Errorf("failed to download icon for chart %s, err: %s", chart.Name(), err)
+		}
+		chartYamlPath := fmt.Sprintf("%s/Chart.yaml", absHelmChartPath)
+		err = chartutil.SaveChartfile(chartYamlPath, chart.Metadata)
+		if err != nil {
+			return fmt.Errorf("failed to save chart.yaml file. err: %w", err)
+		}
+	}
+	return nil
+}
+
 // GenerateCharts creates Helm chart archives for each chart after preparing it
-func (p *Package) GenerateCharts(omitBuildMetadataOnExport bool, validateOnly bool) error {
+func (p *Package) GenerateCharts(omitBuildMetadataOnExport bool) error {
 	if p.DoNotRelease {
 		logrus.Infof("Skipping package marked doNotRelease")
 		return nil
@@ -95,12 +135,12 @@ func (p *Package) GenerateCharts(omitBuildMetadataOnExport bool, validateOnly bo
 		return fmt.Errorf("encountered error while trying to prepare package: %s", err)
 	}
 	// Add PackageVersion to format
-	err := p.Chart.GenerateChart(p.rootFs, p.fs, p.PackageVersion, p.Version, omitBuildMetadataOnExport, validateOnly)
+	err := p.Chart.GenerateChart(p.rootFs, p.fs, p.PackageVersion, p.Version, omitBuildMetadataOnExport)
 	if err != nil {
 		return fmt.Errorf("encountered error while exporting main chart: %s", err)
 	}
 	for _, additionalChart := range p.AdditionalCharts {
-		err = additionalChart.GenerateChart(p.rootFs, p.fs, p.PackageVersion, p.Version, omitBuildMetadataOnExport, validateOnly)
+		err = additionalChart.GenerateChart(p.rootFs, p.fs, p.PackageVersion, p.Version, omitBuildMetadataOnExport)
 		if err != nil {
 			return fmt.Errorf("encountered error while exporting %s: %s", additionalChart.WorkingDir, err)
 		}

pkg/helm/export.go

@@ -3,13 +3,9 @@ package helm
 import (
 	"fmt"
 	"math"
-	"net/url"
 	"os"
 	"path/filepath"
 
-	"github.com/rancher/charts-build-scripts/pkg/icons"
-	"helm.sh/helm/v3/pkg/chartutil"
-
 	"github.com/blang/semver"
 	"github.com/go-git/go-billy/v5"
 	"github.com/rancher/charts-build-scripts/pkg/filesystem"
@@ -30,7 +26,7 @@ var (
 
 // ExportHelmChart creates a Helm chart archive and an unarchived Helm chart at RepositoryAssetDirpath and RepositoryChartDirPath
 // helmChartPath is a relative path (rooted at the package level) that contains the chart.
-func ExportHelmChart(rootFs, fs billy.Filesystem, helmChartPath string, packageVersion *int, version *semver.Version, upstreamChartVersion string, omitBuildMetadata, validateOnly bool) error {
+func ExportHelmChart(rootFs, fs billy.Filesystem, helmChartPath string, packageVersion *int, version *semver.Version, upstreamChartVersion string, omitBuildMetadata bool) error {
 	// Try to load the chart to see if it can be exported
 	absHelmChartPath := filesystem.GetAbsPath(fs, helmChartPath)
 	chart, err := helmLoader.Load(absHelmChartPath)
@@ -63,28 +59,6 @@ func ExportHelmChart(rootFs, fs billy.Filesystem, helmChartPath string, packageV
 	}
 	chartVersion := chartVersionSemver.String()
 
-	// If its not only validation then download icons
-	if !validateOnly {
-		//checking if icon is pointing to a valid http/https url
-		u, err := url.Parse(chart.Metadata.Icon)
-		if err == nil && (u.Scheme == "http" || u.Scheme == "https") {
-			logrus.Infof("Chart icon is pointing to a remote url. Downloading it...")
-			// download icon and change the icon property to point to it
-			p, err := icons.Download(rootFs, chart.Metadata)
-			if err == nil { // managed to download the icon and save it locally
-				chart.Metadata.Icon = fmt.Sprintf("file://%s", p)
-			} else {
-				logrus.Errorf("failed to download icon for chart %s, err: %s", chart.Name(), err)
-			}
-		}
-	}
-
-	chartYamlPath := fmt.Sprintf("%s/Chart.yaml", absHelmChartPath)
-	err = chartutil.SaveChartfile(chartYamlPath, chart.Metadata)
-	if err != nil {
-		return err
-	}
-
 	// Assets are indexed by chart name, independent of which package that chart is contained within
 	chartAssetsDirpath := filepath.Join(path.RepositoryAssetsDir, chart.Metadata.Name)
 	// All generated charts are indexed by chart name and version