Incorporated @ncdc feedback.

Author: Arvinderpal

cmd/clusterctl/pkg/client/repository/repository_local_unix.go

@@ -31,7 +31,7 @@ import (
 // localRepository provides support for providers located on the local filesystem.
 // As part of the provider object, the URL is expected to contain the absolute
 // path to the components yaml on the local filesystem.
-// In order to support different versions, the directories containing provider
+// To support different versions, the directories containing provider
 // specific data must adhere to the following layout:
 // {basepath}/{provider-name}/{version}/{components.yaml}
 //
@@ -44,8 +44,7 @@ import (
 // basepath: /home/user/go/src/sigs.k8s.io
 // provider-name: aws
 // version: v0.4.7
-// component.yaml: infrastructure-components.yaml
-
+// components.yaml: infrastructure-components.yaml
 type localRepository struct {
 	providerConfig        config.Provider
 	configVariablesClient config.VariablesClient
@@ -57,22 +56,22 @@ type localRepository struct {
 
 var _ Repository = &localRepository{}
 
-// DefaultVersion returns defaultVersion field of localRepository struct
+// DefaultVersion returns the default version for the local repository.
 func (r *localRepository) DefaultVersion() string {
 	return r.defaultVersion
 }
 
-// RootPath returns rootPath field of localRepository struct
+// RootPath returns the empty string as it is not applicable to local repositories.
 func (r *localRepository) RootPath() string {
-	return "" // Not applicable with localRepository
+	return ""
 }
 
-// ComponentsPath returns componentsPath field of localRepository struct
+// ComponentsPath returns the path to the components file for the local repository.
 func (r *localRepository) ComponentsPath() string {
 	return r.componentsPath
 }
 
-// GetFile returns a file for a given provider version
+// GetFile returns a file for a given provider version.
 func (r *localRepository) GetFile(version, fileName string) ([]byte, error) {
 	var err error
 
@@ -87,34 +86,51 @@ func (r *localRepository) GetFile(version, fileName string) ([]byte, error) {
 
 	absolutePath := filepath.Join(r.basepath, r.providerName, version, r.RootPath(), fileName)
 
-	if f, err := os.Stat(absolutePath); err == nil {
-		if f.IsDir() {
-			return nil, errors.Errorf("invalid path: file %q is actually a directory %q", fileName, absolutePath)
-		}
-		content, err := ioutil.ReadFile(absolutePath)
-		if err != nil {
-			return nil, errors.Wrapf(err, "failed to read files from local release %s", version)
-		}
-		return content, nil
+	f, err := os.Stat(absolutePath)
+	if err != nil {
+		return nil, errors.Errorf("failed to read file %q from local release %s", absolutePath, version)
+	}
+	if f.IsDir() {
+		return nil, errors.Errorf("invalid path: file %q is actually a directory %q", fileName, absolutePath)
+	}
+	content, err := ioutil.ReadFile(absolutePath)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to read file %q from local release %s", absolutePath, version)
 	}
-	return nil, errors.Errorf("failed to read files from local release %s, path %s", version, absolutePath)
+	return content, nil
 
 }
 
-// GetVersion returns the list of versions that are available for a local repository
+// GetVersions returns the list of versions that are available for a local repository.
 func (r *localRepository) GetVersions() ([]string, error) {
-	versions, err := r.getVersions()
+	// get all the sub-directories under {basepath}/{provider-name}/
+	releasesPath := filepath.Join(r.basepath, r.providerName)
+	files, err := ioutil.ReadDir(releasesPath)
 	if err != nil {
-		return nil, errors.Wrapf(err, "failed to get local repository versions")
+		return nil, errors.Wrap(err, "failed to list release directories")
+	}
+	versions := []string{}
+	for _, f := range files {
+		if !f.IsDir() {
+			continue
+		}
+		r := f.Name()
+		sv, err := version.ParseSemantic(r)
+		if err != nil {
+			// discard releases with tags that are not a valid semantic versions (the user can point explicitly to such releases)
+			continue
+		}
+		if sv.PreRelease() != "" || sv.BuildMetadata() != "" {
+			// discard pre-releases or build releases (the user can point explicitly to such releases)
+			continue
+		}
+		versions = append(versions, r)
 	}
 	return versions, nil
 }
 
-// newLocalRepository returns a localRepository implementation
+// newLocalRepository returns a new localRepository.
 func newLocalRepository(providerConfig config.Provider, configVariablesClient config.VariablesClient) (*localRepository, error) {
-
-	var err error
-
 	url, err := url.Parse(providerConfig.URL())
 	if err != nil {
 		return nil, errors.Wrap(err, "invalid url")
@@ -167,14 +183,12 @@ func newLocalRepository(providerConfig config.Provider, configVariablesClient co
 			return nil, errors.Wrap(err, "failed to get latest version")
 		}
 	}
-
 	return repo, nil
 }
 
 // getLatestRelease returns the latest release for the local repository.
 func (r *localRepository) getLatestRelease() (string, error) {
-
-	versions, err := r.getVersions()
+	versions, err := r.GetVersions()
 	if err != nil {
 		return "", errors.Wrapf(err, "failed to get local repository versions")
 	}
@@ -195,31 +209,3 @@ func (r *localRepository) getLatestRelease() (string, error) {
 	}
 	return latestTag, nil
 }
-
-// getVersions returns all the release versions for a local repository
-func (r *localRepository) getVersions() ([]string, error) {
-	// get all the sub-directories under {basepath}/{provider-name}/
-	releasesPath := filepath.Join(r.basepath, r.providerName)
-	files, err := ioutil.ReadDir(releasesPath)
-	if err != nil {
-		return nil, errors.Wrap(err, "failed to list release directories")
-	}
-	versions := []string{}
-	for _, f := range files {
-		if !f.IsDir() {
-			continue
-		}
-		r := f.Name()
-		sv, err := version.ParseSemantic(r)
-		if err != nil {
-			// discard releases with tags that are not a valid semantic versions (the user can point explicitly to such releases)
-			continue
-		}
-		if sv.PreRelease() != "" || sv.BuildMetadata() != "" {
-			// discard pre-releases or build releases (the user can point explicitly to such releases)
-			continue
-		}
-		versions = append(versions, r)
-	}
-	return versions, nil
-}