code.vegaprotocol.io/vega@v0.79.0/wallet/service/store/v1/store_test.go

// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package v1_test

import (
	"testing"
	"time"

	vgencoding "code.vegaprotocol.io/vega/libs/encoding"
	vgrand "code.vegaprotocol.io/vega/libs/rand"
	vgtest "code.vegaprotocol.io/vega/libs/test"
	"code.vegaprotocol.io/vega/paths"
	"code.vegaprotocol.io/vega/wallet/service"
	storeV1 "code.vegaprotocol.io/vega/wallet/service/store/v1"
	v1 "code.vegaprotocol.io/vega/wallet/service/v1"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"go.uber.org/zap"
)

func TestFileStoreV1(t *testing.T) {
	t.Run("New store succeeds", testNewStoreSucceeds)
	t.Run("Saving already existing RSA keys succeeds", testFileStoreV1SaveAlreadyExistingRSAKeysSucceeds)
	t.Run("Saving RSA keys succeeds", testFileStoreV1SaveRSAKeysSucceeds)
	t.Run("Verifying non-existing RSA keys fails", testFileStoreV1VerifyingNonExistingRSAKeysFails)
	t.Run("Verifying existing RSA keys succeeds", testFileStoreV1VerifyingExistingRSAKeysSucceeds)
	t.Run("Getting non-existing RSA keys fails", testFileStoreV1GetNonExistingRSAKeysFails)
	t.Run("Getting existing RSA keys succeeds", testFileStoreV1GetExistingRSAKeysSucceeds)
	t.Run("Getting config while not being initialised succeeds", testFileStoreV1GetConfigWhileNotInitialisedSucceeds)
	t.Run("Saving config succeeds", testFileStoreV1SavingConfigSucceeds)
	t.Run("Verifying config succeeds", testFileStoreV1VerifyingConfigSucceeds)
}

func testNewStoreSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	s, err := storeV1.InitialiseStore(vegaHome)

	require.NoError(t, err)
	assert.NotNil(t, s)
	vgtest.AssertDirAccess(t, rsaKeysHome(t, vegaHome))
}

func testFileStoreV1SaveAlreadyExistingRSAKeysSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	keys := &v1.RSAKeys{
		Pub:  []byte("my public key"),
		Priv: []byte("my private key"),
	}

	// when
	err := s.SaveRSAKeys(keys)

	// then
	require.NoError(t, err)

	// when
	err = s.SaveRSAKeys(keys)

	// then
	require.NoError(t, err)
}

func testFileStoreV1SaveRSAKeysSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	keys := &v1.RSAKeys{
		Pub:  []byte("my public key"),
		Priv: []byte("my private key"),
	}

	// when
	err := s.SaveRSAKeys(keys)

	// then
	require.NoError(t, err)
	vgtest.AssertFileAccess(t, publicRSAKeyFilePath(t, vegaHome))
	vgtest.AssertFileAccess(t, privateRSAKeyFilePath(t, vegaHome))

	// when
	returnedKeys, err := s.GetRsaKeys()

	// then
	require.NoError(t, err)
	assert.Equal(t, keys, returnedKeys)
}

func testFileStoreV1VerifyingNonExistingRSAKeysFails(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)

	// when
	exists, err := s.RSAKeysExists()

	// then
	assert.NoError(t, err)
	assert.False(t, exists)
}

func testFileStoreV1VerifyingExistingRSAKeysSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	keys := &v1.RSAKeys{
		Pub:  []byte("my public key"),
		Priv: []byte("my private key"),
	}

	// when
	err := s.SaveRSAKeys(keys)

	// then
	require.NoError(t, err)
	vgtest.AssertFileAccess(t, publicRSAKeyFilePath(t, vegaHome))
	vgtest.AssertFileAccess(t, privateRSAKeyFilePath(t, vegaHome))

	// when
	exists, err := s.RSAKeysExists()

	// then
	require.NoError(t, err)
	assert.True(t, exists)
}

func testFileStoreV1GetNonExistingRSAKeysFails(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)

	// when
	keys, err := s.GetRsaKeys()

	// then
	assert.Error(t, err)
	assert.Nil(t, keys)
}

func testFileStoreV1GetExistingRSAKeysSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	keys := &v1.RSAKeys{
		Pub:  []byte("my public key"),
		Priv: []byte("my private key"),
	}

	// when
	err := s.SaveRSAKeys(keys)

	// then
	require.NoError(t, err)
	vgtest.AssertFileAccess(t, publicRSAKeyFilePath(t, vegaHome))
	vgtest.AssertFileAccess(t, privateRSAKeyFilePath(t, vegaHome))

	// when
	returnedKeys, err := s.GetRsaKeys()

	// then
	require.NoError(t, err)
	assert.Equal(t, keys, returnedKeys)
}

func testFileStoreV1GetConfigWhileNotInitialisedSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)

	// when
	cfg, err := s.GetConfig()

	// then
	require.NoError(t, err)
	assert.Equal(t, service.DefaultConfig(), cfg)
}

func testFileStoreV1SavingConfigSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	originalCfg := &service.Config{
		LogLevel: vgencoding.LogLevel{
			Level: zap.DebugLevel,
		},
		Server: service.ServerConfig{
			Port: 123456789,
			Host: vgrand.RandomStr(5),
		},
		APIV1: service.APIV1Config{
			MaximumTokenDuration: vgencoding.Duration{
				Duration: 234 * time.Second,
			},
		},
	}

	// when
	err := s.SaveConfig(originalCfg)

	// then
	require.NoError(t, err)

	// when
	cfg, err := s.GetConfig()

	// then
	require.NoError(t, err)
	assert.Equal(t, originalCfg, cfg)
}

func testFileStoreV1VerifyingConfigSucceeds(t *testing.T) {
	vegaHome := newVegaHome(t)

	// given
	s := initialiseFromPath(t, vegaHome)
	originalCfg := &service.Config{
		LogLevel: vgencoding.LogLevel{
			Level: zap.DebugLevel,
		},
		Server: service.ServerConfig{
			Port: 123456789,
			Host: vgrand.RandomStr(5),
		},
		APIV1: service.APIV1Config{
			MaximumTokenDuration: vgencoding.Duration{
				Duration: 234 * time.Second,
			},
		},
	}

	// when
	err := s.SaveConfig(originalCfg)

	// then
	require.NoError(t, err)

	// when
	cfg, err := s.GetConfig()

	// then
	require.NoError(t, err)
	assert.Equal(t, originalCfg, cfg)
}

func initialiseFromPath(t *testing.T, vegaHome *paths.CustomPaths) *storeV1.Store {
	t.Helper()
	s, err := storeV1.InitialiseStore(vegaHome)
	if err != nil {
		t.Fatalf("couldn't initialise store: %v", err)
	}

	return s
}

func newVegaHome(t *testing.T) *paths.CustomPaths {
	t.Helper()
	return &paths.CustomPaths{CustomHome: t.TempDir()}
}

func rsaKeysHome(t *testing.T, vegaHome *paths.CustomPaths) string {
	t.Helper()
	return vegaHome.DataPathFor(paths.WalletServiceRSAKeysDataHome)
}

func publicRSAKeyFilePath(t *testing.T, vegaHome *paths.CustomPaths) string {
	t.Helper()
	return vegaHome.DataPathFor(paths.WalletServicePublicRSAKeyDataFile)
}

func privateRSAKeyFilePath(t *testing.T, vegaHome *paths.CustomPaths) string {
	t.Helper()
	return vegaHome.DataPathFor(paths.WalletServicePrivateRSAKeyDataFile)
}