Perform a catalog initialization if needed (#738)

If the last executed version is < 1.3.0, we refresh some of the catalog
data to make sure all the command remapping data is properly stored.

The commit also stores the last executed CLI version in the datastore to
make it available for future use.

Signed-off-by: Marc Khouzam <marc.khouzam@broadcom.com>

Author: marckhouzam

pkg/command/plugin_search_test.go

@@ -11,9 +11,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-
-	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
-	"github.com/vmware-tanzu/tanzu-plugin-runtime/config"
 )
 
 func TestPluginSearch(t *testing.T) {
@@ -61,10 +58,6 @@ func TestPluginSearch(t *testing.T) {
 	os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 	os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
 
-	featureArray := strings.Split(constants.FeatureContextCommand, ".")
-	err = config.SetFeature(featureArray[1], featureArray[2], "true")
-	assert.Nil(err)
-
 	defer func() {
 		os.Unsetenv("TANZU_CONFIG")
 		os.Unsetenv("TANZU_CONFIG_NEXT_GEN")

pkg/command/plugin_test.go

@@ -17,8 +17,6 @@ import (
 	"github.com/vmware-tanzu/tanzu-cli/pkg/catalog"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/cli"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/common"
-	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
-	"github.com/vmware-tanzu/tanzu-plugin-runtime/config"
 	configtypes "github.com/vmware-tanzu/tanzu-plugin-runtime/config/types"
 	"github.com/vmware-tanzu/tanzu-plugin-runtime/plugin"
 )
@@ -109,11 +107,6 @@ func TestPluginList(t *testing.T) {
 		os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 		os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
 
-		// Always turn on the context feature
-		featureArray := strings.Split(constants.FeatureContextCommand, ".")
-		err = config.SetFeature(featureArray[1], featureArray[2], "true")
-		assert.Nil(t, err)
-
 		var completionType uint8
 		t.Run(spec.test, func(t *testing.T) {
 			assert := assert.New(t)
@@ -389,10 +382,6 @@ func TestInstallPlugin(t *testing.T) {
 	os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 	os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
 
-	featureArray := strings.Split(constants.FeatureContextCommand, ".")
-	err = config.SetFeature(featureArray[1], featureArray[2], "true")
-	assert.Nil(err)
-
 	defer func() {
 		os.Unsetenv("TANZU_CONFIG")
 		os.Unsetenv("TANZU_CONFIG_NEXT_GEN")
@@ -444,10 +433,6 @@ func TestUpgradePlugin(t *testing.T) {
 	os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 	os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
 
-	featureArray := strings.Split(constants.FeatureContextCommand, ".")
-	err = config.SetFeature(featureArray[1], featureArray[2], "true")
-	assert.Nil(err)
-
 	defer func() {
 		os.Unsetenv("TANZU_CONFIG")
 		os.Unsetenv("TANZU_CONFIG_NEXT_GEN")

pkg/command/root.go

@@ -25,6 +25,7 @@ import (
 	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/discovery"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/globalinit"
+	"github.com/vmware-tanzu/tanzu-cli/pkg/lastversion"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/pluginmanager"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/pluginsupplier"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/recommendedversion"
@@ -297,6 +298,16 @@ func newRootCmd() *cobra.Command {
 			// for any other logic below.
 			if !shouldSkipGlobalInit(cmd) {
 				checkGlobalInit(cmd)
+
+				// Store the last executed CLI version in the datastore.
+				// This can be useful for future features.
+				// This must be done after the global initialization so initializers can
+				// use the previously stored version if necessary.
+				//
+				// Note that we cannot run this in the PersistentPostRunE because if the command fails,
+				// the PersistentPostRunE will not be called.  This could lead to the global initialization
+				// running again on the next command execution.
+				lastversion.SetLastExecutedCLIVersion()
 			}
 
 			// Ensure mutual exclusion in current contexts just in case if any plugins with old

pkg/command/root_test.go

@@ -19,6 +19,7 @@ import (
 	configtypes "github.com/vmware-tanzu/tanzu-plugin-runtime/config/types"
 	"github.com/vmware-tanzu/tanzu-plugin-runtime/plugin"
 
+	"github.com/vmware-tanzu/tanzu-cli/pkg/buildinfo"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/catalog"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/cli"
 	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
@@ -98,6 +99,7 @@ type testCLIEnvironment struct {
 	cacheDir     string
 	configFile   string
 	configFileNG string
+	dataStore    string
 	envVars      []string
 }
 
@@ -120,6 +122,9 @@ func setupTestCLIEnvironment(t *testing.T) testCLIEnvironment {
 	os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 	os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
 
+	tmpDataStoreFile, _ := os.CreateTemp("", "data-store.yaml")
+	os.Setenv("TEST_CUSTOM_DATA_STORE_FILE", tmpDataStoreFile.Name())
+
 	// Start each test with the defaults of the target commands
 	// and reset the help flag in case it was set
 	tmcCmd.ResetCommands()
@@ -145,12 +150,15 @@ func setupTestCLIEnvironment(t *testing.T) testCLIEnvironment {
 		cacheDir:     dir,
 		configFile:   configFile.Name(),
 		configFileNG: configFileNG.Name(),
+		dataStore:    tmpDataStoreFile.Name(),
+
 		envVars: []string{
 			"TEST_CUSTOM_CATALOG_CACHE_DIR",
 			"TANZU_CONFIG",
 			"TANZU_CONFIG_NEXT_GEN",
 			"TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER",
 			"TANZU_CLI_EULA_PROMPT_ANSWER",
+			"TEST_CUSTOM_DATA_STORE_FILE",
 		},
 	}
 }
@@ -160,6 +168,7 @@ func tearDownTestCLIEnvironment(env testCLIEnvironment) {
 	os.RemoveAll(env.cacheDir)
 	os.RemoveAll(env.configFile)
 	os.RemoveAll(env.configFileNG)
+	os.RemoveAll(env.dataStore)
 
 	for _, envVar := range env.envVars {
 		os.Unsetenv(envVar)
@@ -895,6 +904,48 @@ func TestGlobalInit(t *testing.T) {
 	}
 }
 
+func TestSetLastVersion(t *testing.T) {
+	tests := []struct {
+		test            string
+		version         string
+		expectedVersion string
+	}{
+		{
+			test:            "set version to v1.2.3",
+			version:         "v1.2.3",
+			expectedVersion: "v1.2.3",
+		},
+	}
+
+	originalVersion := buildinfo.Version
+	defer func() {
+		buildinfo.Version = originalVersion
+	}()
+
+	for _, spec := range tests {
+		env := setupTestCLIEnvironment(t)
+		defer tearDownTestCLIEnvironment(env)
+
+		t.Run(spec.test, func(t *testing.T) {
+			assert := assert.New(t)
+
+			buildinfo.Version = spec.version
+
+			rootCmd, err := NewRootCmd()
+			assert.Nil(err)
+			// Execute any command to trigger the version update
+			rootCmd.SetArgs([]string{"plugin", "list"})
+			err = rootCmd.Execute()
+			assert.Nil(err)
+
+			// Read the data store file and make sure it contains the last executed version
+			b, err := os.ReadFile(env.dataStore)
+			assert.Nil(err)
+			assert.Contains(string(b), spec.expectedVersion)
+		})
+	}
+}
+
 func TestEnvVarsSet(t *testing.T) {
 	env := setupTestCLIEnvironment(t)
 	defer tearDownTestCLIEnvironment(env)

pkg/config/defaults_test.go

@@ -5,7 +5,6 @@ package config
 
 import (
 	"os"
-	"strings"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -47,10 +46,6 @@ var _ = Describe("defaults test cases", func() {
 				configFileNG, err = os.CreateTemp("", "config_ng")
 				Expect(err).To(BeNil())
 				os.Setenv("TANZU_CONFIG_NEXT_GEN", configFileNG.Name())
-
-				featureArray := strings.Split(constants.FeatureContextCommand, ".")
-				err = configlib.SetFeature(featureArray[1], featureArray[2], "true")
-				Expect(err).To(BeNil())
 			})
 			AfterEach(func() {
 				os.Unsetenv("TANZU_CONFIG")

pkg/config/discovery_test.go

@@ -5,7 +5,6 @@ package config
 
 import (
 	"os"
-	"strings"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -31,10 +30,6 @@ var _ = Describe("Populate default central discovery", func() {
 		os.Setenv("TANZU_CONFIG_NEXT_GEN", configFileNG.Name())
 		os.Setenv("TANZU_CLI_CEIP_OPT_IN_PROMPT_ANSWER", "No")
 		os.Setenv("TANZU_CLI_EULA_PROMPT_ANSWER", "Yes")
-
-		featureArray := strings.Split(constants.FeatureContextCommand, ".")
-		err = configlib.SetFeature(featureArray[1], featureArray[2], "true")
-		Expect(err).To(BeNil())
 	})
 	AfterEach(func() {
 		os.Unsetenv("TANZU_CONFIG")

pkg/config/init.go

@@ -10,6 +10,10 @@ import (
 )
 
 func init() {
+	runInit()
+}
+
+func runInit() {
 	// Configure default feature flags
 	_ = config.ConfigureFeatureFlags(constants.DefaultCliFeatureFlags, config.SkipIfExists())
 

pkg/config/init_test.go

@@ -0,0 +1,82 @@
+// Copyright 2021 VMware, Inc. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Package config contains useful functionality for config updates
+package config
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
+	"github.com/vmware-tanzu/tanzu-plugin-runtime/config"
+)
+
+func TestFeatureContextCommandDoesNotGetSet(t *testing.T) {
+	assert := assert.New(t)
+
+	// Setup a temporary configuration
+	configFile, err := os.CreateTemp("", "config")
+	assert.Nil(err)
+	err = os.Setenv("TANZU_CONFIG", configFile.Name())
+	assert.Nil(err)
+	defer os.RemoveAll(configFile.Name())
+	defer os.Unsetenv("TANZU_CONFIG")
+
+	configFileNG, err := os.CreateTemp("", "config_ng")
+	assert.Nil(err)
+	err = os.Setenv("TANZU_CONFIG_NEXT_GEN", configFileNG.Name())
+	assert.Nil(err)
+	defer os.RemoveAll(configFileNG.Name())
+	defer os.Unsetenv("TANZU_CONFIG_NEXT_GEN")
+
+	runInit()
+
+	// Starting with CLI 1.3.0 we no longer set the feature flag features.global.context-target-v2.
+	// This is important because it allows us to determine if the last version executed was < 1.3.0.
+	assert.False(config.IsFeatureActivated(constants.FeatureContextCommand))
+}
+
+func TestCentralRepoGetsSet(t *testing.T) {
+	assert := assert.New(t)
+
+	// Setup a temporary configuration
+	configFile, err := os.CreateTemp("", "config")
+	assert.Nil(err)
+	err = os.Setenv("TANZU_CONFIG", configFile.Name())
+	assert.Nil(err)
+	defer os.RemoveAll(configFile.Name())
+	defer os.Unsetenv("TANZU_CONFIG")
+
+	configFileNG, err := os.CreateTemp("", "config_ng")
+	assert.Nil(err)
+	err = os.Setenv("TANZU_CONFIG_NEXT_GEN", configFileNG.Name())
+	assert.Nil(err)
+	defer os.RemoveAll(configFileNG.Name())
+	defer os.Unsetenv("TANZU_CONFIG_NEXT_GEN")
+
+	// Check that the central repo gets set
+	runInit()
+
+	sources, err := config.GetCLIDiscoverySources()
+	assert.Nil(err)
+	assert.Equal(1, len(sources))
+	assert.Equal(DefaultStandaloneDiscoveryName, sources[0].OCI.Name)
+	assert.Equal(constants.TanzuCLIDefaultCentralPluginDiscoveryImage, sources[0].OCI.Image)
+
+	// Check that the central repo does not get set if the user has deleted it
+	err = config.DeleteCLIDiscoverySource(DefaultStandaloneDiscoveryName)
+	assert.Nil(err)
+
+	sources, err = config.GetCLIDiscoverySources()
+	assert.Nil(err)
+	assert.Equal(0, len(sources))
+
+	runInit()
+
+	sources, err = config.GetCLIDiscoverySources()
+	assert.Nil(err)
+	assert.Equal(0, len(sources))
+}

pkg/constants/featureflags.go

@@ -6,6 +6,8 @@ package constants
 // This block is for global feature constants, to allow them to be used more broadly
 const (
 	// FeatureContextCommand determines whether to surface the context command. This is disabled by default.
+	// This feature flag is no longer used.  However, we keep it defined so that it can be used to know
+	// if an older CLI (< 1.3.0) was last executed.
 	FeatureContextCommand = "features.global.context-target-v2"
 
 	// FeaturePluginDiscoveryForTanzuContext determines whether to enable context-scoped plugin discovery for Tanzu context.
@@ -25,10 +27,5 @@ const (
 // mainstreaming the feature (with a default true value) under the flag name "features.global.foo-bar", as there will be
 // no conflict with previous installs (that have a false value for the entry "features.global.foo-bar-beta").
 var (
-	DefaultCliFeatureFlags = map[string]bool{
-		FeatureContextCommand: true,
-		// Do NOT include the test feature flag to disable the central repo.
-		// We don't want to publicize this feature flag.
-		// It defaults to false when not specified, which is what is needed.
-	}
+	DefaultCliFeatureFlags = map[string]bool{}
 )

pkg/discovery/oci_test.go

@@ -5,14 +5,11 @@ package discovery
 
 import (
 	"os"
-	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 
 	"github.com/vmware-tanzu/tanzu-cli/pkg/common"
-	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
-	"github.com/vmware-tanzu/tanzu-plugin-runtime/config"
 )
 
 func Test_NewOCIDiscovery(t *testing.T) {
@@ -26,10 +23,6 @@ func Test_NewOCIDiscovery(t *testing.T) {
 	assert.Nil(err)
 	os.Setenv("TANZU_CONFIG_NEXT_GEN", configFileNG.Name())
 
-	featureArray := strings.Split(constants.FeatureContextCommand, ".")
-	err = config.SetFeature(featureArray[1], featureArray[2], "true")
-	assert.Nil(err)
-
 	defer func() {
 		os.Unsetenv("TANZU_CONFIG")
 		os.Unsetenv("TANZU_CONFIG_NEXT_GEN")