helper

Documentation

Overview

Package helper provides helper functions for testing.

Index

• Variables
• func BuildIndexTree(node *json.TreeNode) *index.Tree[*crdt.TreeNode]
• func BuildTreeNode(node *json.TreeNode) *crdt.TreeNode
• func CreateAdminCli(t assert.TestingT, rpcAddr string) *adminClient.Client
• func IssuePos(change *change.Context, offset ...int) *crdt.TreeNodeID
• func IssueTime(change *change.Context) *time.Ticket
• func NewRangeSlice(start, end int) []int
• func NodesBetweenEqual(t assert.TestingT, tree *index.Tree[*crdt.TreeNode], from, to int, ...) bool
• func TestConfig() *server.Config
• func TestDBName() string
• func TestDocKey(t testing.TB) key.Key
• func TestRoot() *crdt.Root
• func TestServer() *server.Yorkie
• func TestSlugName(t testing.TB) string
• func TextChangeContext(root *crdt.Root) *change.Context
• func ToDiagnostic(node *crdt.TreeNode) string

Variables

var (
	RPCPort                  = 21101
	RPCMaxRequestBytes       = uint64(4 * 1024 * 1024)
	RPCMaxConnectionAge      = 8 * gotime.Second
	RPCMaxConnectionAgeGrace = 2 * gotime.Second

	ProfilingPort = 21102

	AdminUser                             = server.DefaultAdminUser
	AdminPassword                         = server.DefaultAdminPassword
	HousekeepingInterval                  = 10 * gotime.Second
	HousekeepingCandidatesLimitPerProject = 10
	HousekeepingProjectFetchSize          = 10

	AdminTokenDuration         = "10s"
	ClientDeactivateThreshold  = "10s"
	SnapshotThreshold          = int64(10)
	SnapshotWithPurgingChanges = false
	AuthWebhookMaxWaitInterval = 3 * gotime.Millisecond
	AuthWebhookSize            = 100
	AuthWebhookCacheAuthTTL    = 10 * gotime.Second
	AuthWebhookCacheUnauthTTL  = 10 * gotime.Second
	ProjectInfoCacheSize       = 256
	ProjectInfoCacheTTL        = 5 * gotime.Second

	MongoConnectionURI     = "mongodb://localhost:27017"
	MongoConnectionTimeout = "5s"
	MongoPingTimeout       = "5s"
)

Below are the values of the Yorkie config used in the test.

Functions

func BuildIndexTree

func BuildIndexTree(node *json.TreeNode) *index.Tree[*crdt.TreeNode]

BuildIndexTree builds an index tree from the given block node.

func BuildTreeNode

func BuildTreeNode(node *json.TreeNode) *crdt.TreeNode

BuildTreeNode builds a crdt.TreeNode from the given tree node.

func CreateAdminCli

func CreateAdminCli(t assert.TestingT, rpcAddr string) *adminClient.Client

CreateAdminCli returns a new instance of admin cli for testing.

func IssuePos

func IssuePos(change *change.Context, offset ...int) *crdt.TreeNodeID

IssuePos is a helper function that issues a new CRDTTreeNodeID.

func IssueTime

func IssueTime(change *change.Context) *time.Ticket

IssueTime is a helper function that issues a new TimeTicket

func NewRangeSlice

func NewRangeSlice(start, end int) []int

NewRangeSlice returns a slice of integers from start to end.

func NodesBetweenEqual

func NodesBetweenEqual(t assert.TestingT, tree *index.Tree[*crdt.TreeNode], from, to int, expected []string) bool

NodesBetweenEqual is a helper function that checks the nodes between the given indexes.

func TestConfig

func TestConfig() *server.Config

TestConfig returns config for creating Yorkie instance.

func TestDBName

func TestDBName() string

TestDBName returns the name of test database with timestamp. timestamp is set only once on first call.

func TestDocKey

func TestDocKey(t testing.TB) key.Key

TestDocKey returns a new instance of document key for testing.

func TestRoot

func TestRoot() *crdt.Root

TestRoot returns the root

func TestServer

func TestServer() *server.Yorkie

TestServer returns a new instance of Yorkie for testing.

func TestSlugName

func TestSlugName(t testing.TB) string

TestSlugName returns a new instance of slug name for testing.

func TextChangeContext

func TextChangeContext(root *crdt.Root) *change.Context

TextChangeContext returns the context of test change.

func ToDiagnostic

func ToDiagnostic(node *crdt.TreeNode) string

ToDiagnostic is a helper function that converts the given node to a diagnostic string.