test_provider_deal_environment.go

// Package testing provides test implementations of retieval market interfaces
package testing

import (
	"context"

	"github.com/ipfs/go-cid"

	datatransfer "github.com/filecoin-project/go-data-transfer/v2"

	rm "github.com/filecoin-project/go-fil-markets/retrievalmarket"
	retrievalimpl "github.com/filecoin-project/go-fil-markets/retrievalmarket/impl"
	"github.com/filecoin-project/go-fil-markets/retrievalmarket/impl/providerstates"
)

// TestProviderDealEnvironment is a test implementation of ProviderDealEnvironment used
// by the provider state machine.
type TestProviderDealEnvironment struct {
	node                        rm.RetrievalProviderNode
	ResumeDataTransferError     error
	PrepareBlockstoreError      error
	CloseDataTransferError      error
	DeleteStoreError            error
	ReturnedChannelState        datatransfer.ChannelState
	ChannelStateError           error
	NewValidationStatus         datatransfer.ValidationResult
	UpdateValidationStatusError error
}

// NewTestProviderDealEnvironment returns a new TestProviderDealEnvironment instance
func NewTestProviderDealEnvironment(node rm.RetrievalProviderNode) *TestProviderDealEnvironment {
	return &TestProviderDealEnvironment{
		node: node,
	}
}

// Node returns a provider node instance
func (te *TestProviderDealEnvironment) Node() rm.RetrievalProviderNode {
	return te.node
}

func (te *TestProviderDealEnvironment) DeleteStore(dealID rm.DealID) error {
	return te.DeleteStoreError
}

func (te *TestProviderDealEnvironment) PrepareBlockstore(ctx context.Context, dealID rm.DealID, pieceCid cid.Cid) error {
	return te.PrepareBlockstoreError
}

func (te *TestProviderDealEnvironment) ResumeDataTransfer(_ context.Context, _ datatransfer.ChannelID) error {
	return te.ResumeDataTransferError
}

func (te *TestProviderDealEnvironment) CloseDataTransfer(_ context.Context, _ datatransfer.ChannelID) error {
	return te.CloseDataTransferError
}

func (te *TestProviderDealEnvironment) ChannelState(_ context.Context, _ datatransfer.ChannelID) (datatransfer.ChannelState, error) {
	return te.ReturnedChannelState, te.ChannelStateError
}

func (te *TestProviderDealEnvironment) UpdateValidationStatus(_ context.Context, _ datatransfer.ChannelID, status datatransfer.ValidationResult) error {
	te.NewValidationStatus = status
	return te.UpdateValidationStatusError
}

// TrivialTestDecider is a shortest possible DealDecider that accepts all deals
var TrivialTestDecider retrievalimpl.DealDecider = func(_ context.Context, _ rm.ProviderDealState) (bool, string, error) {
	return true, "", nil
}

var _ providerstates.ProviderDealEnvironment = (*TestProviderDealEnvironment)(nil)