gitlab.com/SiaPrime/SiaPrime@v1.4.1/modules/renter/contractor/persist_test.go

package contractor

import (
	"io/ioutil"
	"os"
	"path/filepath"
	"testing"

	"gitlab.com/NebulousLabs/fastrand"
	"gitlab.com/SiaPrime/SiaPrime/build"
	"gitlab.com/SiaPrime/SiaPrime/modules"
	"gitlab.com/SiaPrime/SiaPrime/modules/renter/proto"
	"gitlab.com/SiaPrime/SiaPrime/types"
)

// memPersist implements the persister interface in-memory.
type memPersist contractorPersist

func (m *memPersist) save(data contractorPersist) error { *m = memPersist(data); return nil }
func (m memPersist) load(data *contractorPersist) error { *data = contractorPersist(m); return nil }

// TestSaveLoad tests that the contractor can save and load itself.
func TestSaveLoad(t *testing.T) {
	// create contractor with mocked persist dependency
	c := &Contractor{
		persist: new(memPersist),
	}

	c.oldContracts = map[types.FileContractID]modules.RenterContract{
		{0}: {ID: types.FileContractID{0}, HostPublicKey: types.SiaPublicKey{Key: []byte("foo")}},
		{1}: {ID: types.FileContractID{1}, HostPublicKey: types.SiaPublicKey{Key: []byte("bar")}},
		{2}: {ID: types.FileContractID{2}, HostPublicKey: types.SiaPublicKey{Key: []byte("baz")}},
	}

	c.renewedFrom = map[types.FileContractID]types.FileContractID{
		{1}: {2},
	}
	c.renewedTo = map[types.FileContractID]types.FileContractID{
		{1}: {2},
	}

	// save, clear, and reload
	err := c.save()
	if err != nil {
		t.Fatal(err)
	}
	c.hdb = stubHostDB{}
	c.oldContracts = make(map[types.FileContractID]modules.RenterContract)
	c.renewedFrom = make(map[types.FileContractID]types.FileContractID)
	c.renewedTo = make(map[types.FileContractID]types.FileContractID)
	err = c.load()
	if err != nil {
		t.Fatal(err)
	}
	// Check that all fields were restored
	_, ok0 := c.oldContracts[types.FileContractID{0}]
	_, ok1 := c.oldContracts[types.FileContractID{1}]
	_, ok2 := c.oldContracts[types.FileContractID{2}]
	if !ok0 || !ok1 || !ok2 {
		t.Fatal("oldContracts were not restored properly:", c.oldContracts)
	}
	id := types.FileContractID{2}
	if c.renewedFrom[types.FileContractID{1}] != id {
		t.Fatal("renewedFrom not restored properly:", c.renewedFrom)
	}
	if c.renewedTo[types.FileContractID{1}] != id {
		t.Fatal("renewedTo not restored properly:", c.renewedTo)
	}
	// use stdPersist instead of mock
	c.persist = NewPersist(build.TempDir("contractor", t.Name()))
	os.MkdirAll(build.TempDir("contractor", t.Name()), 0700)

	// COMPATv136 save the allowance but make sure that the newly added fields
	// are 0. After loading them from disk they should be set to the default
	// values.
	c.allowance = modules.DefaultAllowance
	c.allowance.ExpectedStorage = 0
	c.allowance.ExpectedUpload = 0
	c.allowance.ExpectedDownload = 0
	c.allowance.ExpectedRedundancy = 0

	// save, clear, and reload
	err = c.save()
	if err != nil {
		t.Fatal(err)
	}
	c.oldContracts = make(map[types.FileContractID]modules.RenterContract)
	c.renewedFrom = make(map[types.FileContractID]types.FileContractID)
	c.renewedTo = make(map[types.FileContractID]types.FileContractID)
	err = c.load()
	if err != nil {
		t.Fatal(err)
	}
	// check that all fields were restored
	_, ok0 = c.oldContracts[types.FileContractID{0}]
	_, ok1 = c.oldContracts[types.FileContractID{1}]
	_, ok2 = c.oldContracts[types.FileContractID{2}]
	if !ok0 || !ok1 || !ok2 {
		t.Fatal("oldContracts were not restored properly:", c.oldContracts)
	}
	if c.renewedFrom[types.FileContractID{1}] != id {
		t.Fatal("renewedFrom not restored properly:", c.renewedFrom)
	}
	if c.renewedTo[types.FileContractID{1}] != id {
		t.Fatal("renewedTo not restored properly:", c.renewedTo)
	}
	if c.allowance.ExpectedStorage != modules.DefaultAllowance.ExpectedStorage {
		t.Errorf("ExpectedStorage was %v but should be %v",
			c.allowance.ExpectedStorage, modules.DefaultAllowance.ExpectedStorage)
	}
	if c.allowance.ExpectedUpload != modules.DefaultAllowance.ExpectedUpload {
		t.Errorf("ExpectedUpload was %v but should be %v",
			c.allowance.ExpectedUpload, modules.DefaultAllowance.ExpectedUpload)
	}
	if c.allowance.ExpectedDownload != modules.DefaultAllowance.ExpectedDownload {
		t.Errorf("ExpectedDownload was %v but should be %v",
			c.allowance.ExpectedDownload, modules.DefaultAllowance.ExpectedDownload)
	}
	if c.allowance.ExpectedRedundancy != modules.DefaultAllowance.ExpectedRedundancy {
		t.Errorf("ExpectedRedundancy was %v but should be %v",
			c.allowance.ExpectedRedundancy, modules.DefaultAllowance.ExpectedRedundancy)
	}

	// Change the expected* fields of the allowance again, save, clear and reload.
	c.allowance.ExpectedStorage = uint64(fastrand.Intn(100))
	c.allowance.ExpectedUpload = uint64(fastrand.Intn(100))
	c.allowance.ExpectedDownload = uint64(fastrand.Intn(100))
	c.allowance.ExpectedRedundancy = float64(fastrand.Intn(100))
	a := c.allowance
	// Save
	err = c.save()
	if err != nil {
		t.Fatal(err)
	}
	// Clear allowance.
	c.allowance = modules.Allowance{}
	// Load
	err = c.load()
	if err != nil {
		t.Fatal(err)
	}
	// Check if fields were restored.
	if c.allowance.ExpectedStorage != a.ExpectedStorage {
		t.Errorf("ExpectedStorage was %v but should be %v",
			c.allowance.ExpectedStorage, a.ExpectedStorage)
	}
	if c.allowance.ExpectedUpload != a.ExpectedUpload {
		t.Errorf("ExpectedUpload was %v but should be %v",
			c.allowance.ExpectedUpload, a.ExpectedUpload)
	}
	if c.allowance.ExpectedDownload != a.ExpectedDownload {
		t.Errorf("ExpectedDownload was %v but should be %v",
			c.allowance.ExpectedDownload, a.ExpectedDownload)
	}
	if c.allowance.ExpectedRedundancy != a.ExpectedRedundancy {
		t.Errorf("ExpectedRedundancy was %v but should be %v",
			c.allowance.ExpectedRedundancy, a.ExpectedRedundancy)
	}
}

// TestConvertPersist tests that contracts previously stored in the
// .journal format can be converted to the .contract format.
func TestConvertPersist(t *testing.T) {
	dir := build.TempDir(filepath.Join("contractor", t.Name()))
	os.MkdirAll(dir, 0700)
	// copy the test data into the temp folder
	testdata, err := ioutil.ReadFile(filepath.Join("testdata", "TestConvertPersist.journal"))
	if err != nil {
		t.Fatal(err)
	}
	err = ioutil.WriteFile(filepath.Join(dir, "contractor.journal"), testdata, 0600)
	if err != nil {
		t.Fatal(err)
	}

	// convert the journal
	err = convertPersist(dir)
	if err != nil {
		t.Fatal(err)
	}

	// load the persist
	var p contractorPersist
	err = NewPersist(dir).load(&p)
	if err != nil {
		t.Fatal(err)
	}
	if !p.Allowance.Funds.Equals64(10) || p.Allowance.Hosts != 7 || p.Allowance.Period != 3 || p.Allowance.RenewWindow != 20 {
		t.Fatal("recovered allowance was wrong:", p.Allowance)
	}

	// load the contracts
	cs, err := proto.NewContractSet(filepath.Join(dir, "contracts"), modules.ProdDependencies)
	if err != nil {
		t.Fatal(err)
	}
	if cs.Len() != 1 {
		t.Fatal("expected 1 contract, got", cs.Len())
	}
	m := cs.ViewAll()[0]
	if m.ID.String() != "792b5eec683819d78416a9e80cba454ebcb5a52eeac4f17b443d177bd425fc5c" {
		t.Fatal("recovered contract has wrong ID", m.ID)
	}
}