Select Git revision
utils_test.go 12.06 KiB
////////////////////////////////////////////////////////////////////////////////
// Copyright © 2022 xx foundation //
// //
// Use of this source code is governed by a license that can be found in the //
// LICENSE file. //
////////////////////////////////////////////////////////////////////////////////
package e2e
import (
"bytes"
"github.com/pkg/errors"
"gitlab.com/elixxir/client/cmix"
"gitlab.com/elixxir/client/cmix/gateway"
"gitlab.com/elixxir/client/cmix/identity"
"gitlab.com/elixxir/client/cmix/identity/receptionID"
"gitlab.com/elixxir/client/cmix/message"
"gitlab.com/elixxir/client/cmix/rounds"
"gitlab.com/elixxir/client/e2e/receive"
"gitlab.com/elixxir/client/stoppable"
"gitlab.com/elixxir/comms/network"
"gitlab.com/elixxir/primitives/format"
"gitlab.com/xx_network/comms/connect"
"gitlab.com/xx_network/primitives/id"
"gitlab.com/xx_network/primitives/id/ephemeral"
"gitlab.com/xx_network/primitives/ndf"
"gitlab.com/xx_network/primitives/netTime"
"math/rand"
"sync"
"testing"
"time"
)
func e2eMessagesEqual(received, expected e2eMessage, t *testing.T) bool {
equals := true
if !bytes.Equal(received.Recipient, expected.Recipient) {
t.Errorf("Receipient values for messages are not equivalent")
equals = false
}
if !bytes.Equal(received.Payload, expected.Payload) {
equals = false
t.Errorf("Payload values for messages are not equivalent")
}
if received.MessageType != expected.MessageType {
equals = false
t.Errorf("MessageType values for messages are not equivalent")
}
return equals
}
// makeTestE2EMessages creates a list of messages with random data and the
// expected map after they are added to the buffer.
func makeTestE2EMessages(n int, t *testing.T) []e2eMessage {
prng := rand.New(rand.NewSource(netTime.Now().UnixNano()))
msgs := make([]e2eMessage, n)
for i := range msgs {
rngBytes := make([]byte, 128)
prng.Read(rngBytes)
msgs[i].Recipient = id.NewIdFromBytes(rngBytes, t).Bytes()
prng.Read(rngBytes)
msgs[i].Payload = rngBytes
prng.Read(rngBytes)
msgs[i].MessageType = uint32(rngBytes[0])
}
return msgs}
////////////////////////////////////////////////////////////////////////////////
// Mock Listener //
////////////////////////////////////////////////////////////////////////////////
type mockListener struct {
receiveChan chan receive.Message
}
func (m *mockListener) Hear(item receive.Message) { m.receiveChan <- item }
func (m *mockListener) Name() string { return "" }
////////////////////////////////////////////////////////////////////////////////
// Mock Events Manager //
////////////////////////////////////////////////////////////////////////////////
type mockEventsManager struct{}
func (m mockEventsManager) Report(int, string, string, string) {}
////////////////////////////////////////////////////////////////////////////////
// Mock Services //
////////////////////////////////////////////////////////////////////////////////
type mockServices struct {
services map[id.ID]map[string]message.Processor
sync.Mutex
}
func newMockServices() *mockServices {
return &mockServices{
services: make(map[id.ID]map[string]message.Processor),
}
}
func (m *mockServices) AddService(
clientID *id.ID, ms message.Service, p message.Processor) {
m.Lock()
defer m.Unlock()
if m.services[*clientID] == nil {
m.services[*clientID] = map[string]message.Processor{ms.Tag: p}
} else {
m.services[*clientID][ms.Tag] = p
}
m.services[*clientID][ms.Tag] = p
}
func (m *mockServices) DeleteService(
clientID *id.ID, ms message.Service, _ message.Processor) {
m.Lock()
defer m.Unlock()
if m.services[*clientID] != nil {
delete(m.services[*clientID], ms.Tag)
}
}
////////////////////////////////////////////////////////////////////////////////
// Mock cMix //
////////////////////////////////////////////////////////////////////////////////
type mockCmixHandler struct {
processorMap map[format.Fingerprint]message.Processor
serviceMap map[string]message.Processor
sync.Mutex
}
func newMockCmixHandler() *mockCmixHandler { return &mockCmixHandler{
processorMap: make(map[format.Fingerprint]message.Processor),
serviceMap: make(map[string]message.Processor),
}
}
// todo: implement this for specific tests
type mockCmix struct {
t testing.TB
myID *id.ID
numPrimeBytes int
health bool
handler *mockCmixHandler
instance *network.Instance
}
func newMockCmix(myID *id.ID, handler *mockCmixHandler, t testing.TB) *mockCmix {
comms := &connect.ProtoComms{Manager: connect.NewManagerTesting(t)}
def := getNDF()
instance, err := network.NewInstanceTesting(comms, def, def, nil, nil, t)
if err != nil {
panic(err)
}
return &mockCmix{
t: t,
myID: myID,
numPrimeBytes: 4096,
health: true,
handler: handler,
instance: instance,
}
}
func (m *mockCmix) Follow(cmix.ClientErrorReport) (stoppable.Stoppable, error) { return nil, nil }
func (m *mockCmix) GetMaxMessageLength() int {
msg := format.NewMessage(m.numPrimeBytes)
return msg.ContentsSize()
}
func (m *mockCmix) Send(_ *id.ID, fp format.Fingerprint, srv message.Service,
payload, mac []byte, _ cmix.CMIXParams) (rounds.Round, ephemeral.Id, error) {
m.handler.Lock()
defer m.handler.Unlock()
msg := format.NewMessage(m.numPrimeBytes)
msg.SetContents(payload)
msg.SetMac(mac)
msg.SetKeyFP(fp)
if m.handler.processorMap[fp] != nil {
m.handler.processorMap[fp].Process(
msg, receptionID.EphemeralIdentity{}, rounds.Round{})
return rounds.Round{}, ephemeral.Id{}, nil
} else if m.handler.serviceMap[srv.Tag] != nil {
m.handler.serviceMap[srv.Tag].Process(
msg, receptionID.EphemeralIdentity{}, rounds.Round{})
return rounds.Round{}, ephemeral.Id{}, nil
}
m.t.Errorf("No processor found for fingerprint %s", fp)
return rounds.Round{}, ephemeral.Id{},
errors.Errorf("No processor found for fingerprint %s", fp)
}
func (m *mockCmix) SendWithAssembler(recipient *id.ID, assembler cmix.MessageAssembler,
cmixParams cmix.CMIXParams) (rounds.Round, ephemeral.Id, error) { panic("implement me")
}
func (m *mockCmix) SendMany([]cmix.TargetedCmixMessage, cmix.CMIXParams) (rounds.Round, []ephemeral.Id, error) {
return rounds.Round{}, nil, nil
}
func (m *mockCmix) AddIdentity(*id.ID, time.Time, bool) {}
func (m *mockCmix) AddIdentityWithHistory(id *id.ID, validUntil, beginning time.Time, persistent bool) {
}
func (m *mockCmix) RemoveIdentity(*id.ID) {}
func (m *mockCmix) GetIdentity(*id.ID) (identity.TrackedID, error) { return identity.TrackedID{}, nil }
func (m *mockCmix) AddFingerprint(_ *id.ID, fp format.Fingerprint, mp message.Processor) error {
m.handler.Lock()
defer m.handler.Unlock()
m.handler.processorMap[fp] = mp
return nil
}
func (m *mockCmix) DeleteFingerprint(_ *id.ID, fp format.Fingerprint) {
m.handler.Lock()
delete(m.handler.processorMap, fp)
m.handler.Unlock()
}
func (m *mockCmix) AddService(myId *id.ID, srv message.Service, proc message.Processor) {
m.handler.Lock()
m.handler.serviceMap[srv.Tag] = proc
m.handler.Unlock()
}
func (m *mockCmix) IncreaseParallelNodeRegistration(int) func() (stoppable.Stoppable, error) {
return nil
}
func (m *mockCmix) DeleteClientFingerprints(*id.ID) {}
func (m *mockCmix) DeleteService(*id.ID, message.Service, message.Processor) {}
func (m *mockCmix) DeleteClientService(*id.ID) {}
func (m *mockCmix) TrackServices(message.ServicesTracker) {}
func (m *mockCmix) CheckInProgressMessages() {}
func (m *mockCmix) IsHealthy() bool { return m.health }
func (m *mockCmix) WasHealthy() bool { return true }
func (m *mockCmix) AddHealthCallback(func(bool)) uint64 { return 0 }
func (m *mockCmix) RemoveHealthCallback(uint64) {}
func (m *mockCmix) HasNode(*id.ID) bool { return true }
func (m *mockCmix) NumRegisteredNodes() int { return 0 }
func (m *mockCmix) TriggerNodeRegistration(*id.ID) {}
func (m *mockCmix) GetRoundResults(time.Duration, cmix.RoundEventCallback, ...id.Round) {
}
func (m *mockCmix) LookupHistoricalRound(id.Round, rounds.RoundResultCallback) error { return nil }
func (m *mockCmix) SendToAny(func(host *connect.Host) (interface{}, error), *stoppable.Single) (interface{}, error) {
return nil, nil
}
func (m *mockCmix) SendToPreferred([]*id.ID, gateway.SendToPreferredFunc, *stoppable.Single, time.Duration) (interface{}, error) {
return nil, nil
}
func (m *mockCmix) SetGatewayFilter(gateway.Filter) {}
func (m *mockCmix) GetHostParams() connect.HostParams { return connect.HostParams{} }
func (m *mockCmix) GetAddressSpace() uint8 { return 0 }
func (m *mockCmix) RegisterAddressSpaceNotification(string) (chan uint8, error) { return nil, nil }
func (m *mockCmix) UnregisterAddressSpaceNotification(string) { return }
func (m *mockCmix) GetInstance() *network.Instance { return m.instance }
func (m *mockCmix) GetVerboseRounds() string { return "" }
////////////////////////////////////////////////////////////////////////////////
// NDF //
////////////////////////////////////////////////////////////////////////////////
func getNDF() *ndf.NetworkDefinition {
return &ndf.NetworkDefinition{
E2E: ndf.Group{ Prime: "E2EE983D031DC1DB6F1A7A67DF0E9A8E5561DB8E8D49413394C049B7A" +
"8ACCEDC298708F121951D9CF920EC5D146727AA4AE535B0922C688B55B3D" +
"D2AEDF6C01C94764DAB937935AA83BE36E67760713AB44A6337C20E78615" +
"75E745D31F8B9E9AD8412118C62A3E2E29DF46B0864D0C951C394A5CBBDC" +
"6ADC718DD2A3E041023DBB5AB23EBB4742DE9C1687B5B34FA48C3521632C" +
"4A530E8FFB1BC51DADDF453B0B2717C2BC6669ED76B4BDD5C9FF558E88F2" +
"6E5785302BEDBCA23EAC5ACE92096EE8A60642FB61E8F3D24990B8CB12EE" +
"448EEF78E184C7242DD161C7738F32BF29A841698978825B4111B4BC3E1E" +
"198455095958333D776D8B2BEEED3A1A1A221A6E37E664A64B83981C46FF" +
"DDC1A45E3D5211AAF8BFBC072768C4F50D7D7803D2D4F278DE8014A47323" +
"631D7E064DE81C0C6BFA43EF0E6998860F1390B5D3FEACAF1696015CB79C" +
"3F9C2D93D961120CD0E5F12CBB687EAB045241F96789C38E89D796138E63" +
"19BE62E35D87B1048CA28BE389B575E994DCA755471584A09EC723742DC3" +
"5873847AEF49F66E43873",
Generator: "2",
},
CMIX: ndf.Group{
Prime: "9DB6FB5951B66BB6FE1E140F1D2CE5502374161FD6538DF1648218642" +
"F0B5C48C8F7A41AADFA187324B87674FA1822B00F1ECF8136943D7C55757" +
"264E5A1A44FFE012E9936E00C1D3E9310B01C7D179805D3058B2A9F4BB6F" +
"9716BFE6117C6B5B3CC4D9BE341104AD4A80AD6C94E005F4B993E14F091E" +
"B51743BF33050C38DE235567E1B34C3D6A5C0CEAA1A0F368213C3D19843D" +
"0B4B09DCB9FC72D39C8DE41F1BF14D4BB4563CA28371621CAD3324B6A2D3" +
"92145BEBFAC748805236F5CA2FE92B871CD8F9C36D3292B5509CA8CAA77A" +
"2ADFC7BFD77DDA6F71125A7456FEA153E433256A2261C6A06ED3693797E7" +
"995FAD5AABBCFBE3EDA2741E375404AE25B",
Generator: "5C7FF6B06F8F143FE8288433493E4769C4D988ACE5BE25A0E2480" +
"9670716C613D7B0CEE6932F8FAA7C44D2CB24523DA53FBE4F6EC3595892D" +
"1AA58C4328A06C46A15662E7EAA703A1DECF8BBB2D05DBE2EB956C142A33" +
"8661D10461C0D135472085057F3494309FFA73C611F78B32ADBB5740C361" +
"C9F35BE90997DB2014E2EF5AA61782F52ABEB8BD6432C4DD097BC5423B28" +
"5DAFB60DC364E8161F4A2A35ACA3A10B1C4D203CC76A470A33AFDCBDD929" +
"59859ABD8B56E1725252D78EAC66E71BA9AE3F1DD2487199874393CD4D83" +
"2186800654760E1E34C09E4D155179F9EC0DC4473F996BDCE6EED1CABED8" +
"B6F116F7AD9CF505DF0F998E34AB27514B0FFE7",
},
}
}