Override default index (kubernetes-sigs#666)

* Add initial changes

* Use krew-index tar for alternative default index

* Add tests for index list and install

* Use consistent naming for new tests

* Don't initialize index in test and let update clone it

* Add code change suggestions

* Remove extra tests

* Remove outdated comment

* Fix code patterns error

* Update integration_test/version_test.go

Co-authored-by: Cornelius Weig <[email protected]>

Co-authored-by: Cornelius Weig <[email protected]>

Author: chriskim06

integration_test/version_test.go

@@ -19,6 +19,8 @@ import (
 	"regexp"
 	"strings"
 	"testing"
+
+	"github.com/pkg/errors"
 )
 
 func TestKrewVersion(t *testing.T) {
@@ -27,7 +29,25 @@ func TestKrewVersion(t *testing.T) {
 	test := NewTest(t)
 
 	stdOut := string(test.Krew("version").RunOrFailOutput())
+	err := checkRequiredSubstrings(test, "https://github.com/kubernetes-sigs/krew-index.git", stdOut)
+	if err != nil {
+		t.Error(err)
+	}
+}
 
+func TestKrewVersion_CustomDefaultIndexURI(t *testing.T) {
+	skipShort(t)
+
+	test := NewTest(t)
+
+	stdOut := string(test.WithEnv("KREW_DEFAULT_INDEX_URI", "foo").Krew("version").RunOrFailOutput())
+	err := checkRequiredSubstrings(test, "foo", stdOut)
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func checkRequiredSubstrings(test *ITest, index, stdOut string) error {
 	lineSplit := regexp.MustCompile(`\s+`)
 	actual := make(map[string]string)
 	for _, line := range strings.Split(stdOut, "\n") {
@@ -36,7 +56,7 @@ func TestKrewVersion(t *testing.T) {
 		}
 		optionValue := lineSplit.Split(line, 2)
 		if len(optionValue) < 2 {
-			t.Errorf("Expect `krew version` to output `OPTION VALUE` pair separated by spaces, got: %v", optionValue)
+			return errors.Errorf("`%v` is not an `OPTION VALUE` pair separated by spaces", optionValue)
 		}
 		actual[optionValue[0]] = optionValue[1]
 	}
@@ -46,7 +66,7 @@ func TestKrewVersion(t *testing.T) {
 		"BasePath":         test.Root(),
 		"GitTag":           "",
 		"GitCommit":        "",
-		"IndexURI":         "https://github.com/kubernetes-sigs/krew-index.git",
+		"IndexURI":         index,
 		"IndexPath":        path.Join(test.Root(), "index"),
 		"InstallPath":      path.Join(test.Root(), "store"),
 		"BinPath":          path.Join(test.Root(), "bin"),
@@ -56,9 +76,11 @@ func TestKrewVersion(t *testing.T) {
 	for k, v := range requiredSubstrings {
 		got, ok := actual[k]
 		if !ok {
-			t.Errorf("`krew version` output doesn't contain field %q", k)
+			return errors.Errorf("`krew version` output doesn't contain field %q", k)
 		} else if !strings.Contains(got, v) {
-			t.Errorf("`krew version` %q field doesn't contain string %q (got: %q)", k, v, got)
+			return errors.Errorf("`krew version` %q field doesn't contain string %q (got: %q)", k, v, got)
 		}
 	}
+
+	return nil
 }

pkg/constants/constants.go

@@ -14,14 +14,26 @@
 
 package constants
 
+import "os"
+
 const (
 	CurrentAPIVersion = "krew.googlecontainertools.github.com/v1alpha2"
 	PluginKind        = "Plugin"
 	ManifestExtension = ".yaml"
 	KrewPluginName    = "krew" // plugin name of krew itself
 
-	// DefaultIndexURI points to the upstream index.
-	DefaultIndexURI = "https://github.com/kubernetes-sigs/krew-index.git"
 	// DefaultIndexName is a magic string that's used for a plugin name specified without an index.
 	DefaultIndexName = "default"
+
+	// defaultIndexURI is the default krew-index URI that gets used unless it's overridden
+	defaultIndexURI = "https://github.com/kubernetes-sigs/krew-index.git"
 )
+
+// DefaultIndexURI points to the upstream index.
+var DefaultIndexURI = defaultIndexURI
+
+func init() {
+	if uri := os.Getenv("KREW_DEFAULT_INDEX_URI"); uri != "" {
+		DefaultIndexURI = uri
+	}
+}