Merge pull request #186 from rancher/debug-repo

feat(dev) : specify root repo path using DEV_REPO_ROOT for debugging

Author: nicholasSUSE

main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"strings"
 
@@ -582,7 +581,7 @@ func validateRepo(c *cli.Context) {
 			u := chartsScriptOptions.ValidateOptions.UpstreamOptions
 			branch := chartsScriptOptions.ValidateOptions.Branch
 			logrus.Infof("Performing upstream validation against repository %s at branch %s", u.URL, branch)
-			compareGeneratedAssetsResponse, err := validate.CompareGeneratedAssets(repoFs, u, branch, releaseOptions)
+			compareGeneratedAssetsResponse, err := validate.CompareGeneratedAssets(repoRoot, repoFs, u, branch, releaseOptions)
 			if err != nil {
 				logrus.Fatal(err)
 			}
@@ -634,17 +633,17 @@ func createOrUpdateTemplate(c *cli.Context) {
 }
 
 func setupCache(c *cli.Context) error {
-	return puller.InitRootCache(CacheMode, path.DefaultCachePath)
+	return puller.InitRootCache(getRepoRoot(), CacheMode, path.DefaultCachePath)
 }
 
 func cleanCache(c *cli.Context) {
-	if err := puller.CleanRootCache(path.DefaultCachePath); err != nil {
+	if err := puller.CleanRootCache(getRepoRoot(), path.DefaultCachePath); err != nil {
 		logrus.Fatal(err)
 	}
 }
 
 func parseScriptOptions() *options.ChartsScriptOptions {
-	configYaml, err := ioutil.ReadFile(defaultChartsScriptOptionsFile)
+	configYaml, err := os.ReadFile(ChartsScriptOptionsFile)
 	if err != nil {
 		logrus.Fatalf("Unable to find configuration file: %s", err)
 	}
@@ -656,6 +655,13 @@ func parseScriptOptions() *options.ChartsScriptOptions {
 }
 
 func getRepoRoot() string {
+	var repoRoot string
+	repoRoot = os.Getenv("DEV_REPO_ROOT")
+	if repoRoot != "" {
+		logrus.Debugf("Using repo root : %s", repoRoot)
+		return repoRoot
+	}
+
 	repoRoot, err := os.Getwd()
 	if err != nil {
 		logrus.Fatalf("Unable to get current working directory: %s", err)
@@ -697,11 +703,12 @@ func checkImages(c *cli.Context) {
 }
 
 func checkRCTagsAndVersions(c *cli.Context) {
+	repoRoot := getRepoRoot()
 	// Grab all images that contain RC tags
-	rcImageTagMap := images.CheckRCTags()
+	rcImageTagMap := images.CheckRCTags(repoRoot)
 
 	// Grab all chart versions that contain RC tags
-	rcChartVersionMap := charts.CheckRCCharts()
+	rcChartVersionMap := charts.CheckRCCharts(repoRoot)
 
 	// If there are any charts that contains RC version or images that contains RC tags
 	// log them and return an error
@@ -717,8 +724,9 @@ func checkRCTagsAndVersions(c *cli.Context) {
 func lifecycleStatus(c *cli.Context) {
 	// Initialize dependencies with branch-version and current chart
 	logrus.Info("Initializing dependencies for lifecycle-status")
-	rootFs := filesystem.GetFilesystem(getRepoRoot())
-	lifeCycleDep, err := lifecycle.InitDependencies(rootFs, c.String("branch-version"), CurrentChart)
+	repoRoot := getRepoRoot()
+	rootFs := filesystem.GetFilesystem(repoRoot)
+	lifeCycleDep, err := lifecycle.InitDependencies(repoRoot, rootFs, c.String("branch-version"), CurrentChart)
 	if err != nil {
 		logrus.Fatalf("encountered error while initializing dependencies: %s", err)
 	}
@@ -738,8 +746,9 @@ func autoForwardPort(c *cli.Context) {
 
 	// Initialize dependencies with branch-version and current chart
 	logrus.Info("Initializing dependencies for auto-forward-port")
-	rootFs := filesystem.GetFilesystem(getRepoRoot())
-	lifeCycleDep, err := lifecycle.InitDependencies(rootFs, c.String("branch-version"), CurrentChart)
+	repoRoot := getRepoRoot()
+	rootFs := filesystem.GetFilesystem(repoRoot)
+	lifeCycleDep, err := lifecycle.InitDependencies(repoRoot, rootFs, c.String("branch-version"), CurrentChart)
 	if err != nil {
 		logrus.Fatalf("encountered error while initializing dependencies: %v", err)
 	}
@@ -773,10 +782,10 @@ func release(c *cli.Context) {
 	if CurrentChart == "" {
 		logrus.Fatal("CHART environment variable must be set to run release cmd")
 	}
+	repoRoot := getRepoRoot()
+	rootFs := filesystem.GetFilesystem(repoRoot)
 
-	rootFs := filesystem.GetFilesystem(getRepoRoot())
-
-	dependencies, err := lifecycle.InitDependencies(rootFs, c.String("branch-version"), CurrentChart)
+	dependencies, err := lifecycle.InitDependencies(repoRoot, rootFs, c.String("branch-version"), CurrentChart)
 	if err != nil {
 		logrus.Fatalf("encountered error while initializing dependencies: %v", err)
 	}
@@ -825,15 +834,15 @@ func validateRelease(c *cli.Context) {
 		fmt.Println("BRANCH environment variable must be set to run validate-release-charts")
 		os.Exit(1)
 	}
-
-	rootFs := filesystem.GetFilesystem(getRepoRoot())
+	repoRoot := getRepoRoot()
+	rootFs := filesystem.GetFilesystem(repoRoot)
 
 	if !strings.HasPrefix(Branch, "release-v") {
 		fmt.Println("Branch must be in the format release-v2.x")
 		os.Exit(1)
 	}
 
-	dependencies, err := lifecycle.InitDependencies(rootFs, strings.TrimPrefix(Branch, "release-v"), "")
+	dependencies, err := lifecycle.InitDependencies(repoRoot, rootFs, strings.TrimPrefix(Branch, "release-v"), "")
 	if err != nil {
 		fmt.Printf("encountered error while initializing d: %v \n", err)
 		os.Exit(1)

pkg/auto/chart_bump.go

@@ -77,7 +77,7 @@ func SetupBump(repoRoot, targetPackage, targetBranch string, chScriptOpts *optio
 	}
 
 	//Initialize the lifecycle dependencies because of the versioning rules and the index.yaml mapping.
-	dependencies, err := lifecycle.InitDependencies(filesystem.GetFilesystem(repoRoot), branch, bump.targetChart)
+	dependencies, err := lifecycle.InitDependencies(repoRoot, filesystem.GetFilesystem(repoRoot), branch, bump.targetChart)
 	if err != nil {
 		err = fmt.Errorf("failure at SetupBump: %w ", err)
 		return bump, err

pkg/charts/checkRCCharts.go

@@ -1,7 +1,6 @@
 package charts
 
 import (
-	"os"
 	"strings"
 
 	"github.com/rancher/charts-build-scripts/pkg/filesystem"
@@ -10,14 +9,7 @@ import (
 )
 
 // CheckRCCharts checks for any charts that have RC versions
-func CheckRCCharts() map[string][]string {
-
-	// Get the current working directory
-	repoRoot, err := os.Getwd()
-	if err != nil {
-		logrus.Fatalf("Unable to get current working directory: %s", err)
-	}
-
+func CheckRCCharts(repoRoot string) map[string][]string {
 	// Get the filesystem on the repo root
 	repoFs := filesystem.GetFilesystem(repoRoot)
 

pkg/charts/crdchart.go

@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -77,7 +76,7 @@ func AddCRDValidationToChart(fs billy.Filesystem, helmChartPathWithoutCRDs, helm
 			return nil
 		}
 		absPath := filesystem.GetAbsPath(fs, path)
-		yamlFile, err := ioutil.ReadFile(absPath)
+		yamlFile, err := os.ReadFile(absPath)
 		if err != nil {
 			return fmt.Errorf("unable to read file %s: %s", absPath, err)
 		}
@@ -133,7 +132,7 @@ func AddCRDValidationToChart(fs billy.Filesystem, helmChartPathWithoutCRDs, helm
 	validateInstallCRDsContents := fmt.Sprintf(ValidateInstallCRDContentsFmt, strings.Join(formattedCRDs, "\n"))
 	validateInstallCRDsDestpath := filepath.Join(helmChartPathWithoutCRDs, path.ChartValidateInstallCRDFile)
 	// Write to file
-	err = ioutil.WriteFile(filesystem.GetAbsPath(fs, validateInstallCRDsDestpath), []byte(validateInstallCRDsContents), os.ModePerm)
+	err = os.WriteFile(filesystem.GetAbsPath(fs, validateInstallCRDsDestpath), []byte(validateInstallCRDsContents), os.ModePerm)
 	if err != nil {
 		return fmt.Errorf("encountered error while writing into %s: %s", validateInstallCRDsDestpath, err)
 	}

pkg/filesystem/filesystem.go

@@ -6,15 +6,15 @@ import (
 	"compress/gzip"
 	"crypto/sha1"
 	"fmt"
-	"github.com/rancher/charts-build-scripts/pkg/util"
 	"io"
-	"io/ioutil"
 	"net/http"
 	"os"
 	"path/filepath"
 	"sort"
 	"strings"
 
+	"github.com/rancher/charts-build-scripts/pkg/util"
+
 	"github.com/go-git/go-billy/v5"
 	"github.com/go-git/go-billy/v5/osfs"
 	"github.com/sirupsen/logrus"
@@ -591,11 +591,11 @@ func CopyDir(fs billy.Filesystem, srcDir string, dstDir string) error {
 		if isDir {
 			return fs.MkdirAll(dstPath, os.ModePerm)
 		}
-		data, err := ioutil.ReadFile(GetAbsPath(fs, srcPath))
+		data, err := os.ReadFile(GetAbsPath(fs, srcPath))
 		if err != nil {
 			return err
 		}
-		return ioutil.WriteFile(GetAbsPath(fs, dstPath), data, os.ModePerm)
+		return os.WriteFile(GetAbsPath(fs, dstPath), data, os.ModePerm)
 	})
 }
 
@@ -608,7 +608,7 @@ func MakeSubdirectoryRoot(fs billy.Filesystem, path, subdirectory string) error
 	if !exists {
 		return fmt.Errorf("subdirectory %s does not exist in path %s in filesystem %s", subdirectory, path, fs.Root())
 	}
-	absTempDir, err := ioutil.TempDir(fs.Root(), "make-subdirectory-root")
+	absTempDir, err := os.MkdirTemp(fs.Root(), "make-subdirectory-root")
 	if err != nil {
 		return err
 	}

pkg/images/checkRCTags.go

@@ -1,7 +1,6 @@
 package images
 
 import (
-	"os"
 	"strings"
 
 	"github.com/rancher/charts-build-scripts/pkg/filesystem"
@@ -11,10 +10,10 @@ import (
 )
 
 // CheckRCTags checks for any images that have RC tags
-func CheckRCTags() map[string][]string {
+func CheckRCTags(repoRoot string) map[string][]string {
 
 	// Get the release options from the release.yaml file
-	releaseOptions := getReleaseOptions()
+	releaseOptions := getReleaseOptions(repoRoot)
 
 	logrus.Infof("Checking for RC tags in charts: %v", releaseOptions)
 
@@ -41,13 +40,7 @@ func CheckRCTags() map[string][]string {
 }
 
 // getReleaseOptions returns the release options from the release.yaml file
-func getReleaseOptions() options.ReleaseOptions {
-	// Get the current working directory
-	repoRoot, err := os.Getwd()
-	if err != nil {
-		logrus.Fatalf("Unable to get current working directory: %s", err)
-	}
-
+func getReleaseOptions(repoRoot string) options.ReleaseOptions {
 	// Get the filesystem on the repo root
 	repoFs := filesystem.GetFilesystem(repoRoot)
 

pkg/lifecycle/lifecycle.go

@@ -2,7 +2,6 @@ package lifecycle
 
 import (
 	"errors"
-	"os"
 
 	"github.com/go-git/go-billy/v5"
 	"github.com/rancher/charts-build-scripts/pkg/filesystem"
@@ -37,13 +36,10 @@ type WalkDirFunc func(fs billy.Filesystem, dirPath string, doFunc filesystem.Rel
 // InitDependencies will check the filesystem, branch version,
 // git status, initialize the Dependencies struct and populate it.
 // If anything fails the operation will be aborted.
-func InitDependencies(rootFs billy.Filesystem, branchVersion string, currentChart string) (*Dependencies, error) {
+func InitDependencies(repoRoot string, rootFs billy.Filesystem, branchVersion string, currentChart string) (*Dependencies, error) {
 	var err error
 
-	workDir, err := os.Getwd()
-	if err != nil {
-		return nil, err
-	}
+	workDir := repoRoot
 
 	git, err := git.OpenGitRepo(workDir)
 	if err != nil {

pkg/options/package.go

@@ -2,7 +2,6 @@ package options
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 
 	"github.com/go-git/go-billy/v5"
@@ -105,7 +104,7 @@ func LoadPackageOptionsFromFile(fs billy.Filesystem, path string) (PackageOption
 	if !exists {
 		return packageOptions, fmt.Errorf("unable to load package options from file %s since it does not exist", filesystem.GetAbsPath(fs, path))
 	}
-	chartOptionsBytes, err := ioutil.ReadFile(filesystem.GetAbsPath(fs, path))
+	chartOptionsBytes, err := os.ReadFile(filesystem.GetAbsPath(fs, path))
 	if err != nil {
 		return packageOptions, err
 	}
@@ -146,7 +145,7 @@ func LoadChartOptionsFromFile(fs billy.Filesystem, path string) (ChartOptions, e
 	if !exists {
 		return chartOptions, fmt.Errorf("unable to load chart options from file %s since it does not exist", filesystem.GetAbsPath(fs, path))
 	}
-	chartOptionsBytes, err := ioutil.ReadFile(filesystem.GetAbsPath(fs, path))
+	chartOptionsBytes, err := os.ReadFile(filesystem.GetAbsPath(fs, path))
 	if err != nil {
 		return chartOptions, err
 	}

pkg/options/validate.go

@@ -1,7 +1,6 @@
 package options
 
 import (
-	"io/ioutil"
 	"os"
 
 	"github.com/hashicorp/go-version"
@@ -78,7 +77,7 @@ func LoadReleaseOptionsFromFile(fs billy.Filesystem, path string) (ReleaseOption
 		// If release.yaml does not exist, return an empty ReleaseOptions
 		return releaseOptions, nil
 	}
-	releaseOptionsBytes, err := ioutil.ReadFile(filesystem.GetAbsPath(fs, path))
+	releaseOptionsBytes, err := os.ReadFile(filesystem.GetAbsPath(fs, path))
 	if err != nil {
 		return releaseOptions, err
 	}

pkg/puller/cache.go

@@ -13,16 +13,12 @@ import (
 var RootCache cacher = &noopCache{}
 
 // InitRootCache initializes a cache at the repository's root to be used, if it does not currently exist
-func InitRootCache(cacheMode bool, path string) error {
+func InitRootCache(repoRoot string, cacheMode bool, path string) error {
 	if !cacheMode {
 		return nil
 	}
 	logrus.Infof("Setting up cache at %s", path)
 	// Get repository filesystem
-	repoRoot, err := os.Getwd()
-	if err != nil {
-		return fmt.Errorf("unable to get current working directory: %s", err)
-	}
 	rootFs := filesystem.GetFilesystem(repoRoot)
 
 	// Instantiate cache
@@ -41,12 +37,7 @@ func InitRootCache(cacheMode bool, path string) error {
 }
 
 // CleanRootCache removes any existing entries in the cache
-func CleanRootCache(path string) error {
-	// Get repository filesystem
-	repoRoot, err := os.Getwd()
-	if err != nil {
-		logrus.Fatalf("Unable to get current working directory: %s", err)
-	}
+func CleanRootCache(repoRoot string, path string) error {
 	rootFs := filesystem.GetFilesystem(repoRoot)
 	if err := filesystem.RemoveAll(rootFs, path); err != nil {
 		return err