test

Documentation

Index

• Variables
• func NewEmptyTestRepo() (mr *repo.MemRepo, err error)
• func NewMemRepoFromDir(path string) (repo.Repo, crypto.PrivKey, error)
• func NewTestCrypto() gen.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 ReadRepoConfig(path string) (pro *profile.Profile, pk crypto.PrivKey, err error)
• func TestdataPath(path string) string
• type TempRepo
  • func NewTempRepo(peername, prefix string) (r TempRepo, err error)
  • func NewTempRepoFixedProfileID(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) GetOutput() string
  • func (r *TempRepo) GetPathForDataset(index int) (string, error)
  • func (r *TempRepo) ReadBodyFromIPFS(keyPath string) (string, error)
  • func (r *TempRepo) Repo() (repo.Repo, error)
  • func (r *TempRepo) WriteConfigFile() 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() (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() gen.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 ReadRepoConfig

func ReadRepoConfig(path string) (pro *profile.Profile, pk crypto.PrivKey, err error)

ReadRepoConfig loads configuration data from a .yaml file

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 gen.CryptoGenerator
	Streams    ioes.IOStreams

	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) (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 (*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) GetOutput

func (r *TempRepo) GetOutput() string

GetOutput returns the output from the previously executed command.

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) 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() (repo.Repo, error)

Repo accesses the actual repo, building one if it doesn't already exist

func (*TempRepo) WriteConfigFile

func (r *TempRepo) WriteConfigFile() error

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