Do not expect specific folder layout in LoadPluginFileFromFS

kubernetes-sigs · Jun 21, 2019 · eb428ac · eb428ac
1 parent 52bc435
commit eb428ac
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 12 deletions.
diff --git a/cmd/krew/cmd/install.go b/cmd/krew/cmd/install.go
@@ -84,7 +84,7 @@ Remarks:
 
 			var install []index.Plugin
 			for _, name := range pluginNames {
-				plugin, err := indexscanner.LoadPluginFileFromFS(paths.IndexPath(), name)
+				plugin, err := indexscanner.LoadPluginFileFromFS(paths.IndexPluginsPath(), name)
 				if err != nil {
 					return errors.Wrapf(err, "failed to load plugin %q from the index", name)
 				}

diff --git a/cmd/krew/cmd/search.go b/cmd/krew/cmd/search.go
@@ -41,7 +41,7 @@ Examples:
   To fuzzy search plugins with a keyword:
     kubectl krew search KEYWORD`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		plugins, err := indexscanner.LoadPluginListFromFS(paths.IndexPath())
+		plugins, err := indexscanner.LoadPluginListFromFS(paths.IndexPluginsPath())
 		if err != nil {
 			return errors.Wrap(err, "failed to load the index")
 		}

diff --git a/cmd/krew/cmd/upgrade.go b/cmd/krew/cmd/upgrade.go
@@ -53,7 +53,7 @@ kubectl krew upgrade foo bar"`,
 		}
 
 		for _, name := range pluginNames {
-			plugin, err := indexscanner.LoadPluginFileFromFS(paths.IndexPath(), name)
+			plugin, err := indexscanner.LoadPluginFileFromFS(paths.IndexPluginsPath(), name)
 			if err != nil {
 				return errors.Wrapf(err, "failed to load the index file for plugin %s", plugin.Name)
 			}

diff --git a/pkg/environment/environment.go b/pkg/environment/environment.go
@@ -59,6 +59,11 @@ func (p Paths) BasePath() string { return p.base }
 // e.g. {IndexPath}/plugins/{plugin}.yaml
 func (p Paths) IndexPath() string { return filepath.Join(p.base, "index") }
 
+// IndexPluginsPath returns the plugins directory of the index repository.
+//
+// e.g. {IndexPath}/plugins/
+func (p Paths) IndexPluginsPath() string { return filepath.Join(p.base, "index", "plugins") }
+
 // ReceiptsPath returns the base directory where plugin receipts are stored.
 //
 // e.g. {ReceiptsPath}/krew-index/{plugin}.yaml

diff --git a/pkg/environment/environment_test.go b/pkg/environment/environment_test.go
@@ -56,6 +56,9 @@ func TestPaths(t *testing.T) {
 	if got, expected := p.IndexPath(), filepath.FromSlash("/foo/index"); got != expected {
 		t.Fatalf("IndexPath()=%s; expected=%s", got, expected)
 	}
+	if got, expected := p.IndexPluginsPath(), filepath.FromSlash("/foo/index/plugins"); got != expected {
+		t.Fatalf("IndexPluginsPath()=%s; expected=%s", got, expected)
+	}
 	if got, expected := p.InstallPath(), filepath.FromSlash("/foo/store"); got != expected {
 		t.Fatalf("InstallPath()=%s; expected=%s", got, expected)
 	}

diff --git a/pkg/index/indexscanner/scanner.go b/pkg/index/indexscanner/scanner.go
@@ -38,7 +38,7 @@ func LoadPluginListFromFS(indexDir string) (index.PluginList, error) {
 		return indexList, err
 	}
 
-	files, err := ioutil.ReadDir(filepath.Join(indexDir, "plugins"))
+	files, err := ioutil.ReadDir(indexDir)
 	if err != nil {
 		return indexList, errors.Wrap(err, "failed to open index dir")
 	}
@@ -66,17 +66,17 @@ func LoadPluginListFromFS(indexDir string) (index.PluginList, error) {
 
 // LoadPluginFileFromFS loads a plugins index file by its name. When plugin
 // file not found, it returns an error that can be checked with os.IsNotExist.
-func LoadPluginFileFromFS(indexDir, pluginName string) (index.Plugin, error) {
+func LoadPluginFileFromFS(pluginsDir, pluginName string) (index.Plugin, error) {
 	if !index.IsSafePluginName(pluginName) {
 		return index.Plugin{}, errors.Errorf("plugin name %q not allowed", pluginName)
 	}
 
 	glog.V(4).Infof("Reading plugin %q", pluginName)
-	indexDir, err := filepath.EvalSymlinks(filepath.Join(indexDir, "plugins"))
+	pluginsDir, err := filepath.EvalSymlinks(pluginsDir)
 	if err != nil {
 		return index.Plugin{}, err
 	}
-	p, err := ReadPluginFile(filepath.Join(indexDir, pluginName+constants.ManifestExtension))
+	p, err := ReadPluginFile(filepath.Join(pluginsDir, pluginName+constants.ManifestExtension))
 	if os.IsNotExist(err) {
 		return index.Plugin{}, err
 	} else if err != nil {

diff --git a/pkg/index/indexscanner/scanner_test.go b/pkg/index/indexscanner/scanner_test.go
@@ -101,7 +101,7 @@ func TestLoadIndexListFromFS(t *testing.T) {
 		{
 			name: "load index dir",
 			args: args{
-				indexDir: filepath.Join(testdataPath(t), "testindex"),
+				indexDir: filepath.Join(testdataPath(t), "testindex", "plugins"),
 			},
 		},
 	}
@@ -134,7 +134,7 @@ func TestLoadIndexFileFromFS(t *testing.T) {
 		{
 			name: "load single index file",
 			args: args{
-				indexDir:   filepath.Join(testdataPath(t), "testindex"),
+				indexDir:   filepath.Join(testdataPath(t), "testindex", "plugins"),
 				pluginName: "foo",
 			},
 			wantErr:           false,
@@ -143,7 +143,7 @@ func TestLoadIndexFileFromFS(t *testing.T) {
 		{
 			name: "plugin file not found",
 			args: args{
-				indexDir:   filepath.FromSlash("./testdata"),
+				indexDir:   filepath.FromSlash("./testdata/plugins"),
 				pluginName: "not",
 			},
 			wantErr:           true,
@@ -152,7 +152,7 @@ func TestLoadIndexFileFromFS(t *testing.T) {
 		{
 			name: "plugin file bad name",
 			args: args{
-				indexDir:   filepath.FromSlash("./testdata"),
+				indexDir:   filepath.FromSlash("./testdata/plugins"),
 				pluginName: "wrongname",
 			},
 			wantErr:           true,

diff --git a/pkg/info/info.go b/pkg/info/info.go
@@ -39,5 +39,5 @@ func LoadManifestFromReceiptOrIndex(p environment.Paths, name string) (index.Plu
 	}
 
 	glog.V(3).Infof("Plugin manifest for %q not found in the receipts dir", name)
-	return indexscanner.LoadPluginFileFromFS(p.IndexPath(), name)
+	return indexscanner.LoadPluginFileFromFS(p.IndexPluginsPath(), name)
 }