deploytest

type Deployment struct {

	// The fake transport layer is only used if the deployment is configured to use it
	// by setting testConfig.Net to "fake".
	// Otherwise, the fake transport might be created, but will not be used.
	FakeTransport *FakeTransport

	// The replicas of the deployment.
	TestReplicas []*TestReplica

	// Dummy clients to submit requests to replicas over the (local loopback) network.
	Clients []*dummyclient.DummyClient
	// contains filtered or unexported fields
}

type FakeApp struct {

	// The state of the FakeApp only consists of a counter of processed requests.
	RequestsProcessed uint64
}

type FakeLink struct {
	FakeTransport *FakeTransport
	Source        t.NodeID
}

type FakeTransport struct {
	// Buffers is source x dest
	Buffers   [][]chan *messagepb.Message
	NodeSinks []chan modules.ReceivedMessage
	WaitGroup sync.WaitGroup
	DoneC     chan struct{}
}

type NodeStatus struct {

	// Status as returned by mirbft.Node.Status()
	Status *statuspb.NodeStatus

	// Potential error returned by mirbft.Node.Status() in case of obtaining of the status failed.
	StatusErr error

	// Reason the node terminated, as returned by mirbft.Node.Run()
	ExitErr error
}

type TestConfig struct {

	// Number of replicas in the tested deployment.
	NumReplicas int

	// Number of clients in the tested deployment.
	NumClients int

	// Type of networking to use.
	// Current possible values: "fake", "grpc"
	Transport string

	// The number of requests each client submits during the execution of the deployment.
	NumFakeRequests int

	// The number of requests sent over the network (by a single DummyClient)
	NumNetRequests int

	// Directory where all the test-related files will be stored.
	// If empty, an OS-default temporary directory will be used.
	Directory string

	// Duration after which the test deployment will be asked to shut down.
	Duration time.Duration
}

type TestReplica struct {

	// ID of the replica as seen by the protocol.
	Id t.NodeID

	// Dummy test application the replica is running.
	App *FakeApp

	// Name of the directory where the persisted state of this TestReplica will be stored,
	// along with the logs produced by running the replica.
	Dir string

	// Configuration of the node corresponding to this replica.
	Config *mirbft.NodeConfig

	// List of replica IDs constituting the (static) membership.
	Membership []t.NodeID

	// List of IDs of all clients the replica will accept requests from.
	ClientIDs []t.ClientID

	// Network transport subsystem.
	Net modules.Net

	// Number of simulated requests inserted in the test replica by a hypothetical client.
	NumFakeRequests int

	// Configuration of the ISS protocol, if used. If set to nil, the default ISS configuration is assumed.
	ISSConfig *iss.Config
}