grafana/pkg/apimachinery/apis/common/v0alpha1/secure_values_test.go

package v0alpha1

import (
	"bytes"
	"encoding/json"
	"fmt"
	"testing"

	"github.com/stretchr/testify/require"
	"gopkg.in/yaml.v3"
)

func TestSecureValues(t *testing.T) {
	expected := "[REDACTED]"

	rawValue := "a-password"
	esv := NewSecretValue(rawValue)

	// String must not return the exposed secure value.
	require.Equal(t, expected, esv.String())

	// Format/GoString must not return the exposed secure value.
	require.Equal(t, expected, fmt.Sprintf("%+#v", esv))
	require.Equal(t, expected, fmt.Sprintf("%v", esv))
	require.Equal(t, expected, fmt.Sprintf("%s", esv))

	buf := new(bytes.Buffer)
	_, err := fmt.Fprintf(buf, "%#v", esv)
	require.NoError(t, err)
	require.Equal(t, expected, buf.String())

	// MarshalJSON must not return the exposed secure value.
	bytes, err := json.Marshal(esv)
	require.NoError(t, err)
	require.Equal(t, `"`+expected+`"`, string(bytes))

	// MarshalYAML must not return the exposed secure value.
	bytes, err = yaml.Marshal(esv)
	require.NoError(t, err)
	require.Equal(t, "'"+expected+"'\n", string(bytes))

	// DangerouslyExposeAndConsumeValue returns the raw value.
	require.Equal(t, rawValue, esv.DangerouslyExposeAndConsumeValue())

	// Further calls to DangerouslyExposeAndConsumeValue will panic.
	require.Panics(t, func() { esv.DangerouslyExposeAndConsumeValue() })
}