steampipe/cmd/plugin.go

package cmd

import (
	"fmt"
	"log"
	"os"
	"strings"

	"github.com/turbot/steampipe/constants"

	"github.com/jedib0t/go-pretty/v6/table"
	"github.com/spf13/cobra"
	"github.com/turbot/steampipe-plugin-sdk/logging"
	"github.com/turbot/steampipe/cmdconfig"
	"github.com/turbot/steampipe/db"
	"github.com/turbot/steampipe/pluginmanager"
	"github.com/turbot/steampipe/utils"
)

func init() {
	rootCmd.AddCommand(PluginCmd())
}

// PluginCmd :: Plugin management commands
func PluginCmd() *cobra.Command {

	var cmd = &cobra.Command{
		Use:   "plugin [command]",
		Args:  cobra.NoArgs,
		Short: "Steampipe plugin management",
		Long: `Steampipe plugin management.

Plugins extend Steampipe to work with many different services and providers.
Find plugins using the public registry at https://registry.steampipe.io.

Examples:

  # Install or update a plugin
  steampipe plugin install aws

  # List installed plugins
  steampipe plugin list

  # Uninstall a plugin
  steampipe plugin uninstall aws`,
	}

	cmd.AddCommand(PluginInstallCmd())
	cmd.AddCommand(PluginListCmd())
	cmd.AddCommand(PluginUninstallCmd())

	return cmd
}

// PluginInstallCmd :: Install a plugin
func PluginInstallCmd() *cobra.Command {

	var cmd = &cobra.Command{
		Use:   "install [flags] [registry/[org/]]name[:version]",
		Args:  cobra.ArbitraryArgs,
		Run:   runPluginInstallCmd,
		Short: "Install or update a plugin",
		Long: `Install or update a plugin.

Install a Steampipe plugin, making it available for queries and configuration.
The plugin name format is [registry/[org/]]name[:version]. The default
registry is registry.steampipe.io, default org is turbot and default version
is latest. The name is a required argument.

Examples:

  # Install a common plugin (turbot/aws)
  steampipe plugin install aws

  # Install a plugin published by DMI to the public registry
  steampipe plugin install dmi/paper

  # Install a plugin from a private registry
  steampipe plugin install my-registry.dmi.com/dmi/internal

  # Install a specific plugin version
  steampipe plugin install turbot/azure:0.1.0

  # Update a plugin to the latest version (identical to installing it)
  steampipe plugin install aws

  # Update all plugins to their latest available version
  steampipe plugin install --update-all

  # Install multiple plugins at once
  steampipe plugin install aws dmi/paper`,
	}

	cmdconfig.
		OnCmd(cmd).
		AddBoolFlag("update-all", "", false, "Update each plugin to its latest available version")

	return cmd
}

// PluginListCmd :: List plugins
func PluginListCmd() *cobra.Command {

	var cmd = &cobra.Command{
		Use:   "list",
		Args:  cobra.NoArgs,
		Run:   runPluginListCmd,
		Short: "List currently installed plugins",
		Long: `List currently installed plugins.

List all Steampipe plugins installed for this user.

Examples:

  # List installed plugins
  steampipe plugin list

  # List plugins that have updates available
  steampipe plugin list --outdated`,
	}

	cmdconfig.
		OnCmd(cmd).
		AddBoolFlag("outdated", "", false, "Check each plugin in the list for updates")

	return cmd
}

// PluginUninstallCmd :: Uninstall a plugin
func PluginUninstallCmd() *cobra.Command {
	var cmd = &cobra.Command{
		Use:   "uninstall [flags] [registry/[org/]]name",
		Args:  cobra.ArbitraryArgs,
		Run:   runPluginUninstallCmd,
		Short: "Uninstall a plugin",
		Long: `Uninstall a plugin.

Uninstall a Steampipe plugin, removing it from use. The plugin name format is
[registry/[org/]]name. (Version is not relevant in uninstall, since only one
version of a plugin can be installed at a time.)

Examples:

  # Uninstall a common plugin (turbot/aws)
  steampipe plugin uninstall aws

  # Uninstall a plugin published by DMI to the public registry
  steampipe plugin uninstall dmi/paper

  # Uninstall a plugin from a private registry
  steampipe plugin uninstall my-registry.dmi.com/dmi/internal`,
	}

	cmdconfig.OnCmd(cmd)

	return cmd
}

func runPluginInstallCmd(cmd *cobra.Command, args []string) {
	logging.LogTime("runPluginInstallCmd install")
	defer logging.LogTime("runPluginInstallCmd end")

	// args to 'plugin install' -- one or more plugins to install
	// These can be simple names ('aws') for "standard" plugins, or
	// full refs to the OCI image (us-docker.pkg.dev/steampipe/plugin/turbot/aws:1.0.0)
	for _, plugin := range args {
		if len(args) > 1 {
			fmt.Println("")
		}
		if image, err := pluginmanager.Install(plugin); err != nil {
			msg := fmt.Sprintf("plugin install failed for plugin '%s'", plugin)
			if strings.HasSuffix(err.Error(), "not found") {
				msg += ": not found"
			} else {
				log.Printf("[DEBUG] %s", err.Error())
			}
			utils.ShowError(fmt.Errorf(msg))
			return
		} else {
			versionString := ""
			if image.Config.Plugin.Version != "" {
				versionString = " v" + image.Config.Plugin.Version
			}
			fmt.Printf("Installed plugin: %s%s\n", constants.Bold(plugin), versionString)
			org := image.Config.Plugin.Organization
			if org == "turbot" {
				fmt.Println(fmt.Sprintf("Documentation:    https://hub.steampipe.io/plugins/%s/%s", org, plugin))
			}
		}
	}
	if len(args) > 1 {
		fmt.Println("")
	}

}

func runPluginListCmd(cmd *cobra.Command, args []string) {
	logging.LogTime("runPluginListCmd list")
	defer logging.LogTime("runPluginListCmd end")

	connectionMap, err := getPluginConnectionMap()
	if err != nil {
		utils.ShowErrorWithMessage(err,
			fmt.Sprintf("Plugin Listing failed"))
		return
	}

	list, err := pluginmanager.List(connectionMap)
	if err != nil {
		utils.ShowErrorWithMessage(err,
			fmt.Sprintf("Plugin Listing failed"))
	}
	t := table.NewWriter()
	t.SetStyle(table.StyleLight)
	t.SetOutputMirror(os.Stdout)
	t.AppendHeader(table.Row{"Name", "Version", "Connections"})
	for _, item := range list {
		t.AppendRow(table.Row{item.Name, item.Version, strings.Join(item.Connections, ",")})
	}
	t.Render()
}

func runPluginUninstallCmd(cmd *cobra.Command, args []string) {
	logging.LogTime("runPluginUninstallCmd uninstall")
	defer logging.LogTime("runPluginUninstallCmd end")

	connectionMap, err := getPluginConnectionMap()
	if err != nil {
		utils.ShowError(err)
		return
	}

	for _, plugin := range args {
		if err := pluginmanager.Remove(plugin, connectionMap); err != nil {
			utils.ShowErrorWithMessage(err, fmt.Sprintf("Failed to uninstall plugin '%s'", plugin))
		} else {
			fmt.Println("Uninstalled plugin", plugin)
		}
	}
}

// returns a map of pluginFullName -> []{connections using pluginFullName}
func getPluginConnectionMap() (map[string][]string, error) {
	status, err := db.GetStatus()
	if err != nil {
		return nil, fmt.Errorf("Could not start steampipe service")
	}

	if status == nil {
		// the db service is not started - start it
		db.StartService(db.InvokerPlugin)
		defer func() {
			status, _ := db.GetStatus()
			if status.Invoker == db.InvokerPlugin {
				db.StopDB(true)
			}
		}()
	}

	client, err := db.GetClient(true)
	if err != nil {
		return nil, fmt.Errorf("Could not connect with steampipe service")
	}

	pluginConnectionMap := map[string][]string{}

	for k, v := range *client.ConnectionMap() {
		_, found := pluginConnectionMap[v.Plugin]
		if !found {
			pluginConnectionMap[v.Plugin] = []string{}
		}
		pluginConnectionMap[v.Plugin] = append(pluginConnectionMap[v.Plugin], k)
	}
	return pluginConnectionMap, nil
}