ethdo/util/passphrases_test.go

// Copyright © 2019 Weald Technology Trading
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package util_test

import (
	"testing"

	"github.com/spf13/viper"
	"github.com/stretchr/testify/require"
	"github.com/wealdtech/ethdo/util"
)

func TestGetStorePassphrase(t *testing.T) {
	tests := []struct {
		name       string
		env        map[string]string
		store      string
		passphrase string
	}{
		{
			name: "Default",
			env: map[string]string{
				"store-passphrase": "pass",
			},
			store:      "test",
			passphrase: "pass",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			for k, v := range test.env {
				viper.Set(k, v)
			}
			require.Equal(t, test.passphrase, util.GetStorePassphrase(test.passphrase))
		})
	}
}

func TestGetWalletPassphrase(t *testing.T) {
	tests := []struct {
		name       string
		passphrase string
	}{
		{
			name:       "Good",
			passphrase: "pass",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			viper.Set("wallet-passphrase", test.passphrase)
			require.Equal(t, test.passphrase, util.GetWalletPassphrase())
		})
	}
}

func TestGetPassphrases(t *testing.T) {
	tests := []struct {
		name        string
		passphrases []string
	}{
		{
			name:        "Single",
			passphrases: []string{"pass"},
		},
		{
			name:        "Multi",
			passphrases: []string{"pass1", "pass2"},
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			if len(test.passphrases) == 1 {
				viper.Set("passphrase", test.passphrases[0])
			} else {
				viper.Set("passphrase", test.passphrases)
			}
			require.Equal(t, test.passphrases, util.GetPassphrases())
		})
	}
}

func TestGetPassphrase(t *testing.T) {
	tests := []struct {
		name        string
		passphrases interface{}
		err         string
	}{
		{
			name: "None",
			err:  "passphrase is required",
		},
		{
			name:        "Single",
			passphrases: "pass",
		},
		{
			name:        "Multi",
			passphrases: []string{"pass1", "pass2"},
			err:         "multiple passphrases supplied",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			viper.Set("passphrase", test.passphrases)
			res, err := util.GetPassphrase()
			if test.err != "" {
				require.EqualError(t, err, test.err)
			} else {
				require.NoError(t, err)
				require.Equal(t, test.passphrases, res)
			}
		})
	}
}

func TestGetOptionalPassphrase(t *testing.T) {
	tests := []struct {
		name        string
		passphrases interface{}
		err         string
	}{
		{
			name:        "None",
			passphrases: "",
		},
		{
			name:        "Single",
			passphrases: "pass",
		},
		{
			name:        "Multi",
			passphrases: []string{"pass1", "pass2"},
			err:         "multiple passphrases supplied",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			viper.Set("passphrase", test.passphrases)
			res, err := util.GetOptionalPassphrase()
			if test.err != "" {
				require.EqualError(t, err, test.err)
			} else {
				require.NoError(t, err)
				require.Equal(t, test.passphrases, res)
			}
		})
	}
}

func TestStorePassphrase(t *testing.T) {
	tests := []struct {
		name     string
		inputs   map[string]interface{}
		store    string
		expected string
	}{
		{
			name: "Nil",
		},
		{
			name: "Current",
			inputs: map[string]interface{}{
				"store-passphrase": "secret",
			},
			expected: "secret",
		},
		{
			name: "Deprecated",
			inputs: map[string]interface{}{
				"storepassphrase": "secret",
			},
			expected: "secret",
		},
		{
			name: "Override",
			inputs: map[string]interface{}{
				"storepassphrase":  "secret",
				"store-passphrase": "secret2",
			},
			expected: "secret2",
		},
		{
			name: "StoreSpecific",
			inputs: map[string]interface{}{
				"storepassphrase":        "secret",
				"store-passphrase":       "secret2",
				"stores.test.passphrase": "secret3",
			},
			store:    "test",
			expected: "secret3",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			for k, v := range test.inputs {
				viper.Set(k, v)
			}
			res := util.GetStorePassphrase(test.store)
			require.Equal(t, test.expected, res)
		})
	}
}

func TestWalletPassphrase(t *testing.T) {
	tests := []struct {
		name     string
		inputs   map[string]interface{}
		expected string
	}{
		{
			name: "Nil",
		},
		{
			name: "Current",
			inputs: map[string]interface{}{
				"wallet-passphrase": "secret",
			},
			expected: "secret",
		},
		{
			name: "Deprecated",
			inputs: map[string]interface{}{
				"walletpassphrase": "secret",
			},
			expected: "secret",
		},
		{
			name: "Override",
			inputs: map[string]interface{}{
				"walletpassphrase":  "secret",
				"wallet-passphrase": "secret2",
			},
			expected: "secret2",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			viper.Reset()
			for k, v := range test.inputs {
				viper.Set(k, v)
			}
			res := util.GetWalletPassphrase()
			require.Equal(t, test.expected, res)
		})
	}
}