github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/contacts/mocks.go

//go:build !production
// +build !production

package contacts

import (
	"errors"
	"time"

	"github.com/stretchr/testify/require"

	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/protocol/keybase1"
)

// Contacts package things that are useful for testing within contacts package
// but also in other packages if necessary (mostly service/contacts_test.go).

type MockLookupUser struct {
	UID        keybase1.UID
	Username   string
	Fullname   string
	ServiceMap libkb.UserServiceSummary
}

func MakeMockLookupUser(username, fullname string) MockLookupUser {
	return MockLookupUser{
		Username: username,
		UID:      libkb.UsernameToUID(username),
		Fullname: fullname,
	}
}

type MockContactsProvider struct {
	T                 libkb.TestingTB
	PhoneNumbers      map[keybase1.RawPhoneNumber]MockLookupUser
	PhoneNumberErrors map[keybase1.RawPhoneNumber]string
	Emails            map[keybase1.EmailAddress]MockLookupUser
	Following         map[keybase1.UID]bool
}

func MakeMockProvider(t libkb.TestingTB) *MockContactsProvider {
	return &MockContactsProvider{
		T:                 t,
		PhoneNumbers:      make(map[keybase1.RawPhoneNumber]MockLookupUser),
		PhoneNumberErrors: make(map[keybase1.RawPhoneNumber]string),
		Emails:            make(map[keybase1.EmailAddress]MockLookupUser),
		Following:         make(map[keybase1.UID]bool),
	}
}

func (c *MockContactsProvider) LookupAllWithToken(mctx libkb.MetaContext, emails []keybase1.EmailAddress,
	numbers []keybase1.RawPhoneNumber, _ Token) (ContactLookupResults, error) {
	return c.LookupAll(mctx, emails, numbers)
}

func (c *MockContactsProvider) LookupAll(mctx libkb.MetaContext, emails []keybase1.EmailAddress,
	numbers []keybase1.RawPhoneNumber) (ContactLookupResults, error) {

	ret := NewContactLookupResults()
	for _, email := range emails {
		if user, found := c.Emails[email]; found {
			ret.Results[MakeEmailLookupKey(email)] = ContactLookupResult{UID: user.UID}
		}
	}
	for _, number := range numbers {
		if user, found := c.PhoneNumbers[number]; found {
			ret.Results[MakePhoneLookupKey(number)] = ContactLookupResult{UID: user.UID}
		}
		if errStr, found := c.PhoneNumberErrors[number]; found {
			ret.Results[MakePhoneLookupKey(number)] = ContactLookupResult{Error: errStr}
		}
	}
	ret.ResolvedFreshness = 10 * 24 * time.Hour  // approx 10 days
	ret.UnresolvedFreshness = 1 * 24 * time.Hour // approx one day
	return ret, nil
}

func (c *MockContactsProvider) FindUsernames(mctx libkb.MetaContext, uids []keybase1.UID) (map[keybase1.UID]ContactUsernameAndFullName, error) {
	res := make(map[keybase1.UID]ContactUsernameAndFullName)
	uidSet := make(map[keybase1.UID]struct{}, len(uids))
	for _, v := range uids {
		uidSet[v] = struct{}{}
	}

	for _, v := range c.PhoneNumbers {
		if _, found := uidSet[v.UID]; found {
			res[v.UID] = ContactUsernameAndFullName{
				Username: v.Username,
				Fullname: v.Fullname,
			}
		}
	}
	for _, v := range c.Emails {
		if _, found := uidSet[v.UID]; found {
			res[v.UID] = ContactUsernameAndFullName{
				Username: v.Username,
				Fullname: v.Fullname,
			}
		}
	}
	return res, nil
}

func (c *MockContactsProvider) FindFollowing(mctx libkb.MetaContext, uids []keybase1.UID) (map[keybase1.UID]bool, error) {
	res := make(map[keybase1.UID]bool)
	for _, uid := range uids {
		res[uid] = c.Following[uid]
	}
	return res, nil
}

func (c *MockContactsProvider) FindServiceMaps(mctx libkb.MetaContext, uids []keybase1.UID) (res map[keybase1.UID]libkb.UserServiceSummary, err error) {
	res = make(map[keybase1.UID]libkb.UserServiceSummary)
	uidSet := make(map[keybase1.UID]struct{}, len(uids))
	for _, v := range uids {
		uidSet[v] = struct{}{}
	}

	for _, v := range c.PhoneNumbers {
		if _, found := uidSet[v.UID]; found && v.ServiceMap != nil {
			res[v.UID] = v.ServiceMap
		}
	}
	for _, v := range c.Emails {
		if _, found := uidSet[v.UID]; found && v.ServiceMap != nil {
			res[v.UID] = v.ServiceMap
		}
	}
	return res, nil
}

type ErrorContactsProvider struct {
	NoFail bool
	T      libkb.TestingTB
}

func (c *ErrorContactsProvider) LookupAllWithToken(mctx libkb.MetaContext, emails []keybase1.EmailAddress,
	numbers []keybase1.RawPhoneNumber, _ Token) (ret ContactLookupResults, err error) {

	if !c.NoFail {
		require.Fail(c.T, "Call to ErrorContactsProvider.LookupAllWithToken")
	}
	return ret, errors.New("error contacts provider")
}

func (c *ErrorContactsProvider) LookupAll(mctx libkb.MetaContext, emails []keybase1.EmailAddress,
	numbers []keybase1.RawPhoneNumber) (ret ContactLookupResults, err error) {
	if !c.NoFail {
		require.Fail(c.T, "Call to ErrorContactsProvider.LookupAll")
	}
	return ret, errors.New("error contacts provider")
}

func (c *ErrorContactsProvider) FindUsernames(mctx libkb.MetaContext, uids []keybase1.UID) (map[keybase1.UID]ContactUsernameAndFullName, error) {
	if !c.NoFail {
		require.Fail(c.T, "Call to ErrorContactsProvider.FindUsernames")
	}
	return nil, errors.New("mock error")
}

func (c *ErrorContactsProvider) FindFollowing(mctx libkb.MetaContext, uids []keybase1.UID) (map[keybase1.UID]bool, error) {
	if !c.NoFail {
		require.Fail(c.T, "Call to ErrorContactsProvider.FindFollowing")
	}
	return nil, errors.New("mock error")
}

func (c *ErrorContactsProvider) FindServiceMaps(mctx libkb.MetaContext, uids []keybase1.UID) (map[keybase1.UID]libkb.UserServiceSummary, error) {
	if !c.NoFail {
		require.Fail(c.T, "Call to ErrorContactsProvider.FindServiceMaps")
	}
	return nil, errors.New("mock error")
}

func MakePhoneComponent(label string, phone string) keybase1.ContactComponent {
	num := keybase1.RawPhoneNumber(phone)
	return keybase1.ContactComponent{
		Label:       label,
		PhoneNumber: &num,
	}
}

func MakeEmailComponent(label string, email string) keybase1.ContactComponent {
	em := keybase1.EmailAddress(email)
	return keybase1.ContactComponent{
		Label: label,
		Email: &em,
	}
}

func MakeContact(name string, args ...keybase1.ContactComponent) keybase1.Contact {
	return keybase1.Contact{
		Name:       name,
		Components: args,
	}
}