vault/command/plugin_test.go

// Copyright IBM Corp. 2016, 2025
// SPDX-License-Identifier: BUSL-1.1

package command

import (
	"crypto/sha256"
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"testing"

	"github.com/hashicorp/vault/api"
)

// testPluginCreate creates a sample plugin in a tempdir and returns the shasum
// and filepath to the plugin.
func testPluginCreate(tb testing.TB, dir, name string) (string, string) {
	tb.Helper()

	pth := dir + "/" + name
	if err := ioutil.WriteFile(pth, nil, 0o755); err != nil {
		tb.Fatal(err)
	}

	f, err := os.Open(pth)
	if err != nil {
		tb.Fatal(err)
	}
	defer f.Close()

	h := sha256.New()
	if _, err := io.Copy(h, f); err != nil {
		tb.Fatal(err)
	}
	sha256Sum := fmt.Sprintf("%x", h.Sum(nil))

	return pth, sha256Sum
}

// testPluginCreateAndRegister creates a plugin and registers it in the catalog.
func testPluginCreateAndRegister(tb testing.TB, client *api.Client, dir, name string, pluginType api.PluginType, version string) (string, string) {
	tb.Helper()

	pth, sha256Sum := testPluginCreate(tb, dir, name)

	resp, err := client.Sys().RegisterPluginDetailed(&api.RegisterPluginInput{
		Name:    name,
		Type:    pluginType,
		Command: name,
		SHA256:  sha256Sum,
		Version: version,
	})
	if err != nil {
		tb.Fatal(err)
	}
	if len(resp.Warnings) > 0 {
		tb.Errorf("expected no warnings, got: %v", resp.Warnings)
	}

	return pth, sha256Sum
}

// testPluginCreateAndRegisterVersioned creates a versioned plugin and registers it in the catalog.
func testPluginCreateAndRegisterVersioned(tb testing.TB, client *api.Client, dir, name string, pluginType api.PluginType) (string, string, string) {
	tb.Helper()

	pth, sha256Sum := testPluginCreate(tb, dir, name)

	resp, err := client.Sys().RegisterPluginDetailed(&api.RegisterPluginInput{
		Name:    name,
		Type:    pluginType,
		Command: name,
		SHA256:  sha256Sum,
		Version: "v1.0.0",
	})
	if err != nil {
		tb.Fatal(err)
	}
	if len(resp.Warnings) > 0 {
		tb.Errorf("expected no warnings, got: %v", resp.Warnings)
	}

	return pth, sha256Sum, "v1.0.0"
}

func testPluginRegisterWithDownload(tb testing.TB, client *api.Client, name string, pluginType api.PluginType, version string) {
	tb.Helper()

	resp, err := client.Sys().RegisterPluginDetailed(&api.RegisterPluginInput{
		Name:     name,
		Type:     pluginType,
		Version:  version,
		Download: true,
	})
	if err != nil {
		tb.Fatal(err)
	}
	if len(resp.Warnings) > 0 {
		tb.Errorf("expected no warnings, got: %v", resp.Warnings)
	}
}