essentials.go

// Copyright 2023 VMware, Inc. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

package pluginmanager

import (
	"fmt"
	"os"

	"github.com/vmware-tanzu/tanzu-cli/pkg/constants"
	"github.com/vmware-tanzu/tanzu-cli/pkg/essentials"
	"github.com/vmware-tanzu/tanzu-plugin-runtime/log"
)

// InstallPluginsFromEssentialPluginGroup is a function that installs or upgrades the essential plugin groups.
func InstallPluginsFromEssentialPluginGroup() (string, error) {
	// Retrieve the name and version of the essential plugin group.
	name, version := essentials.GetEssentialsPluginGroupDetails()

	// Check if the plugins from the plugin group are installed, and if an update is available.
	installed, updateAvailable, err := IsPluginsFromPluginGroupInstalled(name, version, DisableLogs())
	// If there's an error, return it with additional context.
	if err != nil {
		return "", fmt.Errorf("failed to check if plugins from group are installed: %w", err)
	}

	// If the plugins are already installed and no update is available, return with no error.
	if installed && !updateAvailable {
		return "", nil
	}

	// If an update is available, log a message indicating that the essential plugin groups are being upgraded.
	// If the plugins are not installed, log a message indicating that the essential plugin groups are being installed.
	actionMessage := constants.InstallEssentialPluginGroupsMsg
	if updateAvailable {
		actionMessage = constants.UpgradeEssentialPluginGroupsMsg
	}

	log.Info(actionMessage)

	// Attempt to install or upgrade the essential plugin group.
	_, err = installPluginsFromEssentialPluginGroup(name, version)

	// Print an empty line to delimit the essential plugins output with any actual command output
	fmt.Fprintln(os.Stderr)

	// If there's an error during installation or upgrade, return it with additional context.
	if err != nil {
		return "", fmt.Errorf("failed to install or upgrade essential plugin group: %w", err)
	}

	// If the installation or upgrade is successful, return with no error.
	return "", nil
}

// installEssentialPluginGroup is a function that installs the essential plugin group.
func installPluginsFromEssentialPluginGroup(name, version string) (string, error) {
	pluginGroupNameWithVersion := name

	// Combine the name and version into a single string.
	if version != "" {
		pluginGroupNameWithVersion = fmt.Sprintf("%v:%v", pluginGroupNameWithVersion, version)
	}

	// Attempt to install the plugins from the group.
	groupWithVersion, err := InstallPluginsFromGroup("all", pluginGroupNameWithVersion, DisableLogs())

	// If there's an error during installation, return it with additional context.
	if err != nil {
		return "", fmt.Errorf("failed to install plugins from group: %w", err)
	}
	log.Successf("successfully installed all plugins from group '%s'", groupWithVersion)

	// If the installation is successful, return the group with version.
	return groupWithVersion, nil
}