test

Documentation

Index

• Variables
• func NewEmptyTestRepo(bus event.Bus) (mr *repo.MemRepo, err error)
• func NewMemRepoFromDir(path string) (repo.Repo, crypto.PrivKey, error)
• func NewTestCrypto() key.CryptoGenerator
• func NewTestRepo() (mr *repo.MemRepo, err error)
• func NewTestRepoFromProfileID(id profile.ID, peerNum int, dataIndex int) (repo.Repo, error)
• func NewTestRepoWithHistory() (mr *repo.MemRepo, refs []reporef.DatasetRef, err error)
• func ProfileConfig() *config.ProfilePod
• func TestdataPath(path string) string
• type TempRepo
  • func NewTempRepo(peername, prefix string, g key.CryptoGenerator) (r TempRepo, err error)
  • func NewTempRepoFixedProfileID(peername, prefix string) (r TempRepo, err error)
  • func NewTempRepoUsingPeerInfo(peerInfoNum int, peername, prefix string) (r TempRepo, err error)
  • func (r *TempRepo) DatasetMarshalJSON(ref string) (string, error)
  • func (r *TempRepo) Delete()
  • func (r *TempRepo) GetConfig() *config.Config
  • func (r *TempRepo) GetPathForDataset(index int) (string, error)
  • func (r *TempRepo) LoadDataset(ref string) (*dataset.Dataset, error)
  • func (r *TempRepo) ReadBodyFromIPFS(keyPath string) (string, error)
  • func (r *TempRepo) Repo(ctx context.Context) (repo.Repo, error)
  • func (r *TempRepo) WriteConfigFile() error
  • func (r *TempRepo) WriteRootFile(filename, data string) (path string, err error)

Variables

var BadBodyFile = qfs.NewMemfileBytes("bad_csv_file.csv", []byte(`
asdlkfasd,,
fm as
f;lajsmf 
a
's;f a'
sdlfj asdf`))

BadBodyFile is a bunch of bad CSV data

var BadDataFormatFile = qfs.NewMemfileBytes("abc.csv", []byte(`
"colA","colB","colC","colD"
1,2,3,4
1,2,3`))

BadDataFormatFile has weird line lengths

var BadStructureFile = qfs.NewMemfileBytes("badStructure.csv", []byte(`
colA, colB, colB, colC
1,2,3,4
1,2,3,4`))

BadStructureFile has double-named columns

Functions

func NewEmptyTestRepo

func NewEmptyTestRepo(bus event.Bus) (mr *repo.MemRepo, err error)

NewEmptyTestRepo initializes a test repo with no contents

func NewMemRepoFromDir

func NewMemRepoFromDir(path string) (repo.Repo, crypto.PrivKey, error)

NewMemRepoFromDir reads a director of testCases and calls createDataset on each case with the given privatekey, yeilding a repo where the peer with this pk has created each dataset in question

func NewTestCrypto

func NewTestCrypto() key.CryptoGenerator

NewTestCrypto returns a mocked cryptographic generator for tests

func NewTestRepo

func NewTestRepo() (mr *repo.MemRepo, err error)

NewTestRepo generates a repository usable for testing purposes

func NewTestRepoFromProfileID

func NewTestRepoFromProfileID(id profile.ID, peerNum int, dataIndex int) (repo.Repo, error)

NewTestRepoFromProfileID constructs a repo from a profileID, usable for tests

func NewTestRepoWithHistory

func NewTestRepoWithHistory() (mr *repo.MemRepo, refs []reporef.DatasetRef, err error)

NewTestRepoWithHistory generates a repository with a dataset that has a history, usable for testing purposes

func ProfileConfig

func ProfileConfig() *config.ProfilePod

ProfileConfig returns the test profile as a config.Profile

func TestdataPath

func TestdataPath(path string) string

TestdataPath returns the absolute path to a file in the testdata diretory

Types

type TempRepo

type TempRepo struct {
	RootPath   string
	IPFSPath   string
	QriPath    string
	TestCrypto key.CryptoGenerator

	UseMockRemoteClient bool
	// contains filtered or unexported fields
}

TempRepo manages a temporary repository for testing purposes, adding extra methods for testing convenience

func NewTempRepo

func NewTempRepo(peername, prefix string, g key.CryptoGenerator) (r TempRepo, err error)

NewTempRepo constructs the test repo and initializes everything as cheaply as possible. This function is non-deterministic. Each successive call to TempRepo will use different PKI credentials

func NewTempRepoFixedProfileID

func NewTempRepoFixedProfileID(peername, prefix string) (r TempRepo, err error)

NewTempRepoFixedProfileID creates a temp repo that always uses the same PKI credentials

func NewTempRepoUsingPeerInfo

func NewTempRepoUsingPeerInfo(peerInfoNum int, peername, prefix string) (r TempRepo, err error)

NewTempRepoUsingPeerInfo creates a temp repo using the given peerInfo

func (*TempRepo) DatasetMarshalJSON

func (r *TempRepo) DatasetMarshalJSON(ref string) (string, error)

DatasetMarshalJSON reads the dataset head and marshals it as json.

func (*TempRepo) Delete

func (r *TempRepo) Delete()

Delete removes the test repo on disk.

func (*TempRepo) GetConfig

func (r *TempRepo) GetConfig() *config.Config

GetConfig returns the configuration for the test repo.

func (*TempRepo) GetPathForDataset

func (r *TempRepo) GetPathForDataset(index int) (string, error)

GetPathForDataset returns the path to where the index'th dataset is stored on CAFS.

func (*TempRepo) LoadDataset

func (r *TempRepo) LoadDataset(ref string) (*dataset.Dataset, error)

LoadDataset from the temp repository

func (*TempRepo) ReadBodyFromIPFS

func (r *TempRepo) ReadBodyFromIPFS(keyPath string) (string, error)

ReadBodyFromIPFS reads the body of the dataset at the given keyPath stored in CAFS

func (*TempRepo) Repo

func (r *TempRepo) Repo(ctx context.Context) (repo.Repo, error)

Repo constructs the repo for use in tests, the passed in context MUST be cancelled when finished. This repo creates it's own event bus

func (*TempRepo) WriteConfigFile

func (r *TempRepo) WriteConfigFile() error

WriteConfigFile serializes the config file and writes it to the qri repository

func (*TempRepo) WriteRootFile

func (r *TempRepo) WriteRootFile(filename, data string) (path string, err error)

WriteRootFile writes a file string to the root directory of the temp repo